listGoogleUsersInDomain: List Google Users in a Domain

Description Usage Arguments Value References

Description

Retrieves a paginated list of either deleted users or all users in a domain.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
listGoogleUsersInDomain(
  domain,
  orderBy = NULL,
  sortOrder = NULL,
  showDeleted = NULL,
  query = NULL,
  projection = NULL,
  customFieldMask = NULL,
  viewType = NULL,
  customer = NULL
)

Arguments

domain

The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead. Either the customer or the domain parameter must be provided.

orderBy

Property to use for sorting results. Acceptable values are: "email": Primary email of the user, "familyName": User's family name, and "givenName": User's given name.

sortOrder

Whether to return results in ascending or descending order. Acceptable values are: "ASCENDING": Ascending order, and "DESCENDING": Descending order.

showDeleted

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

query

Query string for searching user fields. For more information on constructing user queries, see https://developers.google.com/admin-sdk/directory/v1/guides/search-users Search for Users.

projection

What subset of fields to fetch for this user. Acceptable values are: "basic": Do not include any custom fields for the user (default), "custom": Include custom fields from schemas requested in customFieldMask, and "full": Include all fields associated with this user.

customFieldMask

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

viewType

Whether to fetch the administrator-only or domain-wide public view of the user. Acceptable values are "admin_view": Results include both administrator-only and domain-public fields for the user. (default), and "domain_public": Results only include fields for the user that are publicly visible to other users in the domain.

customer

The unique ID for the customer's G Suite account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. Either the customer or the domain parameter must be provided.

maxResults

Maximum number of results to return. Acceptable values are 1 to 500, inclusive. (Default: 100)

Value

A paginated list of either deleted users or all users in a domain.

References

Google API Documentation


samterfa/rgsuiteadmin documentation built on Dec. 26, 2021, 11:14 p.m.