{"id":27044,"date":"2021-03-17T06:01:02","date_gmt":"2021-03-17T06:01:02","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=27044"},"modified":"2022-09-28T07:48:22","modified_gmt":"2022-09-28T06:48:22","slug":"alert-task-oauth-v2","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-builder-tool\/alert\/alert-task-oauth-v2\/","title":{"rendered":"Alert Task \u2013 OAuth v2"},"content":{"rendered":"

We have seen how an Alert task can be set up in the Kore.ai XO Platform  <\/span>here<\/span><\/a>. In this article, we will see how alert task authorization can be set up using the OAuth v2.<\/span><\/p>\n

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

How it Works <\/span><\/span><\/h1>\n
    \n
  1. The Kore.ai application 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 Kore.ai application with an access token.<\/span><\/li>\n
  4. The Kore.ai application validates the access token.<\/span><\/li>\n
  5. The access token allows the Kore.ai application to access a protected resource at the provider, on behalf of the user.<\/span><\/li>\n<\/ol>\n
    <\/div><\/div>\n

    General Setup<\/span><\/span><\/h1>\n

    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. To use oAuth v2, you must first register an account with the web application as you will need the log-in credentials for that application to configure the settings for the Authorization Mechanism.<\/span><\/p>\n

    To begin your configuration, follow the steps below:<\/span><\/p>\n

      \n
        \n
      1. Select the <\/span>VA <\/strong>you want to work with.<\/span><\/li>\n
      2. Go to <\/span>Build > Conversation Skills > Alert Tasks<\/strong>. <\/span><\/li>\n
      3. Select the <\/span>task <\/strong>you want to work with. <\/span><\/li>\n
      4. Click the <\/span>API Request<\/strong> tab within the Alert Task.<\/span><\/li>\n
      5. Expand the <\/span>Authorization <\/strong>section and click <\/span>Create New<\/strong> to configure a new authorization. \"\"<\/a>\n

        <\/span><\/li>\n

      6. Next, the <\/span>New Authorization Mechanism<\/strong> window opens, as shown in the illustration below.
        <\/span>        \"\"<\/a><\/li>\n<\/ol>\n<\/ol>\n

        To configure OAuth1 for your Alert Task, please configure each area presented below. <\/span><\/p>\n

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

        Form 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
        \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.<\/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> is provided as a read-only value by the Kore.ai application when you define oAuth v2 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>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.<\/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.<\/span><\/p>\n<\/td>\n<\/tr>\n

        \n

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

        		\n

        The URL used to obtain end-user authorization for the Kore.ai application to access the web application or web service using the access token. This field is required.<\/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. 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 <\/span>Key\/Value<\/span> pairs. For example, some Bot 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><\/p>\n<\/td>\n<\/tr>\n

        \n

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

        		\n

        Add the refresh token URL that you want to use for this authentication.<\/span><\/p>\n<\/td>\n<\/tr>\n

        \n

        Auth Error Status Code<\/span><\/p>\n<\/td>\n

        		\n

        When there is an error in authentication, use this field to provide a status code for the particular error.<\/span><\/p>\n<\/td>\n<\/tr>\n

        \n

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

        		\n

        Provide a description for your Alert Task authentication. <\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

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

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

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

        Additional Fields<\/span><\/span><\/h1>\n
          \n
        1. Click <\/span>+ Add Additional Fields <\/strong>to open the <\/span>Additional Fields<\/strong> window, and then enter one or more key\/value pairs that represent additional authorization input fields if required as shown in the following illustration. 
          \"\"<\/a>
          <\/span><\/li>\n
        2. Specify the following fields:<\/span>\n
            \n
          1. Field Key<\/strong> – The name of the custom field to specify for authorization.<\/span><\/li>\n
          2. Value<\/strong> – The value of the custom field to specify for the authorization.<\/span><\/li>\n
          3. Click <\/span>Add<\/strong> to save the <\/span>Additional Field<\/strong>.<\/span><\/li>\n<\/ol>\n<\/li>\n
          4. To add more <\/span>Additional Fields<\/strong>, click <\/span>Add<\/strong> in the <\/span>Additional Fields<\/strong> section.<\/span><\/li>\n<\/ol>\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,<\/span><\/p>\n

              \n
            1. Click <\/span>+ Add Authorization Field <\/strong>and then define the fields as shown in the following illustration.<\/span>
              \"\"<\/a><\/li>\n
            2. 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>\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 uery 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<\/li>\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>Add<\/strong>. The new authorization field is added in the <\/span>Authorization Fields<\/strong> section.<\/span><\/li>\n
              8. To add additional authorization fields, click <\/span>Add<\/strong> in the <\/span>Authorization Fields<\/strong> section.<\/span><\/li>\n<\/ol>\n

                Click <\/span>Save Auth<\/strong> to save the authorization settings and close the <\/span>New Authorization Mechanism<\/strong> dialog.<\/span><\/p>\n

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

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

                After you save the authorization, you can test it using the <\/span>Authorization<\/strong> page.<\/span><\/p>\n

                  \n
                    \n
                  1. Click <\/span>Test Authorization<\/strong> before continuing to develop the remaining steps of your task.<\/span>\"\"<\/a><\/li>\n
                  2. After you click <\/span>Test Authorization<\/strong>, the test is executed using the authentication token URLs and the <\/span>Client ID<\/strong> and <\/span>Client Secret Key<\/strong>. If the tenancy was defined, the <\/span>Test Authorization<\/strong> window is displayed as shown in the following illustration.<\/span>
                    \"\"<\/a><\/li>\n
                  3. Click <\/span>Test<\/strong> to begin the authorization test. When the validation of authentication is complete, the <\/span>Test Authorization<\/strong> window is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <\/span>Test Authorization<\/strong> button. 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>
                    \"\"<\/a><\/li>\n<\/ol>\n<\/ol>\n

                     <\/p>\n

                    <\/p>\n

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

                    <\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

                    We have seen how an Alert task can be set up in the Kore.ai XO Platform  here. In this article, we will see how alert task authorization can be set up using the OAuth v2. How it Works  The Kore.ai application redirects the user to a login dialog at the web application. The user authenticates….<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[67],"tags":[],"class_list":["post-27044","post","type-post","status-publish","format-standard","hentry","category-alert"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/27044","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\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=27044"}],"version-history":[{"count":3,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/27044\/revisions"}],"predecessor-version":[{"id":45842,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/27044\/revisions\/45842"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=27044"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=27044"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=27044"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}