Read User

Retrieve details of a user in Google Workspace.

Input

Field Definition Type Required
Read By
User ID Unique identifier of the user. String TRUE

Output

Field Definition Type
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
Full Name User's full name. String
Notes Notes for the user. String
Is Admin? Indicator if the user has super administrator privileges (this field can only be edited in the Make a User an Administrator action). Boolean
Is Delegated Admin? Indicator if 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? Indicator if the 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? Indicator if the user has completed an initial login and accepted the Terms of Service agreement. Boolean
IP Allow Listed? Indicator if the user's IP address is allow listed. Boolean
Suspended? Indicator if the 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.

Note

You can't remove a user from an organizational unit. This field only allows you to change the organizational unit to which a user belongs.

String
Customer ID Customer ID to retrieve all account users. String
Is Enrolled in 2SV? Indicates if user enrolled in 2-step verification. Boolean
Is Enforced in 2SV? Indicates if user is 2-step verification enforced. Boolean
Is Mailbox Setup? Indicates if the user's Google mailbox is created. Boolean
Aliases Alias email addresses. String
Is Archived? Indicates whether a user profile is archived. Boolean
IMs
IM Network ID User's IM accounts (user may have multiple IM accounts but only one primary). String
Type IM account type:
  • home
  • work
  • custom
  • other
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
  • home
  • work
  • custom
  • other
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
Extenal ID Value of the ID. String
Type Type of external ID:
  • account
  • custom
  • customer
  • login_ID
  • network
  • organization
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:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse
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
  • home
  • work
  • custom
  • other
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:
  • 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
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:
  • app_install_page
  • blog
  • custom
  • ftp
  • home
  • home_page
  • other
  • profile
  • reservations
  • resume
  • work
String
Custom Type Required, user defined value if website type is custom. String
Primary? Indicator if this is the user's primary website. Boolean
Custom Fields All fields from a custom schema for a user. String

Related topics

Google Workspace Admin connector

About the elements of Okta Workflows

Google Workspace API documentation