Method: accounts.update

Actualiza la información relacionada con la cuenta del usuario especificado configurando campos específicos o aplicando códigos de acción. Se admiten solicitudes de administradores y usuarios finales.

Solicitud HTTP

POST https://identitytoolkit.googleapis.com/v1/accounts:update

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "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,
  "tenantId": string,
  "targetProjectId": string,
  "mfa": {
    object (MfaInfo)
  },
  "linkProviderUserInfo": {
    object (ProviderUserInfo)
  }
}
Campos
idToken

string

Un token de ID de Identity Platform válido Obligatorio cuando se intenta cambiar la información relacionada con el usuario.

localId

string

El ID del usuario Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. En el caso de las solicitudes de los usuarios finales, se debe pasar un token de ID.

displayName

string

Es el nuevo nombre visible del usuario que se actualizará en los atributos de la cuenta. La longitud del nombre visible debe ser inferior o igual a 256 caracteres.

email

string

Es el correo electrónico nuevo del usuario que se actualizará en los atributos de la cuenta. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato name@domain.tld. El correo electrónico también debe coincidir con la producción de addr-spec de la RFC 822. Si la protección de enumeración de correo electrónico está habilitada, el usuario no puede cambiar el correo electrónico sin verificarlo primero, pero un administrador sí puede hacerlo.

password

string

La nueva contraseña del usuario que se actualizará en los atributos de la cuenta. La contraseña debe tener al menos 6 caracteres.

provider[]

string

Los proveedores de identidad con los que se debe asociar la cuenta.

oobCode

string

Es el código fuera de banda que se aplicará a la cuenta del usuario. Se admiten los siguientes tipos de códigos fuera de banda: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL

emailVerified

boolean

Indica si se verificó el correo electrónico del usuario. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados.

upgradeToFederatedLogin

boolean

Indica si la cuenta debe restringirse para usar solo el acceso federado.

captchaChallenge
(deprecated)

string

captchaResponse

string

La respuesta del desafío de reCAPTCHA. Esto es obligatorio cuando el sistema detecta posibles actividades de abuso.

validSince

string (int64 format)

Especifica la marca de tiempo mínima en segundos para que un token de ID de Identity Platform se considere válido.

disableUser

boolean

Si es verdadero, marca la cuenta como inhabilitada, lo que significa que el usuario ya no podrá acceder.

instanceId
(deprecated)

string

delegatedProjectNumber
(deprecated)

string (int64 format)

photoUrl

string

La nueva URL de foto del usuario para que se actualice la foto de perfil de la cuenta en sus atributos. La longitud de la URL debe ser inferior o igual a 2,048 caracteres.

deleteAttribute[]

enum (UserAttributeName)

returnSecureToken

boolean

Indica si se debe mostrar o no un ID y un token de actualización. Siempre debe ser verdadero.

deleteProvider[]

string

Los proveedores de identidad que se desvincularán de la cuenta del usuario

lastLoginAt

string (int64 format)

Es la marca de tiempo, en milisegundos, en la que se accedió a la cuenta por última vez.

createdAt

string (int64 format)

Es la marca de tiempo, en milisegundos, en la que se creó la cuenta.

phoneNumber

string

Es el número de teléfono que se actualizará en los atributos de la cuenta.

customAttributes

string

Atributos personalizados con formato JSON que se almacenarán en el token de ID de Identity Platform. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados.

tenantId

string

El ID de usuario del usuario de Identity Platform al que pertenece la cuenta. Las solicitudes de los usuarios finales deben pasar un token de ID de Identity Platform en lugar de configurar este campo.

targetProjectId

string

Es el ID del proyecto al que pertenece la cuenta. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados. En su lugar, las solicitudes de los usuarios finales deben pasar un token de ID de Identity Platform.

La autorización requiere el siguiente permiso IAM en el recurso especificado targetProjectId:

  • firebaseauth.users.update
mfa

object (MfaInfo)

Es la información relacionada con la autenticación de varios factores que se establecerá en la cuenta del usuario. Esta acción reemplazará cualquier información relacionada con la autenticación de varios factores que se haya ingresado anteriormente en la cuenta. Para especificar este campo, se requiere una credencial de OAuth 2.0 de Google con los permisos adecuados.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de SetAccountInfoResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Authentication Overview.