Method: accounts.sendOobCode

Envoie un code de confirmation hors bande pour un compte. Les requêtes d'une requête authentifiée peuvent éventuellement renvoyer un lien incluant le code hors bande au lieu de l'envoyer.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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
}
Champs
requestType

enum (OobReqType)

Obligatoire. Type de code hors bande (OOB) à envoyer. En fonction de cette valeur, d'autres champs de cette requête seront obligatoires et/ou auront une signification différente. Quatre codes hors connexion différents peuvent être envoyés: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
email

string

Adresse e-mail du compte à laquelle envoyer le code hors connexion, généralement l'adresse e-mail du compte à mettre à jour. Obligatoire pour PASSWORD_RESET, EMAIL_SIGNIN et VERIFY_EMAIL. Obligatoire uniquement pour les requêtes VERIFY_AND_CHANGE_EMAIL lorsque returnOobLink est défini sur "true". Dans ce cas, il s'agit de l'adresse e-mail d'origine de l'utilisateur.
challenge
(deprecated)

string
captchaResp

string

Pour une requête PASSWORD_RESET, une réponse reCaptcha est requise lorsque le système détecte une activité suspecte. Dans ce cas, il s'agit de la réponse du défi reCaptcha utilisé pour valider l'appelant.
userIp

string

Adresse IP de l'appelant Obligatoire uniquement pour les requêtes PASSWORD_RESET.
newEmail

string

Adresse e-mail à laquelle le compte est mis à jour. Obligatoire uniquement pour les requêtes VERIFY_AND_CHANGE_EMAIL.
idToken

string

Jeton d'ID du compte. Il est obligatoire pour les requêtes VERIFY_AND_CHANGE_EMAIL et VERIFY_EMAIL, sauf si returnOobLink est défini sur "true".
continueUrl

string

URL à suivre après que l'utilisateur a cliqué sur le lien envoyé par e-mail. Il s'agit de l'URL qui permettra au widget Web de gérer le code OOB.
iOSBundleId

string

Si une application iOS associée peut gérer le code hors bande, l'ID de bundle iOS de cette application. Cela permet d'ouvrir l'application appropriée si elle est déjà installée.
iOSAppStoreId

string

Si une application iOS associée peut gérer le code hors bande, l'ID de l'App Store de cette application. Cela permettra à l'App Store de s'ouvrir sur la bonne application si elle n'est pas encore installée.
androidPackageName

string

Si une application Android associée peut gérer le code hors bande, nom du package Android de l'application Android qui gérera le rappel lorsque ce code hors bande sera utilisé. L'application appropriée s'ouvrira si elle est déjà installée, ou le Google Play Store s'ouvrira sur l'application appropriée si elle ne l'est pas encore.
androidInstallApp

boolean

Si une application Android associée peut gérer le code hors bande, indique si l'application Android doit être installée ou non sur l'appareil où le lien est ouvert si elle n'est pas déjà installée.
androidMinimumVersion

string

Si une application Android associée peut gérer le code hors bande, la version minimale de l'application. Si la version installée sur l'appareil est inférieure à cette version, l'utilisateur est redirigé vers le Google Play Store pour mettre à niveau l'application.
canHandleCodeInApp

boolean

Si cette valeur est définie sur "true", le lien du code hors connexion sera envoyé en tant que lien universel ou Android App Link, et sera ouvert par l'application correspondante si elle est installée. Si ce paramètre n'est pas défini ou est défini sur "false", le code hors bande est d'abord envoyé au widget Web, puis, si l'application est installée, l'utilisateur est redirigé vers celle-ci.
tenantId

string

ID du locataire Identity Platform auquel le compte appartient.
targetProjectId

string

ID du projet Identity Platform auquel le compte appartient. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

L'autorisation IAM suivante est requise pour la ressource targetProjectId indiquée :

  • firebaseauth.users.sendEmail
clientType

enum (ClientType)

Type de client: Web, Android ou iOS Obligatoire lorsque la protection reCAPTCHA Enterprise est activée.
recaptchaVersion

enum (RecaptchaVersion)

Version reCAPTCHA du jeton reCAPTCHA dans captchaResponse.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de GetOobCodeResponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Authentication Overview.