OAuth v2は新規のWeb、モバイル、デスクトップアプリケーションから簡単に標準的な方法で安全認証を可能にするオープンプロトコルです。oAuth v2の使用で認証メカニズムの設定を設定するためには、そのアプリケーションのログイン認証クレデンシャルが必要になるため、まずはウェブアプリケーションにアカウントをログインする必要があります。

oAuth v2の仕組み

1. Kore.ai アプリケーションはユーザーをウェブアプリケーションのロクインダイアログへ導き直します。
2. ユーザーは認証します。
3. ウェブアプリケーションはアクセストークンでユーザーをKore.ai アプリケーションへ導き直します。
4. Kore.ai アプリケーションはアクセストークンを検証します。
5. アクセストークンはKore.aiアプリケーションをユーザーの身分として、提供元の保護済のリソースへアクセスことを可能にします。

oAuth v2の定義

ボットに認証を定義するには、以下の手順に従います。

1. 認証プロファイルを設定するボットを開きます。
2. 左側のナビゲーションパネルにカーソルを合わせ、設定 > 設定するから認証プロファイルを選択します。
3. 追加をクリックします。新しい認証メカニズムダイアログが開きます。
4. 認証タイプドロップダウンリストでauth v2を選択します。
5. 名前フィールドに認証の名前を入力します。

以下の図は、ボットの基本認証を有効にするために定義する必要がある、oAuth v2フィールドの例です。
oAuth v2の調整は、下記のテーブルの説明の通りにフィルドを定義してください。

テナントを定義する

テナントを定義するWeb アプリケーションやユーザー インターフェイスがベース URL にテナント名を使用する場合は、必要に応じて [サブドメイン] セクションで [はい] を選択します。例えば、koreは、www.kore.someCompany.comとしてテナントを使用したウェブサービスのテナント組織です。下記の設定の例では、テンナンシーURLは{tenant}組織のプレースホルダが含まれます。

フィールドの追加

追加をクリックして追加のフィールドダイアログを開き、追加の認証入力フィールドを表す1つ以上のキー/値の組み合わせを入力します。デフォルトのユーザー名とパスワードのフィールドが承認入力のニーズを満たしていない場合は、 追加フィールド を追加することで、エンドユーザーに表示されるキーと値のペアとしてカスタムフィールドを追加できます。これらのフィールドは、たとえば、ユーザー名フィールドとパスワードフィールドに加えて、認証プロセスでPINコードが必要な場合に使用することができます。下図のように、追加のフィールドが追加されます。 以下のフィルドを指定 してください：

• フィールド キー – 認証に指定するカスタム フィールド名です。
• 値 – カスタム フィールドの認証に指定する値です。

追加をクリックして追加のフィールドを保存します。追加のフィールドを追加する場合、認証フィールドセクションの追加をクリックしてください。

認証フィールドの追加

デフォルトでは、ボットリクエストメッセージのヘッダーの一部として、認証フィールドは設定されていません。ボットリクエストに認証フィールドが必要、または想定される認証がヘッダーの一部ではない場合（例：ソーシャルセキュリティ番号やPINなど）、認証フィールドの追加をクリックして下図の通りにフィールドを定義します。

1. フィールドタイプフィルドに、以下のうちの一つを選択することができます： 必須のボットリクエストメッセージの位置および認証フィルドのタイプの次第です。
   • ヘッダー – ボットは認証フィールドをリクエストのヘッダーの一部として求めます。
   • ペイロード – ボットは認証フィールドをリクエスト本体のコンテンツの一部として求めます。
   • クエリー文字列―ボットは認証フィールドをリクエストのボディにあるクエリー として予想します。
   • パースパラメータ（PathParam）―認証フィールドをURLパースリクエストの一部として予想されるボット。
2. フィールドキーフィールドに、選択済のフィールドタイプフィールド名を入力してください。
3. フィールド値フィールドに、フィールドキーの指定された値を入力してください。
4. 追加をクリックします。新規の認証フィールドは認証フィールドのセクションに追加されました。

認証フィールドを追加する場合、認証フィールドセクションの追加をクリックしてください。

認証テスト

認証を保存した後、タスクの残りのステップの開発を続ける前に、認証ページでテストをクリックして、認証定義をテストすることができます。テストをクリックすると、認証トークンのURLとクライアントIDおよびクライアントシックレットキーを使用してテストが実行されます。テンナンシーが定義済みの場合、テスト認証ダイアログが表示されます。テストをクリックすると認証テストを開始します。認証の検証が完了すると、次の図のようにテスト認証のダイアログが閉じられ、成功または失敗の検証結果がテスト認証ボタンの右横に表示されます。認証失敗の場合、下記の図の通りに、認証テスト失敗のメッセージはヘッダーおよび応答のタブとともに表示します。

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 sign in credentials for that application to configure the settings for the Authorization Mechanism.

How oAuth v2 Works

1. The Kore.ai application redirects the user to a login dialog at the web application.
2. The user authenticates.
3. The web application redirects the user back to the Kore.ai application with an access token.
4. The Kore.ai application validates the access token.
5. The access token allows the Kore.ai application to access a protected resource at the provider, on behalf of the user.

Defining oAuth v2

To define Authorization for your bot, follow these steps:

1. Open the bot for which you want to configure an Authorization profile.
2. Select the Build tab from the top menu.
3. From the left menus, click Configurations -> Authorization Profile
   
4. Click Add. The New Authorization Mechanism dialog opens.
5. In the Authorization Type drop-down list, select auth v2.
6. In the Name field, enter the name for your authorization.

The following illustration is an example of the oAuth v2 fields that you must define to enable basic authorization for your Bot.

To configure oAuth v2, define the fields described in the following table.

Defining Tenancy

If required, in the Subdomain section, select Yes if the base URL for a web application or user interface that uses a tenant name in the URL. For example, kore is the tenant organization for a web service using tenants at www.kore.someCompany.com.

In the following example configuration, the tenancy URL contains the {tenant} organization placeholder.

Adding Additional Fields

Click Add to open the Additional Fields dialog and then enter one or more key/value pairs that represent additional authorization input fields.

If the default username and password fields do not meet your needs for authorization input, you can add custom fields as key/value pairs that are displayed to the end-user by adding Additional Fields. You can use these fields, for example, if a PIN code is required in the authorization process, in addition to the Username and Password fields.

Additional Fields are added as shown in the following illustration.

Specify the following fields:

• Field Key – The name of the custom field to specify for authorization.
• Value – The value of the custom field to specify for the authorization.

Click Add to save the Additional Field.
To add more Additional Fields, click Add in the Additional Fields section.

Adding Authorization Fields

By default, no authorization fields are configured as part of the header of the Bot request message. If your Bot request requires authorization fields or the expected authorization is not part of the header, for example, social security number or PIN, click Add in the Authorization Fields section and then define the fields as shown in the following illustration.

1. In the Field Type field, you can select one of the following depending on where in the Bot request message and the type of authorization fields that are required.
   • Header – The Bot expects the authorization fields as part of the header of the request.
   • Payload – The Bot expects the authorization fields as part of the content of the body of the request.
   • Query String – The Bot expects the authorization fields as a query in the body of the request.
   • Path Param – The Bot expects the authorization fields as part of the URL path for the request.
2. In the Field Key field, enter the name of the field for the selected Field Type.
3. In the Field Value field, enter the value for the Field Key specified.
4. Click Add. The new authorization field is added in the Authorization Fields section.

To add additional authorization fields, click Add in the Authorization Fields section.

Testing the Authorization

After you save the authentication, you can test your authorization definition on the Authentication page when you click Test before continuing to develop the remain steps of your task. When you click Test, the test is executed using the authentication token URLs and the Client ID and Client Secret Key. If tenancy was defined, the Test Authorization dialog is displayed.

Click Test to begin the authorization test. When the validation of authentication is complete, the Test Authorization dialog is closed and the results of the validation, either success or failure, is displayed to the immediate right of the Test Authorization button. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs as shown in the following illustration.