カスタム認証を構築する
カスタム認証では、APIリクエストに含める必要がある任意の情報をユーザーから収集できます。
一般的な例としては、サードパーティシステムで管理されるAPIキー(api_key)の使用が挙げられます。これは、その他のヘッダーオブジェクトのキー/値と共にHTTPリクエストに渡されます。これらのキー/値のペアは、オプションのパラメーターフィールドセクションを使って作成できます。
カスタム認証を追加する手順は次のとおりです。
-
概要(Overview)タブをクリックします。
-
認証方法が存在しない場合は、認証設定(Set up authentication)をクリックします。存在する場合は、認証を追加(Add Authentication)をクリックします。
-
認証(Authentication)ダイアログで、ディスプレイ名を入力し、認証タイプ(Auth Type)ドロップダウンリストから
Customを選択します。 -
カスタム認証に必要な任意のフィールドを追加します。
| フィールド | 定義 |
|---|---|
| パラメーター(任意)(Parameters (Optional)) |
パラメーターを使用することで、インスタンスやサブドメインなど、認証に必要な追加情報をコネクターユーザーから収集できます。これらのフィールドは、ユーザーが接続を最初に作成する際に表示され、必須です。 ラベル(Label):コネクターのセットアップ時に新規接続(New Connection)ダイアログに表示されるパラメーターの名前。 キー(Key):サービスで使用されるキー/値ペアのテキスト値。たとえば タイプ(Type):3つのフィールドタイプから選択できます。
|
| 構成値(任意)(Config Values (Optional)) |
コネクターに対してユーザーを認証する方法を定義するために、その他の構成値が必要になる場合があります。構成値を追加(Add Config Value)をクリックします。 ラベル(Label):コネクターのセットアップ時に新規接続(New Connection)ダイアログに表示される構成値の名前。 定義(Definition):このフィールドに静的な値が入力されるか、ヘルパーフローからの値が入力されるかを示します。
タイプ(Type):2つのフィールドタイプから選択できます。
可視性(Visible)トグルは、コネクターの認証ダイアログに構成値を表示するかどうかを決定します。 |
次の手順
この認証方式を作成したら、認証方式を通じて呼び出しを管理するhttpHelperフローを作成する必要があります。httpHelperフローを構築するを参照してください。