> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zendesk OAuth 2.0 connector profile – StackOne setup guide

> Set up a connector profile using OAuth 2.0 for Zendesk in StackOne to allow users to link their accounts.

> [!WARNING]
>
> You need a Zendesk developer account (subdomain prefixed `d3v-`) where you are an administrator, and a proof of business document.

Select Actions to adjust the guideSome actions may require additional configuration in the provider to be accessible. Choose the actions you need and the guide will be updated.

Select all
Clear

ActionScope(s)

Loading actions...No actions match your search.

Dynamic Guide URL

Copy URL

Scopes Selected

<pre role="textbox" aria-readonly="true" tabIndex="0" />

Separator

Copy scopes

## Registering a local OAuth client

Zendesk creates a global OAuth client by converting a local OAuth client that you register first in your developer account.\
\
If Zendesk has already converted an OAuth client of yours to a global client, use that client and skip the rest of the steps. Copy the **Identifier** to **Client ID** in your Connector Profile. Copy the **Secret** to **Client Secret** in your Connector Profile.

**1. Enter the client details**

Sign in to your [Zendesk developer account](https://www.zendesk.com/login/). If you do not have one, see [Getting a trial or sponsored account for development](https://developer.zendesk.com/documentation/api-basics/getting-started/getting-a-trial-or-sponsored-account-for-development/).\
\
Zendesk shows this information to users when they are asked to grant access, and it cannot be changed after the client is globalized.

<ul>
  <li>In the top bar, click the product switcher labeled **Support**.</li>
  <li>Select **Admin center**.</li>
  <li>In the sidebar, select **Apps and integrations** > **APIs** > **OAuth clients**.</li>
  <li>Click **Add OAuth client**.</li>
  <li>**Name**: `StackOne Integration`</li>
  <li>**Description**: Short summary of your app</li>
  <li>**Company**: Your company name</li>
  <li>**Logo**: Your company logo</li>
</ul>

![The Add OAuth client form with the Name, Description, and Company fields highlighted](https://mintcdn.com/stackone-60/agMuabB96JYIMQc7/connectors/zendesk/images/oauth2_global-setup-client-details.png?fit=max\&auto=format\&n=agMuabB96JYIMQc7\&q=85\&s=52bacc13c4523527ae3ab7de7cb0c314)

**2. Set the identifier, client kind, and redirect URL**

Zendesk reserves identifiers that start with `zdg-` for global OAuth clients.

<ul>
  <li>**Identifier**: Replace the suggested value with one that starts with `zdg-`</li>
  <li>**Client kind**: **Confidential**</li>
  <li>**Redirect URLs**: the **Callback URL** from your Connector Profile</li>
</ul>

![The Add OAuth client form with the Identifier, Client kind, and Redirect URLs fields highlighted](https://mintcdn.com/stackone-60/agMuabB96JYIMQc7/connectors/zendesk/images/oauth2_global-setup-client-settings.png?fit=max\&auto=format\&n=agMuabB96JYIMQc7\&q=85\&s=7acd66e753d885db5095e986e37a3752)

**3. Select scopes**

Enables actions: Add Tags, Check Brand Host Mapping Validity, Check Host Mapping Validity, Count Organizations, Count Tags, Count Tickets, Count Users, Create Brand, Create Group, Create Group Membership, Create Organization, Create Organization Membership, Create Ticket, Create Ticket Field, Create Ticket Form, Create Trigger, Create User, Delete Brand, Delete Brand Logo, Delete Group, Delete Group Membership, Delete Organization, Delete Organization Membership, Delete Ticket, Delete Ticket Field, Delete Ticket Form, Delete Ticket Trigger, Delete User, List Audits For Ticket, List Brands, List Group Memberships, List Groups, List Organization Memberships, List Organizations, List Resource Tags, List Search Results, List Tags, List Ticket Comments, List Ticket Fields, List Ticket Forms, List Ticket Triggers, List Tickets, List Users, Merge Tickets Into Target Ticket, Remove Tags, Search Organizations, Search Tags, Search Ticket Triggers, Search Users, Set Tags, Show Attachment, Show Brand, Show Group, Show Group Membership, Show Organization, Show Organization Membership, Show Self, Show Ticket, Show Ticket Field, Show Ticket Form, Show Ticket Trigger, Show User, Update Brand, Update Brand Logo, Update Group, Update Organization, Update Ticket, Update Ticket Field, Update Ticket Form, Update Ticket Trigger, Update User, Upload Files

In **Scopes**, click **Select scopes**.

<ul>
  <li>Select each scope listed.</li>
</ul>

![The Scopes field with the selected scopes highlighted](https://mintcdn.com/stackone-60/agMuabB96JYIMQc7/connectors/zendesk/images/oauth2_global-setup-scopes.png?fit=max\&auto=format\&n=agMuabB96JYIMQc7\&q=85\&s=c0e390957ec5dcf9c3c43a5787565718)

<ul>
  <li>
    read
  </li>

  <li>
    write
  </li>

  <li>
    tickets:read
  </li>

  <li>
    tickets:write
  </li>

  <li>
    ticket\_attachments:read
  </li>

  <li>
    ticket\_attachments:write
  </li>

  <li>
    users:read
  </li>

  <li>
    users:write
  </li>

  <li>
    organizations:read
  </li>

  <li>
    organizations:write
  </li>

  <li>
    groups:read
  </li>

  <li>
    groups:write
  </li>

  <li>
    brands:read
  </li>

  <li>
    brands:write
  </li>

  <li>
    triggers:read
  </li>

  <li>
    triggers:write
  </li>
</ul>

**4. Save the client and copy the credentials**

Click **Save**. The **Secret** field now shows the generated secret.

<ul>
  <li>Copy the **Identifier** to **Client ID** in your Connector Profile.</li>
  <li>Click **Copy** next to **Secret**. Zendesk shows the secret in full only once.</li>
  <li>Copy the **Secret** to **Client Secret** in your Connector Profile.</li>
  <li>Click **Save** again to finish creating the client.</li>
</ul>

![The generated Secret with the Copy button highlighted and the secret value masked](https://mintcdn.com/stackone-60/agMuabB96JYIMQc7/connectors/zendesk/images/oauth2_global-setup-secret.png?fit=max\&auto=format\&n=agMuabB96JYIMQc7\&q=85\&s=c63cd944b3eb41e5d9448f121db35683)

## Requesting a global OAuth client

Ask Zendesk to convert your local OAuth client into a global client that works across all Zendesk accounts. Zendesk keeps the client's **Identifier** and **Secret** when it converts the client.

**1. Complete the request form**

Sign in to the [Zendesk Marketplace Portal](https://apps.zendesk.com).\
\
Only submit a global OAuth request if the client is ready for production. Client information such as company, description, and logo can't be changed.

<ul>
  <li>If you do not have an account, click **Register**.</li>
  <li>In the sidebar, click **Global OAuth**.</li>
  <li>Click **Request new OAuth**.</li>
  <li>**Zendesk Support account**: The part of your developer subdomain after `d3v-`</li>
  <li>**Unique identifier**: The part of your client's **Identifier** after `zdg-`</li>
  <li>Select **I confirm the company details related to this OAuth client are correct**.</li>
  <li>**Proof of business**: An incorporation document or company registration</li>
  <li>Select the checkbox to agree to the Zendesk Partner and Developer Terms and Privacy Policy.</li>
  <li>Click **Send request**.</li>
  <li>Zendesk reviews each request manually and does not publish a turnaround time. Track progress through the ticket reference in the confirmation email.</li>
</ul>

![The Request new OAuth form with the account, identifier, and Send request fields highlighted](https://mintcdn.com/stackone-60/agMuabB96JYIMQc7/connectors/zendesk/images/oauth2_global-setup-request-new-oauth.png?fit=max\&auto=format\&n=agMuabB96JYIMQc7\&q=85\&s=883d913468f44f7c4feac17c174a8469)

## Create the StackOne Connector Profile

**1. Create a Connector Profile**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

**2. Link an Account**

Once the Connector Profile is created, continue to [link an account](https://docs.stackone.com/connectors/zendesk/guides/link-account/oauth-2-0.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.