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 one of the following options to display your search results:
|
Dropdown | TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
Search By | |||
Name | Name of the user. | String | FALSE |
Email address of the user. | String | FALSE | |
First Name | User's first name. | String | FALSE |
Last Name | User's last name. | String | FALSE |
Is Admin? | Indicates whether the user has super administrator privileges (this field can only be edited in the Make User Admin action). | Boolean | FALSE |
Is Delegated Admin? | Indicates whether the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console. | Boolean | FALSE |
Is Suspended? | Indicates whether the user is suspended. | Boolean | FALSE |
IM Network ID | User's IM accounts (user may have multiple IM accounts, but only one primary). | String | FALSE |
External ID |
Unique external ID of the user. |
String | FALSE |
Manager Email | Email address of the user's manager. | String | FALSE |
Manager ID | Unique identifier of the user's manager. | String | FALSE |
Direct Manager Email | Email address of the user's direct manager. | String | FALSE |
Direct Manager ID | Unique identifier of the user's direct manager. | String | FALSE |
Address | User's address. | String | FALSE |
Address Street | Street portion of the user's address. | String | FALSE |
Address PO Box | User's post office box. | String | FALSE |
Address City | User's city of residence. | String | FALSE |
Address Region | User's geographic region. | String | FALSE |
Address Postal Code | Zip or postal code of the user's address. | String | FALSE |
Address Country | User's country of residence. | String | FALSE |
Organization Name | Name of the organization. | String | FALSE |
Organization Department | Department in the organization that the user is associated with (for example, sales or engineering). | String | FALSE |
Organization Description | Description of the organization. | String | FALSE |
Organization Cost Center | Cost center of the organization. | String | FALSE |
Phone | Phone number of the organization. | String | FALSE |
Organization Unit Path |
Full path to the organizational 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 /corp/sales/sales_support organizational unit. The organization key is not required. |
String | FALSE |
Is Enrolled in 2SV? | Indicates whether a user is enrolled in 2-step verification. | String | FALSE |
Is Enforced in 2SV? | Indicates whether two-step verification is enforced for a user. | String | FALSE |
Custom Schema Name | Custom schema for the user. | String | FALSE |
Custom Field Name | Custom fields for the user. | String | FALSE |
Search Criteria | |||
Record Limit |
Specify the number of records to stream.
Appears when |
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. | String |
ETag | ETag of the resource. | String |
First Name | User's first name. | String |
Last Name | User's last name. | String |
Notes | Notes for the user. | String |
Is Admin? | Indicates whether the user has super administrator privileges (this field can only be edited in the Make a User an Administrator action). | Boolean |
Is Delegated Admin? | Indicates whether the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console. | Boolean |
Change Password At Next Login? | Indicates whether a user is forced to change their password at next login (does not apply when SSO is configured with a third party identity provider). | Boolean |
Agreed to Terms? | Indicates whether a user has completed an initial login and accepted the Terms of Service agreement. | Boolean |
IP Allow Listed? | Indicates whether a user's IP address is allow listed. | Boolean |
Suspended? | Indicates whether a user is suspended. | Boolean |
Suspension Reason | Reason that the user is suspended by either the administrator or by Google at the time of suspension; options are ABUSE , ADMIN , UNDER13 , or WEB_LOGIN_REQUIRED . |
String |
Organization Unit Path |
Full path to the organizational 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 is not required. |
String |
Customer ID | Customer ID to retrieve all account users. | String |
Is Enrolled in 2SV? | Indicates whether a user enrolled in 2-step verification. | Boolean |
Is Enforced in 2SV? | Indicates whether a user is 2-step verification enforced. | Boolean |
Is Mailbox Setup? | Indicates whether a user's Google mailbox is created. | Boolean |
Custom Fields | All fields from a custom schema for a user. | String |
Aliases | Alias email addresses. | List of Strings |
IMs | ||
IM Network ID | User's IM accounts (user may have multiple IM accounts but only one primary). | String |
Type |
IM account type:
|
String |
Custom Type | Required, user defined value if IM type is custom . |
String |
Protocol | IM network (custom network or standard network). | String |
Custom Protocol | Required, user defined value if the protocol is custom . |
String |
Primary? | Indicates whether this is the user's primary IM. | Boolean |
Emails | ||
Email Address | Email address of the user. | String |
Type |
Email account type:
|
Dropdown |
Custom Type | Required, user defined value if email address type selection is custom . |
String |
Primary? | Indicates whether this is the user's primary email address. | Boolean |
External IDs | ||
External ID | Value of the ID. | String |
Type |
Type of external ID:
|
String |
Custom Type | Required, user defined value if address type selection is custom . |
String |
Relations | ||
Relation Name | Name of the person the user is related to. | String |
Type |
Type of relation:
|
String |
Custom Type | Required, user defined value if type is custom. | String |
Addresses | ||
Street | Street portion of the user’s address. | String |
PO Box | User’s post office box. | String |
City | User’s city of residence. | String |
Region | User’s geographic region. | String |
Country | User's country of residence. | String |
Country Code | Telephone prefix for user's country of residence (ISO 3166-1 standard). | String |
Extended Address | Extended fields for addresses that includes a sub-region. | String |
Formatted Address | Formatted version of the address. | String |
Type |
Type of address:
|
Dropdown |
Custom Type | Required, user defined value if address type selection is custom . |
String |
Primary? | Indicates whether this is the user's primary address. | Boolean |
Organizations | ||
Organization Name | Name of the organization. | String |
Description | Description of the organization. | String |
Department | Department in the organization that the user is associated with (for example, sales or engineering). | String |
Job Title | User's title in the organization (for example, member or engineer). | String |
Location | Physical location of the organization (this is not required to be an address). | String |
Symbol | Text string symbol of the organization (for example, Google's symbol is GOOG). | String |
Cost Center | Cost center of the user's organization. | String |
Domain | Domain that the organization belongs to. | String |
Type | Type of organization. | String |
Custom Type | Required, user defined value if address type selection is custom . |
String |
Primary? | Indicates whether this is the user's primary organization. | Boolean |
Phones | ||
Phone Number | Human-readable phone number (any telephone number format). | String |
Type |
Type of phone number:
|
String |
Custom Type | Required, user defined value if the type is custom. | String |
Primary? | Indicates whether this is the user's primary phone number. | Boolean |
Websites | ||
Website URL | URL of the website. | String |
Type |
Type or purpose of the website:
|
String |
Custom Type | Required, user defined value if website type is custom. | String |
Primary? | Indicates whether this is the user's primary website. | Boolean |
Records Streamed |
Number of records streamed in a streaming flow. Appears when Stream Matching Records is selected from the Result Set option. |
Number |