Sign in
UserService

GetUser gets a user by ID or username. Supports both numeric IDs and username strings:

  • users/{id} (e.g., users/101)
  • users/{username} (e.g., users/steven)
get/api/v1/users/{user}

Path parameters

userstring required

The user id.

Query parameters

readMaskstring field-mask

Optional. The fields to return in the response. If not specified, all fields are returned.

Response

OK

namestring

The resource name of the user. Format: users/{user}

role'ROLE_UNSPECIFIED' | 'ADMIN' | 'USER' enum required

The role of the user.

usernamestring required

Required. The unique username for login.

emailstring

Optional. The email address of the user.

displayNamestring

Optional. The display name of the user.

avatarUrlstring

Optional. The avatar URL of the user.

descriptionstring

Optional. The description of the user.

passwordstring

Input only. The password for the user.

state'STATE_UNSPECIFIED' | 'NORMAL' | 'ARCHIVED' enum required

The state of the user.

createTimestring date-time

Output only. The creation timestamp.

updateTimestring date-time

Output only. The last update timestamp.

Changes