Custom API Action
Make a custom, authenticated HTTP call to the Google Suite Admin API.
NOTE: This action is unlike other Google Suite Admin cards; refer to the Google Suite Admin API documentation.
Options
Field | Definition | Type | Required |
---|---|---|---|
API |
Google API for the custom call; choose from |
Dropdown | TRUE |
Request Type | This is one of the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods) | Dropdown | TRUE |
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. |
Input
Field | Definition | Type | Required |
---|---|---|---|
Relative URL |
Address on the web server you are attempting to interact with. Examples: License: https://www.googleapis.com/apps/licensing/v1{{input.Request.Relative URL}} Directory: https://www.googleapis.com/admin/directory/v1{{input.Request.Relative URL}} |
String | FALSE |
Query |
JSON object that determines the action taken at the URL. 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 example below. Example: {"Content-type":"application/json"} |
Object | FALSE |
Output
Field | Definition | Type |
---|---|---|
Status Code | Success or failure of your HTTP request; here is a list of all status codes. | Number |
Raw | Raw output data | Object |
Body | Data returned from your selected HTTP request (for example, the data from a GET request) |
Object |
Related topics
Google Workspace Admin connector