Read User

Retrieve details of a user in G Suite.

Input

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

Output

Included in Global Address List?(boolean): indicator if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center.

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
    Parent Organization Path Full path of the parent organization associated with the user (if the parent organization is the top-level, it is represented as a forward slash) 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
    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? indicator if 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? indicator if 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? indicator if 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? indicator if 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? indicator if 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

    G Suite Admin connector

    About the elements of Okta Workflows

    G Suite API documentation