Custom API Action

Okta Privileged Access APIに対してカスタムの認証済みHTTP呼び出しを行います。

Custom API Actionカードを使用することで、Okta Privileged Access APIに対する任意のAPI呼び出しを行えます。このカードの主な目的は、自分のユースケースがその他のアクションカードでサポートされない場合にフロー操作を構築することです。

Custom API Actionカードは、提供される資格情報を使ってOkta Privileged Access APIへのURLを自動的に作成して送信します。相対URL（Relative URL）フィールドには、リクエストの送信先エンドポイントへのパスが含まれます。

Custom API Actionは、操作の論理検証を行いません。たとえば、含まれるHTTP本文からのDELETEリクエストを防止しません。APIを正しく確実に呼び出せるように、 Okta Privileged Access APIのドキュメントを確認してください。

オプション

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

フィールド	定義	タイプ	必須
リクエストタイプ（Request Type）	カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです（「HTTPリクエストメソッド」を参照）。 `GET`：パラメーターに応じてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに`200 (OK)`レスポンスメッセージが返されます。 `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)レスポンスメッセージが返されます。
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）
相対URL（Relative URL）	呼び出すWebサーバーのURLアドレス。`/{insert_remaining_URL}`のように相対URLを指定します。 `?`を使用して相対URL内にクエリパラメーターを指定したり、クエリ（Query）入力内のキーと値のペアとしてクエリパラメーターを指定したりすることができます。 Okta Privileged Access APIのURLが`https://{OktaOrg}.pam.okta.com/v1/teams/{teamname}/{endpoint}`であれば、相対URL（Relative URL）は`/{endpoint}`となります。たとえば、Okta Privileged Access APIのURLが`https://myorg.pam.okta.com/v1/teams/adminteam/sudo_command_bundles`であれば、相対URL（Relative URL）は`/sudo_command_bundles`となります。	テキスト	正
クエリ（Query）	キー/値のペアとして含める必要がある追加のクエリパラメーターを指定します。例：`{"name":"something-urgent"}`。	オブジェクト	FALSE
ヘッダー（Headers）	`authorization`または`content-type`のヘッダーにはすでにコネクターが対応しているので、これ以外に必要な任意のヘッダーを指定します。	オブジェクト	FALSE
本文（Body）	リクエスト本文をJSON形式で指定します。この入力は、`POST`、`PUT`、`PATCH`リクエストでのみ使用できます。	オブジェクト	FALSE

出力

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