Questa pagina è stata tradotta dall'API Cloud Translation.

Method: projects.accounts.sendOobCode

Richiesta HTTP
Parametri del percorso
Corpo della richiesta
- Rappresentazione JSON
Corpo della risposta
Ambiti di autorizzazione
Prova!

Invia un codice di conferma fuori banda per un account. Le richieste di una richiesta autenticata possono, facoltativamente, restituire un link che include il codice OOB anziché inviarlo.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri

Parametri
`targetProjectId`	`string` L'ID progetto del progetto Identity Platform a cui appartiene l'account. Per specificare questo campo, è necessaria una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata `targetProjectId`: `firebaseauth.users.sendEmail`

targetProjectId

string

L'ID progetto del progetto Identity Platform a cui appartiene l'account. Per specificare questo campo, è necessaria una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate.

L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata targetProjectId:

firebaseauth.users.sendEmail

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON

Rappresentazione 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 }

{
  "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
}

Campi
`requestType`	`enum (OobReqType)` Obbligatorio. Il tipo di codice out-of-band (OOB) da inviare. A seconda di questo valore, altri campi di questa richiesta saranno obbligatori e/o avranno significati diversi. Esistono 4 diversi codici OOB che possono essere inviati: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
`email`	`string` L'indirizzo email dell'account a cui inviare il codice OOB e in genere l'indirizzo email dell'account da aggiornare. Obbligatorio per PASSWORD_RESET, EMAIL_SIGNIN e VERIFY_EMAIL. Obbligatorio solo per le richieste VERIFY_AND_CHANGE_EMAIL quando returnOobLink è impostato su true. In questo caso, si tratta dell'indirizzo email originale dell'utente.
`challenge (deprecated)`	`string`
`captchaResp`	`string` Per una richiesta PASSWORD_RESET, è necessaria una risposta reCaptcha quando il sistema rileva possibili attività di abuso. In questi casi, si tratta della risposta alla verifica reCaptcha utilizzata per verificare chi chiama.
`userIp`	`string` L'indirizzo IP del chiamante. Obbligatorio solo per le richieste PASSWORD_RESET.
`newEmail`	`string` L'indirizzo email a cui viene aggiornato l'account. Obbligatorio solo per le richieste VERIFY_AND_CHANGE_EMAIL.
`idToken`	`string` Un token ID per l'account. È obbligatorio per le richieste VERIFY_AND_CHANGE_EMAIL e VERIFY_EMAIL, a meno che returnOobLink non sia impostato su true.
`continueUrl`	`string` L'URL per continuare dopo che l'utente fa clic sul link inviato via email. Questo è l'URL che consentirà al widget web di gestire il codice OOB.
`iOSBundleId`	`string` Se un'app per iOS associata può gestire il codice OOB, l'ID pacchetto iOS di questa app. In questo modo, l'app corretta verrà aperta se è già installata.
`iOSAppStoreId`	`string` Se un'app iOS associata può gestire il codice OOB, l'ID App Store di questa app. In questo modo, l'App Store aprirà l'app corretta se non è ancora installata.
`androidPackageName`	`string` Se un'app per Android associata può gestire il codice OOB, il nome del pacchetto Android dell'app per Android che gestirà il callback quando viene utilizzato questo codice OOB. In questo modo, l'app corretta verrà aperta se è già installata oppure Google Play Store aprirà l'app corretta se non è ancora installata.
`androidInstallApp`	`boolean` Se un'app per Android associata può gestire il codice OOB, se installare o meno l'app per Android sul dispositivo in cui viene aperto il link se l'app non è già installata.
`androidMinimumVersion`	`string` Se un'app Android associata può gestire il codice OOB, la versione minima dell'app. Se la versione sul dispositivo è precedente a questa, l'utente viene indirizzato al Google Play Store per eseguire l'upgrade dell'app.
`canHandleCodeInApp`	`boolean` Se impostato su True, il link al codice OOB verrà inviato come link universale o link all'app per Android e verrà aperto dall'app corrispondente, se installata. Se non è impostato o se è impostato su false, il codice OOB verrà inviato prima al widget web e poi al continuare verrà reindirizzato all'app, se installata.
`tenantId`	`string` L'ID del tenant di Identity Platform a cui appartiene l'account.
`dynamicLinkDomain`	`string` Per assicurarci che l'URL utilizzato possa essere aperto facilmente su iOS o Android, creiamo un link dinamico Firebase. La maggior parte dei progetti Identity Platform avrà un solo dominio di collegamento dinamico abilitato e può lasciare vuoto questo campo. Questo campo contiene un dominio Dynamic Link specificato per i progetti in cui sono attivati più domini.
`returnOobLink`	`boolean` Indica se il link di conferma contenente il codice OOB deve essere restituito nella risposta (non viene inviata alcuna email). Viene utilizzato quando uno sviluppatore vuole creare il modello email e inviarlo autonomamente. Per impostazione predefinita, questo valore è false. Per specificare questo campo e impostarlo su true, è necessaria una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate.
`clientType`	`enum (ClientType)` Il tipo di client: web, Android o iOS. Obbligatorio se la protezione reCAPTCHA Enterprise è attivata.
`recaptchaVersion`	`enum (RecaptchaVersion)` La versione reCAPTCHA del token reCAPTCHA in captchaResponse.
`linkDomain`	`string` Facoltativo. Per assicurarci che l'URL utilizzato possa essere aperto facilmente su iOS o Android, creiamo un link di hosting "/__/auth/links". Questo campo facoltativo contiene il dominio da utilizzare per la creazione di un link di hosting. Se non viene impostato, verrà utilizzato il dominio ".firebaseapp.com".

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di GetOobCodeResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la sezione Authentication Overview.