Search Groups

Search for Okta groups based on the properties that are specified in the search parameter.

See the Okta Groups API for information on searching groups.

If you run this card with no values in the input fields, the card returns information for all the groups in your Okta org.

Scopes

See Action cards for the list of required OAuth scopes for 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.

    Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

 Dropdown TRUE

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

Input

The input fields for the card are dynamically generated, based on the properties for your instance group profile.

The card performs an eq (equal) comparison against the provided input value, except for the Custom Search Criteria input.

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

The method used for managing the group's profile and memberships:

  • OKTA_GROUP: The group profile and memberships are managed either directly in Okta through static assignments, or indirectly through group rules.

  • APP_GROUP: The group profile and memberships are imported and must be managed within the app (such as Active Directory or LDAP) that imported the group.

  • BUILT_IN: Okta manages the group profile and memberships and can't be modified.

 Text FALSE

Name

Name of the group. Text FALSE

Description

Description of the group.

 Text FALSE

Custom Search Criteria

Enter any custom string to run the search against a group property using a comparison operator, for example, sw, ew. See the search parameter in the Okta Groups API for details and examples.

If you want to run a search against your groups using either the filter or q query parameters, use the Custom API Action card.

 Text 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 Stream Matching Records 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

The raw payload returned from the Okta API.

This field appears when you select First Matching Record from the Result Set option.

 Object

Groups

This grouping appears when you select First 200 Matching Records from the Result Set option.

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 update to the group profile.

 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

The method used for managing the group's profile and memberships:

  • 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