Custom API Action

Make a custom, authenticated HTTP call to the Auth0 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. Exercise caution to avoid sending multiple POST requests unintentionally. If a request is successful, a 200 (OK) response message is returned.

  • PUT: Sends data to be stored at a specific location on a web server based on parameters, such as uploading a file. Unlike POST requests, PUT requests are idempotent. For successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, a 200 (OK), 201 (Created), or 204 (No Content) response message is returned.

  • PATCH: Applies partial modifications to a resource on a web server based on parameters. PATCH isn't idempotent. Multiple PATCH requests could have unintended consequences. If a PATCH is successful, a 200 (OK) or 204 (No Content) response message is returned.

  • DELETE: Deletes the specified resource if it exists from the web server based on parameters. If a DELETE is successful, a 200 (OK) response message is returned.

Dropdown TRUE

Input

Field Definition Type Required

Relative URL

The URL address of the web server that you're attempting to call. Specify the relative URL as /{insert_remaining_URL}.

You can specify query parameters in the relative URL following a ? character, or specify the query parameters as an object pair in the Query input.

For example, for the Auth0 API endpoint https://example-org.us.auth0.com/api/v2/users/{userid}, the relative URL is /api/v2/users/{userid}.

 Text TRUE

Query

Specify any additional query parameters that should be included in object format as key value pairs.

 Object FALSE

Headers

Specify any headers required in addition to authorization or content-type, because this connector already handles these.

 Object FALSE

Body

Specify a request body in JSON format. Not available for GET requests.

 Object FALSE

Output

Field Definition Type

Response

Status Code

(Undefined variable: workflows_fields.output-status-code)

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