Users
Query user information.
Table Specific Information
Select
To get a list of all the users, CustomerId is required. You can either set it in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.
For example, the following query is processed server side by the Google Directory APIs:
SELECT * FROM Users
Insert
To insert a user, the following columns are required: PrimaryEmail, FirstName, Surname, and Password.
INSERT INTO Users (PrimaryEmail, FirstName, Surname, Password, Suspended) VALUES ('[email protected]', 'John', 'Doe', '12345', true)
Update
To update a user, the Id column is required.
UPDATE Users SET PrimaryEmail = '[email protected]', FirstName = 'John', Surname = 'Doe', Suspended = true WHERE Id = 1231
Delete
To delete users, the Id column is required.
DELETE FROM Users WHERE Id = '12345'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier for the user. |
| CustomerId | String | True |
The customer Id of the user. |
| PrimaryEmail | String | False |
The primary email of the user. |
| FirstName | String | False |
The first name of the user. |
| Surname | String | False |
The surname of the user. |
| Aliases | String | True |
The aliases of the user. |
| IsAdmin | Boolean | True |
Indicates if the user is an admin. |
| IsDelegatedAdmin | Boolean | True |
Indicates if the user is a delegated admin. |
| LastLoginDate | Datetime | True |
Last time the user logged on. |
| CreationDate | Datetime | True |
Creation date of the user. |
| DeletionDate | Datetime | True |
Deletion date of the user. |
| AgreedToTerms | Boolean | True |
Indicates if the user agreed to the terms or not. |
| Suspended | Boolean | False |
Indicates if the user got Suspended. |
| SuspensionReason | String | True |
The reason the user got Suspended. |
| OrgUnitPath | String | False |
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 | True |
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license. |
| IsEnrolledIn2Sv | Boolean | True |
Indicates if the user is enrolled in 2-step verification. |
| IsEnforcedIn2Sv | Boolean | True |
Indicates if the user is enforced in 2-step verification. |
| IncludeInGlobalAddressList | Boolean | True |
Indicates if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. |
| ThumbnailPhotoUrl | String | True |
Photo Url of the user. |
| ChangePasswordAtNextLogin | Boolean | False |
Indicates if the user is forced to change their password at next login. |
| IpWhitelisted | Boolean | False |
If true, the user's IP address is subject to a deprecated IP address allowlist configuration. |
| Kind | String | True |
The type of the API resource. For Users resources, the value is admin#directory#user. |
| ETag | String | True |
ETag of the resource. |
| ExternalIds | String | False |
The list of external IDs for the user, such as an employee or network ID. |
| Relations | String | False |
The list of the user's relationships to other users. |
| Languages | String | False |
The list of the user's languages. |
| PosixAccounts | String | False |
The list of POSIX account information for the user. |
| NonEditableAliases | String | True |
The list of the user's non-editable alias email addresses. |
| SshPublicKeys | String | False |
A list of SSH public keys. |
| Notes | String | False |
Notes for the user. |
| Keywords | String | False |
The list of the user's keywords. |
| Gender | String | False |
A nested object containing the user's gender. |
| ThumbnailPhotoEtag | String | True |
ETag of the user's photo. |
| CustomSchemas | String | False |
Custom fields of the user. The key is a schemaName and its values are field data. |
| Archived | Boolean | False |
Indicates if user is archived. |
| RecoveryEmail | String | False |
Recovery email of the user. |
| RecoveryPhone | String | False |
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). |
| HashFunction | String | False |
Stores the hash format of the password property. The following hashFunction values are allowed: MD5, SHA-1, crypt. |
| FullName | String | True |
The user's full name formed by concatenating the first and last name values. |
| DisplayName | String | False |
The user's display name. Limit: 256 characters. |
| Emails | String | False |
The list of the user's email addresses. |
| Addresses | String | False |
The list of the user's addresses. |
| Organizations | String | False |
The list of organizations the user belongs to. |
| Websites | String | False |
The list of the user's websites. |
| Locations | String | False |
The list of the user's locations. |
| Ims | String | False |
The user's Instant Messenger (IM) accounts. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| Password | String |
The password of the user. It is required for insert and optional for update. |
| Domain | String |
Domain name. |