Search groups

Search for groups in your Zscaler environment.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First Matching Record: Returns the first record that matches.

  • First 100 Matching Records: Returns the first 100 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 FALSE

Input

Field Definition Type Required

Search Criteria

Name

Name of the group.

Text FALSE

Exclude Dynamic

If True, dynamic groups are excluded from the search results.

 True/False 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.

Flow

 TRUE

Record Limit

Specify the number of records to stream.

  • When the Record Limit is set to greater than 0, the stream returns up to the maximum number specified.
  • When the Record Limit is null or not selected, all records are streamed.
  • The default value is 500000.
  • The valid range is from 1 to 500000.

This field appears when you select Stream Matching Records from the Result Set option.

 Number FALSE

Output

Field Definition Type

Result

Groups

List of Objects

ID

Unique identifier of the group.

Text

Name

Name of the group.

Text

Description

Description of the group.

Text

Source

The source type where the group was created.

 Text

Identity Provider

Object

ID

The unique identifier of the referenced entity or identity provider.

 Text

Name

The name of the referenced entity or identity provider.

 Text

Display Name

The name displayed for the referenced entity or identity provider.

 Text

Is Dynamic Group

If True, the group is a dynamic group. The default value is False.

 True/False

Is Admin Entitlement Enabled

If True, the group supports admin entitlements. The default value is False.

 True/False

Is Service Entitlement Enabled

If True, the group supports service entitlements. The default value is False.

 True/False

Records Streamed

The number of streamed records.

This field appears when you select Stream Matching Records from the Result Set option.

 Number

Response

Raw Output

The raw output returned by the Zscaler API.

 Object