Method: projects.accounts.update

Atualiza as informações relacionadas à conta do usuário especificado definindo campos específicos ou aplicando códigos de ação. As solicitações de administradores e usuários finais são aceitas.

Solicitação HTTP

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/accounts:update

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
targetProjectId

string

O ID do projeto ao qual a conta pertence. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas. As solicitações de usuários finais precisam transmitir um token de ID do Identity Platform.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

  • firebaseauth.users.update

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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,
  "mfa": {
    object (MfaInfo)
  },
  "linkProviderUserInfo": {
    object (ProviderUserInfo)
  }
}
Campos
idToken

string

Um token de ID do Identity Platform válido. Obrigatório ao tentar mudar informações relacionadas ao usuário.
localId

string

O ID do usuário. A especificação desse campo requer uma credencial do Google OAuth 2.0 com as permissões adequadas. Para solicitações de usuários finais, um token de ID precisa ser transmitido.
displayName

string

O novo nome de exibição do usuário a ser atualizado nos atributos da conta. O nome de exibição precisa ter menos de 256 caracteres.
email

string

O novo e-mail do usuário que será atualizado nos atributos da conta. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder à produção de addr-spec do RFC 822. Se a proteção contra enumeração de e-mails estiver ativada, o usuário não poderá mudar o e-mail sem verificar o endereço primeiro, mas um administrador poderá fazer isso.
password

string

A nova senha do usuário para ser atualizada nos atributos da conta. A senha precisa ter pelo menos seis caracteres.
provider[]

string

Os provedores de identidade aos quais a conta precisa estar associada.
oobCode

string

O código fora da banda que será aplicado na conta do usuário. Os seguintes tipos de código fora da banda são aceitos: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL
emailVerified

boolean

Indica se o e-mail do usuário foi verificado. A especificação desse campo requer uma credencial do Google OAuth 2.0 com as permissões adequadas.
upgradeToFederatedLogin

boolean

Se a conta precisa ser restrita ao uso apenas do login federado.
captchaChallenge
(deprecated)

string
captchaResponse

string

A resposta do teste reCAPTCHA. Isso é necessário quando o sistema detecta possíveis atividades de abuso.
validSince

string (int64 format)

Especifica o carimbo de data/hora mínimo em segundos para que um token de ID do Identity Platform seja considerado válido.
disableUser

boolean

Se for verdadeiro, marca a conta como desativada, o que significa que o usuário não poderá mais fazer login.
instanceId
(deprecated)

string
delegatedProjectNumber
(deprecated)

string (int64 format)
photoUrl

string

O novo URL da foto do usuário para a foto do perfil da conta ser atualizada nos atributos da conta. O URL precisa ter menos de 2.048 caracteres.
deleteAttribute[]

enum (UserAttributeName)
returnSecureToken

boolean

Indica se é necessário retornar um ID e atualizar o token. Precisa ser sempre verdadeiro.
deleteProvider[]

string

Os provedores de identidade a serem desvinculados da conta do usuário.
lastLoginAt

string (int64 format)

O carimbo de data/hora em milissegundos da última vez que a conta fez login.
createdAt

string (int64 format)

O carimbo de data/hora em milissegundos em que a conta foi criada.
phoneNumber

string

O número de telefone que será atualizado nos atributos da conta.
customAttributes

string

Atributos personalizados formatados em JSON para serem armazenados no token de ID do Identity Platform. A especificação desse campo requer uma credencial do Google OAuth 2.0 com as permissões adequadas.
tenantId

string

O ID do locatário do Identity Platform a que a conta pertence. As solicitações de usuários finais precisam transmitir um token de ID do Identity Platform em vez de definir esse campo.
mfa

object (MfaInfo)

As informações relacionadas à autenticação multifator que serão definidas na conta do usuário. Isso vai substituir todas as informações anteriores relacionadas à autenticação multifator na conta. A especificação desse campo requer uma credencial do Google OAuth 2.0 com as permissões adequadas.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de SetAccountInfoResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.