Method: accounts.sendOobCode

Envía un código de confirmación fuera de banda para una cuenta. Las solicitudes de una solicitud autenticada pueden, opcionalmente, devolver un enlace que incluya el código OOB en lugar de enviarlo.

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Cuerpo de la solicitud

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

Representación 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,
  "targetProjectId": string,
  "dynamicLinkDomain": string,
  "returnOobLink": boolean,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion),
  "linkDomain": string
}
Campos
requestType

enum ( OobReqType )

Requerido. El tipo de código fuera de banda (OOB) que se enviará. Dependiendo de este valor, otros campos de esta solicitud serán obligatorios y/o tendrán significados diferentes. Hay 4 códigos OOB diferentes que se pueden enviar: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL

email

string

La dirección de correo electrónico de la cuenta a la que enviar el código OOB y, en general, la dirección de correo electrónico de la cuenta que debe actualizarse. Requerido para PASSWORD_RESET, EMAIL_SIGNIN y VERIFY_EMAIL. Solo se requiere para solicitudes VERIFY_AND_CHANGE_EMAIL cuando returnOobLink está establecido en verdadero. En este caso, se trata del correo electrónico original del usuario.

challenge
(deprecated)

string

captchaResp

string

Para una solicitud PASSWORD_RESET, se requiere una respuesta reCaptcha cuando el sistema detecta una posible actividad de abuso. En esos casos, esta es la respuesta del desafío reCaptcha utilizado para verificar a la persona que llama.

userIp

string

La dirección IP de la persona que llama. Requerido solo para solicitudes PASSWORD_RESET.

newEmail

string

La dirección de correo electrónico a la que se actualiza la cuenta. Requerido solo para solicitudes VERIFY_AND_CHANGE_EMAIL.

idToken

string

Un token de identificación para la cuenta. Es necesario para las solicitudes VERIFY_AND_CHANGE_EMAIL y VERIFY_EMAIL a menos que returnOobLink esté establecido en verdadero.

continueUrl

string

La URL para continuar después de que el usuario haga clic en el enlace enviado por correo electrónico. Esta es la URL que permitirá que el widget web maneje el código OOB.

iOSBundleId

string

Si una aplicación de iOS asociada puede manejar el código OOB, la identificación del paquete de iOS de esta aplicación. Esto permitirá que se abra la aplicación correcta si ya está instalada.

iOSAppStoreId

string

Si una aplicación de iOS asociada puede manejar el código OOB, la identificación de la App Store de esta aplicación. Esto permitirá que App Store se abra en la aplicación correcta si ésta aún no está instalada.

androidPackageName

string

Si una aplicación de Android asociada puede manejar el código OOB, el nombre del paquete de Android de la aplicación de Android que manejará la devolución de llamada cuando se use este código OOB. Esto permitirá que se abra la aplicación correcta si ya está instalada, o permitirá que Google Play Store se abra en la aplicación correcta si aún no está instalada.

androidInstallApp

boolean

Si una aplicación de Android asociada puede manejar el código OOB, si se debe instalar o no la aplicación de Android en el dispositivo donde se abre el enlace si la aplicación aún no está instalada.

androidMinimumVersion

string

Si una aplicación de Android asociada puede manejar el código OOB, la versión mínima de la aplicación. Si la versión del dispositivo es inferior a esta versión, el usuario será llevado a Google Play Store para actualizar la aplicación.

canHandleCodeInApp

boolean

Cuando se establece en verdadero, el enlace del código OOB se enviará como un enlace universal o un enlace de aplicación de Android y lo abrirá la aplicación correspondiente, si está instalada. Si no se establece, o se establece en falso, el código OOB se enviará primero al widget web y luego, al continuar, se redireccionará a la aplicación si está instalada.

tenantId

string

El ID de inquilino del inquilino de Identity Platform al que pertenece la cuenta.

targetProjectId

string

El ID del proyecto de Identity Platform al que pertenece la cuenta. Para especificar este campo, se requiere una credencial Google OAuth 2.0 con los permisos adecuados.

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

  • firebaseauth.users.sendEmail
clientType

enum ( ClientType )

El tipo de cliente: web, Android o iOS. Requerido cuando la protección reCAPTCHA Enterprise está habilitada.

recaptchaVersion

enum ( RecaptchaVersion )

La versión reCAPTCHA del token reCAPTCHA en captchaResponse.

Cuerpo de respuesta

Si tiene éxito, el cuerpo de la respuesta contiene una instancia de GetOobCodeResponse .

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

Para obtener más información, consulte laAuthentication Overview .