カスタム認証の構築
カスタム認証では、APIリクエストに含める必要がある任意の情報をユーザーから収集できます。一般的な例としては、APIキー(api_key)の使用が挙げられます。APIキーはサードパーティシステムで管理され、その他のヘッダーオブジェクトキーや値とともにHTTPリクエストに渡されます。これは、次に説明する[Auth Fields(Authフィールド)]セクションで作成できます。
カスタム認証を追加するには:
-
[Overview(概要)]タブをクリックします。
-
[Set up authentication(認証設定)]をクリックします。
-
[Authentication(認証)]ダイアログの[Auth Type(認証タイプ)]ドロップダウンから[Custom(カスタム)]を選択します。
-
[Parameters(パラメーター)]フィールドの[Add Parameter(パラメーターの追加)]をクリックします。
-
次のフィールドに値を追加します。
-
Label(ラベル):コネクターのセットアップ時に[New Connection(新規接続)]ダイアログに表示される表示名。
-
Key(キー):サービスが使用する鍵/値ペアのテキスト値。たとえば、
api_key
、application_key
、authentication
。 -
Type(タイプ):フィールドには3つのタイプがあります。
-
Text(テキスト):ユーザーにはプレーンテキストフィールドが表示されます。これは、加工なしのオープンテキストフィールドです。
-
Password(パスワード):加工されたテキストフィールド。ユーザーには、このフィールドの入力内容は表示されません。
-
Dropdown List(ドロップダウンリスト):手動で作成した、ユーザーが選択する値のドロップダウン。
-
-
フィールド | 定義 |
---|---|
Parameters(パラメーター)(オプション) |
パラメーターを使用することで、インスタンスやサブドメインなど、認証に必要な追加情報をコネクターユーザーから収集できます。これらのフィールドは、ユーザーが最初に接続を作成する際に表示され、必須となります。
Label(ラベル):コネクターのセットアップ時に[New Connection(新規接続)]ダイアログに表示される表示名。 Key(キー):サービスが使用する鍵/値ペアのテキスト値。たとえば、api_key、application_key、authentication。 Type(タイプ):フィールドには3つのタイプがあります。
|
Config Values(構成値)(オプション) |
コネクターに対してユーザーを認証する方法を定義するために、追加の設定値が必要になる場合があります。このような値は、このセクションで追加できます。 Label(ラベル):コネクターのセットアップ時に[New Connection(新規接続)]ダイアログに表示される構成値の表示名。 Definition(定義):このフィールドに静的な値が入力されるか、ヘルパーフローからの値が入力されるかを示します。
Type(タイプ):フィールドには2つのタイプがあります。
[Visible(表示)]トグルは、コネクターの認証ダイアログに構成値を表示するかどうかを決定します。 |