Skip to main content
Back to App Settings OAuth v2 is the new version of the open protocol to allow secure authorization via a standard method from web, mobile, and desktop applications. To use oAuth v2, you must first register an account with the web application — you will need the sign-in credentials for that application to configure the Authorization Mechanism settings. The Client Credentials grant type is used when applications request an access token to access their own resources, not on behalf of a user.

​
Configuring oAuth v2 Using Client Credentials

  1. Open the assistant for which you want to configure an Authorization profile.
  2. From the left menu, click App Settings, then select Dev Tools > Authorization Profiles. Auth profiles - Add
  3. Click New. The New Authorization Mechanism dialog opens. Auth profiles - Add
  4. In the Authorization Type drop-down list, select oauth v2 client credentials.
  5. In the Name field, enter the name for your authorization.
The following illustration shows the oAuth v2 fields you must define to enable authorization for your assistant. Fields to define for enabling auth Define the fields as described in the following table:
FIELD NAMEDESCRIPTION
Authorization TypeSet to oAuth v2 Client Credentials.
Identity Provider NameThe name of the web application or web service, for example, Asana. This field is required.
Client IDThe ID of the Kore.ai client. The Platform accepts a maximum length of 255 characters.
Client Secret KeyThe value provided as the Kore.ai application authentication based on the Client ID to the web application. The XO Platform accepts a maximum length of 255 characters.
Token Request URLThe URL used by the Kore.ai application to obtain an unauthorized request token. A request token is a value used by the Kore.ai application to obtain authorization from the end-user to obtain an access token. The XO Platform accepts a valid URL with a maximum length of 3000 characters. After end-user authorization, an access token can be requested by the Kore.ai application. This field is required.
ScopeIf the web service requires additional values for authorization, add one or more Key/Value pairs. For example, some web services support using a scope key using read-only, write, or both as the value.
Refresh Token URLEnter a Refresh Token URL, if required, for cases when the authentication token expires and must be refreshed. The XO Platform accepts a valid URL with a maximum length of 3000 characters.
DescriptionEnter a description for your authorization.

​
Authorization Fields

By default, authorization fields are configured as part of the header of the task request message. If your task request requires additional authorization fields or the expected authorization is not part of the header (for example, a verification code), click + Add Authorization Field and define the fields as shown in the following illustration. Authorization fields
  1. In the Field Type field, select one of the following depending on where in the task request message the authorization fields are required:
    • Header – The AI Agent expects the authorization fields as part of the header of the request.
    • Payload – The AI Agent expects the authorization fields as part of the content of the body of the request.
    • Query String – The AI Agent expects the authorization fields as a query in the body of the request.
    • Path Param – The AI Agent expects the authorization fields as part of the URL path for the request.
  2. In the Field Key field, enter the name of the field for the selected Field Type.
  3. In the Field Value field, enter the value for the Field Key specified.
  4. Click Done. The new authorization field is added in the Authorization Fields section.

​
Testing the Authorization

After saving the authentication, test your authorization definition on the Authentication page by clicking Test before continuing to develop the remaining steps of your task. The test is executed using the authentication token URLs and the Client ID and Client Secret Key. If tenancy was defined, the Test Authorization dialog is displayed. Click Test to begin the authorization test. Testing the auth When validation completes, the results — either success or failure — are displayed. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs.