We have seen how an Alert Task can be set up in the Kore.ai XO Platform here. In this article, we will see how authorization for alert tasks can be set up using the OAuth v2 with client credentials.
General Setup
OAuth v2 is the new version of the open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications. To use oAuth v2, you must first register an account with the web application as you will need the log-in credentials for that application to configure the settings for the Authorization Mechanism.
To begin your configuration, follow the steps below:
- Select the VA you want to work with.
- Go to Build > Conversation Skills > Alert Tasks.
- Select the task you want to work with.
- Click the API Request tab within the Alert Task.
- Expand the Authorization section and click Create New to configure a new authorization.
- Next, the New Authorization Mechanism window opens, as shown in the illustration below.
To define a custom authorization, select oAuth v2 client credentials in the Authorization Type field, then configure each section as explained in the table below:
|
FIELD NAME |
DESCRIPTION |
|---|---|
|
Authorization Type |
Set to oAuth v2 Client Credentials. |
|
Identity Provider Name |
The name of the web application or web service, for example, Asana. This field is required. |
|
Client ID |
The ID of the Kore.ai client. |
|
Client Secret Key |
The value provided as the XO Platform authentication based on the Client ID to the web application. |
|
Token Request URL |
The URL used by the XO Platform to obtain an unauthorized request token. A request token is a value used by the XO Platform to obtain authorization from the end-user to obtain an access token. After end-user authorization, an access token can be requested by the XO Platform. This field is required. |
|
Scope |
If the web service requires additional values for authorization, add one or more Key/Value pairs. For example, some Bot web services support using a scope key using read-only, write, or both as the value. |
|
Refresh Token URL |
Enter a Refresh Token URL, if required, for cases when the authentication token expires and has to be refreshed. Please see below for details. |
|
Description |
Enter a description for your authorization. |
Authorization
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 then define the fields as shown in the following illustration.
- In the Field Type field, you can select one of the following depending on where in the task request message and the type of authorization fields that are required.
- Header – The VA expects the authorization fields as part of the header of the request.
- Payload – The VA expects the authorization fields as part of the content of the body of the request.
- Query String – The VA expects the authorization fields as a query in the body of the request.
- Path Param – The VA expects the authorization fields as part of the URL path for the request.
- In the Field Key field, enter the name of the field for the selected Field Type.
- In the Field Value field, enter the value for the Field Key specified.
- Click Done. The new authorization field is added in the Authorization Fields section.
Click Save Auth to save the authorization settings and close the New Authorization Mechanism dialog.
Testing
After you save the authorization, you can test it using the Authorization page.
- Click Test Authorization before continuing to develop the remaining steps of your task.
- After you click Test Authorization, the test is executed using the authentication token URLs and the Client ID and Client Secret Key. If the tenancy was defined, the Test Authorization window is displayed as shown in the following illustration.
- Click Test to begin the authorization test. When the validation of authentication is complete, the Test Authorization window is closed and the results of the validation, either success or failure, is displayed to the immediate right of the Test Authorization button. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs as shown in the following illustration.
- </ol
