APIエンドポイント

APIエンドポイントは、URLでアクティブ化されるフローを作成するために使用します。

GETとPOSTのリクエストメソッドのみがサポートされています。HEADなどの他のリクエストメソッドは、この関数カードでサポートされません。

入力

入力フィールドはありません。

出力

APIエンドポイントカードの出力フィールドは、ユーザーにより作成されます。API Endpointカードと関連付けられている出力フィールドは、3つのカテゴリーに分けられます。

  • body

    • このヘッダーの下に出力フィールドを作成すると、HTTPリクエストの本文に含まれている値にアクセスできます。これは一般に、POST HTTPリクエストからフローをアクティブ化するときに使用されます。
  • headers

    • 明示的に名前付けされた出力フィールド(「content-type」など)を作成し、HTTPリクエストのヘッダーに含まれている値にアクセスできます。重要:ヘッダーでは通常、大文字と小文字が区別されないため、キャプチャするヘッダーキーはすべて小文字で入力する必要があります。
  • query

    • URL文字列で送信されるパラメーター、たとえばhttp://example.com/example?name=johなどはすべて、クエリーのパラメーターと同じ名前のフィールドを作成することでアクセス可能です。この例では、「name」というフィールドを作成して、このフィールドに含まれている値にアクセスできます。
    • APIエンドポイントを使用する場合、x-okta-workflowsで始まるパラメーターを使用してデータを残りのフローに渡さないでください。このプレフィックスは使用できない場合があります。

関連項目

Workflowsの関数

Workflows要素