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

Adobe User Management APIへの認証済みHTTPリクエストを行います。「Adobe User Management API」を参照してください。

オプション

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

Request Type(リクエストタイプ)

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

  • GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST:パラメーターに基づいてWebサーバーにデータを送信します(ファイルのアップロードなど)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。

ドロップダウン

TRUE

入力

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

Relative URL(相対URL)

呼び出すWebサーバーのURLアドレス。相対URLを、/{relative_URL}のように指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。

たとえば、Adobe User Management APIエンドポイントでは、https://usermanagement.adobe.io/v2/usermanagement/groups/{orgId}/{page}であれば、相対URLは/usermanagement/groups/{orgId}/{page}となります。

テキスト

TRUE

Headers(ヘッダー)

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

オブジェクト

FALSE

Query(クエリ)

オブジェクト形式のキー/値のペアとして含める必要がある追加のクエリパラメーターを指定します。

オブジェクト

FALSE

Body(本文)

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

このフィールドはGETリクエストタイプには利用できません。

テキスト

FALSE

出力

フィールド 定義 タイプ

Response (レスポンス)

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

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

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

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

数値

Headers(ヘッダー)

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

オブジェクト

Body(本文)

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

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

オブジェクト

関連項目

Adobe User Managementコネクター

Workflows要素

Adobe User Managementコネクターに関するガイダンス

User Management Rest APIの概要