Search Group Rules

Search all group rules for your organization.

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.

    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 a large number of records, see Stream matching records with a helper flow.

Input

Field Definition Type Required
Search

Specifies the keyword to use to search rules.

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.

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

When selected from the Result Set option, both First Matching Record and First 200 Matching Records display the following fields unless otherwise stated.

Field Definition Type
ID

Unique ID for the group rule.

Text

Type

Type of rule created.

Text

Status Status of the group rule.

For example, active or inactive.

Text

Name

Name of the group.

Text

Expression Conditions

Okta expressions that would result in a Boolean value.

Text

Excluded Users

User IDs that are excluded when rules are processed.

List of Text

Group Assignments

ID

Unique ID for the group assignment.

Text

Name

Name for the group assignment.

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

Related topics

Okta connector

Workflow elements

Guidance for Okta connector

Okta API documentation