Diese Seite wurde von der Cloud Translation API übersetzt.

Method: projects.tenants.accounts.sendOobCode
Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

HTTP-Anfrage
Pfadparameter
Anfragetext
- JSON-Darstellung
Antworttext
Autorisierungsbereiche
Testen!

Es wird ein Out-of-Band-Bestätigungscode für ein Konto gesendet. Anfragen von einer authentifizierten Anfrage können optional einen Link mit dem OOB-Code zurückgeben, anstatt ihn zu senden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter

Parameter
`targetProjectId`	`string` Die Projekt-ID des Identity Platform-Projekts, zu dem das Konto gehört. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource `targetProjectId` erforderlich: `firebaseauth.users.sendEmail`
`tenantId`	`string` Die Mandanten-ID des Identity Platform-Mandaten, zu dem das Konto gehört.

targetProjectId

string

Die Projekt-ID des Identity Platform-Projekts, zu dem das Konto gehört. Für die Angabe dieses Felds sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource targetProjectId erforderlich:

firebaseauth.users.sendEmail

tenantId

string

Die Mandanten-ID des Identity Platform-Mandaten, zu dem das Konto gehört.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung

JSON-Darstellung
{ "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, "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,
  "dynamicLinkDomain": string,
  "returnOobLink": boolean,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion),
  "linkDomain": string
}

Felder
`requestType`	`enum (OobReqType)` Pflichtangabe. Der Typ des Out-of-Band-Codes (OOB), der gesendet werden soll. Je nach diesem Wert sind andere Felder in dieser Anfrage erforderlich und/oder haben eine andere Bedeutung. Es gibt vier verschiedene OOB-Codes, die gesendet werden können: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
`email`	`string` Die E-Mail-Adresse des Kontos, an die der Bestätigungscode gesendet werden soll, und in der Regel die E-Mail-Adresse des Kontos, das aktualisiert werden muss. Erforderlich für PASSWORD_RESET, EMAIL_SIGNIN und VERIFY_EMAIL. Nur für VERIFY_AND_CHANGE_EMAIL-Anfragen erforderlich, wenn „returnOobLink“ auf „true“ gesetzt ist. In diesem Fall ist es die ursprüngliche E-Mail-Adresse des Nutzers.
`challenge (deprecated)`	`string`
`captchaResp`	`string` Für eine PASSWORD_RESET-Anfrage ist eine reCAPTCHA-Antwort erforderlich, wenn das System mögliche Missbrauchsaktivitäten erkennt. In diesen Fällen ist dies die Antwort auf die reCAPTCHA-Abfrage, die zur Bestätigung des Aufrufers verwendet wird.
`userIp`	`string` Die IP-Adresse des Aufrufers. Nur für PASSWORD_RESET-Anfragen erforderlich.
`newEmail`	`string` Die E-Mail-Adresse, auf die das Konto aktualisiert wird. Nur für VERIFY_AND_CHANGE_EMAIL-Anfragen erforderlich.
`idToken`	`string` Ein ID-Token für das Konto. Er ist für VERIFY_AND_CHANGE_EMAIL- und VERIFY_EMAIL-Anfragen erforderlich, es sei denn, returnOobLink ist auf „true“ gesetzt.
`continueUrl`	`string` Die URL, unter der fortgefahren wird, nachdem der Nutzer auf den in der E-Mail gesendeten Link geklickt hat. Über diese URL kann das Web-Widget den OOB-Code verarbeiten.
`iOSBundleId`	`string` Wenn eine zugehörige iOS-App den OOB-Code verarbeiten kann, die iOS-Bundle-ID dieser App. Dadurch kann die richtige App geöffnet werden, wenn sie bereits installiert ist.
`iOSAppStoreId`	`string` Wenn eine verknüpfte iOS-App den OOB-Code verarbeiten kann, die App Store-ID dieser App. Dadurch wird der App Store mit der richtigen App geöffnet, wenn die App noch nicht installiert ist.
`androidPackageName`	`string` Wenn eine verknüpfte Android-App den OOB-Code verarbeiten kann, der Name des Android-Pakets der Android-App, die den Rückruf verarbeitet, wenn dieser OOB-Code verwendet wird. Dadurch wird die richtige App geöffnet, wenn sie bereits installiert ist, oder der Google Play Store wird mit der richtigen App geöffnet, wenn sie noch nicht installiert ist.
`androidInstallApp`	`boolean` Wenn eine verknüpfte Android-App den OOB-Code verarbeiten kann, wird festgelegt, ob die Android-App auf dem Gerät installiert werden soll, auf dem der Link geöffnet wird, falls die App noch nicht installiert ist.
`androidMinimumVersion`	`string` Wenn eine verknüpfte Android-App den OOB-Code verarbeiten kann, die Mindestversion der App. Wenn die Version auf dem Gerät niedriger ist als diese Version, wird der Nutzer zum Google Play Store weitergeleitet, um die App zu aktualisieren.
`canHandleCodeInApp`	`boolean` Wenn diese Option auf „true“ festgelegt ist, wird der Link zum OOB-Code als universeller Link oder als Android-App-Link gesendet und von der entsprechenden App geöffnet, sofern sie installiert ist. Wenn die Option nicht festgelegt oder auf „false“ gesetzt ist, wird der OOB-Code zuerst an das Web-Widget gesendet und dann bei „Continue“ (Weiter) zur App weitergeleitet, sofern diese installiert ist.
`dynamicLinkDomain`	`string` Damit die verwendete URL unter iOS oder Android problemlos geöffnet werden kann, erstellen wir einen Dynamic Link von Firebase. Bei den meisten Identity Platform-Projekten ist nur eine Dynamic Link-Domain aktiviert. Dieses Feld kann also leer bleiben. Dieses Feld enthält eine angegebene Dynamic Link-Domain für Projekte, für die mehrere aktiviert sind.
`returnOobLink`	`boolean` Gibt an, ob der Bestätigungslink mit dem OOB-Code in der Antwort zurückgegeben werden soll (keine E-Mail wird gesendet). Wird verwendet, wenn ein Entwickler die E-Mail-Vorlage selbst erstellen und senden möchte. Standardmäßig ist dies „falsch“. Wenn Sie dieses Feld angeben und auf „wahr“ setzen möchten, sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich.
`clientType`	`enum (ClientType)` Der Clienttyp: Web, Android oder iOS. Erforderlich, wenn der reCAPTCHA Enterprise-Schutz aktiviert ist.
`recaptchaVersion`	`enum (RecaptchaVersion)` Die reCAPTCHA-Version des reCAPTCHA-Tokens in der captchaResponse.
`linkDomain`	`string` Optional. Damit die verwendete URL unter iOS oder Android problemlos geöffnet werden kann, erstellen wir einen Hosting-Link „/__/auth/links“. Dieses optionale Feld enthält die Domain, die beim Erstellen eines Hosting-Links verwendet werden soll. Wenn Sie diese Option nicht festlegen, wird die Domain .firebaseapp.com verwendet.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von GetOobCodeResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

Method: projects.tenants.accounts.sendOobCode Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.