Custom API Action

Custom API Actionを使用して、Okta APIに対する認証済みのリクエストを発行します。

Okta APIの直接的な操作の詳細については、「 Okta APIリファレンス」を参照してください。

スコープ

このカードで必要なOAuthスコープのリストは「アクションカード」を参照してください。

オプション

フィールド定義タイプ必須

フィールド	定義	タイプ	必須
リクエストタイプ（Request Type）	カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです（「HTTPリクエストメソッド」を参照）。 `GET`：パラメーターに応じてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに`200 (OK)`レスポンスメッセージが返されます。 `GET(Streaming)`： `GET` HTTPメソッドおよび関連するストリーミング（Streaming）入力フィールドのパラメーターに基づいて、Webサーバーからデータをストリーミングします。指定した相対URL（Relative URL）がページ分けに対応していない場合、カードは通常の`GET`リクエストを実行し、ヘルパーフローに対して1つのレコードのみを送信します。ストリーミングされたレコード（Records Streamed）の値は（レコード制限（Record Limit）の値に関係なく）`1`に設定され、ストリーミングプロセスは終了します。ページ分けに使用する`limit`パラメーターをクエリ（Query）フィールドへの入力として指定できます。有効な範囲は`0`～`200`です。値を指定しない場合、デフォルトの制限として`200`が使用されます。ほとんどの場合は制限を手動で構成する必要はありません。ただし、エンドポイントから返される各ペイロードが1MBに近い場合、`200`未満の制限を指定すると、フローのメモリ制限を超えるのを防止する上で役立ちます。 `POST`：パラメーターに応じてWebサーバーにデータを送信します (例：ファイルのアップロード)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信しないよう、注意が必要です。リクエストが成功した場合、`200 (OK)`レスポンスメッセージが返されます。 `PUT`：パラメーターに基づいて、Webサーバーの特定の場所に格納するデータを送信します（ファイルのアップロードなど）。POSTリクエストとは異なり、PUTリクエストは冪等（べきとう）です。リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、`200 (OK)`、`201 (Created)`、または`204 (No Content)`レスポンスメッセージが返されます。 `PATCH`：パラメーターに応じてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、`200 (OK)`または`204 (No Content)`レスポンスメッセージが返されます。 `DELETE`：パラメーターに応じてWebサーバーから特定のリソース（存在する場合）を削除します。DELETEが成功した場合、`200 (OK)`レスポンスメッセージが返されます。	ドロップダウン	正

リクエストタイプ（Request Type）

カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです（「HTTPリクエストメソッド」を参照）。

GET：パラメーターに応じてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
GET(Streaming)： GET HTTPメソッドおよび関連するストリーミング（Streaming）入力フィールドのパラメーターに基づいて、Webサーバーからデータをストリーミングします。

指定した相対URL（Relative URL）がページ分けに対応していない場合、カードは通常のGETリクエストを実行し、ヘルパーフローに対して1つのレコードのみを送信します。ストリーミングされたレコード（Records Streamed）の値は（レコード制限（Record Limit）の値に関係なく）1に設定され、ストリーミングプロセスは終了します。

ページ分けに使用するlimitパラメーターをクエリ（Query）フィールドへの入力として指定できます。有効な範囲は0～200です。値を指定しない場合、デフォルトの制限として200が使用されます。ほとんどの場合は制限を手動で構成する必要はありません。ただし、エンドポイントから返される各ペイロードが1MBに近い場合、200未満の制限を指定すると、フローのメモリ制限を超えるのを防止する上で役立ちます。
POST：パラメーターに応じてWebサーバーにデータを送信します (例：ファイルのアップロード)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信しないよう、注意が必要です。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
PUT：パラメーターに基づいて、Webサーバーの特定の場所に格納するデータを送信します（ファイルのアップロードなど）。POSTリクエストとは異なり、PUTリクエストは冪等（べきとう）です。リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200 (OK)、201 (Created)、または204 (No Content)レスポンスメッセージが返されます。
PATCH：パラメーターに応じてWebサーバー上のリソースに部分的な変更を適用します。PATCHは冪等ではありません。複数のPATCHリクエストによって意図しない結果が生じる可能性があります。PATCHが成功した場合、200 (OK)または204 (No Content)レスポンスメッセージが返されます。
DELETE：パラメーターに応じてWebサーバーから特定のリソース（存在する場合）を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。

ドロップダウン

正

入力

フィールド	定義	タイプ	必須
相対URL（Relative URL）	呼び出すWebサーバーのURLアドレス。`/{insert_remaining_URL}`のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ（Query）入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりできます。相対URLは先頭に`/`文字が必要です。たとえば、Okta APIエンドポイントが `https://{yourOktaDomain}/api/v1/users`の場合、相対URLは`/api/v1/users`です。「Okta API」を参照してください。	テキスト	正
ヘッダー（Headers）	認可またはコンテンツタイプ（これらはすでにこのコネクタで処理されている）に加えて必要な任意のヘッダーを指定します。	オブジェクト	FALSE
クエリ（Query）	オブジェクト形式（キーと値のペア）で含める必要がある追加のクエリパラメーターを指定します。	オブジェクト	FALSE
本文（Body）	リクエストボディーをJSON形式で指定します。 `POST`、 `PUT`、および `PATCH` リクエストでのみ使用できます。	オブジェクト	FALSE
ストリーミング（Streaming）
フロー（Flow）	フローの選択（Choose Flow）をクリックして検索結果をストリーミングするヘルパーフローを参照および選択し、選択（Choose）をクリックして確定します。オプションとして、クリックまたはここにドロップして作成（Click or drop here to create）の下の空のフィールドをクリックし、データをヘルパーフローに渡すカスタム拡張可能フィールドを追加します。これらのフィールドは、ヘルパーフロー内の状態（State）出力オブジェクトの下にキーと値のペアとして追加されます。このフィールドは、リクエストタイプ（Request Type）オプションで`GET(Streaming)`を選択した場合に表示されます。	フロー	正
レコード制限（Record Limit）	ストリーミングするレコードの数を指定します。フィールドを`0`未満に設定すると、カードはエラーを返します。フィールドを`0`または`0`より大きい値に設定すると、ストリームは指定された最大数までを返します。フィールドを空またはnullにする、または選択しない場合、ストリームは全レコードを返します。デフォルト値は`1000000`（100万）です。有効な範囲は`0`～`1000000`です。このフィールドは、リクエストタイプ（Request Type）オプションで`GET(Streaming)`を選択した場合に表示されます。クエリ（Query）入力に設定できる`limit`パラメーターは、ページ分けリクエストのページごとに返されるレコードの数を表しますが、レコード制限（Record Limit）フィールドは、ストリーミングするレコードの総数を表します。レコード制限（Record Limit）の最大値は、limitパラメーターの値の5000倍です。デフォルトでは、`limit`は`200`、レコード制限（Record Limit）の最大値は1,000,000（200 * 5,000）に設定されます。 `limit`パラメーターを手動で設定するときは、レコード制限（Record Limit）の最大値を計算する必要があります。たとえば、`limit=1`を設定すると、レコード制限（Record Limit）フィールドに`5000`より大きい値を指定しても、取得できるレコードの最大数は5000となります。	数値	FALSE

出力

フィールド	定義	タイプ
レスポンス（Response ）
ステータスコード（Status Code）	操作の結果。コネクターは、カードによって実行されたアクションの成否を示すHTTPステータスコードを返します。例： `201 Created`ステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。 `403 Forbidden`エラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。発生する可能性があるステータスコードの完全なリストについては、HTTPステータスコードを参照してください。	数値
ヘッダー（Headers）	出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、`{"Content-type":"application/json"}`のようになります。	オブジェクト
本文（Body）	選択したHTTPリクエストから返されたデータ。たとえば、`GET`リクエストからのデータ。	オブジェクト
ストリーミングされたレコード（Records Streamed）	ストリーミングフロー内でストリーミングされたレコードの数。このフィールドは、リクエストタイプ（Request Type）オプションで`GET(Streaming)`を選択した場合に表示されます。	数値