認証を構成する

コネクタ作成の要の 1 つは、認証設定を識別して正しく連携することです。連携が正しく行われていれば、コネクタが Integration Service カタログにパブリッシュされると、ユーザーはカタログ内の他のコネクタと同様に、コネクタへのコネクションを作成できます。

すべてのコネクタで認証フレームワークが再利用されるため、認証フロー全体とコネクションの管理を統一された方法で管理できます。

認証を行うと最終的に、このコネクタ内の後続の要求では、すべての API 呼び出しに対して認証プロセスの結果が使用されることになります。たとえば、ベアラートークンはすべての API 呼び出しのヘッダーで送信されます。

コネクタビルダーは、長いコーディングではなく、簡単な構成によって次の業界標準をサポートします。

OAuth 2.0 の認可コード
PKCE を使用した OAuth 2.0 認可コード
OAuth 2.0 クライアント資格情報
ベーシック
API キー
個人用アクセストークン (PAT)
カスタム
認証なし

コネクタビルダーは Integration Service フレームワークに結び付けられているため、認証設定の定義に複雑なプロセスは必要なくなり、設定を行うだけでよくなりました。これは、フレームワークがトークンの交換、更新、およびその他の類似のタスクを処理することを意味します。コネクタビルダーでは、OAuth 2.0 認可コードが既定で使用されます。これは、ベンダーを使用した認証を処理する上で最も一般的な手法だからです。

認証ページは、次の 3 つの要素から構成されています。

認証の種類は、認証フレームワークがどのように反映されるかを制御し、PKCE や完全なトークン交換 (OAuth の場合) などの追加の検証を含みます。さらに、必要なプロパティの概要が示されるように、下にプロパティを含んだ表を再構成います。
プロパティ表は、カスタムパラメーターで変更および/または既存のパラメーターを編集したりできます。ドロップダウンメニューで選択した認証の種類によっては、一部のフィールドは必須で、赤で指定されている場合があります。
注: この表でこれらのプロパティを変更するか、認証の種類全般に変更を加えると、コネクタビルダーで作成済みのコネクションが無効になります。設計時に使用できるコネクションは 1 つのみで、これは最新の認証設定に対して設定・テストする必要があります。
指定した設定に基づいて自動的に生成される認証設定画面です。コネクタビルダーでの構成中に表示される内容は、アクティビティパッケージのユーザーに表示される最終結果と同じです。

認証の表の構成

認証の種類を無視して、読み込まれたプロパティテーブルでは、次の 2 つの項目が識別されます。

認証画面内でユーザーに表示される内容。
認証フレームワークによって認証が処理される方法。

表内のすべての項目は、ユーザーが上書きできるプロパティと上書きできないプロパティを表します。特定のフィールドを画面に表示するには、[ユーザーに確認] 列で [はい] のフラグを付ける必要があります。
すべての項目には [名前] と [表示名] があります。[名前] はベンダーが技術的な設定での使用を期待するものであり、後者は認証画面でユーザーに入力を求める際に重要です。
すべての項目には、プロパティをより詳細に編集できるアクションメニューがあります。ここで、特定のプロパティをヘッダーとして送信する必要があることを指定できます。他の例については「API キー」セクションをご覧ください。

認証の種類

[認証] タブで、コネクタの認証の種類を設定します。サポートされるオプションは次のとおりです。

OAuth 2.0 の認可コード
PKCE を使用した OAuth 2.0 認可コード
OAuth 2.0 クライアント資格情報
ベーシック
API キー
個人用アクセストークン (PAT)
カスタム
認証なし

注: 認証を設定する際は、作成したコネクタを使用する人がどのように認証するかを設定します。コネクタを使用する人とは、コネクタを構築中の自分自身を指しますが、同時に、作成したコネクタを使用する他のユーザーも含みます。

基本認証

[アクション] 列の下の [編集] ボタンを選択して、各プロパティを設定します。既定では、[ユーザー名] と [パスワード] が表示されています。
認証時に使用するフィールドを追加する場合は、[パラメーターを追加] を選択します。
- 表示名 - 接続時にユーザーに表示されます。
- 型 – コネクションダイアログの入力フィールドを定義します。ドロップダウンからオプション (true/false、パスワード、テスト、はい/いいえ) を選択します。
- ユーザーに確認 – ユーザー入力が必要な場合は、[はい] に設定します。
- 値 – 既定値を設定するには、このフィールドを使用します。
- ヒントテキスト – 入力フィールドのユーザーガイダンスです。
- プロバイダー名 - API 呼び出しの技術キーです。
- プロバイダーに次の種類として送信 – API が値をどのように受け取るか指定します。ドロップダウンからオプション (設定、ヘッダー、パス、本文、クエリ、フォーム) を選択します。既定値は header です。
[保存] を選択して、新しい認証パラメーターを保存します。
認証を基本認証の元の値にリセットする場合は、[既定値にリセット] オプションを使用します。この操作は取り消せません。