Search Groups

Search for groups based on the properties specified in the search parameter. The input fields in this card are dynamically generated based on your instance group profile properties. See Search Groups for more information on searching groups.

Scopes

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

Options

Field	Definition	Type	Required
Result Set	Choose a method to filter search results: First Matching Record: returns the first record that matches. First 200 Matching Records: returns the first 200 matching records. Stream Matching Records: passes all matching records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.	Dropdown	TRUE

To learn how to return a large number of records, see Stream matching records with a helper flow.

Input

Appears when First Matching Record or First 200 Matching Record are selected from Result Set unless otherwise stated.

Field	Definition	Type	Required
ID	ID of the group in Okta.	Text	FALSE
Created	Time stamp when the group was created.	Text	FALSE
Last Updated	Time stamp when the group's profile was last updated.	Text	FALSE
Last Membership Updated	Time stamp when the group's membership was last updated.	Text	FALSE
Type	Determines how the group's profile and memberships are managed. Select from the following: OKTA_GROUP APP_GROUP BUILT_IN.	Text	FALSE
Name	Name of the group.	Text	FALSE
Description	Description of the group.	Text	FALSE
Custom Search Criteria	Any custom search criteria you want to add. See Okta Developer documentation.	Text	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow to which 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. Appears when Stream Matching Records is selected from the Result Set option.	Flow	TRUE
Search Criteria
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 Stream Matching Records from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Raw Object	Raw payload returned from the Okta API. Appears if First Matching Record is selected from the Result Set option.	Object
Groups	Appears if First 200 Matching Records is selected from the Result Set field. ID, Created, Last Updated, Last Membership Updated, Object Class, Type, Profile fields display for First Matching Records and First 200 Matching Records.
ID	ID of the group in Okta.	Text
Created	Date and time when the object was created.	Text
Last Updated	Time stamp of the last group update.	Text
Last Membership Updated	Time stamp of the last update to the group's membership.	Text
Object Class	Determiner of the group's profile.	List of Text
Type	How the group's profile and memberships are managed; this is one of: OKTA_GROUP APP_GROUP BUILT_IN.	Text
Profile
Name	Name of the group.	Text
Description	Description of the group.	Text
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select Stream Matching Records from the Result Set option.	Number

Search Groups

Scopes

Options

Input

Output

Related topics