認証アクションを有効にする

アプリケーションにアクセスするための認証を有効にして、Control Room がアプリケーション データにアクセスできるようにします。

アプリケーションのセッションをコネクター ビルダーで認証するには、次のオプションがあります。

  • 認証トグル スイッチ: このオプションを使用すると、認証トークンはセッション内に保持されます。Control Room はこのセッションを管理し、このセッションを利用するパッケージ内のすべてのアクションにトークンを渡します。セッション コンテキストは Control Room によって保持され、各アクションで認証ヘッダーやクエリ パラメーターを明示的に渡す必要がないため、このオプションを使用することをお勧めします。
  • 認証アクションを追加する: このオプションを使用すると、パッケージ内の他のすべてのアクションに明示的に認証トークンを渡す必要があります。使用される API 仕様に基づいて、ヘッダーにトークンを送信するか、パッケージ内の各アクションのクエリ パラメーターを送信します。「コネクター ビルダーでのアクションの追加」を参照してください。

前提条件

カスタム コネクターを作成したことを確認してください。「カスタム コネクターの作成」を参照してください。

手順

  1. [認証] トグル スイッチをオンにします。
  2. ドロップダウンから次のいずれかの認証タイプを選択します。
    認証タイプ 説明
    基本 パッケージ アクションを使用する場合、ユーザー名とパスワードを入力して、ターゲット アプリケーションを認証する必要があります。Control Room は、API リクエスト内の「Basic <base-64 encoded>」形式の認証ヘッダーで base-64 エンコードされた資格情報を自動的に送信します。
    Oauth 2.0 パッケージ アクションを使用する場合、オートメーションを使用する際に、Control Room から既存の OAuth2 接続を選択する必要があります。Control Room は、API リクエストに Control Room から取得したアクセス トークンを含めます。
    1. ヘッダーまたはクエリ パラメーターとして API プロバイダーに送信する適切な場所タイプを選択します。
    2. ヘッダー パラメーターには名前と接頭辞を、クエリ パラメーターには名前を入力します。
    API キー パッケージ アクションを使用する場合、API キーを入力して認証する必要があります。Control Room は、API リクエストにヘッダーやパラメーターと一緒に API キーを自動的に送信します。
    1. ヘッダーまたはクエリ パラメーターとして API プロバイダーに送信する適切な場所タイプを選択します。
    2. ヘッダー パラメーターには名前と接頭辞を、クエリ パラメーターには名前を入力します。
    カスタム パッケージ アクションを使用する場合、情報を入力して接続を確立する必要があります。作成するセッションの構成方法に応じて、Control Room は API リクエストにセッション情報を含めます。認証で使用する設定を構成するには、「コネクター エディターのアクションの構成」を参照してください。