Custom API Action(カスタムAPIアクション)

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

オプション

フィールド定義タイプ必須
Request Type (リクエストタイプ) これはカスタムAPI呼び出しでサポートされる以下のいずれかのHTTPリクエストメソッド、つまりHTTP動詞です(「HTTPリクエストメソッド」を参照)。
  • GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST: パラメーターに基づいてWebサーバーにデータを送信します(たとえば、ファイルのアップロードなど)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
ドロップダウンTRUE

入力

フィールド定義タイプ必須
Relative URL(相対URL) 対話を試みるWebサーバーのURLアドレス。/{version}/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリーパラメーターを指定したり、クエリー入力内のオブジェクトキーペアとしてクエリーパラメーターを指定したりすることができます。

たとえば、Datagrail APIエンドポイントの場合、
https://api.datagrail.io/v1/privacy_requestsであれば相対URLは/privacy_requestsとなります。

文字列FALSE
Query (クエリー)オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリーパラメーターを指定します。オブジェクトFALSE
Headers (ヘッダー)承認またはコンテンツタイプ (これらはすでにこのコネクタで処理されている) に加えて必要な任意のヘッダーを指定します。オブジェクトFALSE
Body (ボディー)リクエストボディーをJSON形式で指定します。POSTリクエストでのみ使用できます。オブジェクトFALSE

出力

フィールド定義タイプ
Status Code(ステータスコード)操作の結果。HTTPステータスコードはコネクタによって返され、カードによって実行されたアクションが成功したか失敗したかを示します。以下に例を挙げます。
  • 201 Createdステータスコードは、新しいリソースが作成された場合の成功を示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

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

数値
Headers (ヘッダー)出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは選択されたHTTPリクエストオプションに依存します。すべてのヘッダーがレスポンスヘッダーではないことに注意してください。通常、{"Content-type":"application/json"}のようになります。オブジェクト
Body (ボディー)選択されたHTTPリクエストから返されるデータ (たとえば、GETリクエストからのデータなど)。オブジェクト

関連項目

DataGrailコネクタ

Okta Workflowsの要素について

DataGrail APIドキュメンテーション