Create a custom API action

Make a custom, authenticated HTTP request to the DataGrail API.

Required fields are indicated in red on the Action Card.

Options

Request Type(drop-down): This is one of 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 your parameters. This method requests a representation of the specified resource. If a request is successful, you receive a 200 (OK) response message with the requested content.

  • POST - sends data to a web server based on your parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST requests. If a request is successful, you receive a 200 (OK) response message.

Input

  • Relative URL(text): Specify the relative URL as /api/v2/{insert_remaining_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. Example: https://api.datagrail.io/v1{{input.Request.Relative URL}}

  • Query(object): Specify any additional query parameters that should be included in object format (key value pairs).

  • Headers(object): Specify any headers required in addition to authorization or content-type (these are already handled by this connector).

  • Body(object): Specify a request body in JSON format. Only available for POST requests.

Output

Response

  • Status Code(number): The result of your HTTP request. See HTTP status codes.
  • Headers(object): A detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will be usually similar to {"Content-type":"application/json"}.
  • Body(object): The data returned from your selected HTTP request (for example, the data from a GET request).

See Also

DataGrail connector

About the elements of Okta Workflows