カスタム認証の構築

カスタム認証では、APIリクエストに含める必要がある任意の情報をユーザーから収集できます。

一般的な例としては、サードパーティシステムで管理されるAPIキー(api_key)の使用が挙げられます。これは、その他のヘッダーオブジェクトのキー/値と共にHTTPリクエストに渡されます。これらのキー/値のペアは、オプションのパラメーターフィールドセクションを使って作成できます。

カスタム認証を追加する手順は次のとおりです。

  1. [Overview(概要)]タブをクリックします。

  2. [Set up authentication(認証設定)]をクリックします。

  3. [認証]ダイアログで[Auth Type(認証タイプ)]ドロップダウンリストから[Custom(カスタム)]を選択します。

  4. カスタム認証に必要な任意のフィールドを追加します。

フィールド 定義
Parameters(パラメーター)(オプション) パラメーターを使用することで、インスタンスやサブドメインなど、認証に必要な追加情報をコネクターユーザーから収集できます。これらのフィールドは、ユーザーが接続を最初に作成する際に表示され、必須です。

Label(ラベル):コネクターのセットアップ時に[New Connection(新規接続)]ダイアログに表示されるパラメーターの名前。

Key(キー):サービスで使用されるキー/値ペアのテキスト値。たとえば、api_keyapplication_keyauthentication

Type(タイプ):3つのフィールドタイプから選択できます。

  • Text(テキスト):ユーザーにプレーンテキストを表示します。これは、加工なしのオープンテキストフィールドです。

  • Password(パスワード):加工されたテキストフィールドを表示します。このフィールドに入力されたテキストの内容はユーザーにはわかりません。

  • Dropdown List(ドロップダウンリスト):手動で作成された、ユーザーが値を選択するためのドロップダウンリスト。

Config Values(構成値)(オプション) コネクターに対してユーザーを認証する方法を定義するために、その他の設定値が必要になる場合があります。[Add Config Value(構成値を追加)]をクリックします。

Label(ラベル):コネクターのセットアップ時に[New Connection(新規接続)]ダイアログに表示される構成値の名前。

Definition(定義):このフィールドに静的な値が入力されるか、ヘルパーフローからの値が入力されるかを示します。

  • Static Value(静的な値)であれば、[Value(値)]フィールドに値を入力します。

  • Value from Helper Flow(ヘルパーフローからの値)であれば、[Choose Flow(フローの選択)]ダイアログでフローを選択します。

Type(タイプ):2つのフィールドタイプから選択できます。

  • Text(テキスト):ユーザーにプレーンテキストを表示します。これは、加工なしのオープンテキストフィールドです。

  • Password(パスワード):加工されたテキストフィールドを表示します。このフィールドに入力されたテキストの内容はユーザーにはわかりません。

[Visible(可視性)]トグルは、コネクターの認証ダイアログに構成値を表示するかどうかを決定します。

次の手順

この認証方式を作成したら、認証方式を通じて呼び出しを管理するhttpHelperフローを作成する必要があります。「httpHelperフローの構築」を参照してください。

コネクターカードへのオプションフィールドの追加