{"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":"2022-10-03T15:46:54","modified_gmt":"2022-10-03T14:46:54","slug":"setting-up-authorization-using-oauth-v1","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-oauth-v1\/","title":{"rendered":"Setting Up Authorization using OAuth v1"},"content":{"rendered":"

OAuth v1 is an open protocol to allow secure authorization in a simple and standardized method from web, mobile, and desktop applications.<\/span><\/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.<\/span><\/p>\n

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

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

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

    \n
  1. The XO Platform obtains an unauthorized request token from the web application.<\/span><\/li>\n
  2. The XO Platform redirects the user to a login dialog at the web application.<\/span><\/li>\n
  3. The user authorizes the request token, associating it with their account.<\/span><\/li>\n
  4. The web application redirects the user back to the XO Platform.
    \"\"<\/a>
    <\/span><\/li>\n
  5. The XO Platform exchanges the request token for an access token.<\/span><\/li>\n
  6. The access token allows the XO Platform to access a protected resource at the provider, on behalf of the user.
    \"\"<\/a>
    <\/span><\/li>\n<\/ol>\n
    <\/div><\/div>\n

    Configuring oAuth v1 Authorization<\/span><\/span><\/h1>\n

    To define authorization for your assistant, 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>.<\/span>\u00a0<\/strong><\/li>\n
    4. Click<\/span> Add<\/strong> to open the <\/span>New Authorization Mechanism<\/strong> dialog.<\/span><\/li>\n
    5. In the Authorization Type<\/strong> drop-down list, select oAuth v1<\/strong>.<\/li>\n
    6. The following illustration is an example of the <\/span>oAuth v1 <\/strong>authorization type fields that you must define to enable a customized authorization for your assistant.<\/span><\/li>\n<\/ol>\n
      <\/div><\/div>\n

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

      To define oAuth v1, configure the fields described in the following table.<\/span><\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
      \n

      FIELD NAME<\/strong><\/p>\n<\/th>\n

      		\n

      DESCRIPTION<\/strong><\/p>\n<\/th>\n<\/tr>\n

      \n

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

      		\n

      Set to <\/span>oAuth v1<\/strong>.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

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

      		\n

      The 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>,\u00a0 is provided as a read-only value by the XO Platform when you define oAuth v1 settings.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Identity Provider Name<\/span><\/p>\n<\/td>\n

      		\n

      The name of the web application or web service, for example, <\/span>Twitter<\/span><\/em>. This field is required. This is the name under which the authorization profile will be displayed within the XO Platform.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Consumer Key<\/span><\/p>\n<\/td>\n

      		\n

      The value provided as the XO Platform identification to the web application. This field is required.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Consumer Secret<\/span><\/p>\n<\/td>\n

      		\n

      The secret value provided by the XO Platform to establish ownership of the <\/span>Consumer Key<\/strong>. This field is required.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Request Token Link<\/span><\/p>\n<\/td>\n

      		\n

      The URL used by the XO Platform to obtain an unauthorized request token. The request token is a value used by the XO Platform to obtain authorization from the end-user to obtain an access token. For example, <\/span>https:\/\/{tenant}.someCompany.com\/oauth\/request_token<\/span>. After end-user authorization, an access token can be requested by the XO Platform. This field is required.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Access Token Link<\/span><\/p>\n<\/td>\n

      		\n

      The URL used to exchange the end-user authorized request token for an access token. The access token is the value used by the XO Platform to gain access to the web application or web service on behalf of the end-user, instead of using the end-user credentials. For example, <\/span>https:\/\/{tenant}.someCompany.com\/oauth\/access_token<\/span>. This field is required.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      User Authorization Link<\/span><\/p>\n<\/td>\n

      		\n

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

      \u00a0\u00a0\u00a0\u00a0\u00a0https:\/\/kore.someCompany.com\/sap\/opu\/odata\/sap\/{{authfield1}}\/?$format=json<\/span><\/p>\n

      or<\/span><\/p>\n

      https:\/\/{tenant}.service-now.com\/api\/now\/v1\/table\/incident<\/span><\/p>\n

      For more information, see <\/span>Using Session and Context Variables in Tasks<\/span><\/a>.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Access Using a Connector<\/span><\/p>\n<\/td>\n

      		\n

      Select <\/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><\/p>\n<\/td>\n<\/tr>\n

      \n

      Refresh Token URL<\/span><\/p>\n<\/td>\n

      		\n

      This is a URL that lets the XO Platform get new access tokens without asking the user to log in again.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Description<\/span><\/p>\n<\/td>\n

      		\n

      :Enter a description for your authorization task.\u00a0<\/span><\/p>\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 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><\/p>\n

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

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

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

      Click <\/span>Add Additional Fields <\/strong>to open the <\/span>Additional Fields<\/strong> dialog 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