Webhookイベントフローを構築する

Okta Workflowsを使用すると、Webhookフレームワークをサポートするイベントカードを構築できます。これはリモートシステムで発生したイベントへのほぼリアルタイムのレスポンスを提供します。Webhookイベントの構築方法は、リモートサービスAPIで提供される機能とイベントカードの目標に応じて異なります。

Webhookイベントフローを使用すると、ユーザーの作成、ファイルの削除、不審なアクティビティの報告などのイベントに基づいてトリガーされるコネクター用のカードを構築できます。

Webhookの動作方法の詳細については、「Webhookイベントカード」を参照してください。

はじめに

  • Okta Workflowsにアクセスできるスーパー管理者である必要があります。

  • コネクターをまだ作成していないときは、次の手順に従って作成します。

    • Okta Workflowsコンソール[App switcher(アプリスイッチャー)]アイコンをクリックし、次にコネクタービルダーコンソールのリンクをクリックします。

    • コネクタービルダー[追加(+)]アイコンをクリックしてコネクターを作成します。新しいコネクターに一意の名前と有用な説明を付けます。

  • コネクターに、「基本的なことからすぐに始める」セクションのタスクで基本的な基盤と認証要素があることを確認してください。

このタスクを開始する

  1. メインパネルで新しいコネクターをクリックして開きます。

  2. [Flows(フロー)]タブで、[+ New Flow(新規フロー)]をクリックしてフローを作成します。

  3. [Add event(イベントを追加)]をクリックし、[Events(イベント)]の選択肢から[Webhook Event(Webhookイベント)]を選択します。

  4. [Add Options(オプションを追加)]をクリックして、Webhookイベントカード用に宣言したいオプションを追加します。

  5. [Webhook Registration(Webhook登録)]セクションで [Configure(構成)]をクリックしてWebhook登録ダイアログを開きます。

  6. [登録]ダイアログで、[Choose Flow(フローを選択)]をクリックして、Webhookイベントの登録および登録解除ヘルパーフローを選択します。ヘルパーフローが存在しない場合は、[Create new flow(新規フローを作成)]をクリックできます。

    • 登録フロー

      ユーザーが、デプロイ済みのWebhookイベントカードを含むフローを有効にすると、登録ヘルパーフローがトリガーされます。

      登録フローでは、ユーザーのフローの一意のEvent URL(イベントURL)を外部サービスに登録し、Webhookペイロードの送信先がサービスに認識されるようにします。

      Event URL(イベントURL)は自動生成されるURLです。これはユーザーがこのWebhookイベントを含むフォローを有効にすると作成されます。

      登録ヘルパーフローを選択したら、Webhookイベントカードにあるオプションフィールドを使用して、登録ヘルパーフローに渡す入力フィールドをマッピングできます。これにより、各Webhookカードから異なるオプションを渡すことで、同じ登録ヘルパーフローを複数のWebhookイベントカードに使用できるようになります。

      登録ヘルパーフローには、[Registration Data(登録データ)]というオブジェクトフィールドがあるリターンカードが含まれています。このオブジェクトは、登録解除フローの実行時に必要になる参照を保存するために使用されます。

      Webhookイベントを登録する」を参照してください。

    • 登録解除フロー

      登録フローと同様に、ユーザーが、デプロイ済みのWebhookイベントカードを含むフローを無効にすると、登録解除ヘルパーフローがトリガーされます。

      登録フローからRegistration Data(登録データ)出力を使用して定義された情報はすべて、登録解除フローイベントカードの入力として使用できます。

      登録解除ヘルパーフローを選択したら、Webhookイベントカードにあるオプションフィールドを使用して、登録解除ヘルパーフローに渡す入力フィールドをマッピングできます。登録ヘルパーフローと同様に、これによって同じ登録解除ヘルパーフローを複数のWebhookイベントカードに使用できるようになります。

      登録解除ヘルパーフローにはリターンカードは含まれていません。

      Webhookイベントの登録を解除する」を参照してください。

    • [Apply(適用)]をクリックして、登録および登録解除ヘルパーフローとその入力マッピングを確定します。選択した登録または登録解除ヘルパーフローを削除する必要がある場合は、ごみ箱アイコンをクリックします。

    Webhookイベントカードの場合、登録または登録解除フローは60秒以内に完了する必要があります。完了しない場合、ユーザーのフローは有効になりません。

  7. [Add Outputs(出力を追加)]をクリックして、Webhookイベントフローの[Return Outputs(出力を返す)]カードを構成します。

  8. [オプション]ダイアログでは、Webhookで返したい出力を指定できます。[Add group(グループを追加)]をクリックして出力グループを作成します。

    1. Webhookペイロードがレコードのリストを返し、このWebhookイベントカードを使用するフローの実行モードを指定したい場合は、[Enable Run mode(実行モードを有効化)]をアクティブ化します。「Webhookの実行モードを有効にする」を参照してください。

    2. [Static Output Group(静的出力グループ)]ペインで、この出力セットの[Group Name(グループ名)]を指定します。出力として返したいフィールドごとに、[Label(ラベル)]を指定し、[Field Type(フィールドタイプ)][Data Type(データ型)]をドロップダウンメニューから選択します。プレビューカードにリターンカードがどのように表示されるかが示されます。

    3. [Add group(グループを追加)]をクリックして別の出力グループを追加します。

      [Enable Run mode(実行モードを有効化)]オプションがアクティブになっている場合、イベントカードは1つの出力グループしか返せません。

  9. [Apply(適用)]をクリックして、[Return Outputs(出力を返す)]カードへの変更を保存します。

  10. ツールバーの[Save(保存)]ボタンをクリックし、フローに名前を付けます。

次の手順

Webhookイベントフローの既知の問題と制限

フローのテスト

コネクターのデプロイ