Skip to main content

About the Zendesk Connector

The EmpowerID Zendesk connector lets you create, synchronize, and manage Zendesk users, groups, group memberships, user roles, custom roles, organizations, and organization membership within EmpowerID. Imported user data can be managed and synchronized with data in any connected back-end user directories.

Authentication

Zendesk connector uses basic authentication. In basic authentication, the username and password are used for authentication. The account used for authentication should be an administrator account.

Supported Features and Attribute Mappings

  • Account Management

    • Inventory Zendesk users as EmpowerID accounts
    • Create, Update, Disable, Enable and Delete users – Disabling a user in EmpowerID suspends the user in Zendesk, while enabling a user in EmpowerID restores suspended users in Zendesk
    • Reset password – Allow admins to set passwords must be enabled in Zendesk for this to function in EmpowerID
    • Change password – EmpowerID impersonates the user whose password is being changed
    Fields supported by Create and Update
    Zendesk User AttributesData TypeDescription
    nameStringUser's name
    emailStringUser’s email
    phoneStringUser’s phone
    roleStringUser’s role. Possible values admin, agent and end-user
    chat_onlyBoolean
    restricted_agentBooleanDetermines if the agent has any restrictions
    suspendedBooleanDetermines if the agent is suspended
    only_private_commentsBooleanDetermines if the user can only create private comments
    moderatorBooleanDesignates whether the user has forum moderation capabilities
    verifiedBooleanDetermines if the user's identity has been verified or not
    activeBooleanDetermines if the user has been deleted
    ticket_restrictionStringSpecifies which tickets the user has access to. Possible values are: organization, groupsassigned, requested, and null
    notesStringAny notes about the user
    detailsStringAny details you want to store about the user, such as an address
    signatureStringThe user's signature. Only agents and admins can have signatures
    aliasStringAn alias displayed to end users
  • Group Management

    • Inventory Zendesk groups as EmpowerID groups
    • Inventory Zendesk group memberships as EmpowerID group accounts
    • Create, Update and Delete groups
    • Add and Remove members to and from groups
  • Organizations

    • Inventory Zendesk organizations (ExternalOrgZones in the EmpowerID Identity Warehouse)
  • Roles

    • Inventory Zendesk Roles (ExternalOrgRoles in the EmpowerID Identity Warehouse)
  • Organization Memberships

    • Inventory Zendesk Organization Memberships (AccountExternalOrgRoleOrgZone in the EmpowerID Identity Warehouse)
  • Account Attributes
    Users in Zendesk are inventoried as accounts in EmpowerID. The below table shows the attribute mappings of Zendesk user attributes to EmpowerID Person attributes.

    Zendesk AttributeZendesk EndpointEmpowerID AttributeDescription
    nameusersNameName of the user.
    name (string before space)*usersFirstNameFirst name of the user.
    name (string after space)*usersLastNameLast name of the user.
    idusersLogonNameUnique System Identifier of the user.
    idusersSystemIdenitfierUnique System Identifier of the user.
    phoneusersTelephonePhone number of the user.
    emailusersEmailEmail ID of the user.
    localeusersPreferredLanguageLocale of the user.
    suspendedusersActiveDetermines if the user is suspended.
    roleusersJobTitleRole of the user.  Possible values are "end-user""agent", or"admin"
    aliasusersAliasAlias of the user.
    urlusersDistinguishedNameThe user’s API url.
    name (organization name)organizationsCompanyCompany name of the user.
    nameusersNameName of the user.
    info

    EmpowerID parses name into FirstName and LastName if it contains a space.

  • Group Attributes
    EmpowerID inventories Groups in Zendesk as Groups in EmpowerID. The below table shows the attribute mappings of Zendesk group attributes to EmpowerID group attributes.

    Zendesk AttributeZendesk EndpointEmpowerID AttributeDescription
    namegroupsNameName of the group.
    idgroupsSystemIdentifierUnique System Identifier of the group.
    urlgroupsDistinguishedNameGroup’s API url.
    idgroupsLogonNameUnique System Identifier of the group.
    deletedgroupsDeletedDetermines if the group is deleted.
  • Role Attributes
    EmpowerID inventories Roles / Custom Agent Roles in Zendesk as ExternalOrgRoles in EmpowerID. Possible values of roles in Zendesk are end-user, agent or admin. The below table shows the attribute mappings of Custom Agent Role attributes to EmpowerID ExternalOrgRole attributes.

    Zendesk AttributeZendesk EndpointEmpowerID AttributeDescription
    idcustom_rolesSystemIdentifierUnique Identifier of the Role.
    namecustom_rolesNameName of the Role.
    descriptioncustom_rolesDescriptionDescription of the Role.
  • Organization Attributes
    EmpowerID inventories Organizations in Zendesk as ExternalOrgZones in EmpowerID. The below table shows the attribute mappings of Zendesk Organization attributes to EmpowerID ExternalOrgZones attributes.

    Zendesk AttributeZendesk EndpointEmpowerID AttributeDescription
    idorganizationsSystemIdentifierUnique Identifier of the organization.
    nameorganizationsNameName of the Location along with name of the company in that location.
    urlorganizationsDistinguishedNameThe organization’s API URL

Group Membership

With the Zendesk connector, you can have EmpowerID inventory Group memberships (GroupAccount table) in EmpowerID. You can also add members to groups and remove members from groups in either EmpowerID or Zendesk, and the changes will propagate to the other system on the next inventory.

User Role and Location Mapping

User roles along with corresponding organization of the user are stored in AccountExternalOrgRoleOrgZone table in EmpowerID.  Roles (admin, agent or end-user) in Zendesk are inventoried as primary roles and Custom Roles in Zendesk are inventoried as secondary roles in EmpowerID.

Inventory

The Zendesk connector supports two types of inventory functionality.

  • Incremental Inventory — Keeps track of the inventory run's LastTimeStamp, and brings in only users and groups updated after that time.
  • Full Inventory — Inventories every user and group every time it runs.