Google Workspace · Schema
User
A Google Workspace user account. JSON representation of a user resource from the Admin SDK Directory API.
CalendarCollaborationEmailProductivityStorageVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| kind | string | The type of the API resource. |
| id | string | The unique ID for the user. |
| etag | string | ETag of the resource. |
| primaryEmail | string | The user primary email address. This property is required in a request to create a user account. The primaryEmail must be unique and cannot be an alias of another user. |
| isAdmin | boolean | Indicates a user with super administrator privileges. The isAdmin property can only be edited using the makeAdmin method; it is not directly editable in the user resource. |
| isDelegatedAdmin | boolean | Indicates if the user is a delegated administrator. |
| lastLoginTime | string | The last time the user logged into the user account. The value is in ISO 8601 date and time format. |
| creationTime | string | The time the user account was created. The value is in ISO 8601 date and time format. |
| deletionTime | string | The time the user account was deleted (for deleted users). |
| agreedToTerms | boolean | Indicates whether the user has completed an initial login and accepted the Terms of Service. |
| password | string | Stores the password for the user account. The password value is never returned in the API response body. Required when creating a user account. Must be 8-100 ASCII characters. |
| hashFunction | string | Stores the hash format of the password property. Use MD5, SHA-1, or crypt for supported hash formats. |
| suspended | boolean | Indicates if the user is suspended. A suspended user cannot sign in. |
| suspensionReason | string | The reason a user account is suspended. Only returned when the suspended property is true. |
| changePasswordAtNextLogin | boolean | Indicates if the user is forced to change their password at next login. |
| ipWhitelisted | boolean | If true, the user IP address is subject to a deprecated IP address allowlist configuration. |
| customerId | string | The customer ID to retrieve all account users. You can use the alias my_customer to represent the account customerId. |
| orgUnitPath | string | The 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 (/). |
| isMailboxSetup | boolean | Indicates if the user Gmail mailbox has been created. |
| includeInGlobalAddressList | boolean | Indicates if the user profile is visible in the Google Workspace global address list. |
| thumbnailPhotoUrl | string | Photo URL of the user. The URL might be temporary or private. Read-only. |
| thumbnailPhotoEtag | string | ETag of the user photo. |
| archived | boolean | Indicates if the user is archived. |
| recoveryEmail | string | Recovery email of the user. |
| recoveryPhone | string | Recovery phone of the user in E.164 format. |
| isEnrolledIn2Sv | boolean | Is enrolled in 2-step verification. Read-only. |
| isEnforcedIn2Sv | boolean | Is 2-step verification enforced. Read-only. |
| emails | array | A list of the user email addresses. The maximum allowed data size is 10KB. |
| phones | array | A list of the user phone numbers. |
| addresses | array | A list of the user addresses. |
| organizations | array | A list of organizations the user belongs to. |
| relations | array | A list of the user relationships to other users. |
| externalIds | array | A list of external IDs for the user. |
| websites | array | A list of the user websites. |
| ims | array | The user Instant Messenger (IM) accounts. |
| languages | array | The user languages. |
| gender | object | The user gender. |
| keywords | array | The user keywords. |
| locations | array | The user locations. |
| notes | object | Notes for the user. |
| customSchemas | object | Custom fields of the user. Keys are schema names and values are objects with field name/value pairs. |