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 the alert tasks can be set up using the OAuth v2 with password grant.
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 password grant in the Authorization Type field. Then specify a Name for the authorization to be displayed in the XO Platform user interface. Next, configure each section as follows:
Tenancy
If required, in the Subdomain section, select Yes if the base URL for a web application or user interface uses a tenant name in the URL. For example, kore is the tenant organization for a web service using tenants as www.kore.someCompany.com.
In the following example configuration, the tenancy URL contains the {tenant} organization placeholder.
Form Fields
If the default username and password fields do not meet your needs, you can add new fields displayed to the end-user by adding authorization form fields. To add fields on the authorization form, click + Add Form Field.
The following illustration is an example of a definition to add a password field to the authorization dialog.
The following table describes the fields used to define an authorization IDP form field.
|
FIELD NAME |
DESCRIPTION |
|---|---|
|
Field Title |
Specify the name of the field displayed to the end-user in the authentication dialog. |
|
Field Key |
The value represents the end-user input value to the authenticating service. |
|
Help Hint |
The help text displayed in the field to describe what should be entered into the field. |
|
Field Type |
When Advanced Options is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the Field Key, one of:
|
|
Mandatory |
When Advanced Options is selected, select if the end-user must define this field to complete authentication. |
|
Data Type |
When Advanced Options is selected, specify the type of data expected as input from the end-user, for example, String. |
|
Visibility |
When Advanced Options is selected, specify if the authentication field should be visible, hidden, or displayed as read-only. |
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, social security number or PIN, 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.
To add additional authorization fields, click Add in the Authorization Fields section.
Token URL
To define the token URL, follow the below steps:
- In the Token URL field, optionally define a URL that can be used to test the authentication settings from the XO Platform before you deploy the task with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,
http://{tenant}.someCompany.com/test/{{tokenId}} - In the Token URL Method field, select the HTTP request method type for the Token URL. One of PUT, POST, PATCH, DELETE, and GET.
- In the Token URL Content Type field, select the content type expected from the Token URL. One of: JSON, RSS, XML, URL Encoded JSON, CSV, Text, Twitter Encoded JSON, Multipart/Form-data,Multipart/Related, or Oracle ADF.
- In the Refresh Token URL, enter the refresh token URL if required.
- For situations when there may be authentication errors, enter the Auth Error Status Code.
Click Save Auth to save the authorization settings and close the New Authorization Mechanism dialog.
Testing
To test your authorization, follow the below steps:
- After you save the authentication, if you have defined an Authorization URL for your new authorization type, you can test your authorization definition on the Authorization page when you click Test Authorization before continuing to develop the remaining steps of your task.
- After you click Test Authorization, the Test Authorization window is displayed and populated with the URL you specified in the Authorization Check URL section, 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.
