Read User

ID

Unique identifier of the user.

ETag

ETag of the resource.

First Name

User's first name.

Last Name

User's last name.

Full Name

User's full name.

Address Me As

Pronouns of the user. For example, they/them/their.

Type

Type of gender. Acceptable values are female, male, other, and unknown.

Custom Gender

Name of a custom gender.

Content Type

Content type of the note. Acceptable values are text_plain and text_html. Default is text_plain.

Value

Content of the note.

Is Admin?

Indicator if the user has super administrator privileges.

Is Delegated Admin?

Indicator if the user is a delegated admin. Delegated admins are supported by the API but cannot create or undelete users, or assign admin roles to users. These requests are ignored by the API service. Roles and privileges for admin are assigned using the Admin Console.

Change Password At Next Login?

Indicator if the user is forced to change their password the next time they sign in (this doesn't apply when SSO is configured with a third-party identity provider).

Agreed to Terms?

Indicator if the user has completed an initial login and accepted the Terms of Service agreement.

IP Allow Listed?

Indicator if the user's IP address is allow listed.

Suspended?

Indicator if the user is suspended.

Suspension Reason

Reason that the user is suspended by either the admin or by Google at the time of suspension; options are ABUSE, ADMIN, UNDER13, or WEB_LOGIN_REQUIRED.

Last Login Time

Last time the user signed in to the account.

Creation Time

Time the user account was created.

Deletion Time

Time the user account was deleted.

Organization Unit Path

Full path to the organizational unit that's 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.

Customer ID

Customer ID to retrieve all account users.

Is Enrolled in 2SV?

Indicates if user enrolled in two-step verification.

Is Enforced in 2SV?

Indicates if user is two-step verification enforced.

Is Mailbox Setup?

Indicates if the user's Google mailbox is created.

Included in Global Address List?

Indicates whether the user profile is visible in the Google Workspace global address list. Contact sharing feature must be enabled for the domain.

Aliases

Alias email addresses.

Is Archived?

Indicates whether a user profile is archived.

Recovery Email

Recovery email of the user.

Recovery Phone

Recovery phone of the user.

Type

Type of keyword. Acceptable values are: custom, mission, occupation, and outlook.

Custom Type

Custom type for keyword. Required if type is custom.

Value

Keyword.

IM Network ID

User's IM accounts (user may have multiple IM accounts but only one primary).

Type

IM account type:

• home
• work
• custom
• other

Custom Type

Required, user defined value if IM type is custom.

Protocol

IM network (custom network or standard network).

Custom Protocol

Required, user defined value if the protocol is custom.

Primary?

Indicates whether this is the user's primary IM.

Email Address

Email address of the user.

Type

Type of email:

• home
• work
• custom
• other

Custom Type

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

Primary?

Indicates whether this is the user's primary email address.

External ID

Value of the ID.

Type

Type of external ID:

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

Custom Type

Required, user defined value if address type selection is custom.

Relation Name

Name of the person the user is related to.

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

Custom Type

Required, user defined value if type is custom.

Area

Textual location. For example, San Francisco, CA or near New York.

Building ID

Identifier of the building.

Desk Code

Textual code of individual desk location.

Floor Name

Floor name or number.

Floor Section

Section of the floor. For example, East or West.

Type

Type of the location. Acceptable values are custom, default, and desk.

Custom Type

Custom type of the location. Required if type is custom.

Street

Street portion of the user's address.

PO Box

User's post office box.

City

User's city of residence.

Region

User's geographic region.

Country

User's country of residence.

Country Code

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

Extended Address

Extended fields for addresses that includes a sub-region.

Formatted Address

Formatted version of the address.

Type

Type of address:

• home
• work
• custom
• other

Custom Type

Required, user defined value if address type selection is custom.

Primary?

Indicates whether this is the user's primary address.

Organization Name

Name of the organization.

Description

Description of the organization.

Department

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

Job Title

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

Location

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

Symbol

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

Cost Center

Cost center of the user's organization.

Domain

Domain that the organization belongs to.

Type

Type of organization.

Custom Type

Required, user defined value if address type selection is custom.

Primary?

Indicates whether this is the user's primary organization.

Phone Number

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

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

Custom Type

Required, user defined value if the type is custom.

Primary?

Indicates whether this is the user's primary phone number.

Website URL

URL of the website.

Type

Type or purpose of the website:

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

Custom Type

Required, user defined value if website type is custom.

Primary?

Indicator if this is the user's primary website.