PATCH
/
v1
/
users
/
{user}
{
  "name": "<string>",
  "state": "STATE_UNSPECIFIED",
  "email": "<string>",
  "title": "<string>",
  "userType": "USER_TYPE_UNSPECIFIED",
  "mfaEnabled": true,
  "mfaSecret": "<string>",
  "recoveryCodes": [
    "<string>"
  ],
  "phone": "<string>",
  "profile": {
    "lastLoginTime": "2023-11-07T05:31:56Z",
    "lastChangePasswordTime": "2023-11-07T05:31:56Z",
    "source": "<string>"
  },
  "groups": [
    "<string>"
  ]
}

Path Parameters

​
user
string
required

The user id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to update.

​
otpCode
string

The otp_code is used to verify the user's identity by MFA.

​
regenerateTempMfaSecret
boolean

The regenerate_temp_mfa_secret flag means to regenerate temporary MFA secret for user. This is used for MFA setup. The temporary MFA secret and recovery codes will be returned in the response.

​
regenerateRecoveryCodes
boolean

The regenerate_recovery_codes flag means to regenerate recovery codes for user.

Body

application/json

Response

200
application/json

OK

The response is of type object.