1. Home
  2. Kore.ai Conversational Platform
  3. Advanced Topics
  4. Bot Authorization
  5. Setting Up Authorization using Basic Auth

Setting Up Authorization using Basic Auth

To define Basic Authorization for your bot, follow these steps:

  1. Open the bot for which you want to configure a Basic Authorization profile.
  2. Hover over the left-side navigation panel and click Settings.
  3. Click Authorization Profiles > Add. The New Authorization Mechanism dialog opens.
  4. In the Authorization Type drop-down list, select Basic Auth.
  5. In the Name field, enter the name for your Basic Auth type.

Defining 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.

Adding Authorization Fields

By default, authorization fields are configured as part of the header of the Bot request message. If your Bot request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click Add in the Authorization Fields section and then define the required fields.

In the Field Type field, you can select one of the following depending on where in the Bot request message and the type of authorization fields that are required.

  • Header – The bot looks for the authorization fields in the request header.
  • Payload – The bot looks for the authorization fields in the request body content.
  • Query String – The bot looks for the authorization fields as a query in the request body.
  • Path Param – The book looks for the authorization fields in the request URL path.

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 Add. The new authorization field is added in the Authorization Fields section.

To add additional authorization fields, click Add in the Authorization Fields section.

Adding IDP Form Fields to the Authorization Form

If the default username and password fields do not meet your needs for authorization input, you can add custom fields displayed to the end-user by adding authorization IDP form fields. You can use these form fields, for example, if a PIN code is required in the authentication process, in addition to the Username and Password form fields.



The following table describes the fields used to define an authorization IDP form field.

FIELD NAME DESCRIPTION
Title of Field 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:

  • Textbox
  • Password
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.

 

In the Authorization Check URL field, optionally define a URL that can be used to test the authentication settings from Bot Builder before you deploy the Bot with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,

https://kore.someCompany.com/sap/opu/odata/sap/{{authfield1}}/?$format=json

or

https://{tenant}.service-now.com/api/now/v1/table/incident

For more information, see Using Session and Context Variables in Tasks.

In the Access Using a Connector section, select Yes to enable access for Kore.ai Bots using the Kore.ai Connector Agent.

The Kore.ai Connecter Agent can be used to establish and maintain secure data connectivity between cloud-based Kore.ai Bots and your on-premises Bots application. Using an on-premises Bots application, communications security is maintained by restricting users and systems within the company intranet or by configuring specific channels for specific data exchange.

If your domain does not have any active Kore.ai Connectors defined, a warning message is displayed to contact the Bots Admin Console system administrator. For more information, see Using the Kore.ai Connector in the Bots Admin Console documentation.

Click Save to save the authorization settings and close the New Authorization Mechanism dialog.

Testing the Authorization 

After you save the authentication, if you defined an Authorization Check URL for your new authorization type, you can test your authorization definition on the Authentication tab when you click Test Authorization before continuing to develop the remaining steps of your Bot.

When you click Test Authorization, the Test Authorization dialog opens populated with the URL you specified in the Authorization Check URL section.

 

To configure the Test Authorization – Basic Auth

  1. In the Auth Check URL field, verify or enter the URL to test the authentication configuration.
  2. If your bot uses subdomains, the Tenancy field is displayed and you must specify the tenant.
  3. Enter your User Name and Password for the web service.
  4. Select the content type expected for the URL in the Content-Type field.
  5. For testing the URL, the Method field is read-only and set to GET.
  6. Click Test to begin the authorization test.

When the validation of authentication is complete, the Test Authorization dialog closes and you can see the results of the validation, either success or failure, on the top-right corner of the screen. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs.

How it all Works 

When basic authorization is used for a Bot, the Kore.ai application automatically prompts the user for log on credentials to access the web application or web service as shown in the following illustration.

DIYBasicAuthRequest

After the end-user authenticates, the settings are saved using the following naming syntax:

{{ First Name }} {{ Last Name }} {{ Bot Name }} {{ Account # }} {{ Sequence # }}

For example, John Smith’s Twitter Account #1.

The Kore.ai application can access the web application or web service for all future Bot requests using this account. In addition, the end-user can reuse the account for other tasks for the same Bot.

Next Steps

The Kore.ai Bots Platform supports the following authentication types as well:

  • OAuth v2 password grant type – Define a custom authorization type for non-standard web service authorization types. For more information, see Setting Up Authorization using oAuth v2 password grant.
  • OAuth v1 – Enables web applications or web services to access protected resources using an API without end-users having to disclose their log on credentials to Kore.ai. For more information, see Setting Up Authorization using OAuth v1.
  • OAuth v2 – The newest version of OAuth protocol focusing on specific authorization flows for web applications and web services. For more information, see Setting Up Authorization using OAuth v2.
  • API Key – An identification and authorization token generated or provided by a web application or web service used to identify the incoming application request, and in some cases, also provides authentication for secure access. For more information, see Setting Up Authorization using an API Key.
Was this article helpful to you? Yes 1 No