› Integration › OAuth servers › Configure OAuth server › Configure OAuth server using Client credentials grant type

Configure OAuth server using Client credentials grant type

The Client credentials grant type is suitable for cases where the client application needs to access resources or call functions in the resource server, which are not related to a specific resource owner.

The client can request an access token using only its client credentials, which means the client requests access to the protected resources under its control or those of another resource owner that has previously engaged with the authorization server.

  1. Navigate to Integration > OAuth servers.

    The OAuth servers page appears.

  2. Click New.

    The New OAuth server configuration dialog box is displayed. By default, the General tab is open.

  3. Configure the properties on the following tabs.
  4. Click Save to save the authorization.

    • If the token generation fails, an error message is displayed; however, the configuration details are saved for reuse.

    • When you edit an OAuth server that has already been authorized you need to authorize it again.

General properties

Name

A globally unique name for the OAuth server.

The name can have a maximum of 50 characters.

Category

By default, the system automatically saves a new OAuth server in your working category. To store it in a different category, select a category.

Grant type

Client credentials.

Authentication method

Specify the authentication methods to add additional security to an authorization grant. The following methods are available:

See Authentication methods for a description of fields specific to an authentication method.
Client ID

An ID to identify the client. The ID must be an alphanumeric string.

Client secret

To log in, select either option:

  • Local: Enter the secret string that the client uses.

  • External: Enter the secret string stored in the configured external storage.

Access token URL

The URL to get an access token.

Scope

The scope to restrict access to specified areas.

The value of the scope must be defined as a list of space-delimited and case-sensitive strings.

Disabled reason

If TotalAgility is unable to refresh the access tokens for an OAuth server in multiple retries, the OAuth Server is disabled. This causes the import sources and web service activities that rely on the OAuth Server to stop working. When the OAuth server is disabled, the system displays the error description and the reason in the "Disabled reason" box. The status column on the OAuth servers list page displays the configuration status as follows:

  • Error: If the OAuth server is disabled.

  • OK: If the OAuth server is enabled.

.

This option is only available upon saving the OAuth server configuration when the OAuth Server is disabled .

Additional properties

Access token request

You can exclude the scope when sending the access token request by clearing Include scope: (Default: selected)

Maximum retry attempts

The maximum number of retry attempts to acquire an access token. (Default:3)

Maximum wait duration

The maximum wait duration to acquire an access token. (Default:1 Minute)

Query parameters

The query parameters (if any) required by the authorization server. To add query parameters:

  1. Click .

  2. Provide a Name and Value.

  3. Click Add.

Post parameters

The post parameters (if any) required by the authorization server. To add post parameters:

  1. Click .

  2. Provide a Name and Value.

  3. Click Add.