Method: users.get

Retrieves a user.

HTTP request

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userKey

string

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

Query parameters

Parameters
customFieldMask

string

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

projection

enum (Projection)

What subset of fields to fetch for this user.

viewType

enum (ViewType)

Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of User.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly

For more information, see the OAuth 2.0 Overview.

Projection

Enums
PROJECTION_UNDEFINED
BASIC Do not include any custom fields for the user.
CUSTOM Include custom fields from schemas requested in customFieldMask.
FULL Include all fields associated with this user.

ViewType

Enums
VIEW_TYPE_UNDEFINED
ADMIN_VIEW Results include both administrator-only and domain-public fields for the user.
DOMAIN_PUBLIC Results only include fields for the user that are publicly visible to other users in the domain.