APIエンドポイントを使ったフローの呼び出し
APIエンドポイントは、外部ソースの変化によってトリガーされるフローのタイプです。
接続アプリに関連付けられるイベントによって開始されるフローとは異なり、これらのフローはいつでもトリガーできます。外部クライアントがエンドポイントを呼び出すと、フローが実行され、クライアントはそのフロー実行からの出力を受信します。
唯一の要件は、外部のクライアントが有効なセキュリティ資格情報を使って指定のエンドポイントを呼び出すことです。Okta WorkflowsのAPIエンドポイントを保護するには、次の3つの方法があります。
- OAuth 2.0で保護する
-
APIエンドポイントフローは、スコープ設定されたアクセストークンの認可にOAuth 2.0を使用することによって保護されます。管理者は、APIを呼び出す必要があるすべてのアプリ統合に適切なスコープを追加します。この機能では、プライベートJSONウェブトークン（JWT）を使用することによってOAuthクライアント資格情報付与タイプをサポートします。フローは、Okta認証サーバーがアクセストークンを受信して承認した後にトリガーされます。
この方式では、カスタム認証サーバーはサポートされません。
「OAuth 2.0でAPIエンドポイントを使ったフローの呼び出し」を参照してください。
- クライアントトークンで保護する
-
APIエンドポイントフローはWebhookとして登録され、固有のクライアントトークンによって保護されます。APIエンドポイントフローには、リクエスト元のサービスが呼び出しURLを介して適切なクライアントトークンを渡した場合にのみアクセスできます。呼び出しURLはフローエイリアスを使用して構築します。
「クライアントトークンでAPIエンドポイントを使ったフローの呼び出し」を参照してください。
- なし（パブリックサービス）
-
APIエンドポイントフローは、誰でも呼び出しURLを使用してパブリックに利用できます。呼び出しURLはフローエイリアスを使用して構築します。
「APIをパブリックサービスとして使ったフローの呼び出し」を参照してください。
フローを呼び出すと、フロー出力がレスポンスオブジェクトとして送信されます。
関連項目
関数：APIエンドポイント