List groups

List groups in Harmony SASE.

Options

Field Definition Type Required

Result Set

Choose a method to filter search results:

  • First 100 Records: Returns the first 100 matching records.

  • Stream Records: Passes all matching user 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

Processing Method

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

  • Return List: Returns groups 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 List option appears when First 100 Records is selected from the Result Set field. Sequential and Concurrent options appear when you select Stream Records from the Result Set field.

 Dropdown TRUE

Input

Field Definition Type Required

Sort

Sort Order

Indicate the sort order for the filtered results:

  • Ascending

  • Descending

Dropdown FALSE

Sort By

Sort the results by field:

  • Name

  • Description

  • 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).

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

Users

The users of the group.

 List of Text

VPN Locations

The VPN locations of the group.

 List of Text

Networks

The networks of the group.

 List of Text

Applications

The apps of the group.

 List of Text

Tenant ID

The tenant ID.

 Text

Is Default

If True, the group is the default group.

 True/False

Is Deleted

If True, the group is deleted.

 True/False

Created At

Date and time when the group was created.

 Date & Time

Updated At

Date and time when the group 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 Records from the Result Set field.

 Number