Read User

Retrieve details of a user in G Suite.

Unless otherwise indicated, field types are text.

Input

  • Read By

    • User ID: unique identifier of the user

Output

  • User

    • First Name: user's first name

    • Last Name: user's last name

    • Primary Email: user's primary email address (must be unique and cannot be an alias of another user)

    • Notes: notes for the user

    • Is Admin?(boolean): indicator if the user has super administrator privileges (this field can only be edited in the Make a User an Administrator action)

    • Is Delegated Admin?(boolean): An 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.

    • 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.

    • Password: password for the user account (password requirements: minimum 8 characters, maximum 100 characters, may contain any combination of ASCII characters). We recommend sending the password property value as a base 16 bit, hexadecimal-encoded hash value. If a hashFunction is specified, the password must be a valid hash key. The password value is never returned in the API's response body.

    • Change Password At Next Login?(boolean): 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)

    • IP Whitelisted?(boolean): indicator if the user's IP address is white listed

    • Alias: alias email address

  • IM

    • 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(option): IM network (custom network or standard network)

    • Custom Protocol: required, user defined value if the protocol is custom

    • Primary(boolean): indicator if this is the user's primary IM

  • Email

    • Address: email address of the user

    • Primary?(boolean): indicator if this is the user's primary email address

    • Type (drop-down)

      • home

      • work

      • custom

      • other

    • Custom Type: required, user defined value if email address type selection is custom

  • External ID

    • Extenal ID: value of the ID

    • Type(option): type of external ID

      • account

      • custom

      • customer

      • login_ID

      • network

      • organization

    • Custom Type: required, user defined value if address type selection is custom

  • Relation

    • 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

  • Address

    • 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

    • Postal Code: zip or postal code of the user’s address

    • 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 (drop-down)

      • home

      • work

      • custom

      • other

    • Custom Type: required, user defined value if address type selection is custom

    • Primary? (true/false): indicator if this is the user's primary address

  • Organization

    • 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 is not required 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

    • Primary(boolean): indicator if this is the user's primary organization

  • Phone

    • 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?(boolean): indicator if this is the user's primary phone number

  • Website

    • 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(boolean): indicator if this is the user's primary website

  • Product

    • Licenses(list of object): product licenses that you want to assign to the user

See Also

G Suite Admin connector

About the elements of Okta Workflows

G Suite API documentation