Esta página foi traduzida pela API Cloud Translation.

Method: accounts.signInWithEmailLink

Solicitação HTTP
Corpo da solicitação
- Representação JSON
Corpo da resposta
- Representação JSON
Escopos de autorização
Faça um teste

Faz login ou registra um usuário com um código externo usando um link de e-mail. Se não houver um usuário com esse endereço de e-mail, um registro de usuário será criado. Se o login for bem-sucedido, um ID do Identity Platform e um token de atualização serão emitidos para o usuário autenticado.

Uma chave de API é necessária na solicitação para identificar o projeto do Google Cloud.

Solicitação HTTP

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

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

Corpo da solicitação

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

Representação JSON
{ "oobCode": string, "email": string, "idToken": string, "tenantId": string }

Campos
`oobCode`	`string` Obrigatório. O código fora de banda do link do e-mail.
`email`	`string` Obrigatório. O endereço de e-mail para o qual o link de login foi enviado. 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.
`idToken`	`string` Um token de ID válido para uma conta do Identity Platform. Se for aprovado, essa solicitação vai vincular o endereço de e-mail ao usuário representado por esse token de ID e ativar o login com o link de e-mail na conta no futuro.
`tenantId`	`string` O ID do locatário do Identity Platform em que o usuário está fazendo login. Se não for definido, o usuário vai fazer login no projeto padrão do Identity Platform.

Corpo da resposta

Mensagem de resposta para accounts.signInWithEmailLink.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON

Representação JSON
{ "kind": string, "idToken": string, "email": string, "refreshToken": string, "expiresIn": string, "localId": string, "isNewUser": boolean, "mfaPendingCredential": string, "mfaInfo": [ { object (`MfaEnrollment`) } ] }

{
  "kind": string,
  "idToken": string,
  "email": string,
  "refreshToken": string,
  "expiresIn": string,
  "localId": string,
  "isNewUser": boolean,
  "mfaPendingCredential": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ]
}

Campos
`kind (deprecated)`	`string` Este item está obsoleto.
`idToken`	`string` Um token de ID do Identity Platform para o usuário autenticado.
`email`	`string` O e-mail usado para fazer login. Sempre presente na resposta.
`refreshToken`	`string` Token de atualização para o usuário autenticado.
`expiresIn`	`string (int64 format)` O número de segundos até o token de ID expirar.
`localId`	`string` O ID do usuário autenticado. Sempre presente na resposta.
`isNewUser`	`boolean` Informa se o usuário autenticado foi criado por essa solicitação.
`mfaPendingCredential`	`string` Uma string opaca que funciona como prova de que o usuário passou na verificação do primeiro fator.
`mfaInfo[]`	`object (MfaEnrollment)` Informações sobre quais provedores de autenticação multifator estão ativados. Apresente se o usuário precisar concluir o login usando a autenticação multifator.

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.