イベントフックを作成する

外部サービス(コード)を作成したら、その外部サービスをOktaに接続し、特定のプロセスフローに対して有効にする必要があります。

イベントフックを表示・構成できるのはスーパー管理者のみです。orgごとに最大で10個のイベントフックが許可されます。

早期アクセス機能の「Event Hooks Filters(イベントフックフィルター)」を有効にしている場合は、イベントの作成手順が異なります。次の手順をスキップして、次のセクション「フィルターを使用してイベントフックを作成する」に進みます。

  1. Admin Consoleで、[Workflow(ワークフロー)][Event Hooks(イベントフック)]に移動します。

  2. [Create Event Hook(イベントフックを作成)]をクリックします。
  3. 次の属性を定義します。

    • [Name(名前)]:イベントフックを説明する名前を入力します。
    • [URL]:イベントフックがリクエストを送信する外部サービスのエンドポイントURLを入力します。
    • 任意。セキュリティを強化し、Oktaと外部サービス間の通信チャネルを保護するため、次のフィールドに認証を追加します。

      • [Authentication field(認証フィールド)]:認可ヘッダーの名前を入力します。
      • [Authentication secret(認証シークレット)]:フィールド名に対応する値を入力します。
    • 任意。認証のセキュリティを強化するために独自のカスタムヘッダーを作成するには、[Custom headers(カスタムヘッダー)]領域にある[Add Field(フィールドを追加)]をクリックして以下のフィールドに入力します。

      • [CField Name(フィールド名)]:リクエストとともに送信するオプションのフィールド名/値のペア
      • [Value(値)]:フィールド名の値を入力します。

    • [Subscribe to events(イベントをサブスクライブ)]:テキストボックス内をクリックしてイベントのリストを表示し、追加するイベントを選択します。
  4. [Save & Continue(保存して続行)]をクリックします。
  5. [Verify Endpoint Ownership(エンドポイントの所有権の確認)]ウィンドウで、[Verify(確認)]をクリックします。必要な場合は、後でフックを確認できます。

  6. Oktaがエンドポイントを正常に確認すると、[Event Hooks(イベントフック)]ページに[Active(アクティブ)]と表示されます。

フィルターを使用してイベントフックを作成する

早期アクセスリリース。「早期アクセス機能とBeta機能を管理する」を参照してください。

特定のイベントタイプに対してイベントフックが呼び出されるタイミングを絞り込むときは、イベントフックにフィルターを使用します。

フックの詳細を追加

  1. Admin Consoleで、[Workflow(ワークフロー)][Event Hooks(イベントフック)]に移動します。

  2. [Create Event Hook(イベントフックを作成)]をクリックします。
  3. 以下のフィールドに入力します。

    • [Endpoint URL(エンドポイントのURL)]:イベントフックがリクエストを送信する外部サービスのエンドポイントURLを入力します。
    • [Event Hook name(イベントフック名)]:イベントフックの一意の名前を入力します。
    • [Description(説明)]:任意。イベントフックの目的と説明を入力します。

  4. 任意。セキュリティを強化し、Oktaと外部サービス間の通信チャネルを保護するため、[ Enhance security(セキュリティを強化)]の下に認証を追加します。

    • [Authentication field(認証フィールド)]:認可ヘッダーの名前を入力します。

    • [Authentication secret(認証シークレット)]:フィールド名に対応する値を入力します。
  5. 任意。認証のセキュリティを強化するために独自のカスタムヘッダーを作成するには、[Custom headers(カスタムヘッダー)]の下にある[Add Field(フィールドを追加)]をクリックして以下のフィールドに入力します。

    • [Field Name(フィールド名)]:カスタムヘッダーの名前を入力します。

    • [Value(値)]:フィールド名の値を入力します。

  6. [Select Events(イベントを選択)]の下にあるテキストボックス内をクリックし、追加するイベントを選択します。

  7. [Create hook & Continue(フックを作成して続行)]をクリックして、未検証のイベントフックを保存します。

イベントにフィルターを適用(オプション)

  1. イベントのセットごとに、受信するイベントの数をフィルタリングするには、[Apply filter(フィルターを適用)]を選択します。

  2. フィールドのドロップダウンメニューを使用してフィルターを作成するか、[Use Okta Expression(Okta Expressionを使用)]をクリックしてカスタムフィルターを入力します。「Okta Expression Languageとイベントフック」を参照してください。

  3. [Save & Continue(保存して続行)]をクリックします。

プレビュー(オプション)

Event Hook Preview関数は、すべてのイベントフックフィルターをバイパスします。

  1. [Configure Event Hook request(イベントフックのリクエストを構成)]セクションで、イベントフックの名前とURLが正しいことを確認します。

  2. ドロップダウンメニューからイベントタイプを選択します。

  3. イベントタイプに[System Log Event(システムログイベント)]を選択します。利用可能なイベントがない場合は、プレビューではサンプルJSONが使用されます。

  4. 任意。[JSON]セクションで[Edit(編集)]をクリックしてコードを変更し、[Save(保存)]をクリックします。

    あるイベントタイプに対してイベントが生成されない場合は、Event Hook Previewにはサンプル・データを含むサンプル・イベントが表示されます。未確定のフィールドはnullに設定され、テスト用にカスタム値に置き換えることができます。

  5. イベントフックのリクエストのJSONペイロードをテストするには、[Deliver Request(リクエストを配信)]をクリックします。イベントフックのリクエストのステータスを示すメッセージが表示されます。

  6. [Next(次へ)]をクリックします。

フックをアクティブ化

エンドポイントにイベントリクエストを送信する前に、Oktaはエンドポイントに1回限りのGET検証リクエストを行う必要があります。Oktaは、エンドポイントを制御していることを確認するために、返送する必要がある検証値をサービスに渡します。エンドポイント確認の仕組みを理解するには、「1回限りの確認リクエスト」および「エンドポイントを検証する」を参照してください。

Workflows APIのURLは、確認する必要はありません。

外部サービスコードでイベントフックを確認する準備ができている場合は、[Verify(確認)]をクリックします。 または、[Do it later(後で実行)]をクリックします。

Oktaがエンドポイントを正常に確認すると、[Event Hooks(イベントフック)]ページに[Active(アクティブ)]と表示されます。

イベントフックの作成または更新後、イベントがイベントフックに送信されるまでに数分かかる場合があります。

関連項目

イベントフックを確認する

イベントフックのプレビュー