{"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":"2021-03-18T10:11:31","modified_gmt":"2021-03-18T10:11:31","slug":"setting-up-authorization-using-an-api-key","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-an-api-key\/","title":{"rendered":"Setting Up Authorization using an API Key"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

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 Bot.<\/p>\n

To use the API Key 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.<\/p>\n

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

    \n
  1. Open the bot for which you want to configure an Authorization profile.<\/li>\n
  2. Hover over the left-side navigation panel and from Settings -> Config Settings<\/strong> select Authorization Profile<\/strong>
    \n\"\"<\/a><\/li>\n
  3. Click Add<\/strong>.\u00a0The New Authorization Mechanism<\/strong> dialog opens.<\/li>\n
  4. In the Authorization Type<\/strong> drop-down list, select\u00a0Api Key<\/strong>.<\/li>\n
  5. The following illustration shows the fields to define for the API Key Authorization Type<\/strong>.
    \n    \"Authorization<\/a><\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

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

    If\u00a0required, in the\u00a0Subdomain<\/strong>\u00a0section, select Yes<\/strong>\u00a0if the base URL for a web application or user interface the uses a\u00a0tenant name in the URL. For example,\u00a0kore<\/span> is the tenant organization for a web service using tenants at www.kore<\/em><\/strong>.someCompany.com.<\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

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

    By default, authorization fields are configured as part of the header of the Bot\u00a0request message. If your Bot\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click Add<\/strong>\u00a0in the Authorization Fields<\/strong> section and then define the fields as shown in the following illustration.
    \n\"Adding<\/a><\/p>\n

      \n
    1. In the Field Type<\/strong> field, you can select one of the following depending on where in the Bot\u00a0request message and the type of authorization fields that are required.\n