Custom API Action

Make a custom HTTP Request to the GitHub API.

Options

Field Definition Type Required
Request Type

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.
  • PUT: Sends data to be stored at a specific location on a web server based on your parameters (for example, uploading a file). The difference between PUT and POST requests is that PUT is idempotent. This means that for successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, you receive a 200 (OK), 201 (Created), or 204 (No Content) response message.
  • PATCH: Applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, which means that multiple PATCH requests could have unintended consequences. If a PATCH is successful, you receive a 200 (OK) or 204 (No Content) response message.
  • DELETE: Deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you receive a 200 (OK) response message.
 Dropdown TRUE

Input

Field Definition Type Required
Relative URL Base URL is https://api.github.com/{{Relative-URL.Input-request}} .

An example of a relative URL for an input request is /repos

Note

The version of the API is handled by the connector in the Accept header.

 String FALSE
Query Specify any additional query parameters that should be included in object format (key value pairs). Object FALSE
Headers Specify any headers required in addition to authorization or content-type (these are already handled by this connector). Object FALSE
Body Specify a request body in JSON format. Only available for POST, PUT, and PATCH requests. Object FALSE

Output

Field Definition Type
Status Code Success or failure of your HTTP request. Here is a list of all status codes. Number
Headers 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 usually be a replica of the following:

Example: {"Content-type":"application/json"}

 Object
Body Data returned from your selected HTTP request (for example, the data from a GET request). Object

Related topics

GitHub connector

About the elements of Okta Workflows

GitHub API documentation