Skip to content

Enable Authentication in Zendesk

For Basic Authentication

Enable password or token access in the Zendesk API admin configuration.

To enable password or token access:

  1. In Zendesk Support, select Admin > Channels > API.
  2. On the Settings tab, enable Password Access or Token Access.

For OAuth 2.0 Authentication

  • Enable Password Access in the Zendesk API admin configuration. Refer to enabling password or token access.
  • Create a new OAuth client by providing the Client Name in the Zendesk API admin configuration.
  • Use the same Client Name for the Client ID and generated Client Secret on your Zendesk application.

Important

Client Secret is only visible in the Zendesk managed system during the creation of the OAuth client.

For the most up-to-date information about performing tasks in Zendesk, refer to the Zendesk documentation.

To create an OAuth client:

  1. In Zendesk Support, select Admin > Channels > API, then select the OAuth clients tab.
  2. Select the plus icon (+) on the right side of the client list.
  3. Complete the following fields to create a client:
    • Client Name: Enter a name for your app. This is the name that users see when asked to grant access to your application, and when they check the list of third-party apps that have access to their Zendesk.
    • Description (Optional): Enter a short description of your app that users see when asked to grant access to it.
    • Company (Optional): Enter the company name that users see when asked to grant access to your application. The information can help them understand who they're granting access to.
    • Logo (Optional): Select the logo that users see when asked to grant access to your application. The image can be a JPG, GIF, or PNG. For best results, upload a square image. It is resized for the authorization page.
    • Unique Identifier: This field is auto-populated with a reformatted version of the name you entered for your app. You can change it if you want.
    • Redirect URLs: Enter the URL or URLs that Zendesk should use to send the user's decision to grant access to your application. The URLs must be absolute and not relative, HTTPS (unless localhost or 127.0.0.1), and newline-separated.

  4. Select Save.

    After the page refreshes, a new pre-populated Secret field appears on the lower side. This is the client_secret value specified in the OAuth2 spec.

  5. Copy the Secret value to your clipboard and save it somewhere safe.

    Note

    The characters might extend past the width of the text box, so make sure to select everything before copying.

    Important

    For security reasons, your secret is displayed fully only once. After you select Save, you only have access to the first nine characters.

  6. Select Save.

Use the unique identifier and the secret value in the Connectivity and Authentication section.

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.