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サーバーからデータをストリーミングします。指定した［Relative URL（相対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)レスポンスメッセージが返されます。	ドロップダウン	TRUE

フィールド

定義

タイプ

必須

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

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

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

指定した［Relative URL（相対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)レスポンスメッセージが返されます。

ドロップダウン

TRUE

入力

フィールド	定義	タイプ	必須
Relative URL（相対URL）	呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。相対URLは先頭に「/」文字が必要です。たとえば、Okta APIエンドポイントが https://{yourOktaDomain}/api/v1/usersの場合、相対URLは/api/v1/usersです。「Okta API」を参照してください。	テキスト	TRUE
Headers（ヘッダー）	認可またはコンテンツタイプ (これらはすでにこのコネクタで処理されている) に加えて必要な任意のヘッダーを指定します。	オブジェクト	FALSE
Query (クエリー)	オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリーパラメーターを指定します。	オブジェクト	FALSE
Body（本文）	リクエストボディーをJSON形式で指定します。 POST・PUT・PATCHリクエストでのみ使用できます。	オブジェクト	FALSE
ストリーミング
Flow（フロー）	［Choose Flow（フローの選択）］をクリックして検索結果をストリーミングするヘルパーフローを参照および選択し、［Choose（選択）］をクリックして確定します。オプションとして、［Click or drop here to create（クリックまたはここにドロップして作成）］の下の空のフィールドをクリックし、データをヘルパーフローに渡すカスタム拡張可能フィールドを追加します。これらのフィールドは、ヘルパーフロー内の［State（状態）］出力オブジェクトの下にキー/値のペアとして追加されます。このフィールドは、［Request Type（リクエストタイプ）］オプションでGET(Streaming)を選択した場合に表示されます。	フロー	TRUE
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)を選択した場合に表示されます。	数値

Custom API Action

スコープ

オプション

入力

出力

関連項目