FireDAC Components for Jira Service Desk

Build 21.0.7930

Custom Credentials

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

Get an OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: Set to the Client ID in your app settings.
  • OAuthClientSecret: Set to the Client Secret in your app settings.
  • CallbackURL: Set to the Redirect URL in your app settings.
  • OAuthVersion: Set to 2.0.
  • Url: The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.
  • InitiateOAuth: Set to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
When you connect, the component opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The component then completes the following 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, you need to register a custom OAuth app with Jira Service Desk. See Creating a Custom OAuth App for more information. You can then use the component to get and manage the OAuth token values.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • OAuthClientId: Set to the Client ID in your app settings.
  • OAuthClientSecret: Set to the Client Secret in your app settings.
  • OAuthVersion: Set to 2.0.
  • Url: The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.

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. If necessary, set the Permissions parameter to request custom permissions. The stored procedure returns the URL to the OAuth endpoint.
  2. Open the URL, 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. If necessary, set the Permissions parameter to request custom permissions.

To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930