Memos unofficial
GET/api/v1/users/{user}

Get a user by username

Retrieves a user by username. Use the user resource name in the format users/{user}; specify readMask to limit the fields in the response, or omit it to receive all fields.

2 parameters
userstringrequired
The user resource name, in the format `users/{user}`.
readMaskstringoptional
A field mask specifying which fields to return. Defaults to all fields when omitted.

2 status codes
200Returns the user object, including its role, username, state, and any other fields selected by `readMask`.
namestringoptional
The resource name of the user. Format: users/{user}
rolestringrequired
The role of the user.
Allowed:ROLE_UNSPECIFIEDADMINUSER
usernamestringrequired
Required. The unique username for login.
emailstringoptional
Optional. The email address of the user. Stored trimmed and lowercased; empty means no address. An address belongs to at most one user on the instance, so writes that would reuse one fail with ALREADY_EXISTS.
displayNamestringoptional
Optional. The display name of the user.
avatarUrlstringoptional
Optional. The avatar URL of the user.
descriptionstringoptional
Optional. The description of the user.
passwordstringoptional
Input only. The password for the user.
statestringrequired
The state of the user.
Allowed:STATE_UNSPECIFIEDNORMALARCHIVED
createTimestringoptional
Output only. The creation timestamp.
updateTimestringoptional
Output only. The last update timestamp.
defaultDefault error response
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The user path parameter identifies the user resource and uses the format users/{user}. Use readMask as a field mask to select response fields, or omit it to receive all fields.