{"id":27042,"date":"2021-03-17T05:53:50","date_gmt":"2021-03-17T05:53:50","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-1\/?p=27042"},"modified":"2021-03-17T05:58:02","modified_gmt":"2021-03-17T05:58:02","slug":"alert-task-oauth-v1","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-1\/docs\/bots\/bot-builder-tool\/alert\/alert-task-oauth-v1\/","title":{"rendered":"Alert Task \u2013 OAuth v1"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

We have seen how an Alert task can be set up in Kore.ai virtual assistant platform here<\/a>. In this section, we will see how authorization for the alert tasks can be set up using the OAuth v1.<\/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

Setting Up<\/span><\/h2>\n

OAuth is an open protocol to allow secure authorization in a simple and standard method from web, mobile, and desktop applications. To use OAuth, 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.<\/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

Tenancy<\/span><\/h2>\n

If\u00a0required, in the\u00a0Subdomain<\/strong>\u00a0section, select Yes<\/strong> if the base URL for a web application or user interface uses a\u00a0tenant name in the URL. For example,\u00a0kore<\/span> is the tenant organization for a web service using tenants as www.kore<\/em><\/strong>.someCompany.com.<\/span>
\nIn 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

Form Fields<\/span><\/span><\/h2>\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.<\/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. A request token is the\u00a0value 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-users log on credentials. For example, https:\/\/{tenant}.someCompany.com\/oauth\/access_token<\/span>. This field is required.<\/td>\n<\/tr>\n
User Authorization Link<\/td>\nThe URL used to obtain end-user\u00a0authorization for the Kore.ai application to access the web application or web service using the access token. For example, https:\/\/{tenant}.someCompany.com\/oauth\/authorize<\/span>. This field is required.<\/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

Add Additional Fields<\/h4>\n
    \n
  1. Click +\u00a0Add\u00a0Additional Fields <\/strong>to open the 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.
    \n    \"Additional<\/a><\/li>\n
  2. Specify the following fields:
    \nField Key<\/strong> – The\u00a0name of the custom field to specify\u00a0for authorization.Field Value<\/strong> – The value of the custom field to specify for the authorization.<\/li>\n
  3. Click Add<\/strong> to save the Additional Field<\/strong>.<\/li>\n
  4. To add more Additional Fields<\/strong>, click Add<\/strong>\u00a0in the Additional Fields<\/strong> section.<\/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

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

    By default, authorization fields are configured as part of the header of the task\u00a0request message. If your task\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN,<\/p>\n

      \n
    1. Click + Add\u00a0Authorization Field<\/strong>\u00a0and then define the fields as shown in the following illustration.
      \n      \"Authorization<\/a><\/li>\n
    2. In the 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.
      \nHeader<\/strong> –\u00a0The Bot\u00a0expects the authorization fields as part of the header\u00a0of the request.Payload<\/strong> – The Bot\u00a0expects the authorization fields as part of the content of the body of the request.Query String<\/strong> –\u00a0The Bot\u00a0expects the authorization fields as a query in the body\u00a0of the request.Path Param<\/strong> – The Bot expects the authorization fields as part of the URL path for the request.<\/li>\n
    3. In the Field Key<\/strong> field, enter the name of the field for the selected Field Type<\/strong>.<\/li>\n
    4. In the Field Value<\/strong> field,\u00a0enter the value for the Field Key<\/strong> specified.<\/li>\n
    5. Click Add<\/strong>. The new authorization field is added in the Authorization Fields<\/strong> section.<\/li>\n
    6. To add additional authorization fields, click Add<\/strong>\u00a0in the Authorization\u00a0Fields<\/strong> section.<\/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

      Testing<\/span><\/span><\/h2>\n

      After you save the authorization, you can test your authorization definition on the Authorization<\/strong> page.<\/p>\n

        \n
      1. Click Test Authorization<\/strong> before continuing to develop the remain steps of your task.
        \n        \"Test<\/a><\/li>\n
      2. When you\u00a0click Test Authorization<\/strong>, the test is executed using the authentication token URLs and the Consumer Key<\/strong> and Consumer Token<\/strong>. If the tenancy was defined, the Test Authorization<\/strong> dialog is displayed\u00a0as shown in the following illustration.
        \n        \"Test<\/a><\/li>\n
      3. Click Test<\/strong>\u00a0to begin the authorization test.\u00a0When the validation of authentication is complete, the Test Authorization<\/strong> window is closed and the results of the validation, either success or failure, is displayed to the immediate right of the Test Authorization<\/strong> button. If the authorization fails, the Auth Test Failed<\/em> message is displayed along with the Headers<\/strong> and Response<\/strong> tabs as shown in the following illustration.
        \n        \"Authentication<\/a><\/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

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

          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 task.
          \n\"New<\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

          <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>
          \r\n\t
          \r\n\t\t
          \r\n\t\t\t\r\n\t\t<\/div>\r\n\t<\/div>\r\n<\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"We have seen how an Alert task can be set up in Kore.ai virtual assistant platform here. In this section, we will see how authorization for the alert tasks can be set up using the OAuth v1. Setting Up OAuth is an open protocol to allow secure authorization in a simple and standard method from...","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-27042","post","type-post","status-publish","format-standard","hentry","category-alert"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts\/27042","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/comments?post=27042"}],"version-history":[{"count":1,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts\/27042\/revisions"}],"predecessor-version":[{"id":27043,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/posts\/27042\/revisions\/27043"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/media?parent=27042"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/categories?post=27042"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-1\/wp-json\/wp\/v2\/tags?post=27042"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}