Update User

Path Parameters

user*string

The user id.

Query Parameters

updateMask?string

Required. The list of fields to update.

Formatfield-mask

allowMissing?boolean

Optional. If set to true, allows updating sensitive fields.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

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

role*string

The role of the user.

Formatenum

Value in"ROLE_UNSPECIFIED" | "ADMIN" | "USER"

username*string

Required. The unique username for login.

email?string

Optional. The email address of the user.

displayName?string

Optional. The display name of the user.

avatarUrl?string

Optional. The avatar URL of the user.

description?string

Optional. The description of the user.

password?string

Input only. The password for the user.

state*string

The state of the user.

Formatenum

Value in"STATE_UNSPECIFIED" | "NORMAL" | "ARCHIVED"

Response Body

`application/json`

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

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

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

defaultapplication/json

On this page

`application/json`

`application/json`