Configure OAuth 2.0 server using Authorization code grant type
The Authorization code grant type is used to obtain access tokens and refresh tokens from the authorization server and is optimized for confidential clients.
Kofax TotalAgility supports the Authorization code grant only with refresh token grant which means, you should generate access and refresh tokens at design time. TotalAgility uses refresh token to regenerate access token; it does not require manual intervention.
The OAuth 2.0 servers page appears.
The New OAuth 2.0 server configuration dialog box is displayed. By default, the General tab is open.
Configure the following properties.
A globally unique name for the OAuth 2.0 server.
The name can have a maximum of 50 characters.
By default, the system automatically saves a new OAuth server in your working category. To store it in a different category, select a category.
Specify the authentication methods to add additional security to an authorization grant. Following methods are available:
See Authentication methods for description of fields specific to an authentication method.
An ID to identify the client. The ID must be an alphanumeric string.
The secret string the client uses.
Access token URL
The URL to get an access token.
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.
Authorization code URL
The URL to get an authorization code from the authorization server.
If the authorization server is configured to redirect to this preset TotalAgility URI, the authorization code is automatically extracted and used for the token generation process.
If this option is clear, the preset URL is displayed in the Redirect URI field in read-only mode and authorization code is automatically extracted
Use custom redirect URI
Select this option to specify a custom redirect URI which the authorization server is configured with.
When the authorization server redirects to this URI, copy the entire authorization code from the URI and paste it in the Authorization code URL field.
If this option is selected, a random string is generated by the application, which is verified while receiving authorization. (Default: Selected)
If the authorization server supports PKCE (Proof Key for Code Exchange), selecting this option prevents interception of authorization code and several other attacks.
Supports refresh token
If this option is selected, the Authorization server supports refresh token generation.
This option is read-only and always selected for the authorization code grant. (Default: Selected)
Refresh token validity duration
The duration for which the token should remain valid. If set to zero, the refresh token always remains valid. (Default: 0)
Access token request
You can exclude or include the following parameters when sending the access token request:
Include scope (Default: selected)
Include redirect URI (Default: selected)
Maximum retry attempts
The maximum number of retry attempts to acquire access token. (Default:3)
Maximum wait duration
The maximum wait duration to acquire access token. (Default:1 minute)
The query parameters (if any) required by the authorization server. To add query parameters:
Provide a Name and Value.
The post parameters (if any) required by the authorization server. To add post parameters:
Provide a Name and Value.
The authorization server login page appears in a new browser and either of the following occurs depending on the URI configuration.
The authorization button is disabled until the authorization is complete and TotalAgility Designer has extracted the authorization code.
If the authorization server is configured to redirect to preset Kofax TotalAgility Redirect URI, the authorization code is automatically extracted and used for the token generation process.
If the authorization server is configured to redirect to custom URI, you must copy the entire URL from the address bar of the browser and paste it in the Authorization code URL field.
Save to get the access and refresh tokens.
The authorization server exchanges the authorization code for access and refresh tokens.
If the token generation fails, an error message is displayed; however, the configuration details are saved for reuse.
When you edit an OAuth 2.0 server using Authorization code grant type that has already been authorized you need to authorize again.