Search group users

Search for group users 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

Filter

Choose a filter to get specific results:

  • Exact Match: Get the exact matching record.

  • Contains: Get a partial matching record.

Dropdown FALSE

Input

Field Definition Type Required

Group

ID

Unique identifier of the group.

Text TRUE

Search Criteria

Login Name

The email address of the user with your Zscaler domain name.

Text FALSE

Domain Name

The registered domain name of your Zscaler environment.

Text FALSE

IDP Name

The name of the registered referenced entity or identity provider of your Zscaler environment.

Text FALSE

Display Name

Name displayed for the user.

Text FALSE

Primary Email

The email address of the user.

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.

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

Users

List of Objects

ID

Unique identifier of the user.

Text

Login Name

The email address of the user with your Zscaler domain name.

Text

Primary Email

The email address of the user.

Text

Display Name

Name displayed for the user.

Text

Status

The status of the user.

  • Active

  • Inactive

True/False

First Name

Given name of the user.

Text

Last Name

Last name of the user.

Text

Secondary Email

A secondary email address of the user. The primary and secondary email address can't be the same.

Text

Source

The source type where the user was created.

Text

Department

Object

ID

The unique identifier of the department.

Text

Name

The name of the department.

Text

Display Name

The name displayed for the department.

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

Custom Attributes

User-defined custom fields for the user.

Object

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