Invoke Function

Invoke a Google Cloud function using an HTTP request. Refer to the Google Cloud Functions API documentation.

Options

Field Definition Type Required
Region

Assigned region for your project; the following regions are available:

  • asia-east2
  • asia-northeast1
  • europe-west1
  • europe-west2
  • europe-west3
  • us-central1
  • us-east1
  • us-east4

The names of the cloud functions in each region are unique, but you can have the same named function in two different regions. us-central1 is the default.

 Dropdown TRUE
Function Name Name of the function. Dropdown TRUE
Request Type

One of five supported HTTP request methods (sometimes called verbs) in custom API calls:

  • GET retrieves data from a web server based on your parameters. GET requests a representation of the specified resource. If successful, GET will receive a 200 OK response message with the requested content. Refer to additional documentation here.
  • POST sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POSTs may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POSTs. If a POST is successful, you will receive a 200 OK response message. Refer to additional documentation here.
  • PUT sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT's. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Refer to additional documentation here.
  • PATCH applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that multiple PATCHs could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Refer to additional documentation here.
  • DELETE deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Refer to additional documentation here.
 Dropdown TRUE

Input

Field Definition Type Required
Query

JSON object that determines the action taken at the URL:

For example: {"name":"something-urgent"}

 Object or String FALSE
Headers JSON object that determines the content type of the request. This will usually be a replica of the following example: {"Content-type":"application/json"} Object FALSE
Body JSON object that is passed in the content of the request. This will usually be a replica of the following example: {"id":10} 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 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. Object
Body Data returned from your selected HTTP request (for example, the data from a GET request). Object

Related topics

Google Cloud Functions connector

About the elements of Okta Workflows

Google Cloud Functions API documentation