Method: projects.tenants.accounts.update

{
  "idToken": string,
  "localId": string,
  "displayName": string,
  "email": string,
  "password": string,
  "provider": [
    string
  ],
  "oobCode": string,
  "emailVerified": boolean,
  "upgradeToFederatedLogin": boolean,
  "captchaChallenge": string,
  "captchaResponse": string,
  "validSince": string,
  "disableUser": boolean,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "photoUrl": string,
  "deleteAttribute": [
    enum (UserAttributeName)
  ],
  "returnSecureToken": boolean,
  "deleteProvider": [
    string
  ],
  "lastLoginAt": string,
  "createdAt": string,
  "phoneNumber": string,
  "customAttributes": string,
  "mfa": {
    object (MfaInfo)
  },
  "linkProviderUserInfo": {
    object (ProviderUserInfo)
  }
}

string

A valid Identity Platform ID token. Required when attempting to change user-related information.

string

The ID of the user. Specifying this field requires a Google OAuth 2.0 credential with proper permissions. For requests from end-users, an ID token should be passed instead.

string

The user's new display name to be updated in the account's attributes. The length of the display name must be less than or equal to 256 characters.

string

The user's new email to be updated in the account's attributes. The length of email should be less than 256 characters and in the format of name@domain.tld. The email should also match the RFC 822 addr-spec production. If email enumeration protection is enabled, the email cannot be changed by the user without verifying the email first, but it can be changed by an administrator.

string

The user's new password to be updated in the account's attributes. The password must be at least 6 characters long.

string

The Identity Providers that the account should be associated with.

string

The out-of-band code to be applied on the user's account. The following out-of-band code types are supported: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL

boolean

Whether the user's email has been verified. Specifying this field requires a Google OAuth 2.0 credential with proper permissions.

boolean

Whether the account should be restricted to only using federated login.

string

string

The response from reCaptcha challenge. This is required when the system detects possible abuse activities.

string (int64 format)

Specifies the minimum timestamp in seconds for an Identity Platform ID token to be considered valid.

boolean

If true, marks the account as disabled, meaning the user will no longer be able to sign-in.

string

string (int64 format)

string

The user's new photo URL for the account's profile photo to be updated in the account's attributes. The length of the URL must be less than or equal to 2048 characters.

enum (UserAttributeName)

The account's attributes to be deleted.

boolean

Whether or not to return an ID and refresh token. Should always be true.

string

The Identity Providers to unlink from the user's account.

string (int64 format)

The timestamp in milliseconds when the account last logged in.

string (int64 format)

The timestamp in milliseconds when the account was created.

string

The phone number to be updated in the account's attributes.

string

JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper permissions.

object (MfaInfo)

The multi-factor authentication related information to be set on the user's account. This will overwrite any previous multi-factor related information on the account. Specifying this field requires a Google OAuth 2.0 credential with proper permissions.

object (ProviderUserInfo)

The provider to be linked to the user's account. Specifying this field requires a Google OAuth 2.0 credential with proper permissions.