{"id":17946,"date":"2016-12-05T21:43:32","date_gmt":"2016-12-05T21:43:32","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&#038;p=9111"},"modified":"2021-03-18T10:14:47","modified_gmt":"2021-03-18T10:14:47","slug":"setting-up-authorization-using-oauth-v2-password-grant","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-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":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\">\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>To define Authorization for your bot, follow these steps:<\/p>\n<ol>\n<li>Open the bot for which you want to configure an Authorization profile.<\/li>\n<li>Hover over the left-side navigation panel and from <strong>Settings -&gt; Config Settings<\/strong> select <strong>Authorization Profile<\/strong><br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/auth-profiles.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-21924\" src=\"\/wp-content\/uploads\/sites\/18\/auth-profiles.png\" alt=\"\" width=\"349\" height=\"569\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/18\/20221201101820\/auth-profiles.png 349w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/18\/20221201101820\/auth-profiles-184x300.png 184w\" sizes=\"auto, (max-width: 349px) 100vw, 349px\" \/><\/a><\/li>\n<li>Click<strong> Add<\/strong>.\u00a0The <strong>New Authorization Mechanism<\/strong> dialog opens.<\/li>\n<li>In the <strong>Authorization Type<\/strong> drop-down list, select <strong>oAuth v2 password grant type<\/strong>.<\/li>\n<li>The following illustration is an example of the <strong>oAuth v2 password grant<\/strong> authorization type fields that you must define to enable a customized authorization for your Bot.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/first-screen.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-14733 alignnone\" src=\"\/wp-content\/uploads\/sites\/18\/first-screen.png\" alt=\"\" width=\"491\" height=\"484\" \/><\/a><\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Defining_Tenancy\">Defining Tenancy<\/span><\/h3>\n<p>If\u00a0required, in the\u00a0<strong>Subdomain<\/strong>\u00a0section, select <strong>Yes<\/strong>\u00a0if the base URL for a web application or user interface the uses a\u00a0tenant name in the URL. For example,\u00a0<span style=\"color: #0000ff\">kore<\/span> is the tenant organization for a web service using tenants as <span style=\"color: #0000ff\">www.<strong><em>kore<\/em><\/strong>.someCompany.com.<\/span><\/p>\n<p>In the following example configuration, the tenancy URL contains the <span style=\"color: #0000ff\">{tenant}<\/span> organization placeholder.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Tenacy-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-14732 alignnone\" src=\"\/wp-content\/uploads\/sites\/18\/Tenacy-1.png\" alt=\"\" width=\"477\" height=\"135\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Adding_Authorization_Fields\"><span class=\"wysiwyg-font-size-large\">Adding Authorization Fields<\/span><\/span><\/h3>\n<p>By default, authorization fields are configured as part of the header of the Bot\u00a0request message. If your Bot\u00a0request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click <strong>Add<\/strong>\u00a0in the <strong>Authorization Fields<\/strong> section and then define the fields as shown in the following illustration.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Authorization-Fields.png\"><img loading=\"lazy\" decoding=\"async\" class=\"size-full wp-image-14734 alignnone\" src=\"\/wp-content\/uploads\/sites\/18\/Authorization-Fields.png\" alt=\"\" width=\"589\" height=\"245\" \/><\/a><\/p>\n<ol>\n<li>In the <strong>Field Type<\/strong> field, you can select one of the following depending on where in the Bot\u00a0request message and the type of authorization fields that are required.\n<ul>\n<li><strong>Header<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as part of the header\u00a0of the request.<\/li>\n<li><strong>Payload<\/strong> &#8211; The Bot\u00a0expects the authorization fields as part of the content of the body of the request.<\/li>\n<li><strong>Query String<\/strong> &#8211;\u00a0The Bot\u00a0expects the authorization fields as a query in the body\u00a0of the request.<\/li>\n<li><strong>Path Param<\/strong> &#8211; The Bot expects the authorization fields as part of the URL path for the request.<\/li>\n<\/ul>\n<\/li>\n<li>In the <strong>Field Key<\/strong> field, enter the name of the field for the selected <strong>Field Type<\/strong>.<\/li>\n<li>In the <strong>Field Value<\/strong> field,\u00a0enter the value for the <strong>Field Key<\/strong> specified.<\/li>\n<li>Click <strong>Add<\/strong>. The new authorization field is added in the <strong>Authorization Fields<\/strong> section.<\/li>\n<li>To add additional authorization fields, click <strong>Add<\/strong>\u00a0in the <strong>Authorizations\u00a0Fields<\/strong> section.<\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Adding_Form_Fields\"><span class=\"wysiwyg-font-size-large\">Adding Form Fields<\/span><\/span><\/h3>\n<p>If 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.<\/p>\n<p>To add fields\u00a0on the authorization form, click <strong>Add<\/strong>\u00a0in the <strong>IDP Form Fields<\/strong> section. The following\u00a0illustration is an example of a definition to add a password field\u00a0to the authorization dialog.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/Form-fields.png\"><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter wp-image-14735\" src=\"\/wp-content\/uploads\/sites\/18\/Form-fields.png\" alt=\"\" width=\"422\" height=\"425\" \/><\/a><br \/>\nThe following table describes the fields used to define an authorization IDP form field.<\/p>\n<table>\n<thead>\n<tr>\n<th class=\"wysiwyg-text-align-left\" scope=\"col\">FIELD NAME<\/th>\n<th class=\"wysiwyg-text-align-left\">DESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>Title of Field<\/td>\n<td>Specify the name of the field displayed to the end-user in the authorization dialog.<\/td>\n<\/tr>\n<tr>\n<td>Field Key<\/td>\n<td>The value represents the end-user input value to the authorizing service.<\/td>\n<\/tr>\n<tr>\n<td>Help Hint<\/td>\n<td>The help text displayed in the field to describe what should be entered into the field.<\/td>\n<\/tr>\n<tr>\n<td>Field Type<\/td>\n<td>When <strong>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 <strong>Field Key<\/strong>, one of:<\/p>\n<ul>\n<li><strong>Textbox<\/strong><\/li>\n<li><strong>Password<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<tr>\n<td>Mandatory<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, select if the end-user must define this field to complete the authorization.<\/td>\n<\/tr>\n<tr>\n<td>Data Type<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, <strong>String<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td>Visibility<\/td>\n<td>When <strong>Advanced Options<\/strong> is selected, specify if the authorization field should be visible, hidden, or displayed as read-only.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Defining_the_Token_URL\">Defining the Token URL<\/span><\/h3>\n<p>In the <strong>Token\u00a0URL<\/strong> field, optionally define a URL that can be used to test the authorization settings from Bot Builder before you deploy the Bot with the authorization mechanism. You can use dynamic fields, path parameter fields, query fields, and so forth, to define the test URL, for example,<br \/>\n<span style=\"color: #0000ff\">http:\/\/{tenant}.someCompany.com\/test\/{{tokenId}}<\/span><\/p>\n<p>In the <strong>Token URL Method<\/strong> field, select the HTTP request method type for the <strong>Token URL<\/strong>. One of <strong>PUT<\/strong>, <strong>POST<\/strong>, <strong>PATCH<\/strong>, <strong>DELETE<\/strong>, and <strong>GET<\/strong>.<\/p>\n<p>In the <strong>Token URL Content Type<\/strong> field,\u00a0select the content type expected from the <strong>Token\u00a0URL<\/strong>. One of: <strong>JSON, RSS, XML, URL Encoded JSON, CSV, Text, Twitter Encoded JSON, Multipart\/Form-data,Multipart\/Related<\/strong>, or <strong>Oracle ADF<\/strong>.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Access_using_Connector\">Access using Connector<\/span><\/h3>\n<p>In the <strong>Access Using a Connector<\/strong> section, select <strong>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 <a href=\"\/v8-1\/docs\/bots\/admin-console\/security-control\/security-module-overview\/#Why_Use_the_Koreai_Connector_for_Bots\">Using the Kore.ai Connector<\/a>\u00a0in the Bots Admin Console documentation.<\/p>\n<p>Click <strong>Save Auth<\/strong>\u00a0to save the authorization settings and close the <strong>New Authorization Mechanism<\/strong> dialog.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/token-screen.png\"><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-14736 alignnone\" src=\"\/wp-content\/uploads\/sites\/18\/token-screen.png\" alt=\"\" width=\"428\" height=\"463\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h3><span class=\"ez-toc-section\" id=\"Testing_the_Authorization\"><span style=\"color: inherit\">Testing the Authorization\u00a0<\/span><\/span><\/h3>\n<p>After you save the authorization, you can test your authorization definition when you click <strong>Test<\/strong> from the Authorization Profile page. When you\u00a0click <strong>Test<\/strong>, the <strong>Test Authorization<\/strong> dialog is displayed and populated with the URL you specified in the\u00a0<strong>Authorization Check URL<\/strong> section.<\/p>\n<p>Click <strong>Test<\/strong> to begin the authorization test. When the validation of authorization is complete, the <strong>Test Authorization<\/strong> dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the <strong>Test Authorization<\/strong> button.<\/p>\n<p>If the authorization fails, the <em>Auth Test Failed<\/em> message is displayed along with the <strong>Headers<\/strong> and <strong>Response<\/strong> tabs as shown in the following illustration.<br \/>\n<a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogFail.png\"><img loading=\"lazy\" decoding=\"async\" class=\"size-full wp-image-8684 alignnone\" src=\"\/wp-content\/uploads\/sites\/18\/DIYTestAuthorizationDialogFail.png\" alt=\"Test Authorization Failure Dialog\" width=\"595\" height=\"473\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To define Authorization for your bot, follow these steps: Open the bot for which you want to configure an Authorization profile. Hover over the left-side navigation panel and from Settings -&gt; Config Settings select Authorization Profile Click Add.\u00a0The New Authorization Mechanism dialog opens. In the Authorization Type drop-down list, select oAuth v2 password grant type....","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\/v8-1\/wp-json\/wp\/v2\/posts\/17946","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/comments?post=17946"}],"version-history":[{"count":6,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/17946\/revisions"}],"predecessor-version":[{"id":27094,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/posts\/17946\/revisions\/27094"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/media?parent=17946"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/categories?post=17946"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-1\/wp-json\/wp\/v2\/tags?post=17946"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}