{"id":17945,"date":"2016-12-05T21:42:16","date_gmt":"2016-12-05T21:42:16","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=9108"},"modified":"2023-09-25T08:37:06","modified_gmt":"2023-09-25T07:37:06","slug":"setting-up-authorization-using-basic-auth","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-basic-auth\/","title":{"rendered":"Setting Up Authorization using Basic Auth"},"content":{"rendered":"

When basic authorization is used for a task, the XO Platform automatically prompts the user for login credentials to access the web application or web service, as shown in the following illustration.<\/span><\/p>\n

\"\"<\/a><\/p>\n

After the end-user is authorized, the settings are saved using the following naming syntax:<\/span><\/p>\n

{{ First Name }} {{ Last Name }} {{ Bot Name }} {{ Account # }} {{ Sequence # }}<\/span><\/code><\/p>\n

For example, <\/span>John Smith\u2019s Twitter Account #1<\/span>.<\/span><\/p>\n

The XO Platform can access the web application or web service for all future task requests using this account. In addition, the end-user can reuse the account for other tasks for the same Virtual Assistant.<\/span><\/p>\n

You need to have an account with the external application which you want to authorize the XO Platform for.<\/span><\/p>\n

<\/div><\/div>\n

Configuring Basic Authorization<\/span><\/span><\/h1>\n

To define Basic Authorization for your assistant, follow these steps:<\/span><\/p>\n

    \n
  1. Open the VA for which you want to configure the Basic Authorization profile.<\/span><\/li>\n
  2. Select the <\/span>Build<\/strong> tab from the top menu.<\/span><\/li>\n
  3. From the left menus, click <\/span>Configurations > Authorization Profile<\/strong><\/li>\n
  4. Click<\/span> Add<\/strong> to open the <\/span>New Authorization Mechanism<\/strong> dialog.
    \n    \"\"<\/a><\/span>
    \n<\/strong><\/li>\n
  5. In the <\/span>Authorization Type<\/strong> drop-down list, select <\/span>Basic Auth<\/strong>.<\/span><\/li>\n
  6. In the <\/span>Name<\/strong> field, enter the name for your <\/span>Basic Auth<\/strong> type.
    \n    \"\"<\/a><\/span>
    \n<\/span><\/li>\n
  7. Enter the Description<\/strong> for the profile and select the API endpoint Method<\/strong>. You can select either GET<\/strong> or POST<\/strong> method.
    \n    \"\"<\/a>
    \nNote<\/strong>: By default, the GET method is selected for the existing bots.<\/li>\n
  8. Click Save<\/strong>.<\/li>\n<\/ol>\n

    <\/div><\/div><\/span><\/p>\n

    Defining Tenancy<\/span><\/span><\/h1>\n

    If required, in the <\/span>Subdomain<\/strong> section, select <\/span>Yes<\/strong> if the base URL for a web application or user interface uses a tenant name in the URL. For example, <\/span>kore<\/span> is the tenant organization for a web service using tenants as <\/span>www.<\/span>kore<\/em><\/strong>.someCompany.com.<\/span><\/p>\n

    In the following example configuration, the tenancy URL contains the <\/span>{tenant}<\/span> organization placeholder.<\/span><\/p>\n

    \"\"<\/a><\/span><\/p>\n

    <\/div><\/div>\n

    Adding Form Fields\u00a0<\/span><\/span><\/h1>\n

    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 PIN code is required in the authorization process, in addition to the <\/span>Username<\/strong> and <\/span>Password<\/strong> form fields.<\/span><\/p>\n

    \"\"<\/a><\/p>\n

    <\/div><\/div>\n

    Defining Configuration Fields<\/span><\/span><\/h1>\n

    The following table describes the fields used to define an authorization IDP form field.<\/span><\/p>\n\n\n\n\n\n\n\n\n\n\n
    FIELD NAME<\/strong><\/th>\nDESCRIPTION<\/strong><\/th>\n<\/tr>\n
    Field Title<\/span><\/td>\nSpecify the name of the field displayed to the end-user in the authorization dialog.<\/span><\/td>\n<\/tr>\n
    Field Key<\/span><\/td>\nThe value that represents the end-user input value to the authorizing service.<\/span><\/td>\n<\/tr>\n
    Help Hint<\/span><\/td>\nThe help text displayed in the field to describe what should be entered into the field.<\/span><\/td>\n<\/tr>\n
    Field Type<\/span><\/td>\nWhen <\/span>Advanced Options<\/strong> is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the <\/span>Field Key<\/strong>, one of:<\/span><\/p>\n
      \n
    • Textbox<\/strong><\/li>\n
    • Password<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    Mandatory<\/span><\/td>\nWhen <\/span>Advanced Options<\/strong> is selected, select if the end-user must define this field to complete the authorization.<\/span><\/td>\n<\/tr>\n
    Data Type<\/span><\/td>\nWhen <\/span>Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, <\/span>String<\/strong>.<\/span><\/td>\n<\/tr>\n
    Visibility<\/span><\/td>\nWhen <\/span>Advanced Options<\/strong> is selected, specify if the authorization field should be visible, hidden, or displayed as read-only.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    <\/div><\/div>\n

    Adding Authorization Fields<\/span><\/span><\/h1>\n

    By default, authorization fields are configured as part of the header of the request message. If your request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <\/span>Add<\/strong> Authorization Fields<\/strong> and then define the required fields.<\/span><\/p>\n

    \"\"<\/a><\/span><\/p>\n

      \n
    1. In the <\/span>Field Type<\/strong> field, you can select one of the following depending on where in the request message and the type of authorization fields that are required.<\/span>\n
        \n
      1. Header<\/strong> \u2013 The VA looks for the authorization fields in the request header.<\/span><\/li>\n
      2. Payload<\/strong> \u2013 The VA looks for the authorization fields in the request body content.<\/span><\/li>\n
      3. Query String<\/strong> \u2013 The VA looks for the authorization fields as a query in the request body.<\/span><\/li>\n
      4. Path Param<\/strong> \u2013 The VA looks for the authorization fields in the request URL path.<\/span><\/li>\n<\/ol>\n<\/li>\n
      5. In the <\/span>Field Key<\/strong> field, enter the name of the field for the selected <\/span>Field Type<\/strong>.<\/span><\/li>\n
      6. In the <\/span>Field Value<\/strong> field, enter the value for the <\/span>Field Key<\/strong> specified.<\/span><\/li>\n
      7. Click <\/span>Done<\/strong>. The new authorization field is added in the <\/span>Authorization Fields<\/strong> section.
        \n<\/span><\/li>\n<\/ol>\n
        <\/div><\/div>\n

        Authorization Check URL<\/span><\/span><\/h1>\n

        In the <\/span>Authorization Check URL<\/strong> field, optionally define a URL that can be used to test the authorization settings from the XO Platform before you deploy the assistant with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL.<\/span><\/p>\n

        For example<\/span><\/p>\n

        https:\/\/kore.someCompany.com\/sap\/opu\/odata\/sap\/{{authfield1}}\/?$format=json<\/span><\/p>\n

        or<\/span><\/p>\n

        https:\/\/{tenant}.service-now.com\/api\/now\/v1\/table\/incident<\/span><\/p>\n

        For more information, see <\/span>Using Session and Context Variables in Tasks<\/span><\/a>.<\/span><\/p>\n

        Click <\/span>Save<\/strong> to save the authorization settings and close the <\/span>New Authorization Mechanism<\/strong> dialog.<\/span><\/p>\n

        <\/div><\/div>\n

        Testing the Authorization\u00a0<\/span><\/span><\/h1>\n

        Once you save the authorization settings, you can test your authorization definition when you click <\/span>Test <\/strong>from the Authorization Profile page.<\/span><\/p>\n

        \"\"<\/a><\/span><\/p>\n

        To configure testing for Basic Auth, please follow the steps below:<\/span><\/p>\n

          \n
        1. In the <\/span>Auth Check URL<\/strong> field, verify or enter the URL to test the authorization configuration.<\/span><\/li>\n
        2. If your assistant uses subdomains, the <\/span>Tenancy<\/strong> field is displayed and you must specify the tenant.<\/span><\/li>\n
        3. Enter your <\/span>User Name<\/strong> and <\/span>Password<\/strong> for the web service.<\/span><\/li>\n
        4. Select the content type expected for the URL in the <\/span>Content-Type<\/strong> field.<\/span><\/li>\n
        5. Select the Method<\/strong> for testing the URL, You can select either the GET<\/strong> or POST<\/strong> m<\/span>ethod .<\/span><\/li>\n
        6. Click <\/span>Test<\/strong> to begin the authorization test.
          \n          \"\"<\/a>
          \n<\/span><\/li>\n<\/ol>\n

          When the validation of authorization is complete, the <\/span>Test Authorization<\/strong> dialog closes and you can see the results of the validation, either success or failure.<\/span><\/p>\n

          If the authorization fails, the <\/span>Auth Test Failed<\/span><\/em> message is displayed along with the <\/span>Headers<\/strong> and <\/span>Response<\/strong> tabs.<\/span><\/p>\n

          \"\"<\/a><\/p>\n

          <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

          When basic authorization is used for a task, the XO Platform automatically prompts the user for login credentials to access the web application or web service, as shown in the following illustration. After the end-user is authorized, the settings are saved using the following naming syntax: {{ First Name }} {{ Last Name }} {{…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[18],"tags":[],"class_list":["post-17945","post","type-post","status-publish","format-standard","hentry","category-authorization"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17945","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=17945"}],"version-history":[{"count":13,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17945\/revisions"}],"predecessor-version":[{"id":59500,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17945\/revisions\/59500"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=17945"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=17945"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=17945"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}