Skip to main content
PATCH
/
v1
/
users
/
{user}
{
  "name": "<string>",
  "state": "STATE_UNSPECIFIED",
  "email": "<string>",
  "title": "<string>",
  "userType": "USER_TYPE_UNSPECIFIED",
  "mfaEnabled": true,
  "tempOtpSecret": "<string>",
  "tempRecoveryCodes": [
    "<string>"
  ],
  "tempOtpSecretCreatedTime": "2023-11-07T05:31:56Z",
  "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.

​
allowMissing
boolean

If set to true, and the user is not found, a new user will be created. In this situation, update_mask is ignored.

Body

application/json
​
state
enum<string>

The lifecycle state of the user account.

Available options:
STATE_UNSPECIFIED,
ACTIVE,
DELETED
​
email
string

The email address of the user, used for login and notifications.

​
title
string

The display title or full name of the user.

​
userType
enum<string>

The type of user account.

Available options:
USER_TYPE_UNSPECIFIED,
USER,
SYSTEM_BOT,
SERVICE_ACCOUNT
​
password
string

The password for authentication. Only used during user creation or password updates.

​
serviceKey
string

The service key for service account authentication. Only used for service accounts.

​
mfaEnabled
boolean

The mfa_enabled flag means if the user has enabled MFA.

​
tempOtpSecret
string

Temporary OTP secret used during MFA setup and regeneration.

​
tempRecoveryCodes
string[]

Temporary recovery codes used during MFA setup and regeneration.

​
tempOtpSecretCreatedTime
string<date-time>

Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer.

​
phone
string

Should be a valid E.164 compliant phone number. Could be empty.

​
profile
object

User profile metadata.

Response

OK

​
name
string

The name of the user. Format: users/{user}. {user} is a system-generated unique ID.

​
state
enum<string>

The lifecycle state of the user account.

Available options:
STATE_UNSPECIFIED,
ACTIVE,
DELETED
​
email
string

The email address of the user, used for login and notifications.

​
title
string

The display title or full name of the user.

​
userType
enum<string>

The type of user account.

Available options:
USER_TYPE_UNSPECIFIED,
USER,
SYSTEM_BOT,
SERVICE_ACCOUNT
​
mfaEnabled
boolean

The mfa_enabled flag means if the user has enabled MFA.

​
tempOtpSecret
string

Temporary OTP secret used during MFA setup and regeneration.

​
tempRecoveryCodes
string[]

Temporary recovery codes used during MFA setup and regeneration.

​
tempOtpSecretCreatedTime
string<date-time>

Timestamp when temp_otp_secret was created. Used by frontend to show countdown timer.

​
phone
string

Should be a valid E.164 compliant phone number. Could be empty.

​
profile
object

User profile metadata.

​
groups
string[]

The groups for the user. Format: groups/{email}