Custom API Action

Make an authenticated HTTP request to the Adobe User Management API. See Adobe User Management API.

Options

Field	Definition	Type	Required
Request Type	These are the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods). GET: Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content. POST: Sends data to a web server based on parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST. Caution should be exercised to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.	Dropdown	TRUE

Field

Definition

Type

Required

Request Type

These are the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).

GET: Retrieves data from a web server based on parameters. This method requests a representation of the specified resource. If a request is successful, a 200 (OK) response message is returned with the requested content.
POST: Sends data to a web server based on parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST. Caution should be exercised to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.

Dropdown

TRUE

Field	Definition	Type	Required
Relative URL	The URL address of the web server that you're attempting to call. Specify the relative URL as /{relative_URL}. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input. For example, for the Adobe User Management API endpoint https://usermanagement.adobe.io/v2/usermanagement/groups/{orgId}/{page} the relative URL is: /usermanagement/groups/{orgId}/{page}.	Text	TRUE
Headers	Specify any headers required in addition to authorization or content-type as the connector already handles these.	Object	FALSE
Query	Specify any additional query parameters that should be included as key and value pairs in an object format.	Object	FALSE
Body	Specify a request body in JSON format. This field is not available for the Get request type.	Text	FALSE

Field	Definition	Type
Response
Status Code	Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example: A 201 Created status code indicates success where a new resource was created. A 403 Forbidden error indicates that the HTTP request wasn't processed because the necessary permissions were missing. For a full list of possible status codes, see HTTP status codes.	Number
Headers	Detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. This is similar to {"Content-type":"application/json"}.	Object
Body	Data returned from your selected HTTP request. For example, the data from a GET request.	Object