Tutorial: Configure Zendesk for automatic user provisioning

This tutorial demonstrates the steps to perform in Zendesk and Azure Active Directory (Azure AD) to configure Azure AD to automatically provision and deprovision users and groups to Zendesk.

Note

This tutorial describes a connector that's built on top of the Azure AD user provisioning service. For information on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to software-as-a-service (SaaS) applications with Azure Active Directory.

Prerequisites

The scenario outlined in this tutorial assumes that you have:

  • An Azure AD tenant.
  • A Zendesk tenant with the Enterprise plan or better enabled.
  • A user account in Zendesk with admin permissions.

Note

The Azure AD provisioning integration relies on the Zendesk Rest API. This API is available to Zendesk teams on the Enterprise plan or better.

Add Zendesk from the Azure Marketplace

Before you configure Zendesk for automatic user provisioning with Azure AD, add Zendesk from the Azure Marketplace to your list of managed SaaS applications.

To add Zendesk from the Marketplace, follow these steps.

  1. In the Azure portal, in the navigation pane on the left, select Azure Active Directory.

    The Azure Active Directory icon

  2. Go to Enterprise applications, and then select All applications.

    The Enterprise applications blade

  3. To add a new application, select New application at the top of the dialog box.

    The New application button

  4. In the search box, enter Zendesk and select Zendesk from the result panel. To add the application, select Add.

    Zendesk in the results list

Assign users to Zendesk

Azure Active Directory uses a concept called assignments to determine which users should receive access to selected apps. In the context of automatic user provisioning, only the users or groups that were assigned to an application in Azure AD are synchronized.

Before you configure and enable automatic user provisioning, decide which users or groups in Azure AD need access to Zendesk. To assign these users or groups to Zendesk, follow the instructions in Assign a user or group to an enterprise app.

Important tips for assigning users to Zendesk

  • Today, Zendesk roles are automatically and dynamically populated in the Azure portal UI. Before you assign Zendesk roles to users, make sure that an initial sync is completed against Zendesk to retrieve the latest roles in your Zendesk tenant.

  • We recommend that you assign a single Azure AD user to Zendesk to test your initial automatic user provisioning configuration. You can assign additional users or groups later after the tests are successful.

  • When you assign a user to Zendesk, select any valid application-specific role, if available, in the assignment dialog box. Users with the Default Access role are excluded from provisioning.

Configure automatic user provisioning to Zendesk

This section guides you through the steps to configure the Azure AD provisioning service. Use it to create, update, and disable users or groups in Zendesk based on user or group assignments in Azure AD.

Tip

You also can enable SAML-based single sign-on for Zendesk. Follow the instructions in the Zendesk single sign-on tutorial. Single sign-on can be configured independently of automatic user provisioning, although these two features complement each other.

Configure automatic user provisioning for Zendesk in Azure AD

  1. Sign in to the Azure portal. Select Enterprise applications > All applications > Zendesk.

    Enterprise applications blade

  2. In the applications list, select Zendesk.

    The Zendesk link in the applications list

  3. Select the Provisioning tab.

    Zendesk Provisioning

  4. Set the Provisioning Mode to Automatic.

    Zendesk Provisioning Mode

  5. Under the Admin Credentials section, input the admin username, secret token, and domain of your Zendesk account. Examples of these values are:

    • In the Admin Username box, fill in the username of the admin account on your Zendesk tenant. An example is admin@contoso.com.

    • In the Secret Token box, fill in the secret token as described in Step 6.

    • In the Domain box, fill in the subdomain of your Zendesk tenant. For example, for an account with a tenant URL of https://my-tenant.zendesk.com, your subdomain is my-tenant.

  6. The secret token for your Zendesk account is located in Admin > API > Settings. Make sure that Token Access is set to Enabled.

    Zendesk admin settings

    Zendesk secret token

  7. After you fill in the boxes shown in Step 5, select Test Connection to make sure that Azure AD can connect to Zendesk. If the connection fails, make sure your Zendesk account has admin permissions and try again.

    Zendesk Test Connection

  8. In the Notification Email box, enter the email address of the person or group to receive the provisioning error notifications. Select the Send an email notification when a failure occurs check box.

    Zendesk Notification Email

  9. Select Save.

  10. Under the Mappings section, select Synchronize Azure Active Directory Users to Zendesk.

    Zendesk user synchronization

  11. Review the user attributes that are synchronized from Azure AD to Zendesk in the Attribute Mappings section. The attributes selected as Matching properties are used to match the user accounts in Zendesk for update operations. To save any changes, select Save.

    Zendesk matching user attributes

  12. Under the Mappings section, select Synchronize Azure Active Directory Groups to Zendesk.

    Zendesk group synchronization

  13. Review the group attributes that are synchronized from Azure AD to Zendesk in the Attribute Mappings section. The attributes selected as Matching properties are used to match the groups in Zendesk for update operations. To save any changes, select Save.

    Zendesk matching group attributes

  14. To configure scoping filters, follow the instructions in the scoping filter tutorial.

  15. To enable the Azure AD provisioning service for Zendesk, in the Settings section, change Provisioning Status to On.

    Zendesk Provisioning Status

  16. Define the users or groups that you want to provision to Zendesk. In the Settings section, select the values you want in Scope.

    Zendesk Scope

  17. When you're ready to provision, select Save.

    Zendesk Save

This operation starts the initial synchronization of all users or groups defined in Scope in the Settings section. The initial sync takes longer to perform than later syncs. They occur approximately every 40 minutes as long as the Azure AD provisioning service runs.

You can use the Synchronization Details section to monitor progress and follow links to the provisioning activity report. The report describes all the actions performed by the Azure AD provisioning service on Zendesk.

For information on how to read the Azure AD provisioning logs, see Reporting on automatic user account provisioning.

Connector limitations

  • Zendesk supports the use of groups for users with Agent roles only. For more information, see the Zendesk documentation.

  • When a custom role is assigned to a user or group, the Azure AD automatic user provisioning service also assigns the default role Agent. Only Agents can be assigned a custom role. For more information, see the Zendesk API documentation.

Additional resources

Next steps