{"id":46172,"date":"2022-09-29T10:53:31","date_gmt":"2022-09-29T09:53:31","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=46172"},"modified":"2023-05-18T08:19:18","modified_gmt":"2023-05-18T07:19:18","slug":"bot-oauthv2-clientcredentials","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/bot-oauthv2-clientcredentials\/","title":{"rendered":"Setting Up Authorization using OAuth v2 client credentials"},"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

The Client Credentials grant type is used when applications request an access token to access their own resources, not on behalf of a user.<\/span><\/p>\n

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

Configuring oAuth v2 Using Client Credentials<\/span><\/span><\/h1>\n

To configure this audialog opensthorization method 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 menu, click <\/span>Configurations > Authorization Profiles.<\/strong><\/li>\n
  4. Click<\/span> Add<\/strong>. The <\/span>New Authorization Mechanism<\/strong> dialog opens.
    <\/span>\"\"<\/a><\/li>\n
  5. In the <\/span>Authorization Type<\/strong> drop-down list, select <\/span>auth v2 client credentials<\/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.<\/span><\/p>\n

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

    Please define the fields as explained in the following table:<\/span><\/p>\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 oAuth v2 Client Credentials.<\/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>Asana<\/span><\/em>. This field is required.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    Client ID<\/span><\/p>\n<\/td>\n

    		\n

    The ID of the Kore.ai client. The XO Platform accepts a maximum length of 255 characters.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

    Client Secret Key<\/span><\/p>\n<\/td>\n

    		\n

    The value provided as the Kore.ai application authentication based on the Client ID to the web application. The XO Platform accepts a maximum length of 255 characters.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

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

    		\n

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

    \n

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

    		\n

    If the web service requires additional values for authorization, add one or more Key\/Value pairs. For example, some web services support using a scope key using read-only, write, or both as the value.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

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

    		\n

    Enter 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.<\/span><\/p>\n<\/td>\n<\/tr>\n

    \n

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

    		\n

    Enter a description for your authorization. <\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

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

    Authorization Fields<\/span><\/span><\/h1>\n

    By default, authorization fields are configured as part of the header of the task request message. If your task request requires additional authorization fields or the expected authorization is not part of the header, for example, a verification code, click<\/span> + Add Authorization Field <\/strong>and then define the fields as shown in the following illustration. <\/span><\/p>\n

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

      \n
    1. In the <\/span>Field Type<\/strong> field, you can select one of the following depending on where in the task request message and the type of authorization fields that are required.<\/span><\/li>\n
        \n
      1. Header<\/strong> – The VA expects the authorization fields as part of the header of the request.<\/span><\/li>\n
      2. Payload<\/strong> – The VA expects the authorization fields as part of the content of the body of the request.<\/span><\/li>\n
      3. Query String<\/strong> – The VA expects the authorization fields as a query in the body of the request.<\/span><\/li>\n
      4. Path Param<\/strong> – The VA expects the authorization fields as part of the URL path for the request.<\/span><\/li>\n<\/ol>\n
      5. In the <\/span>Field Key<\/strong> field, enter the name of the field for the selected <\/span>Field Type<\/strong>.<\/span><\/li>\n
      6. In the <\/span>Field Value<\/strong> field, enter the value for the <\/span>Field Key<\/strong> specified.<\/span><\/li>\n
      7. Click <\/span>Done<\/strong>. The new authorization field is added in the <\/span>Authorization Fields<\/strong> section.<\/span><\/li>\n<\/ol>\n
        <\/div><\/div>\n

        Testing the Authorization<\/span><\/span><\/h1>\n

        After you save the authentication, you can test your authorization definition on the <\/span>Authentication<\/strong> page when you click <\/span>Test <\/strong>before continuing to develop the remaining steps of your task. When you click <\/span>Test<\/strong>, the test is executed using the authentication token URLs and the <\/span>Client ID<\/strong> and <\/span>Client Secret Key<\/strong>. If tenancy was defined, the <\/span>Test Authorization<\/strong> dialog is displayed.<\/span><\/p>\n

        Click <\/span>Test<\/strong> to begin the authorization test. <\/span><\/p>\n

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

        When the validation of authorization is complete, the results of the validation, either success or failure, are displayed. If the authorization fails, the <\/span>Auth Test Failed<\/span><\/em> message is displayed along with the <\/span>Headers<\/strong> and <\/span>Response<\/strong> tabs as shown in the following illustration.<\/span><\/p>\n

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

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

         <\/p>\n","protected":false},"excerpt":{"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. 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…<\/p>\n","protected":false},"author":27,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[18],"tags":[],"class_list":["post-46172","post","type-post","status-publish","format-standard","hentry","category-authorization"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/46172","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/27"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=46172"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/46172\/revisions"}],"predecessor-version":[{"id":57079,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/46172\/revisions\/57079"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=46172"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=46172"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=46172"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}