{"id":17946,"date":"2016-12-05T21:43:32","date_gmt":"2016-12-05T21:43:32","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=9111"},"modified":"2022-10-03T16:13:49","modified_gmt":"2022-10-03T15:13:49","slug":"setting-up-authorization-using-oauth-v2-password-grant","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-oauth-v2-password-grant\/","title":{"rendered":"Setting Up Authorization using oAuth v2 password grant"},"content":{"rendered":"

Setting Up Authorization using oAuth v2 password grant type<\/strong><\/p>\n

OAuth v2 is the new version of the open protocol to allow secure authorization in a standardized manner from web, mobile, and desktop applications.\u00a0<\/span><\/p>\n

To use this authorization method, 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

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

How oAuth v2 Password Grant Type Works<\/span><\/span><\/h1>\n

The oAuth v2 Password grant type authorization method allows apps to exchange a user’s credentials for an access token.\u00a0<\/span><\/p>\n

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

    Configuring oAuth v2 Using Password Grant Type<\/span><\/span><\/h1>\n

    To define Authorization for your assistant, using oAuth v2 password grant, please 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 Profile.<\/strong><\/li>\n
    4. Click<\/span> Add<\/strong> to open the <\/span>New Authorization Mechanism<\/strong> dialog.
      \"\"<\/a>
      <\/span><\/li>\n
    5. In the Authorization Type<\/strong> drop-down list, select <\/span>oAuth v2 password grant type<\/strong>.<\/span>
      <\/strong><\/li>\n
    6. Enter a <\/span>Name <\/strong>for your authorization, then define the fields to enable it.
      \"\"<\/a>
      <\/span><\/li>\n<\/ol>\n

      The illustration and sections below show an overview of the needed configurations. <\/span>
      <\/span><\/p>\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 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><\/span><\/p>\n

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

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

      If, for example, the default username and password fields do not meet your needs for authorization input, you can add custom fields displayed to the end-user by adding authorization IDP form fields. You can use these form fields, for example, if PIN code is required in the authorization process.<\/span><\/p>\n

      To add fields on the authorization form, click <\/span>Add<\/strong> Form Fields, <\/strong>then configure the necessary parameters for each field. The following table describes the fields used to define an authorization form field.<\/span><\/p>\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

      Title of Field<\/span><\/p>\n<\/td>\n

      		\n

      Specify the name of the field displayed to the end-user in the authorization dialog.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

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

      		\n

      The value represents the end-user input value to the authorizing service.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

      Help Hint<\/span><\/p>\n<\/td>\n

      		\n

      The help text displayed in the field to describe what should be entered into the field.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

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

      		\n

      When <\/span>Advanced Options<\/strong> is selected, specify the type of field displayed in the end-user interface to collect the user input assigned as the value for the <\/span>Field Key<\/strong>, one of:<\/span><\/p>\n

        \n
      • Textbox<\/strong><\/li>\n
      • Password<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
      \n

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

      		\n

      When <\/span>Advanced Options<\/strong> is selected, select if the end-user must define this field to complete the authorization.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

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

      		\n

      When <\/span>Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, <\/span>String<\/strong>.<\/span><\/p>\n<\/td>\n<\/tr>\n

      \n

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

      		\n

      When <\/span>Advanced Options<\/strong> is selected, specify if the authorization field should be visible, hidden, or displayed as read-only.<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      \"\"<\/a><\/h3>\n
      <\/div><\/div>\n

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

      By default, authorization fields are configured as part of the header of the request message. If your request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <\/span>Add<\/strong> Authorization Fields<\/strong> and then define the fields as shown in the following illustration.<\/span>
      <\/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 request message and the type of authorization fields that are required.<\/span><\/li>\n
          \n
        1. Header<\/strong> \u2013 The assistant expects the authorization fields as part of the header of the request.<\/span><\/li>\n
        2. Payload<\/strong> \u2013 The assistant expects the authorization fields as part of the content of the body of the request.<\/span><\/li>\n
        3. Query String<\/strong> \u2013 The assistant expects the authorization fields as a query in the body of the request.<\/span><\/li>\n
        4. Path Param<\/strong> \u2013 The assistant 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

          Defining the Token URLs<\/span><\/span><\/h1>\n

          In the <\/span>Token URL<\/strong> field, optionally define a URL that can be used to test the authorization settings from XO Platform before you deploy the VA with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,<\/span><\/p>\n

          http:\/\/{tenant}.someCompany.com\/test\/{{tokenId}}<\/span><\/p>\n

          In the <\/span>Token URL Method<\/strong> field, select the HTTP request method type for the <\/span>Token URL<\/strong>. One of <\/span>PUT<\/strong>, <\/span>POST<\/strong>, <\/span>PATCH<\/strong>, <\/span>DELETE<\/strong>, and <\/span>GET<\/strong>.<\/span><\/p>\n

          In the <\/span>Token URL Content Type<\/strong> field, select the content type expected from the <\/span>Token URL<\/strong>. One of: <\/span>JSON, RSS, XML, URL Encoded JSON, CSV, Text, Twitter Encoded JSON, Multipart\/Form-data,Multipart\/Related<\/strong>, or <\/span>Oracle ADF<\/strong>.<\/span><\/p>\n

          In the <\/span>Refresh Token URL<\/strong>, enter the refresh token URL if required.\u00a0<\/span><\/p>\n

          For situations when there may be authentication errors, enter the <\/span>Auth Error Status Code<\/strong>.<\/span><\/p>\n

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

          Access using the Connector<\/span><\/span><\/h1>\n

          In the <\/span>Access Using a Connector<\/strong> section, select <\/span>Yes<\/strong> to enable access for Kore.ai Bots using the Kore.ai Connector agent. If your domain does not have any active Kore.ai Connectors defined, a warning message is displayed to contact the Bots Admin Console System Administrator. For more information, see <\/span>Using the Kore.ai Connector<\/span><\/a> in the Bots Admin Console documentation.<\/span><\/span><\/h3>\n

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

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

          After you save the authorization, you can test your authorization definition when you click <\/span>Test<\/strong> from the Authorization Profile page.\u00a0<\/span><\/p>\n

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

          When you click <\/span>Test<\/strong>, the <\/span>Test Authorization<\/strong> dialog is displayed and populated with the URL you specified in the <\/span>Authorization Check URL<\/strong> section. Click <\/span>Test<\/strong> to begin the authorization test.\u00a0<\/span><\/p>\n

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

          When the validation of authorization is complete, the <\/span>Test Authorization<\/strong> dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <\/span>Test <\/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><\/p>\n

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

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

          Setting Up Authorization using oAuth v2 password grant type OAuth v2 is the new version of the open protocol to allow secure authorization in a standardized manner from web, mobile, and desktop applications.\u00a0 To use this authorization method, you must first register an account with the web application as you will need the log-in credentials…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[18],"tags":[],"class_list":["post-17946","post","type-post","status-publish","format-standard","hentry","category-authorization"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17946","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=17946"}],"version-history":[{"count":10,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17946\/revisions"}],"predecessor-version":[{"id":47434,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17946\/revisions\/47434"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=17946"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=17946"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=17946"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}