This section describes desktop authentication using the credentials for your custom OAuth app. See Creating a Custom OAuth App for more information on how to create an app.

Get an OAuth Access Token

After setting the following connection properties, you are ready to connect:

• OAuthClientId: Set this to the client Id that you specified in your app settings.
• OAuthClientSecret: Set this to the client secret that you specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• Url: Set this to the URL of your Zendesk instance.

When you connect, the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process.

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Web Authentication with Your OAuth App

When connecting via a Web application, follow the steps below to get and manage the OAuth token values using the driver.

Get an Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the Client Id in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.
• Url: Set this to the URL of your Zendesk instance.

You can then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings. The stored procedure returns the URL to the OAuth endpoint.
2. Log in and authorize the application. You are redirected back to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL.

Reauthenticate

The OAuthAccessToken returned by GetOAuthAccessToken will not expire, but it can be revoked. If a token is revoked, a new token will need to be retrieved by following the above steps and potentially clearing out the existing token from the OAuthSettingsLocation.