{"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":"2023-05-18T08:14:28","modified_gmt":"2023-05-18T07:14:28","slug":"setting-up-authorization-using-oauth-v2","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-oauth-v2\/","title":{"rendered":"Setting Up Authorization using OAuth v2"},"content":{"rendered":"

OAuth v2 is the new version of the open protocol to allow secure authorization via a standard method from web, mobile, and desktop applications.<\/span><\/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.<\/span><\/p>\n

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

How OAuth v2 Works<\/span><\/span><\/h1>\n

OAuth v2 authorization works as follows:<\/span><\/p>\n

    \n
  1. The XO Platform redirects the user to a login dialog at the web application.<\/span><\/li>\n
  2. The user authenticates.<\/span><\/li>\n
  3. The web application redirects the user back to the XO Platform with an access token.<\/span><\/li>\n
  4. The XO Platform validates the access token.<\/span><\/li>\n
  5. The access token allows the XO Platform to access a protected resource at the provider, on behalf of the user.<\/span><\/li>\n<\/ol>\n
    <\/div><\/div>\n

    Configuring OAuth v2 Authorization<\/span><\/span><\/h1>\n

    To define Authorization for your assistant, using oAuth v2, 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 Profiles.<\/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>auth v2<\/strong>.<\/span><\/li>\n
    6. In the <\/span>Name<\/strong> field, enter the name for your authorization.<\/span><\/li>\n<\/ol>\n

      The following illustration shows the <\/span>oAuth v2<\/strong> fields that you must define to enable authorization for your assistant.
      \"\"<\/a>
      <\/span><\/p>\n

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

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

      To configure oAuth v2, define the fields described in the following table.<\/span><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
      \nFIELD NAME<\/strong>\n<\/th>\n\nDESCRIPTION<\/strong>\n<\/th>\n<\/tr>\n
      \nAuthorization Type<\/span>\n<\/td>\n\nSet to oAuth v2.<\/span>\n<\/td>\n<\/tr>\n
      \nCallback Link<\/span>\n<\/td>\n\nThe URL used by the web application or web service to redirect the end-user after end-user authorization is complete. This value, <\/span>https:\/\/idp.kore.ai\/workflows\/callback\/<\/span> is provided as a read-only value by the XO Platform when you define oAuth v2 settings.<\/span>\n<\/td>\n<\/tr>\n
      \nIdentity Provider Name<\/span>\n<\/td>\n\nThe name of the web application or web service, for example, <\/span>Asana<\/span><\/em>. This field is required.<\/span>\n<\/td>\n<\/tr>\n
      \nClient ID<\/span>\n<\/td>\n\nThe ID of the Kore.ai client. The XO Platform accepts a maximum length of 255 characters.<\/span>\n<\/td>\n<\/tr>\n
      \nClient Secret Key<\/span>\n<\/td>\n\nThe value provided as the XO Platform authentication based on the Client ID to the web application. The XO platform accepts a maximum length of 255 characters.<\/span>\n<\/td>\n<\/tr>\n
      \n

      Authorization URL<\/span><\/p>\n<\/td>\n

      		\nThis is the URL used to obtain end-user authorization for the XO Platform to access the web application or web service using the access token. The XO Platform accepts a valid URL with a maximum length of 3000 characters. This field is required. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the Authorization URL, for example,<\/span>
      \n\u00a0\u00a0\u00a0\u00a0\u00a0https:\/\/kore.someCompany.com\/sap\/opu\/odata\/sap\/{{authfield1}}\/?$format=json<\/span>
      \nor<\/span><\/p>\n

      https:\/\/{tenant}.service-now.com\/api\/now\/v1\/table\/incident<\/span>
      \nFor more information, see <\/span>Using Session and Context Variables in Tasks<\/span><\/a>.<\/span>\n<\/td>\n<\/tr>\n

      \nAccess Using a Connector<\/span><\/p>\n<\/td>\n\nSelect <\/span>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 <\/span>Using the Kore.ai Connector<\/span><\/a>.<\/span>\n<\/td>\n<\/tr>\n
      \nToken Request URL<\/span>\n<\/td>\n\nThe URL used by the XO Platform to obtain an unauthorized request token. A request token is a value used by the XO Platform to obtain authorization from the end-user to obtain an access token. The XO Platform accepts a valid URL with a maximum length of 3000 characters. After end-user authorization, an access token can be requested by the Kore.ai application. This field is required.<\/span>\n<\/td>\n<\/tr>\n
      \nScope<\/span><\/p>\n<\/td>\n\nIf the web service requires additional values for authorization, add one or more <\/span>Key\/Value<\/span> pairs. For example, some web services support using a <\/span>scope<\/span> key using <\/span>read-only<\/span>, <\/span>write<\/span>, or <\/span>both<\/span> as the value.<\/span>\n<\/td>\n<\/tr>\n
      \nRefresh Token URL<\/span><\/p>\n<\/td>\n\nEnter a Refresh Token URL, if required, for cases when the authentication token expires and has to be refreshed. The XO Platform accepts a valid URL with a maximum length of 3000 characters.
      \n<\/span>\n<\/td>\n<\/tr>\n
      \nDescription<\/span><\/p>\n<\/td>\n\nEnter a description for your authorization.<\/span>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
      <\/div><\/div>\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 that 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

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

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

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

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

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

      If, for example, 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 <\/span>Additional Fields<\/strong>. You can use these fields, for example, if a PIN code is required in the authorization process, in addition to the <\/span>Username<\/strong> and <\/span>Password<\/strong> fields.<\/span><\/p>\n

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

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

      Specify the following fields:<\/span><\/p>\n