{"id":17949,"date":"2016-12-05T21:48:09","date_gmt":"2016-12-05T21:48:09","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=9118"},"modified":"2022-10-03T14:57:55","modified_gmt":"2022-10-03T13:57:55","slug":"setting-up-authorization-using-an-api-key","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-an-api-key\/","title":{"rendered":"Setting Up Authorization using an API Key"},"content":{"rendered":"

An API key can act as both a unique identifier and a secret token for identification as well as authorization to provide a set of access rights on the associated API. Instead of prompting the end-user for both a username and password for access, the user is prompted only for an API key when configuring the assistant.<\/span><\/p>\n

To use the API Key <\/span>Authorization Type<\/strong>, you must first register an account with the web application and then generate an API Key for that application to configure the settings for the Kore.ai authorization mechanism.<\/span><\/p>\n

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

Configuring API Key Authorization<\/span><\/span><\/h1>\n

To define Authorization for your assistant, using an API Key, follow these steps:<\/span><\/p>\n

    \n
  1. Open the assistant for which you want to configure an 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.
    \"\"<\/a>
    <\/span><\/li>\n
  5. In the Authorization Type<\/strong> drop-down list, select <\/span>Api Key<\/strong>.
    \"\"<\/a><\/span><\/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 at <\/span>www.<\/span>kore<\/em><\/strong>.someCompany.com.<\/span><\/p>\n

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

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

    If, for example, the default username and password fields do not meet your needs, you can add new fields displayed to the end-user by adding authorization IDP form fields. To add fields on the authorization form, click <\/span>Add<\/strong> Form Fields<\/strong>.<\/span><\/p>\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
    \n

    FIELD NAME<\/strong><\/p>\n<\/th>\n

    		\n

    DESCRIPTION<\/strong><\/p>\n<\/th>\n<\/tr>\n

    \n

    Title of Field<\/span><\/p>\n<\/td>\n

    		\n

    Specify the name of the field displayed to the end-user in the authentication dialog.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    Field Key<\/span><\/p>\n<\/td>\n

    		\n

    The value represents the end-user input value to the authenticating service.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    Help Hint<\/span><\/p>\n<\/td>\n

    		\n

    The help text displayed in the field to describe what should be entered into the field.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    Field Type<\/span><\/p>\n<\/td>\n

    		\n

    When <\/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
    \n

    Mandatory<\/span><\/p>\n<\/td>\n

    		\n

    When <\/span>Advanced Options<\/strong> is selected, select if the end-user must define this field to complete authentication.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    Data Type<\/span><\/p>\n<\/td>\n

    		\n

    When <\/span>Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, <\/span>String<\/strong>.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    Visibility<\/span><\/p>\n<\/td>\n

    		\n

    When <\/span>Advanced Options<\/strong> is selected, specify if the authentication field should be visible, hidden, or displayed as read-only.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    \"\"<\/a><\/p>\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 needs additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <\/span>Add<\/strong> in the <\/span>Authorization Fields<\/strong> section and then define the fields as shown in the following illustration.<\/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><\/li>\n
        \n
      1. Header<\/strong> \u2013 The assistant expects the authorization fields as part of the header of the request.<\/span><\/li>\n
      2. Payload<\/strong> \u2013 The assistant expects the authorization fields as part of the content of the body of the request.<\/span><\/li>\n
      3. Query String<\/strong> \u2013 The assistant expects the authorization fields as a query in the body of the request.<\/span><\/li>\n
      4. Path Param<\/strong> \u2013 The assistant expects the authorization fields as part of the URL path for the request.<\/span><\/li>\n<\/ol>\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>Add<\/strong>. The new authorization field is added in the <\/span>Authorization Fields<\/strong> section.<\/span><\/li>\n<\/ol>\n

        To add additional authorization fields, click <\/span>Add<\/strong> in the <\/span>Authorization Fields<\/strong> section.<\/span><\/p>\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 authentication settings from the XO Platform before you deploy the VA with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,<\/span><\/p>\n

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

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

        Access Using a Connector<\/span><\/span><\/h1>\n

        In the <\/span>Access Using a Connector<\/strong> section, select <\/span>Yes<\/strong> to enable access for Kore.ai assistants using the Kore.ai Connector agent. If your domain does not have any active Kore.ai Connectors defined, a warning message is displayed to contact the Admin Console system administrator. For more information, see <\/span>Using the Kore.ai Connector<\/span><\/a> in the Admin Console documentation.<\/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<\/span><\/span><\/h1>\n

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

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

        When you click <\/span>Test<\/strong>, the <\/span>Test Authorization<\/strong> dialog is displayed.<\/span><\/p>\n

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

        To configure the Test Authorization \u2013 API Key<\/strong><\/p>\n

          \n
        1. In the <\/span>Auth Check URL<\/strong> field, verify or enter the URL to test the authentication 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 the API key for the application in the <\/span>API Key<\/strong> field.<\/span><\/li>\n
        4. Select the content type expected for the URL in the <\/span>Content-Type<\/strong> field.<\/span><\/li>\n
        5. For testing the URL, the <\/span>Method<\/strong> field is read-only and set to <\/span>GET<\/strong>.<\/span><\/li>\n
        6. Click <\/span>Test<\/strong> to begin the authorization test.<\/span><\/li>\n<\/ol>\n

          When the validation of authentication is complete, the <\/span>Test Authorization<\/strong> dialog is closed and the result of the validation, either success or failure, is displayed. 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 as shown in the following illustration.<\/span><\/p>\n

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

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

          An API key can act as both a unique identifier and a secret token for identification as well as authorization to provide a set of access rights on the associated API. Instead of prompting the end-user for both a username and password for access, the user is prompted only for an API key when configuring…<\/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-17949","post","type-post","status-publish","format-standard","hentry","category-authorization"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17949","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=17949"}],"version-history":[{"count":9,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17949\/revisions"}],"predecessor-version":[{"id":47359,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17949\/revisions\/47359"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=17949"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=17949"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=17949"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}