Reference

Authentication Basic Authentication (User ID + Password)

Description

Authenticate using your Zendesk user ID and password. Two-factor authentication (2FA) must be disabled, and Password Access must be enabled under Admin Console > Channels > API > Settings. [API reference]

Instructions

Use Basic Authentication to authenticate with your Zendesk user email and password.

Important: This method cannot be used when two-factor authentication (2FA) is enabled for the Zendesk user. Password access to the API must also be enabled in Zendesk.
  1. Sign in to Zendesk as an administrator.
  2. Go to Admin Center > Apps and integrations > APIs > Zendesk API.
  3. Make sure Password access is enabled.
  4. Enter your Zendesk Sub Domain. For example, if your Zendesk URL is: https://mycompany.zendesk.com, enter mycompany.
  5. Enter your Zendesk User ID / Email and Password.
  6. Click Test Connection.
Recommendation: For new integrations, OAuth is preferred over storing a user's password. For unattended server-side integrations, consider OAuth - Client Credentials (Server-to-Server).

Parameters

Parameter Required Default value Options
Name: Domain

Label: Sub Domain (e.g. mycompany)

 YES
Name: UserName

Label: UserName (2FA Must be OFF)

 YES
Name: Password

Label: Password

 YES
Name: RetryMode

Label: RetryMode

 RetryWhenStatusCodeMatch
Name Value
None None
RetryAny RetryAny
RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
Name: RetryStatusCodeList

Label: RetryStatusCodeList

 429
Name: RetryCountMax

Label: RetryCountMax

 5
Name: RetryMultiplyWaitTime

Label: RetryMultiplyWaitTime

 True