getGoogleUser: Get a Google User.

Description Usage Arguments Value References

View source: R/AdminDirectory.R

Description

This function returns information on a Google user.

Usage

1
2
3
4
5
6
getGoogleUser(
  userKey,
  projection = NULL,
  customFieldMask = NULL,
  viewType = NULL
)

Arguments

userKey

Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.

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.

Value

Information on the Google user.

References

Google API Documentation


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