Search Users

Search for a user in Google Workspace.

This operation is performed for users that are part of the same connection domain.

Options

Field Definition Type Required

Return

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

Input

Field Definition Type Required

Search By

Name

Name of the user. Text FALSE

Email

Email address of the user.

 Text FALSE

First Name

User's first name.

 Text FALSE

Last Name

User's family name.

 Text FALSE

Is Admin?

This indicates whether the user has super administrator privileges.

You can only edit this field in the Make User Admin action card.

 True/False FALSE

Is Delegated Admin?

This indicates whether the user is a delegated administrator.

The API supports delegated administrators but can't create or undelete users, or make users administrators. The API service ignores these requests.

Roles and privileges for administrators are assigned using the Admin Console.

 True/False FALSE

Is Suspended?

This indicates whether the user is suspended.

 True/False FALSE

IM Network ID

User's IM accounts. A user may have multiple IM accounts, but only one primary account.

 Text FALSE

External ID

Unique external ID of the user. Text FALSE

Manager Email

Email address of the user's manager.

 Text FALSE

Manager ID

Unique identifier of the user's manager.

 Text FALSE

Direct Manager Email

Email address of the user's direct manager.

 Text FALSE

Direct Manager ID

Unique identifier of the user's direct manager.

 Text FALSE

Address

User's address.

 Text FALSE

Address Street

Street portion of the user's address.

 Text FALSE

Address PO Box

User's post office box.

 Text FALSE

Address City

User's city of residence.

 Text FALSE

Address Region

User's geographic region.

 Text FALSE

Address Postal Code

Zip or postal code of the user's address.

 Text FALSE

Address Country

User's country of residence.

 Text FALSE

Organization Name

Name of the organization.

 Text FALSE

Organization Department

Department in the organization that the user is associated with (for example, sales or engineering).

 Text FALSE

Organization Description

Description of the organization.

 Text FALSE

Organization Cost Center

Cost center of the organization.

 Text FALSE

Phone

Phone number of the organization.

 Text FALSE

Organization Unit Path

Full path to the organizational unit associated with the user.

The path requires a leading slash (/) or a 400 Bad Request message is returned. For example, /corp/sales is the parent path for the /corp/sales/sales_support organizational unit.

The organization key isn't required.

 Text FALSE

Is Enrolled in 2SV?

This indicates whether a user is enrolled in two-step verification.

 Text FALSE

Is Enforced in 2SV?

This indicates whether two-step verification is enforced for a user.

 Text FALSE

Custom Schema Name

Custom schema for the user.

 Text FALSE

Custom Field Name

Custom fields for the user.

 Text FALSE

Search 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 1 through 500000.

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

 Number 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

Output

Field Definition Type

Result

User ID

Unique identifier of the user.

 Text

ETag

ETag of the resource.

 Text

First Name

User's first name.

 Text

Last Name

User's family name.

 Text

Notes

Notes for the user.

 Text

Is Admin?

This indicates whether the user has super administrator privileges.

You can only edit this field in the Make User Admin action card.

 True/False

Is Delegated Admin?

Indicates whether the user is a delegated administrator.

The API supports delegated administrators but can't create or undelete users, or make users administrators. The API service ignores these requests.

Roles and privileges for administrators are assigned using the Admin Console.

 True/False

Change Password At Next Login?

This indicates whether a user is forced to change their password the next time they sign in.

It doesn't apply when SSO is configured with a third-party Identity Provider.

 True/False

Agreed to Terms?

This indicates whether a user has completed an initial sign-in flow and accepted the terms of service agreement.

 True/False

IP Allow Listed?

This indicates whether a user's IP address is on the allowlist.

 True/False

Suspended?

This indicates whether a user is suspended.

 True/False

Suspension Reason

The reason why the user was suspended, either by the administrator or by Google at the time of suspension.

The valid states are:

  • ABUSE

  • ADMIN

  • UNDER13

  • WEB_LOGIN_REQUIRED

 Text

Organization Unit Path

Full path to the organizational unit associated with the user.

A user's organizational unit determines to which Google Workspace services the user has access. If the user is moved to a new organization, the user's access changes.

The full path requires a leading slash (/).

For example, for an organization unit named sales_support under /corp/sales, the full organization unit path is /sales/sales_support. The organization key corp isn't required.

 Text

Customer ID

Customer ID to retrieve all account users.

 Text

Is Enrolled in 2SV?

This indicates whether a user is enrolled in two-step verification.

 True/False

Is Enforced in 2SV?

This indicates whether a user is two-step verification enforced.

 True/False

Is Mailbox Setup?

This indicates whether a user's Google mailbox is created.

 True/False

Custom Fields

All fields from a custom schema for a user.

 Text

Aliases

Alias email addresses.

 List of Text

IMs

IM Network ID

User's IM accounts. A user may have multiple IM accounts, but only one primary account.

 Text

Type

IM account type:

  • home

  • work

  • custom

  • other

Text

Custom Type

Required, user-defined value if the IM type is custom.

 Text

Protocol

IM network (custom network or standard network).

 Text

Custom Protocol

Required, user-defined value if the protocol is custom.

 Text

Primary?

This indicates whether this is the user's primary IM.

 True/False

Emails

Email Address

Email address of the user.

 Text

Type

Email account type:

  • home
  • work
  • custom
  • other
Dropdown

Custom Type

Required, user-defined value if the email address type is custom.

 Text

Primary?

This indicates whether this is the user's primary email address.

 True/False

External IDs

External ID

Value of the ID.

 Text

Type

Type of external ID:

  • account
  • custom
  • customer
  • login_ID
  • network
  • organization
Text

Custom Type

Required, user-defined value if the address type is custom.

 Text

Relations

Relation Name

The name of the person the user is related to.

 Text

Type

Type of relation:

  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse
Text

Custom Type

Required, user-defined value if the relation type is custom.

 Text

Addresses

Street

Street portion of the user's address.

 Text

PO Box

User's post office box.

 Text

City

User's city of residence.

 Text

Region

User's geographic region.

 Text

Country

User's country of residence.

 Text

Country Code

Telephone prefix for the user's country of residence (ISO 3166-1 standard).

 Text

Extended Address

Extended fields for addresses that include a subregion.

 Text

Formatted Address

Formatted version of the address.

 Text

Type

Type of address:

  • home
  • work
  • custom
  • other
Dropdown

Custom Type

Required, user-defined value if the address type is custom.

 Text

Primary?

This indicates whether this is the user's primary address.

 True/False

Organizations

Organization Name

Name of the organization.

 Text

Description

Description of the organization.

 Text

Department

Department in the organization that the user is associated with, for example, sales or engineering.

 Text

Job Title

User's title in the organization, for example, member or engineer.

 Text

Location

Physical location of the organization. This doesn't have to be an address.

 Text

Symbol

Text string symbol of the organization, for example, Google's symbol is GOOG.

 Text

Cost Center

Cost center of the user's organization.

 Text

Domain

Domain that the organization belongs to.

 Text

Type

Type of organization.

 Text

Custom Type

Required, user-defined value if the address type is custom.

 Text

Primary?

This indicates whether this is the user's primary organization.

 True/False

Phones

Phone Number

Human-readable phone number (any telephone number format).

 Text

Type

Type of phone number:

  • assistant
  • callback
  • car
  • company_main
  • custom
  • grand_central
  • home
  • home_fax
  • isdn
  • main
  • mobile
  • other
  • other_fax
  • pager
  • radio
  • telex
  • tty_ttd
  • work
  • work_fax
  • work_mobile
  • work_pager
Text

Custom Type

Required, user-defined value if the phone type is custom.

 Text

Primary?

This indicates whether this is the user's primary phone number.

 True/False

Websites

Website URL

URL of the website.

 Text

Type

Type or purpose of the website:

  • app_install_page
  • blog
  • custom
  • ftp
  • home
  • home_page
  • other
  • profile
  • reservations
  • resume
  • work
Text

Custom Type

Required, user-defined value if the website type is custom.

 Text

Primary?

This indicates whether this is the user's primary website.

 True/False

Records Streamed

Number of records streamed in a streaming flow.

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

 Number