Update User

UpdateUser updates a user. Users may update themselves; admins may update anyone. Changing the password ends the user's other sessions.

Query Parameters

updateMask?string

Required. The fields to update. Supported paths: username, display_name, email, avatar_url, description, password, role, state. role and state require an admin.

Formatfield-mask

allowMissing?boolean

Optional. Currently ignored; updating a missing user fails with NOT_FOUND.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

User is an account on the instance.

name?string

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

username*string

Required. The unique username, used to sign in.

displayName?string

Optional. The display name of the user.

email?string

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. Returned only to the user and to admins.

avatarUrl?string

Optional. The avatar URL of the user. An avatar set as a data URI (PNG, JPEG, GIF or WebP, at most 2 MiB) is returned as a file server URL.

description?string

Optional. The description of the user.

password?string

Input only. The password of the user. Never returned.

role*string

Required. The role of the user. Only admins can change it.

Formatenum

Value in

"ROLE_UNSPECIFIED"
"ADMIN"
"USER"

state*string

Required. The state of the user. Only admins can change it.

Formatenum

Value in

"STATE_UNSPECIFIED"
"NORMAL"
"ARCHIVED"

Response Body

`application/json`

curl -X PATCH "https://example.com/api/users/string" \  -H "Content-Type: application/json" \  -d '{    "username": "string",    "role": "ROLE_UNSPECIFIED",    "state": "STATE_UNSPECIFIED"  }'

{  "name": "string",  "username": "string",  "displayName": "string",  "email": "string",  "avatarUrl": "string",  "description": "string",  "password": "string",  "role": "ROLE_UNSPECIFIED",  "state": "STATE_UNSPECIFIED",  "createTime": "2019-08-24T14:15:22Z",  "updateTime": "2019-08-24T14:15:22Z"}

Update View

UpdateMemoView updates a View. Only the owner may call it.

Update User Notification

UpdateUserNotification updates a notification's status. Only the receiver may call it.

Update User

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`