Search members

Search for members in Harmony SASE.

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 TRUE

Search Type

Indicate the search type for the filtered results:

  • Specific field: Search by specific field values.

  • Multi field: Search using a free-form query across multiple fields with fuzzy, relevance-based matching.

 Dropdown TRUE

Processing Method

Determines how records are retrieved and processed based on the selected Result Set type.

  • Return Record: Returns member as output.

  • Return List: Returns members list as output.

  • Sequential: Passes all records from the parent flow to a helper flow in sequential order based on the sort values.

  • Concurrent: Passes all records from your parent flow to a helper flow concurrently.

The Return Record option appears when First Matching Record is selected from the Result Set field. The Return List option appears when First 100 Matching Records is selected from the Result Set field. Sequential and Concurrent options appear when Stream Matching Recordsis selected from the Result Set field.

 Dropdown TRUE

Input

Field Definition Type Required

Search By

First Name

The given name of the member.

 Text FALSE

Last Name

The last name of the member.

 Text FALSE

Email

The email address of the member.

 Text FALSE

Department

The department, job, or title of the member.

 Text FALSE

Terminated

If True, the member is deleted.

 True/False FALSE

Email Verified

If True, the member's email address is verified.

 True/False FALSE

Query

Enter a free-form search query value.

 Text FALSE

Custom

Operator

Boolean Operator

  • AND

  • OR

The default operator is AND.

 Dropdown FALSE

Filter

To make your search more flexible, provide a member API attribute name with a value.

Custom search takes priority over other search fields.

 Object FALSE

Sort

Sort Order

Indicate the sort order for the filtered results:

  • Ascending

  • Descending

Dropdown FALSE

Sort By

Sort the results by field:

  • First Name

  • Last Name

  • Full Name

  • Email

  • Username

  • Is Email Verified

  • Is Terminated

  • Created At

  • Updated At

Default sorting is based on the Created At field in the ascending order.

 Dropdown 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 Records from the Result Set field.

Flow

 TRUE

Record Limit

Specify the number of records to stream.

  • When the Limit field is set to greater than 0, the stream returns up to the maximum number specified.

  • When the Limit field is empty, null, or not selected, the stream returns all records.

  • The default value is 10000000 (10 million).

 Number FALSE

If the Is Terminated filter isn't applied, search results include both active and terminated members.

Output

Field Definition Type

Result

ID

Unique identifier of the member.

 Text

Email

The email address of the member.

 Text

Username

The username of the member.

 Text

Is Email Verified

If True, the member's email address is verified.

 True/False

First Name

The given name of the member.

 Text

Last Name

The last name of the member.

 Text

Full Name

The full name of the member.

 Text

Department

The department, job, or title of the member.

 Text

Role

The role of the member.

 Text

Phone Number

The phone number of the member.

 Text

Tenant ID

The tenant ID.

 Text

Is Terminated

If True, the member is deleted.

 True/False

Initials

The initials of the member.

 Text

Initials Color

The hexadecimal color code of the member's initials.

 Text

Invitation Attempts

The number of invitation attempts.

 Number

Invitation Token

The invitation token.

 Text

Identity Providers

Object

Database

The identity provider type.

Object

Created At

Date and time for when the member was created.

 Date & Time

Updated At

Date and time for when the member was updated.

 Date & Time

Raw Output

The raw output returned by the Harmony SASE API.

 Object

Members

List of Objects

ID

Unique identifier of the member.

 Text

Email

The email address of the member.

 Text

Username

The username of the member.

 Text

Is Email Verified

If True, the member's email address is verified.

 True/False

First Name

The given name of the member.

 Text

Last Name

The last name of the member.

 Text

Full Name

The full name of the member.

 Text

Department

The department, job, or title of the member.

 Text

Role

The role of the member.

 Text

Phone Number

The phone number of the member.

 Text

Tenant ID

The tenant ID.

 Text

Is Terminated

If True, the member is deleted.

 True/False

Initials

The initials of the member.

 Text

Initials Color

The hexadecimal color code of the member's initials.

 Text

Invitation Attempts

The number of invitation attempts.

 Number

Invitation Token

The invitation token.

 Text

Identity Providers

The identity provider type.

Object

Created At

Date and time for when the member was created.

 Date & Time

Updated At

Date and time for when the member was updated.

 Date & Time

Raw Output

The raw output returned by the Harmony SASE API.

 Object

Records Streamed

The number of records streamed in a streaming flow.

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

 Number