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

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

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

早期アクセス機能のイベントフックフィルター（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）をクリックします。必要な場合は、後でフックを確認できます。

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

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

早期アクセスリリース。セルフサービス機能を有効にするを参照してください。

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

フックの詳細を追加

  1. Admin Consoleで、ワークフロー（Workflow） > イベントフック（Event Hooks）に移動します。

  2. イベントフックを作成（Create Event Hook）をクリックします。

  3. 以下のフィールドに入力します。

    • エンドポイントのURL（Endpoint 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. フィールドのドロップダウンメニューを使用してフィルターを作成するか、Okta Expressionを使用（Use Okta Expression）をクリックしてカスタムフィルターを入力します。「Okta Expression Languageとイベントフック」を参照してください。

  3. 保存して続行（Save & Continue）をクリックします。

プレビュー（任意）

  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回限りの確認リクエスト」および「エンドポイントを検証する」を参照してください。

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

Oktaがエンドポイントを正しく確認すると、イベントフック（Event Hooks）ページに［Active（アクティブ）］と表示されます。

関連項目

エンドポイントを確認する

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