List

Retrieve either deleted users or all users in a domain (paginated)

11 variables
56 variables

Retrieve either deleted users or all users in a domain (paginated)

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage the provisioning of users on your domain
  • View users on your domain
  • View and manage your data across Google Cloud Platform services

Input

This building block consumes 11 input parameters

  = Parameter name
  = Format

query STRING

Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users

projection ENUMERATION

What subset of fields to fetch for this user

orderBy ENUMERATION

Column to use for sorting results

customFieldMask STRING

Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom

viewType ENUMERATION

Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user

domain STRING

Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead

maxResults INTEGER

Maximum number of results to return

sortOrder ENUMERATION

Whether to return results in ascending or descending order

pageToken STRING

Token to specify next page in the list

customer STRING

Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain

showDeleted STRING

If set to true, retrieves the list of deleted users. (Default: false)

Output

This building block provides 56 output parameters

  = Parameter name
  = Format

users[] OBJECT

STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber)

users[].addresses ANY

Addresses of User

users[].archived BOOLEAN

Indicates if user is archived

users[].deletionTime DATE_TIME

users[].phones ANY

Phone numbers of User

users[].isMailboxSetup BOOLEAN

Output only. Is mailbox setup (Read-only)

users[].creationTime DATE_TIME

User's G Suite account creation time. (Read-only)

users[].isEnrolledIn2Sv BOOLEAN

Output only. Is enrolled in 2-step verification (Read-only)

users[].thumbnailPhotoEtag STRING

Output only. ETag of the user's photo (Read-only)

users[].suspended BOOLEAN

Indicates if user is suspended

users[].posixAccounts ANY

The POSIX accounts of User

users[].emails ANY

Emails of User

users[].externalIds ANY

The external Ids of User *

users[].gender ANY

Gender of User

users[].password STRING

User's password

users[].hashFunction STRING

Hash function name for password. Supported are MD5, SHA-1 and crypt

users[].recoveryEmail STRING

Recovery email of the user

users[].locations ANY

Locations of User

users[].kind STRING

Output only. Kind of resource this is

users[].aliases[] STRING

users[].includeInGlobalAddressList BOOLEAN

Boolean indicating if user is included in Global Address List

users[].suspensionReason STRING

Output only. Suspension reason if user is suspended (Read-only)

users[].etag STRING

Output only. ETag of the resource

users[].name OBJECT

users[].name.fullName STRING

Full Name

users[].name.givenName STRING

First Name

users[].name.familyName STRING

Last Name

users[].sshPublicKeys ANY

The SSH public keys of User

users[].keywords ANY

Keywords of User

users[].isAdmin BOOLEAN

Output only. Boolean indicating if the user is admin (Read-only)

users[].customerId STRING

Output only. CustomerId of User (Read-only)

users[].recoveryPhone STRING

Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212

users[].ims ANY

User's Instant Messenger

users[].id STRING

Unique identifier of User (Read-only)

users[].nonEditableAliases[] STRING

users[].notes ANY

Notes of User

users[].relations ANY

The Relations of User *

users[].customSchemas OBJECT

Custom fields of the user

users[].customSchemas.customKey OBJECT

Add additional named properties

users[].customSchemas.customKey.customKey.value ANY

JSON template for a set of custom properties (i.e. all fields in a particular schema)

users[].primaryEmail STRING

username of User

users[].websites ANY

Websites of User

users[].orgUnitPath STRING

OrgUnit of User

users[].thumbnailPhotoUrl STRING

Output only. Photo Url of the user (Read-only)

users[].isEnforcedIn2Sv BOOLEAN

Output only. Is 2-step verification enforced (Read-only)

users[].agreedToTerms BOOLEAN

Output only. Indicates if user has agreed to terms (Read-only)

users[].organizations ANY

Organizations of User

users[].changePasswordAtNextLogin BOOLEAN

Boolean indicating if the user should change password in next login

users[].languages ANY

Languages of User

users[].ipWhitelisted BOOLEAN

Boolean indicating if ip is whitelisted

users[].lastLoginTime DATE_TIME

User's last login time. (Read-only)

users[].isDelegatedAdmin BOOLEAN

Output only. Boolean indicating if the user is delegated admin (Read-only)

trigger_event STRING

Event that triggered this response (only used in case of Push Response)

kind STRING

Kind of resource this is

etag STRING

ETag of the resource

nextPageToken STRING

Token used to access next page of this result