Authentication

An authentication profile stores authentication data for use with the Integration node and Task Export and Import.

Creating an Authentication Profile

  1. From the Manage menu, select Authentication.

  2. From the tabs at the top of the screen, select the authentication type:

    • Basic

    • Certificate

    • OAuth2

    A basic authentication profile is appropriate for basic and digest authentication types.

  3. Click the create button in the top-right corner.

    Where the authentication type is OAuth2, click the down arrow to the right of the create button and select from the options: client credentials grant, password credentials grant, and JWT bearer grant.

  4. Fill in the Authentication Profile Parameters.

Managing Authentication Profiles

  1. From the Manage menu, select Authentication.

  2. From the tabs, select the authentication type.

    The options are Basic, Certificate, and OAuth2.

  3. Select a profile from the list.

    The profile is highlighted. Profile details display to the right.

    From the Actions menu, you can select to Edit or Delete the profile. For more information on how to edit the profile parameters, see Authentication Profile Parameters.

Note:

Click Check in Use from the Actions menu to check if this authentication profile is in use and where it is used.

Verifying OAuth2 Credentials

Click the OAuth2 tab to display a table of authentication profiles using OAuth2.

In the table, the Status and Token columns verify the credentials are valid or indicate problems. This information is updated in the browser every minute, when you refresh the screen, or change tabs to basic and back to OAuth2. When the credentials are valid, the status column is marked OK with a green circle and the token icon is present. When the credentials fail, the status column is marked error with a red circle and the token column is blank. Hover over the red circle and an error message displays if one is available.

Note:

Studio caches the bearer token and re-uses it until the token expires. Studio runs a job to check the token expiry every minute. In each run, the job picks the authentication profiles for which the token might expire in the next three minutes and refreshes the token. If the token expiry is not known, Studio establishes when the newly retrieved token is going to expire using Default Token Expiration set in Authentication Profile Parameters.

For a quick test, select the profile from the list. From the Actions menu, click Test.

For more detail about the failure, return to the Actions menu. Click Edit. Test the authentication profile from Authentication Profile Parameters.