Custom API Action

Use the Custom API Action to make an authenticated request to the Okta API.

See Okta API Reference for more information on working directly with the Okta API.

Scopes

See Action cards for the list of required OAuth scopes for this card.

Options

Field Definition Type Required

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. `GET(Streaming)`: Streams data from a web server based on parameters with the `GET` HTTP method and the related Streaming input fields. If the provided Relative URL doesn't support pagination, then the card performs a regular `GET` request and sends only one record to the helper flow. Then the value of Records Streamed is set to `1` (regardless of the Record Limit value) and the streaming process ends. You can provide a `limit` parameter to use for pagination as an input to the Query field. The valid range is from `0` to `200`. If no value is provided, `200` is used as the default limit. For most cases, you don't need to manually configure a limit. However, if each payload returned from your endpoint is close to 1MB, then providing a limit lower than `200` helps to prevent exceeding the flow's memory limit. `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

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.
GET(Streaming): Streams data from a web server based on parameters with the GET HTTP method and the related Streaming input fields.

If the provided Relative URL doesn't support pagination, then the card performs a regular GET request and sends only one record to the helper flow. Then the value of Records Streamed is set to 1 (regardless of the Record Limit value) and the streaming process ends.

You can provide a limit parameter to use for pagination as an input to the Query field. The valid range is from 0 to 200. If no value is provided, 200 is used as the default limit. For most cases, you don't need to manually configure a limit. However, if each payload returned from your endpoint is close to 1MB, then providing a limit lower than 200 helps to prevent exceeding the flow's memory limit.
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 using "?", or specify the query parameters as an object key pair in the Query input. A relative URL must have a leading `/` character. For example, for the Okta API endpoint: `https://{yourOktaDomain}/api/v1/users` the relative URL is `/api/v1/users`. See Okta API.	Text	TRUE
Headers	Specify any headers required in addition to authorization or content-type (these are already handled by this connector).	Object	FALSE
Query	Specify any additional query parameters that should be included in object format (key value pairs).	Object	FALSE
Body	Specify a request body in JSON format. Only available for `POST`, `PUT`, and `PATCH` requests.	Object	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. This field appears when you select `GET(Streaming)` in the Request Type option.	Flow	TRUE
Record Limit	Specify the number of records to stream. When the field is set to less than `0`, the card returns an error. When the field is set to either `0` or a value greater than `0`, the stream returns up to the maximum number specified. When the field is empty, null, or not selected, the stream returns all records. The default value is `1000000` (1 million). The valid range is from `0` to `1000000`. This field appears when you select `GET(Streaming)` in the Request Type option. The `limit` parameter that you can set in the Query input represents the number of records returned for each page in a pagination request, but the Record Limit field represents the total number of records you want to stream. The maximum Record Limit is equal to 5000 times the value of the limit parameter. As the default `limit` is `200`, by default the maximum Record Limit is 1,000,000 (that is, 200 * 5,000). If you manually set the `limit` parameter, you need to calculate the maximum Record Limit. For example if you set `limit=1`, then the maximum number of records you can get is 5000, even if you put a number greater than `5000` into the Record Limit field.	Number	FALSE

Output

Field	Definition	Type
Response
Status Code	Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example: A `201 Created` status code indicates success where a new resource was created. A `403 Forbidden` error indicates that the HTTP request wasn't processed because the necessary permissions were missing. For a full list of possible status codes, see HTTP status codes.	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
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select `GET(Streaming)` in the Request Type option.	Number