Requires authorization
Retrieves a user. Try it now.
Request
HTTP request
GET https://www.googleapis.com/admin/directory/v1/users/userKey
Parameters
Parameter name | Value | Description |
---|---|---|
Path 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. |
Optional query 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 |
string |
What subset of fields to fetch for this user.
Acceptable values are:
|
viewType |
string |
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.
Acceptable values are:
|
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/admin.directory.user.readonly |
https://www.googleapis.com/auth/admin.directory.user |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a Users resource in the response body.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.