Method: projects.accounts.sendOobCode

Envia um código de confirmação fora de banda para uma conta. As solicitações de uma solicitação autenticada podem retornar opcionalmente um link incluindo o código OOB em vez de enviá-lo.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
targetProjectId

string

O ID do projeto do projeto Identity Platform ao qual a conta pertence. Para especificar este campo, é necessária uma credencial 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

Solicitar corpo

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 de banda (OOB) a ser enviado. Dependendo deste valor, outros campos desta solicitação serão obrigatórios e/ou terão significados diferentes. Existem 4 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 a qual enviar o código OOB e, geralmente, o endereço de e-mail da conta que precisa ser atualizada. Obrigatório para PASSWORD_RESET, EMAIL_SIGNIN e VERIFY_EMAIL. Necessário apenas para solicitações VERIFY_AND_CHANGE_EMAIL quando returnOobLink está definido como verdadeiro. Neste caso, é o email original do usuário.

challenge
(deprecated)

string

captchaResp

string

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

userIp

string

O endereço IP do chamador. 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. É necessário para solicitações VERIFY_AND_CHANGE_EMAIL e VERIFY_EMAIL, a menos que returnOobLink esteja definido como true.

continueUrl

string

O URL para continuar após o usuário clicar no link enviado por e-mail. Este é o URL que permitirá ao widget da web lidar com o código OOB.

iOSBundleId

string

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

iOSAppStoreId

string

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

androidPackageName

string

Se um aplicativo Android associado puder manipular o código OOB, o nome do pacote Android do aplicativo Android que manipulará o retorno de chamada quando esse código OOB for usado. Isso permitirá que o aplicativo correto seja aberto, se já estiver instalado, ou permitirá que a Google Play Store abra o aplicativo correto, se ainda não estiver instalado.

androidInstallApp

boolean

Se um aplicativo Android associado puder lidar com o código OOB, instale ou não o aplicativo Android no dispositivo onde o link está aberto, se o aplicativo ainda não estiver instalado.

androidMinimumVersion

string

Se um aplicativo Android associado puder lidar com o código OOB, a versão mínima do aplicativo. Se a versão do dispositivo for inferior a esta versão, o usuário será direcionado à Google Play Store para atualizar o aplicativo.

canHandleCodeInApp

boolean

Quando definido como verdadeiro, o link do código OOB será enviado como um link universal ou um link de aplicativo Android e será aberto pelo aplicativo correspondente, se instalado. Se não for definido ou definido como falso, o código OOB será enviado primeiro ao widget da web e, em seguida, continuará redirecionando para o aplicativo, 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 reCAPTCHA Enterprise está habilitada.

recaptchaVersion

enum ( RecaptchaVersion )

A versão reCAPTCHA do token reCAPTCHA no captchaResponse.

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de GetOobCodeResponse .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte oAuthentication Overview .