Custom API Action

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

Okta Devices APIの直接的な使用方法の詳細については、「Okta Devices 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)レスポンスメッセージが返されます。

ドロップダウン

TRUE

入力

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

Relative URL(相対URL)

呼び出すWebサーバーのURLアドレス。

/{version}/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、[Query(クエリ)]入力内のキー/値のペアとしてクエリパラメーターを指定したりすることができます。

たとえば、Okta Devices APIエンドポイントがhttps://{yourOktaDomain}/api/v1/devicesであれば、[Relative URL(相対URL)]/api/v1/devicesとなります。

Okta Devices APIリファレンス」を参照してください。

テキスト

TRUE

Headers(ヘッダー)

承認またはコンテンツタイプ(これらのヘッダーにはすでにコネクターが対応しています)以外に必要な任意のヘッダーを指定します。

オブジェクト

FALSE

Query(クエリ)

キー/値のペアとして含める必要がある追加のクエリパラメーターを指定します。例:{"name":"something-urgent"}

オブジェクト

FALSE

Body(本文)

リクエストボディーをJSON形式で指定します。

この入力は、POSTPUTPATCHリクエストでのみ使用できます。

オブジェクト

FALSE

出力

フィールド 定義 タイプ

Response (レスポンス)

Status Code(ステータスコード)

操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:

  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

数値

Headers(ヘッダー)

出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。

オブジェクト

Body(本文)

選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。

オブジェクト

関連項目

Okta Devicesコネクター

Okta Devices API

デバイスライフサイクル

フロー内のカード