Skip to main content
Version: Release 23.3

Personal Access Token for Authentication

This topic describes how to create and use Personal Access Tokens (PAT).

PATs are used as an alternative to passwords for authenticating with Digital.ai Release. You can use PATs with public APIs and webhook endpoints.

Note: Earlier, PATs were supported only for internal users, but now it is supported for LDAP users too. For external users, use OIDC-based authentication. For more information, see Configure OpenID Connect (OIDC) authentication for Release.

Creating a PAT​

  1. Log in to Digital.ai Release.

  2. From the navigation bar, click your profile avatar.

    Profile Avatar

  3. From the menu, click Access tokens.

  4. On the Access Tokens page, under Generate new tokens section, type a token name in the Token name field, and click Generate.
    The PAT is generated.

  5. Click Copy token to copy the token, and save the token in a secure location.

    Personal Access Token

Deleting a token​

To delete a token, click the Delete icon.

Set Expiration Period for Personal Access Token​

You can now set an expiration period for the personal access token (PAT) using the Expiration dropdown in the Personal access tokens screen.

On the top-right corner, click Profile avatar > Access tokens. In the Personal access tokens screen, enter a token name, select the number of days for token expiration, and click Generate. A new PAT with an expiration date is generated.

PAT Expiry

Expiration days can be set as 30 days, 60 days, or 1 year. Note that, you can select No expiration from the dropdown to avoid expiration of the PAT.

Authenticating with Public APIs Using PATs​

You can use the PATs for authentication with public APIs in the following ways:

  • Pass PATs in API calls in place of a password
  • Pass PATs in the header of an API call

Note: Users who authenticate in web application through an external ID provider, such as LDAP, Okta, or Keycloak cannot use PATs.

Pass PATs in API Calls in lieu of a Password​

Here is an example for basic HTTP authentication without a username:

curl -u :<pat> 'http://localhost:5516/api/v1/releases' -i -X GET

Pass PATs in API Call's Header​

Here is an example for passing the token as part of the header:

curl --header 'x-release-personal-token: <pat>' 'http://localhost:5516/api/v1/releases' -i -X GET

For run as automated user for script tasks (see Assigning an Automated Tasks User), keep the user name field blank and set the PAT as your password, and start the release.

Release Template Autentication

Authenticating with Webhook Endpoints Using PATs​

To use PATs with webhook endpoints:

  1. From the navigation pane, under Configuration group, click Connections.

  2. In the Connections page, under Webhooks and Events group, click the + icon next to HTTP Endpoint for Webhooks.
    The New HTTP Endpoint for Webhooks page is displayed.

  3. Choose an HTTP endpoint by selecting one of the check boxes next to HTTP Endpoint for Webhooks.

  4. Do the following:

    • In the Title field, enter a name for the configuration.
    • Select the Enabled check box.
    • In the Endpoint Path field, enter the path for the webhook endpoint.
    • In the Authentication Method drop-down list, select the Token Authentication method.
    • In the Secret Token field, enter the PAT.
    • In the Request Retention field, enter the number of requests you want to keep in the database.

  5. Click Save.

    Webhook Authentication

  6. To authenticate, pass the token with x-release-webhook-token header.