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

OAuth v1 is an open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications.<\/p>\n

To use OAuth v1, you must first register an account with the web application as you will need the login credentials for that application to configure the settings for the authorization mechanism.<\/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

How OAuth v1 Works<\/span><\/span><\/h2>\n
    \n
  1. The Kore.ai application\u00a0obtains an unauthorized request token from the web application.<\/li>\n
  2. The Kore.ai\u00a0application redirects the user to a login dialog at the web application.<\/li>\n
  3. The user authorizes the request token, associating it with their account.<\/li>\n
  4. The web application\u00a0redirects the user back to the Kore.ai application.<\/li>\n
  5. The Kore.ai application\u00a0exchanges the request token for an access token.<\/li>\n
  6. 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

    Configuration<\/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> drop-down list, select\u00a0oAuth v1<\/strong>.<\/li>\n
    5. The following illustration is an example of the oAuth v1 <\/strong>authorization type fields that you must define to enable a customized authorization for your Bot.
      \n      \"\"<\/a><\/li>\n<\/ol>\n

      To define oAuth v1, 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 v1<\/strong>.<\/td>\n<\/tr>\n
      Callback URL<\/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 v1 settings.<\/td>\n<\/tr>\n
      Identity Provider Name<\/td>\nThe name of the web application or web service, for example, Twitter<\/em>. This field is required.<\/td>\n<\/tr>\n
      Consumer Key<\/td>\nThe value provided as the Kore.ai application\u00a0identification to the web application.\u00a0This field is required.<\/td>\n<\/tr>\n
      Consumer Secret<\/td>\nThe secret value\u00a0provided by the Kore.ai application\u00a0to establish ownership of the Consumer Key<\/strong>.\u00a0This field is required.<\/td>\n<\/tr>\n
      Request Token Link<\/td>\nThe URL used by the Kore.ai application to obtain an unauthorized request token. The request token is a value used by the Kore.ai application\u00a0to obtain authorization from the end-user to obtain an access token. For example, https:\/\/{tenant}.someCompany.com\/oauth\/request_token<\/span>. After end-user authorization, an access token can be requested by the Kore.ai application.\u00a0This field is required.<\/td>\n<\/tr>\n
      Access Token Link<\/td>\nThe URL used to exchange the end-user\u00a0authorized request token for an access token. The access token is the\u00a0value used by the Kore.ai application\u00a0to gain access to the web application or web service\u00a0on behalf of the end-user, instead of using the end-user credentials. For example, https:\/\/{tenant}.someCompany.com\/oauth\/access_token<\/span>. This field is required.<\/td>\n<\/tr>\n
      User Authorization Link<\/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<\/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 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

      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.
      \n      \"\"<\/a>
      \nSpecify the following fields:<\/p>\n