---
title: Obtain required information
description: Before you can configure this connector, you must complete the following steps.
component: zendesk
page_id: zendesk:setup:pf_zendesk_connector_obtain_required_information
canonical_url: https://docs.pingidentity.com/integrations/zendesk/setup/pf_zendesk_connector_obtain_required_information.html
revdate: June 17, 2024
section_ids:
  obtain-your-zendesk-administrator-email: Obtain your Zendesk administrator email
  obtain-your-zendesk-subdomain: Obtain your Zendesk subdomain
  obtain-your-zendesk-saml-2-0-metadata-xml-file: Obtain your Zendesk SAML 2.0 metadata XML file
  about-this-task: About this task
  steps: Steps
  example: Example:
  provision-existing-user-accounts-on-zendesk: Provision existing user accounts on Zendesk
  obtain-your-zendesk-api-token: Obtain your Zendesk API token
  about-this-task-2: About this task
  steps-2: Steps
---

# Obtain required information

Before you can configure this connector, you must complete the following steps.

|   |                                                                                                                                                 |
| - | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|   | Some of the following steps result in information that you'll need for subsequent tasks. You should copy this information to a secure location. |

* [Obtain your Zendesk administrator email](pf_zendesk_connector_obtain_your_zendesk_administrator_email.html)

* [Obtain your Zendesk subdomain](pf_zendesk_connector_obtain_your_zendesk_subdomain.html)

* [Obtain your Zendesk API token](pf_zendesk_connector_obtain_your_zendesk_api_token.html)

* [Obtain your Zendesk SAML 2.0 metadata XML file](pf_zendesk_connector_obtain_your_zendesk_saml_20_metadata_xml_file.html)

* [Provision existing user accounts on Zendesk](pf_zendesk_connector_provision_existing_user_accounts_on_zendesk.html)

## Obtain your Zendesk administrator email

This connector requires a valid administrator account email to be used when configuring a service provider (SP) connection for outbound provisioning.

|   |                                                                                                   |
| - | ------------------------------------------------------------------------------------------------- |
|   | You only require this information if you're configuring this connector for outbound provisioning. |

## Obtain your Zendesk subdomain

This connector requires the subdomain, such as *\<YourSubDomain>*.zendesk.com, to access your Zendesk for single sign-on (SSO) and outbound provisioning.

## Obtain your Zendesk SAML 2.0 metadata XML file

### About this task

This connectors quick-connection template uses a metadata XML file to assist in configuring many settings in the SP connection. Before configuring your SP connection, you must first prepare the `zendesk-saml-metadata.xml` that comes packaged with the Zendesk Connector.

### Steps

1. Open the `zendesk-saml-metadata.xml` file that came packaged with the Zendesk Connector in a text editor.

2. Replace all instances of `SUBDOMAIN` with your Zendesk subdomain value:

   #### Example:

   If your Zendesk subdomain is `pingidentity1234567890`, then `SUBDOMAIN.zendesk.com` would become `pingidentity1234567890.zendesk.com`.

3. Save your changes.

## Provision existing user accounts on Zendesk

When configuring the connector, make sure that the value mapped to the `email` attribute matches the existing Zendesk user's email address exactly as it appears in Zendesk.

For example, on the **Attribute Mapping** tab, the user's `email` attribute on Zendesk is mapped to the user `mail` attribute in your LDAP. This will synchronize a user that already exists on Zendesk with an `email` address in Zendesk of `john.smith@mydomain.com`. In this case, the user's `mail` attribute in LDAP would also have to be `john.smith@mydomain.com`.

When the Zendesk connector provisions for the first time, this address is used to synchronize the user in your LDAP data store with the user in Zendesk.

## Obtain your Zendesk API token

### About this task

The Zendesk Connector's outbound provisioning functionality is built using Zendesk's REST API, which requires an authorized OAuth 2.0 Access Token.

|   |                                                                                                    |
| - | -------------------------------------------------------------------------------------------------- |
|   | You only require this information if you are configuring this connector for outbound provisioning. |

### Steps

1. Sign on to Zendesk with your administrator account.

2. Click the **Gear** icon and select **API** in the **Channels** category.

3. On the **Settings** tab, ensure the **Token Access** check box is selected.

4. Note the **API token** value.

   |   |                                                                                                                                                                                                                   |
   | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   |   | These steps are subject to change at the discretion of Zendesk. If these steps are different from the steps in this document, contact your Zendesk representative for updated steps for obtaining this API token. |