{"id":17948,"date":"2016-12-05T21:46:55","date_gmt":"2016-12-05T21:46:55","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=9115"},"modified":"2021-03-18T10:15:52","modified_gmt":"2021-03-18T10:15:52","slug":"setting-up-authorization-using-oauth-v2","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-oauth-v2\/","title":{"rendered":"Setting Up Authorization using OAuth v2"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

OAuth v2 is the new version of the open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications.<\/p>\n

To use oAuth v2, you must first register an account with the web application as you will need the sign in credentials for that application to configure the settings for the Authorization Mechanism.<\/p>\n

How oAuth v2 Works<\/span><\/span><\/h2>\n
    \n
  1. The Kore.ai application redirects the user to a login dialog at the web application.<\/li>\n
  2. The user authenticates.<\/li>\n
  3. The web application\u00a0redirects the user back to the Kore.ai application with an access token.<\/li>\n
  4. The Kore.ai application validates the\u00a0access token.<\/li>\n
  5. The access token allows the Kore.ai application\u00a0to access a protected resource at the provider, on behalf of the user.<\/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 oAuth v2<\/span><\/h2>\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>\u00a0drop-down list, select\u00a0auth v2<\/strong>.<\/li>\n
    5. In the\u00a0Name<\/strong>\u00a0field, enter the name for your authorization.<\/li>\n<\/ol>\n

      The following illustration is an example of the oAuth v2<\/strong>\u00a0fields that you must define to enable basic authorization for your Bot.
      \n      \"\"<\/a><\/p>\n

      To configure oAuth v2, define the fields described in the following table.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
      FIELD NAME<\/th>\nDESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n
      Authorization Type<\/td>\nSet to oAuth v2.<\/td>\n<\/tr>\n
      Bots\u00a0Callback Link<\/td>\nThe URL used by the web application or web service to redirect the end-user after end-user authorization is complete. This value, https:\/\/idp.kore.ai\/workflows\/callback\/<\/span>\u00a0is provided as a read-only value by the Kore.ai application when you define oAuth v2 settings.<\/td>\n<\/tr>\n
      Identity Provider Name<\/td>\nThe name of the web application or web service, for example, Asana<\/em>. This field is required.<\/td>\n<\/tr>\n
      Client ID<\/td>\nThe ID of the Kore.ai client.<\/td>\n<\/tr>\n
      Client Secret Key<\/td>\nThe value provided as the Kore.ai application authentication based on the Client ID\u00a0to the web application.<\/td>\n<\/tr>\n
      Authorization\u00a0URL<\/td>\nThis is the URL used to obtain end-user\u00a0authorization for the Kore.ai application to access the web application or web service using the access token.\u00a0This field is required. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the Authorization\u00a0URL, for example,
      \n\u00a0 \u00a0 \u00a0https:\/\/kore.someCompany.com\/sap\/opu\/odata\/sap\/{{authfield1}}\/?$format=json
      \n<\/span>or
      \n\u00a0 \u00a0 \u00a0https:\/\/{tenant}.service-now.com\/api\/now\/v1\/table\/incident<\/span>
      \nFor more information, see Using Session and Context Variables in Tasks<\/a>.<\/td>\n<\/tr>\n
      Access Using a Connector<\/td>\nSelect Yes<\/strong> to enable access for Kore.ai Bots using the Kore.ai Connector agent. This option is only visible if a Kore.ai Connector agent is configured and enabled in your enterprise on-premises network. For more information, see Using the Kore.ai Connector<\/a>.<\/td>\n<\/tr>\n
      Token Request URL<\/td>\nThe URL used by the Kore.ai application to obtain an unauthorized request token. A request token is a value used by the Kore.ai application to obtain authorization from the end-user to obtain an access token. After end-user authorization, an access token can be requested by the Kore.ai application. This field is required.<\/td>\n<\/tr>\n
      Scope<\/td>\nIf the Bot web service requires additional values for authorization, add one or more Key\/Value<\/span> pairs. For example, some Bot web services support using a scope<\/span> key using\u00a0read-only<\/span>, write<\/span>, or\u00a0both<\/span> as the value.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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><\/h3>\n

      If\u00a0required, in the\u00a0Subdomain<\/strong>\u00a0section, select Yes<\/strong>\u00a0if the base URL for a web application or user interface that 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

      In 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

      Adding Additional Fields<\/span><\/h3>\n

      Click Add<\/strong> to open the Additional Fields<\/strong> dialog and then enter one or more key\/value pairs that represent additional authorization input fields.<\/p>\n

      If the default username and password fields do not meet your needs for authorization input, you can add custom fields as key\/value pairs that are displayed to the end-user by adding Additional Fields<\/strong>. You can use these fields, for example, if a PIN code is required in the authorization process, in addition to the Username<\/strong> and Password<\/strong> fields.<\/p>\n

      Additional Fields<\/strong> are added as shown in the following illustration.<\/p>\n

      \"\"<\/a>
      \nSpecify the following fields:<\/p>\n