Method: projects.accounts.sendOobCode

Envia um código de confirmação externo para uma conta. As solicitações de uma solicitação autenticada podem retornar um link com o código OOB em vez de o enviar.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
targetProjectId

string

O ID do projeto do Identity Platform ao qual a conta pertence. Para especificar esse campo, é necessária uma credencial do Google OAuth 2.0 com as permissões adequadas.

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

  • firebaseauth.users.sendEmail

Corpo da solicitação

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

Representação JSON 
{
  "requestType": enum (OobReqType),
  "email": string,
  "challenge": string,
  "captchaResp": string,
  "userIp": string,
  "newEmail": string,
  "idToken": string,
  "continueUrl": string,
  "iOSBundleId": string,
  "iOSAppStoreId": string,
  "androidPackageName": string,
  "androidInstallApp": boolean,
  "androidMinimumVersion": string,
  "canHandleCodeInApp": boolean,
  "tenantId": string,
  "dynamicLinkDomain": string,
  "returnOobLink": boolean,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion),
  "linkDomain": string
}
Campos
requestType

enum (OobReqType)

Obrigatório. O tipo de código fora da banda (OOB) a ser enviado. Dependendo desse valor, outros campos da solicitação serão obrigatórios e/ou terão significados diferentes. Há quatro códigos OOB diferentes que podem ser enviados: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
email

string

O endereço de e-mail da conta para onde o código OOB será enviado e, geralmente, o endereço de e-mail da conta que precisa ser atualizado. Obrigatório para PASSWORD_RESET, EMAIL_SIGNIN e VERIFY_EMAIL. Só é necessário para solicitações VERIFY_AND_CHANGE_EMAIL quando returnOobLink é definido como verdadeiro. Nesse caso, é o e-mail original do usuário.
challenge
(deprecated)

string
captchaResp

string

Para uma solicitação PASSWORD_RESET, uma resposta do reCaptcha é necessária quando o sistema detecta uma possível atividade de abuso. Nesses casos, essa é a resposta do desafio reCaptcha usado para verificar o autor da chamada.
userIp

string

O endereço IP do autor da chamada. Obrigatório apenas para solicitações PASSWORD_RESET.
newEmail

string

O endereço de e-mail para o qual a conta está sendo atualizada. Obrigatório apenas para solicitações VERIFY_AND_CHANGE_EMAIL.
idToken

string

Um token de ID para a conta. Ele é necessário para solicitações VERIFY_AND_CHANGE_EMAIL e VERIFY_EMAIL, a menos que returnOobLink seja definido como verdadeiro.
continueUrl

string

O URL para continuar depois que o usuário clicar no link enviado por e-mail. Esse é o URL que permite que o widget da Web processe o código OOB.
iOSBundleId

string

Se um app iOS associado puder processar o código OOB, o ID do pacote iOS desse app. Isso permitirá que o app correto seja aberto se já estiver instalado.
iOSAppStoreId

string

Se um app iOS associado puder processar o código OOB, o ID da App Store desse app. Isso permitirá que a App Store abra o app correto se ele ainda não estiver instalado.
androidPackageName

string

Se um app Android associado puder processar o código OOB, o nome do pacote do app Android que vai processar o callback quando esse código OOB for usado. Isso vai permitir que o app correto seja aberto se já estiver instalado ou que a Google Play Store abra o app correto se ele ainda não estiver instalado.
androidInstallApp

boolean

Se um app Android associado puder processar o código OOB, ele vai decidir se vai instalar ou não o app Android no dispositivo em que o link é aberto, caso ele ainda não esteja instalado.
androidMinimumVersion

string

Se um app Android associado puder processar o código OOB, a versão mínima do app. Se a versão no dispositivo for anterior a essa versão, o usuário será direcionado para a Google Play Store para atualizar o app.
canHandleCodeInApp

boolean

Quando definido como "verdadeiro", o link do código OOB será enviado como um link universal ou um link do app Android e será aberto pelo app correspondente, se instalado. Se não for definido ou for definido como "false", o código OOB será enviado primeiro ao widget da Web e, em seguida, redirecionado para o app, se instalado.
tenantId

string

O ID do locatário do Identity Platform ao qual a conta pertence.
clientType

enum (ClientType)

O tipo de cliente: Web, Android ou iOS. Obrigatório quando a proteção do reCAPTCHA Enterprise está ativada.
recaptchaVersion

enum (RecaptchaVersion)

A versão do reCAPTCHA do token reCAPTCHA no captchaResponse.

Corpo da resposta

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

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.