{"id":27046,"date":"2021-03-17T06:05:43","date_gmt":"2021-03-17T06:05:43","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-2\/?p=27046"},"modified":"2021-03-17T06:06:53","modified_gmt":"2021-03-17T06:06:53","slug":"alert-task-api-key-authorization","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-2\/docs\/bots\/bot-builder-tool\/alert\/alert-task-api-key-authorization\/","title":{"rendered":"Alert Task \u2013 Authorization using API Key"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

We have seen how an Alert task can be set up in Kore.ai virtual assistant platform here<\/a>. In this section, we will see how the authorization can be set up using API Key.<\/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

Setting Up<\/span><\/h2>\n

An API key can act as both a unique identifier and a secret token for identification as well as authentication 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 task. 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\u00a0that application to configure the settings for the Kore.ai authorization mechanism.The following illustration shows the fields to define for the API Key\u00a0Authorization Type<\/strong>.\"Authorization<\/a><\/p>\n

To define an API key\u00a0authorization,<\/p>\n

    \n
  1. Select API Key<\/strong>\u00a0in the Authorization Type<\/strong> field. Then specify a\u00a0Name<\/strong>\u00a0for the authorization to be displayed in the Bot\u00a0builder user interface.<\/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

    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 as www.kore<\/em><\/strong>.someCompany.com.<\/span>
    \nIn the following example configuration, the tenancy URL contains the {tenant}<\/span> organization placeholder.
    \n    \"\"<\/a><\/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

    Form Fields<\/span><\/span><\/h2>\n

    If the default username and password fields do not meet your needs, you can add new\u00a0fields displayed to the end-user by adding authorization form fields. To add fields\u00a0on the authorization form,<\/p>\n