APIエンドポイント

APIエンドポイント(API Endpoint)カードを使用すると、URLを介して呼び出せるフローを作成できます。

このカードでは、GETPOSTのリクエストメソッドのみがサポートされます。HEADなどの他のリクエストメソッドはサポートされません。

フローにはエンドポイントセキュリティ設定を1つだけ含められます。一時停止(Pause)および生データの一時停止(Pause Raw)カードはAPIエンドポイント内で使用できません。フローエンドポイントセキュリティ制限をご覧ください。

入力

このカードには入力フィールドがありません。

出力

ユーザーは、次の3つのカテゴリを使用してAPIエンドポイントの出力フィールドを作成します。

フィールド 定義 タイプ

raw

headers

HTTPリクエストのヘッダーに含まれている値にアクセスするための、明示的に名前付けされた出力フィールド(content-typeなど)を作成します。

オブジェクト

本文

HTTPリクエストの本文に含まれている値にアクセスするための、明示的に名前付けされた出力フィールドを作成します。

これは一般に、POST HTTPリクエストを使用してフローをアクティブ化するときに使用されます。

テキスト
クエリ(query)

HTTPリクエストのクエリパラメーターの後のURL文字列内で送信されるパラメーターにアクセスするための、明示的に名前付けされた出力フィールドを作成します。

たとえば、呼び出しURLがhttps://example.com/example?name=johnの場合は、nameというフィールドを追加して、このフィールドに含まれているjohnという値にアクセスできます。

APIエンドポイント(API Endpoint)を呼び出すときには、x-okta-workflowsプレフィックスを含むパラメーターを使用してデータを残りのフローに渡さないでください。このプレフィックスは使用できません。

テキスト

APIエンドポイントを使ったフローの呼び出し