Documentation
Start typing to search…

Detailed User information (Output)

This document provides a comprehensive list of the user-related fields available in the Google Directory actions. Each field provides detailed information about the user's profile, permissions, and settings. Whether you are managing a single user or multiple users within a Google Directory, these fields help in understanding and configuring user data effectively. Feel free to refer to this documentation whenever you need to understand the user output and its associated attributes in Google Directory.

This document details the various fields related to user data in the Google Directory section. It covers all the attributes, their definitions, and their possible values. This documentation is intended to help users fully understand the data output associated with Google Directory for a user.

1. User ID

  • Definition: The unique ID for the user.
  • Use Case: A user ID can be used as a user request URI's userKey.

2. User Primary Email

  • Definition: The user's primary email address.

3. Name

  • Definition: The name of the user.
    • Given Name: First name of the user.
    • Family Name: Last name of the user.
    • Full Name: Full name of the user (typically a combination of the given name and family name).

4. Job Title

  • Definition: The user's job title.

5. Is Admin

  • Definition: Indicates whether the user has super administrator privileges.

6. Is Delegated Admin

  • Definition: Indicates if the user is a delegated administrator.

7. Last Login Time

  • Definition: The last time the user logged into the system.

8. Created Time

  • Definition: The timestamp of when the user was created in the directory.

9. Agreed to Terms

  • Definition: A boolean property that indicates whether the user has accepted the Terms of Service agreement.
    • True: User has completed an initial login and accepted the Terms of Service.
    • False: User has not completed the terms acceptance process.

10. Suspended

  • Definition: Indicates whether the user is suspended or not. This means the user is not able to log into their account.

11. Archived

  • Definition: Indicates if the user is archived.
    • True: The user is archived.
    • False: The user is not archived.

12. Change Password at Next Login

  • Definition: Indicates if the user is required to change their password at the next login.

13. IP Whitelisted

  • Definition: Indicates if the user is part of the whitelist based on their IP address.

14. Emails

A list of the user's email addresses. This field contains multiple sub-attributes.

  • Address: The user's email address. This can either be the user's primary email or an alias email.
  • Primary: A boolean value indicating whether this is the user's primary email address.
  • Custom Type: If the email type is custom, this property contains the custom type string.
  • Type: The type of the email account (e.g., "work," "home," or "custom").

15. Phones

A list of the user's phone numbers, which include multiple attributes:

  • Value: A human-readable phone number. It may be formatted in any valid telephone number format.
  • Type: The type of phone number (e.g., "mobile," "work," or "home").
  • Custom Type: If the phone number type is custom, this property contains the custom type string.
  • Primary: If true, this indicates the user's primary phone number. A user can only have one primary phone number.

16. External IDs

A list of external IDs associated with the user (e.g., employee ID or network ID).

  • Value: The external ID value.
  • Type: The type of external ID (e.g., "employee," "network").

17. Relations

A list of relationships the user has with other users.

  • Value: The user related to this one (e.g., a colleague or manager).
  • Type: The type of relationship (e.g., "manager," "peer").

18. Organizations

A list of organizations the user belongs to. The attributes under each organization are as follows:

  • Title: The user's title within the organization (e.g., "member," "engineer").
  • Primary: Indicates if this is the user's primary organization. A user can have only one primary organization.
  • Custom Type: If the organization type is custom, this property contains the custom type string.
  • Department: The department the user works in within the organization (e.g., "sales," "engineering").
  • Description: A description of the organization.
  • Cost Center: The cost center associated with the user's organization.

19. Aliases

A list of alias email addresses associated with the user. These are alternative email addresses for the user.

  • Item: Represents a single alias email address.

20. Non-Editable Alias

A list of the user's non-editable alias email addresses. These are typically aliases that exist outside the account's primary domain or sub-domain and cannot be modified by the user.

  • Item: Represents a single non-editable alias email address.

21. Customer ID

  • Definition: This is the unique identifier for the customer account.
    • You can use the alias my_customer to represent your account's customerId.

22. Parent Org Path

  • Definition: The full path of the parent organization associated with the user.
    • If the parent organization is the top-level organization, it is represented as a forward slash (/).

23. Is Mailbox Setup

  • Definition: Indicates if the user's mailbox has been set up.

24. 2SV Enrolled

  • Definition: Indicates whether the user is enrolled in two-step verification (2SV).
    • True: The user is enrolled in 2SV.
    • False: The user is not enrolled in 2SV.

25. 2SV Enforced

  • Definition: Indicates whether two-step verification (2SV) is enforced for the user.
    • True: 2SV is enforced.
    • False: 2SV is not enforced.

26. Global Address List

  • Definition: Indicates if the user's profile is visible in the G Suite Global Address List (GAL) when the contact sharing feature is enabled for the domain.
    • True: The user’s profile is visible in the GAL.
    • False: The user’s profile is not visible in the GAL.

27. Addresses

A list of the user's addresses. The maximum allowed data size for this field is 10KB.

  • Country: The country of the user's address.
  • Country Code: The country code (using the ISO 3166-1 standard).
  • Custom Type: If the address type is custom, this property contains the custom value and must be set.
  • Extended Address: Additional address details such as sub-regions or extra address information.
  • Formatted: A full and unstructured postal address, including street address, P.O. box, city, state, ZIP/postal code, and country/region.
  • Locality: The town or city of the address.
  • Post Office Box: The P.O. box, if present.
  • Postal Code: The ZIP or postal code, if applicable.
  • Primary: If true, this is the user’s primary address. There can only be one primary address.
  • Region: The abbreviated province or state.
  • Source Is Structured: Indicates if the user-supplied address was structured.
  • Street Address: The street address (e.g., "1600 Amphitheatre Parkway"). Whitespace within the string is ignored; however, newlines are significant.
  • Type: The address type (e.g., “home,” “work,” or “custom”).

28. Locations

A list of the user's locations. The maximum allowed data size for this field is 10KB.

  • Area: A textual description of the location (e.g., “Mountain View, CA” or “Near Seattle”).
  • Building Id: The building identifier.
  • Custom Type: If the location type is custom, this property contains the custom value and must be set.
  • Desk Code: A specific textual code representing the individual desk location.
  • Floor Name: The name or number of the floor.
  • Floor Section: More specific location within the floor (e.g., if a floor is divided into sections A, B, and C, this field would specify one of those values).
  • Type: The location type (e.g., "custom," "default," or "desk").

29. Hash Function

  • Definition: Stores the hash format of the password property. The following hash function values are allowed:
    • MD5: Accepts simple hex-encoded values.
    • SHA-1: Accepts simple hex-encoded values.
    • Crypt: Compliant with the C crypt library. Supports multiple hash algorithms such as:
      • DES
      • MD5 (hash prefix $1$)
      • SHA-256 (hash prefix $5$)
      • SHA-512 (hash prefix $6$)

30. Gender

A nested object containing the user's gender information.

  • Type: The type of gender. Acceptable values are:
    • Female
    • Male
    • Other
    • Unknown
  • Address Me As: A human-readable string containing the proper pronouns or form of address for the user (e.g., "he/him/his," "they/them/their").
  • Custom Gender: The name of a custom gender, if applicable.

31. Notes

Notes related to the user as a nested object.

  • Content Type: The content type of the note. It can be either:
    • text_plain
    • text_html (Default is plain text).
  • Value: The content of the note.

32. Recovery Email

  • Definition: The recovery email address associated with the user account.

33. Recovery Phone

  • Definition: The recovery phone number of the user, in E.164 format.
    • Example: +16506661212.

34. Deletion Time

  • Definition: The time when the user's account was deleted. The value is provided in ISO 8601 date and time format, which includes the date, time, and timezone.
    • Example: 2010-04-05T17:30:04+01:00.

35. Languages

A list of the user’s languages. The maximum allowed data size for this field is 1KB.

  • Custom Language: The name of a language that the user provides if there is no corresponding ISO 639 language code.
    • If customLanguage is set, languageCode cannot be set.
  • Language Code: The ISO 639 string representation of the language. This code corresponds to standard language codes.
    • If languageCode is set, customLanguage cannot be set.
  • Preference: Specifies whether the languageCode is the user’s preferred language.
    • preferred: The language is preferred.
    • not_preferred: The language is not preferred.

36. Websites

A list of the user's websites. Each website contains several attributes:

  • Website URL: The URL of the user's website.
  • Primary: A boolean value indicating if this is the user's primary website.
    • True: The website is the primary website.
    • False: The website is not the primary website.
  • Custom Type: If the website type is custom, this property contains the custom type string.
  • Type: The type or purpose of the website. Possible types include:
    • app_install_page
    • blog
    • custom
    • ftp
    • home
    • home_page
    • other
    • profile
    • reservations
    • resume
    • work

37. Keywords

A list of keywords associated with the user. Each keyword has the following attributes:

  • Value: The keyword associated with the user.
  • Custom Type: If the keyword type is custom, this property contains the custom type string.
  • Type: The standard type for the keyword. Possible values include:
    • custom
    • mission
    • occupation
    • outlook

38. Custom Schemas

Custom fields associated with the user, allowing for user-defined data.

  • Schema Name: The name of the custom schema.
  • Field Name: The name of the field within the schema.
  • Field Value: The value associated with the custom field.

Updated 14 days ago