How to Use Streaming Action Cards in Okta Workflows
Last Updated:
Overview
When returning records from an API call to the Okta service, the majority of API endpoints are limited to 200 records per page. To return more than 200 records, a flow must either be configured to iterate through additional pages of the API and process those additional outputs or can be configured to Stream the resulting records to a helper flow, with a single record streamed per helper flow invocation. Okta Workflows support Streaming with many third-party services in addition to Okta service.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Okta Workflows
- Okta API
- Large data sets
Solution
How are streaming action cards configured in Okta Workflows?
Configure a helper flow to process individual records, select the stream records option in the parent flow, and define any additional contextual inputs.
- Configure a helper flow to process the individual records returned from the API call. In the Helper event card, define an object called Record and an object called State. Both are required for proper functionality.
-
In the parent flow, select the action card that will be streaming the records, and under the Options dialog Result Set dropdown, select Stream Records. Records returned by this API call will be available in the helper flow in the Record object.
- Click Choose flow and select the helper flow configured in Step 1.
- To pass additional contextual information from the parent flow to the helper flow for processing, define the inputs in the Click or drop here to create input. The helper flow accesses these inputs during execution within the State object.
For a complete walkthrough and using the data in the Helper flow, please see the video:
