{"id":17945,"date":"2016-12-05T21:42:16","date_gmt":"2016-12-05T21:42:16","guid":{"rendered":"https:\/\/developer.kore.com\/?post_type=docs&p=9108"},"modified":"2021-03-18T10:12:28","modified_gmt":"2021-03-18T10:12:28","slug":"setting-up-authorization-using-basic-auth","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-1\/docs\/bots\/advanced-topics\/authorization\/setting-up-authorization-using-basic-auth\/","title":{"rendered":"Setting Up Authorization using Basic Auth"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To define Basic Authorization for your bot, follow these steps:<\/p>\n

    \n
  1. Open the bot for which you want to configure a Basic Authorization profile.<\/li>\n
  2. Hover over the left-side navigation panel and from Settings -> Config Settings<\/strong> select Authorization Profile<\/strong>
    \n\"\"<\/a><\/li>\n
  3. Click Add<\/strong>.\u00a0The New Authorization Mechanism<\/strong> dialog opens.<\/li>\n
  4. In the Authorization Type<\/strong> drop-down list, select\u00a0Basic Auth<\/strong>.<\/li>\n
  5. In the Name<\/strong> field, enter the name for your Basic Auth<\/strong> type.
    \n    \"\"<\/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

    Defining Tenancy<\/span><\/h3>\n

    If\u00a0required, in the\u00a0Subdomain<\/strong>\u00a0section, select Yes<\/strong>\u00a0if 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><\/p>\n

    In 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

    Adding Form Fields\u00a0<\/span><\/span><\/h3>\n

    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, in addition to the Username<\/strong> and Password<\/strong> form fields.
    \n    <\/a>
    \n    \"\"<\/a>
    \nThe following table describes the fields used to define an authorization IDP form field.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
    FIELD NAME<\/th>\nDESCRIPTION<\/th>\n<\/tr>\n<\/thead>\n
    Field Title<\/td>\nSpecify the name of the field displayed to the end-user in the authorization dialog.<\/td>\n<\/tr>\n
    Field Key<\/td>\nThe value that represents the end-user input value to the authorizing service.<\/td>\n<\/tr>\n
    Help Hint<\/td>\nThe help text displayed in the field to describe what should be entered into the field.<\/td>\n<\/tr>\n
    Field Type<\/td>\nWhen 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 Field Key<\/strong>, one of:<\/p>\n
      \n
    • Textbox<\/strong><\/li>\n
    • Password<\/strong><\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    Mandatory<\/td>\nWhen Advanced Options<\/strong> is selected, select if the end-user must define this field to complete the authorization.<\/td>\n<\/tr>\n
    Data Type<\/td>\nWhen Advanced Options<\/strong> is selected, specify the type of data expected as input from the end-user, for example, String<\/strong>.<\/td>\n<\/tr>\n
    Visibility<\/td>\nWhen 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><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

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

    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 Add<\/strong>\u00a0in the Authorization Fields<\/strong> section and then define the required fields.<\/p>\n

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

      \n
    1. In the 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