Configure Connection

Zendesk guide

Configure API token access, enter the connection settings in NIM, and test access by retrieving one user.

Before you startDirect link to Before you start

Arrange API access following the Zendesk API token management documentation. NIM requires Tenant URL, Username, and Password. This connector reads data for auditing users and access.

API token retirement

Zendesk's linked documentation states that all API tokens will stop working on April 30, 2027, and directs integrations to migrate to OAuth. Confirm OAuth support in your NIM connector version before planning that migration; the settings below describe the current API-token connection.

Generate an API tokenDirect link to Generate an API token

Have a Zendesk administrator enable API token access and open Admin Center > Apps and integrations > APIs > API tokens.
Select Add API token, enter a description for NIM, and save to generate the token.
Copy the token securely before closing the dialog.
Use a verified Zendesk user's email address with access to the records needed for the audit.

Zendesk's authentication reference specifies the Basic Authentication format: append /token to the email address and use the API token as the password.

Enter the connection settingsDirect link to Enter the connection settings

In NIM Studio, open Systems > Overview and add a Zendesk system, or select the existing system.
Open its Connection screen.
Enter the following settings and save the connection.

NIM setting	Value
Tenant URL	The HTTPS URL of the Zendesk tenant NIM will access.
Username	The verified user's email address followed by `/token`, such as `nim@example.com/token`.
Password	The generated Zendesk API token.

Test user accessDirect link to Test user access

Select Test Connection. NIM calls this endpoint on the configured tenant:
```
GET /api/v2/users?per_page=1&page=1
```
The request retrieves the first page with a page size of one user.
Confirm that the test succeeds. If it fails, verify the Tenant URL, the Username's /token suffix, token validity, and the user's permissions.
Collect the system and inspect users, groups, group_memberships, and organizations for your audit.
Confirm that the returned records cover the intended users and access before using them in NIM filters and reports.

The connection test reads a single page of user data. Validate access to the other collections separately. The NIM connection is read-only.

Step 1 of 3