List Roles

List the roles in a Google Workspace.

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

Input

Field Definition Type Required

Customer

Customer ID

The unique ID of the Google Workspace account.

You can also use the my_customer alias to represent your account's Customer ID.

Text

TRUE

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

List Criteria

Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, the stream returns no records.

  • 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 500000 (500 thousand).

  • The valid range is from 0 through 500000.

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

Number

FALSE

Output

Field Definition Type

Result

Roles

The roles available for this ID

List of Objects

Role ID

Unique ID of the role.

Text

Role Name

Name of the role.

Text

Description

A short description of the role.

Text

Role Privileges

The set of privileges that are granted to this role.

List of Objects

Service ID The obfuscated ID of the service this privilege is for.

Text

Privilege Name The name of the privilege.

Text

System Role

This field returns true if this is a predefined system role.

True/False

Super Admin

This field returns true if the role is a super admin role.

True/False

Kind

The type of the API resource.

Text

ETag

The ETag of the resource.

Text

Records Streamed

Number of records streamed in a streaming flow.

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

Number