Se usó la API de Cloud Translation para traducir esta página.

Method: accounts.sendOobCode
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Solicitud HTTP
Cuerpo de la solicitud
- Representación JSON
Cuerpo de la respuesta
Alcances de autorización
Pruébalo

Envía un código de confirmación fuera de banda para una cuenta. De manera opcional, las solicitudes de una solicitud autenticada pueden mostrar un vínculo que incluya el código fuera del alcance en lugar de enviarlo.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

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

Representación JSON

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 }

{
  "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)` Obligatorio. Es el tipo de código fuera de banda (OOB) que se enviará. Según este valor, otros campos de esta solicitud serán obligatorios o tendrán diferentes significados. Existen 4 códigos fuera del servicio 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 se enviará el código fuera del dispositivo y, por lo general, la dirección de correo electrónico de la cuenta que se debe actualizar. Obligatorio para PASSWORD_RESET, EMAIL_SIGNIN y VERIFY_EMAIL. Solo es obligatorio para las solicitudes VERIFY_AND_CHANGE_EMAIL cuando returnOobLink se establece en verdadero. En este caso, es el correo electrónico original del usuario.
`challenge (deprecated)`	`string`
`captchaResp`	`string` Para una solicitud de PASSWORD_RESET, se requiere una respuesta de reCAPTCHA cuando el sistema detecta una posible actividad de abuso. En esos casos, esta es la respuesta del desafío de reCAPTCHA que se usa para verificar al llamador.
`userIp`	`string` La dirección IP del emisor de la llamada. Solo es obligatorio para las solicitudes de PASSWORD_RESET.
`newEmail`	`string` La dirección de correo electrónico a la que se actualizará la cuenta. Solo es obligatorio para las solicitudes de VERIFY_AND_CHANGE_EMAIL.
`idToken`	`string` Un token de ID para la cuenta. Es obligatorio para las solicitudes VERIFY_AND_CHANGE_EMAIL y VERIFY_EMAIL, a menos que returnOobLink esté configurado como verdadero.
`continueUrl`	`string` Es la URL para continuar después de que el usuario hace clic en el vínculo que se envió por correo electrónico. Esta es la URL que permitirá que el widget web controle el código fuera del alcance.
`iOSBundleId`	`string` Si una app para iOS asociada puede controlar el código fuera del alcance, el ID del paquete de iOS de esta app. Esto permitirá que se abra la app correcta si ya está instalada.
`iOSAppStoreId`	`string` Si una app para iOS asociada puede controlar el código fuera del alcance, el ID de App Store de esta app. Esto permitirá que App Store abra la app correcta si aún no está instalada.
`androidPackageName`	`string` Si una app para Android asociada puede controlar el código fuera del alcance, el nombre del paquete de Android de la app para Android que controlará la devolución de llamada cuando se use este código fuera del alcance. Esto permitirá que se abra la app correcta si ya está instalada o que Google Play Store abra la app correcta si aún no está instalada.
`androidInstallApp`	`boolean` Si una app para Android asociada puede controlar el código fuera del alcance, si se debe instalar o no la app para Android en el dispositivo en el que se abre el vínculo si aún no está instalada.
`androidMinimumVersion`	`string` Si una app para Android asociada puede controlar el código fuera del alcance, la versión mínima de la app. Si la versión del dispositivo es inferior a esta, se dirige al usuario a Google Play Store para que actualice la app.
`canHandleCodeInApp`	`boolean` Cuando se establece como verdadero, el vínculo del código fuera del alcance se envía como vínculo universal o vínculo de app para Android, y la app correspondiente lo abrirá si está instalada. Si no se establece o se establece como falso, el código fuera del alcance se enviará primero al widget web y, luego, se redireccionará a la app, si está instalada.
`tenantId`	`string` El ID del usuario 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 de OAuth 2.0 de Google con los permisos adecuados. La autorización requiere el siguiente permiso IAM en el recurso especificado `targetProjectId`: `firebaseauth.users.sendEmail`
`dynamicLinkDomain`	`string` Para garantizar que la URL que se usa se pueda abrir fácilmente en iOS o Android, creamos un vínculo dinámico de Firebase. La mayoría de los proyectos de Identity Platform solo tendrán habilitado un dominio de vínculo dinámico y pueden dejar este campo en blanco. Este campo contiene un dominio de Dynamic Links especificado para los proyectos que tienen varios habilitados.
`returnOobLink`	`boolean` Indica si se debe mostrar el vínculo de confirmación que contiene el código fuera del alcance en la respuesta (no se envía ningún correo electrónico). Se usa cuando un desarrollador quiere crear la plantilla de correo electrónico y enviarla por su cuenta. De forma predeterminada, este valor es falso. Para especificar este campo y establecerlo como verdadero, se requiere una credencial de Google OAuth 2.0 con los permisos adecuados.
`clientType`	`enum (ClientType)` El tipo de cliente: Web, Android o iOS Obligatorio cuando la protección de reCAPTCHA Enterprise está habilitada.
`recaptchaVersion`	`enum (RecaptchaVersion)` La versión de reCAPTCHA del token de reCAPTCHA en captchaResponse.
`linkDomain`	`string` Opcional. Para garantizar que la URL que se usa se pueda abrir fácilmente en iOS o Android, creamos un vínculo de Hosting "/__/auth/links". Este campo opcional contiene el dominio que se usará cuando se construya un vínculo de Hosting. Si no se establece, se usará el dominio ".firebaseapp.com".

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de GetOobCodeResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Method: accounts.sendOobCode Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Solicitud HTTP

Cuerpo de la solicitud

Cuerpo de la respuesta

Alcances de autorización

Method: accounts.sendOobCode
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.