BaseAuth class

Interfaccia principale comune per le API Auth e TenantAwareAuth .

Firma:

export declare abstract class BaseAuth 

Metodi

BaseAuth.createCustomToken()

Crea un nuovo token personalizzato Firebase (JWT) che può essere inviato a un dispositivo client da utilizzare per accedere con i metodi signInWithCustomToken() degli SDK client. (Le istanze in grado di riconoscere il tenant incorporeranno anche l'ID del tenant nel token.)

Vedi Creare token personalizzati per esempi di codice e documentazione dettagliata.

Firma:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

Parametri

Ritorna:

Promesso<string>

Una promessa mantenuta con un token personalizzato per l' uid e il payload forniti.

BaseAuth.createProviderConfig()

Restituisce una promessa che si risolve con AuthProviderConfig appena creato quando viene creata la nuova configurazione del provider.

Il supporto dei provider SAML e OIDC richiede la piattaforma Identity di Google Cloud (GCIP). Per ulteriori informazioni su GCIP, inclusi prezzi e funzionalità, consulta la documentazione GCIP .

Firma:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

Parametri

Ritorna:

Promessa< AuthProviderConfig >

Una promessa che si risolve con la configurazione del provider creata.

BaseAuth.createSessionCookie()

Crea un nuovo cookie di sessione Firebase con le opzioni specificate. La stringa JWT creata può essere impostata come cookie di sessione lato server con una politica sui cookie personalizzata ed essere utilizzata per la gestione della sessione. Il cookie di sessione JWT avrà le stesse richieste di carico utile del token ID fornito.

Consulta Gestire i cookie di sessione per esempi di codice e documentazione dettagliata.

Firma:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

Parametri

Ritorna:

Promesso<string>

Una promessa che si risolve in successo con il cookie di sessione creato.

BaseAuth.createUser()

Crea un nuovo utente.

Vedi Creare un utente per esempi di codice e documentazione dettagliata.

Firma:

createUser(properties: CreateRequest): Promise<UserRecord>;

Parametri

Ritorna:

Promessa< Record utente >

Una promessa mantenuta con i dati utente corrispondenti all'utente appena creato.

BaseAuth.deleteProviderConfig()

Elimina la configurazione del provider corrispondente all'ID provider passato. Se l'ID specificato non esiste, viene generato un errore auth/configuration-not-found .

Il supporto dei provider SAML e OIDC richiede la piattaforma Identity di Google Cloud (GCIP). Per ulteriori informazioni su GCIP, inclusi prezzi e funzionalità, consulta la documentazione GCIP .

Firma:

deleteProviderConfig(providerId: string): Promise<void>;

Parametri

Ritorna:

Promesso<vuoto>

Una promessa che si risolve una volta completata.

BaseAuth.deleteUser()

Elimina un utente esistente.

Vedi Eliminare un utente per esempi di codice e documentazione dettagliata.

Firma:

deleteUser(uid: string): Promise<void>;

Parametri

Ritorna:

Promesso<vuoto>

Una promessa vuota mantenuta una volta che l'utente è stato eliminato.

BaseAuth.deleteUsers()

Elimina gli utenti specificati dagli uid specificati.

L'eliminazione di un utente inesistente non genererà un errore (ovvero questo metodo è idempotente). Gli utenti inesistenti sono considerati eliminati con successo e vengono quindi conteggiati nel valore DeleteUsersResult.successCount .

È possibile fornire solo un massimo di 1000 identificatori. Se vengono forniti più di 1000 identificatori, questo metodo genera un FirebaseAuthError.

La velocità di questa API è attualmente limitata sul server a 1 QPS. Se lo superi, potresti ricevere un errore di quota superata. Pertanto, se desideri eliminare più di 1000 utenti, potrebbe essere necessario aggiungere un ritardo per assicurarti di non superare questo limite.

Firma:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

Parametri

Ritorna:

Promessa< EliminaUsersResult >

Una promessa che si risolve nel numero totale di eliminazioni riuscite/non riuscite, nonché nella serie di errori che corrisponde alle eliminazioni non riuscite.

BaseAuth.generateEmailVerificationLink()

Genera il collegamento all'azione e-mail fuori banda per verificare la proprietà dell'utente dell'e-mail specificata. L'oggetto ActionCodeSettings fornito come argomento a questo metodo definisce se il collegamento deve essere gestito da un'app mobile o da un browser insieme alle informazioni aggiuntive sullo stato da passare nel collegamento diretto, ecc.

Firma:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parametri

Ritorna:

Promesso<string>

Una promessa che si risolve con il collegamento generato.

Esempio

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generatePasswordResetLink()

Genera il collegamento all'azione e-mail fuori banda per reimpostare la password di un utente. Il collegamento viene generato per l'utente con l'indirizzo e-mail specificato. L'oggetto facoltativo ActionCodeSettings definisce se il collegamento deve essere gestito da un'app mobile o da un browser e le informazioni aggiuntive sullo stato da passare nel collegamento diretto, ecc.

Firma:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parametri

Ritorna:

Promesso<string>

Una promessa che si risolve con il collegamento generato.

Esempio

var actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generatePasswordResetLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateSignInWithEmailLink()

Genera il collegamento all'azione e-mail fuori banda per verificare la proprietà dell'utente dell'e-mail specificata. L'oggetto ActionCodeSettings fornito come argomento a questo metodo definisce se il collegamento deve essere gestito da un'app mobile o da un browser insieme alle informazioni aggiuntive sullo stato da passare nel collegamento diretto, ecc.

Firma:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

Parametri

Ritorna:

Promesso<string>

Una promessa che si risolve con il collegamento generato.

Esempio

var actionCodeSettings = {
  url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
  iOS: {
    bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true,
  dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
    .generateEmailVerificationLink('user@example.com', actionCodeSettings)
    .then(function(link) {
      // The link was successfully generated.
    })
    .catch(function(error) {
      // Some error occurred, you can inspect the code: error.code
    });

BaseAuth.generateVerifyAndChangeEmailLink()

Genera un collegamento all'azione e-mail fuori banda per verificare la proprietà dell'utente dell'e-mail specificata. L'oggetto ActionCodeSettings fornito come argomento a questo metodo definisce se il collegamento deve essere gestito da un'app mobile o da un browser insieme alle informazioni aggiuntive sullo stato da passare nel collegamento diretto, ecc.

Firma:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parametri

Ritorna:

Promesso<string>

Una promessa che si risolve con il collegamento generato.

BaseAuth.getProviderConfig()

Cerca una configurazione del provider di autenticazione in base all'ID fornito. Restituisce una promessa che si risolve con la configurazione del provider corrispondente all'ID provider specificato. Se l'ID specificato non esiste, viene generato un errore auth/configuration-not-found .

Il supporto dei provider SAML e OIDC richiede la piattaforma Identity di Google Cloud (GCIP). Per ulteriori informazioni su GCIP, inclusi prezzi e funzionalità, consulta la documentazione GCIP .

Firma:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

Parametri

Ritorna:

Promessa< AuthProviderConfig >

Una promessa che si risolve con la configurazione corrispondente all'ID fornito.

BaseAuth.getUser()

Ottiene i dati utente per l'utente corrispondente a un determinato uid .

Vedere Recuperare i dati utente per esempi di codice e documentazione dettagliata.

Firma:

getUser(uid: string): Promise<UserRecord>;

Parametri

Ritorna:

Promessa< Record utente >

Una promessa mantenuta con i dati utente corrispondenti uid fornito .

BaseAuth.getUserByEmail()

Ottiene i dati utente per l'utente corrispondente a un determinato messaggio di posta elettronica.

Vedere Recuperare i dati utente per esempi di codice e documentazione dettagliata.

Firma:

getUserByEmail(email: string): Promise<UserRecord>;

Parametri

Ritorna:

Promessa< Record utente >

Una promessa mantenuta con i dati dell'utente corrispondenti all'e-mail fornita.

BaseAuth.getUserByPhoneNumber()

Ottiene i dati utente per l'utente corrispondente a un determinato numero di telefono. Il numero di telefono deve essere conforme alla specifica E.164.

Vedere Recuperare i dati utente per esempi di codice e documentazione dettagliata.

Firma:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

Parametri

Ritorna:

Promessa< Record utente >

Una promessa mantenuta con i dati dell'utente corrispondenti al numero di telefono fornito.

BaseAuth.getUserByProviderUid()

Ottiene i dati utente per l'utente corrispondente a un determinato ID provider.

Vedere Recuperare i dati utente per esempi di codice e documentazione dettagliata.

Firma:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

Parametri

Ritorna:

Promessa< Record utente >

Una promessa mantenuta con i dati dell'utente corrispondenti all'ID del provider specificato.

BaseAuth.getUsers()

Ottiene i dati utente corrispondenti agli identificatori specificati.

Non ci sono garanzie sull'ordine; in particolare, non è garantito che l'n-esima voce nell'elenco dei risultati corrisponda all'n-esima voce nell'elenco dei parametri di input.

È possibile fornire solo un massimo di 100 identificatori. Se vengono forniti più di 100 identificatori, questo metodo genera un FirebaseAuthError.

Firma:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

Parametri

Ritorna:

Promessa< GetUsersResult >

Una promessa che si risolve nei record utente corrispondenti.

Eccezioni

FirebaseAuthError Se uno qualsiasi degli identificatori non è valido o se sono specificati più di 100 identificatori.

BaseAuth.importUsers()

Importa l'elenco di utenti fornito in Firebase Auth. È possibile importare un massimo di 1000 utenti uno alla volta. Quando si importano utenti con password, è necessario specificare UserImportOptions . Questa operazione è ottimizzata per le importazioni di massa e ignorerà i controlli uid , email e altri identificatori univoci che potrebbero causare duplicazioni.

Firma:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

Parametri

Ritorna:

Promessa< UserImportResult >

Una promessa che si risolve quando l'operazione viene completata con il risultato dell'importazione. Ciò include il numero di importazioni riuscite, il numero di importazioni non riuscite e i relativi errori.

BaseAuth.listProviderConfigs()

Restituisce l'elenco delle configurazioni dei provider esistenti che corrispondono al filtro fornito. È possibile elencare al massimo 100 configurazioni di provider alla volta.

Il supporto dei provider SAML e OIDC richiede la piattaforma Identity di Google Cloud (GCIP). Per ulteriori informazioni su GCIP, inclusi prezzi e funzionalità, consulta la documentazione GCIP .

Firma:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

Parametri

Ritorna:

Promessa< ListProviderConfigResults >

Una promessa che si risolve con l'elenco delle configurazioni dei provider che soddisfano i requisiti del filtro.

BaseAuth.listUsers()

Recupera un elenco di utenti (solo batch singolo) con una dimensione di maxResults a partire dall'offset specificato da pageToken . Viene utilizzato per recuperare tutti gli utenti di un progetto specificato in batch.

Vedi Elenca tutti gli utenti per esempi di codice e documentazione dettagliata.

Firma:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

Parametri

Ritorna:

Promessa< ListUsersResult >

Una promessa che si risolve con l'attuale gruppo di utenti scaricati e il token della pagina successiva.

BaseAuth.revokeRefreshTokens()

Revoca tutti i token di aggiornamento per un utente esistente.

Questa API aggiornerà UserRecord.tokensValidAfterTime dell'utente all'UTC corrente. È importante che il server su cui viene richiamato abbia l'orologio impostato correttamente e sincronizzato.

Anche se ciò revocherà tutte le sessioni per un utente specifico e disabiliterà la creazione di nuovi token ID per le sessioni esistenti, i token ID esistenti potrebbero rimanere attivi fino alla loro scadenza naturale (un'ora). Per verificare che i token ID siano revocati, utilizza BaseAuth.verifyIdToken() dove checkRevoked è impostato su true.

Firma:

revokeRefreshTokens(uid: string): Promise<void>;

Parametri

Ritorna:

Promesso<vuoto>

Una promessa vuota mantenuta una volta revocati i token di aggiornamento dell'utente.

BaseAuth.setCustomUserClaims()

Imposta ulteriori attestazioni dello sviluppatore su un utente esistente identificato uid fornito , in genere utilizzato per definire ruoli utente e livelli di accesso. Queste attestazioni dovrebbero propagarsi a tutti i dispositivi su cui l'utente ha già effettuato l'accesso (dopo la scadenza del token o quando viene forzato l'aggiornamento del token) e al successivo accesso dell'utente. Se viene utilizzato un nome di attestazione OIDC riservato (sub, iat, iss e così via) ), viene generato un errore. Sono impostati sul token ID dell'utente autenticato JWT.

Vedi Definizione dei ruoli utente e dei livelli di accesso per esempi di codice e documentazione dettagliata.

Firma:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

Parametri

Ritorna:

Promesso<vuoto>

Una promessa che si risolve quando l'operazione viene completata con successo.

BaseAuth.updateProviderConfig()

Restituisce una promessa che si risolve con l' AuthProviderConfig aggiornato corrispondente all'ID provider specificato. Se l'ID specificato non esiste, viene generato un errore auth/configuration-not-found .

Il supporto dei provider SAML e OIDC richiede la piattaforma Identity di Google Cloud (GCIP). Per ulteriori informazioni su GCIP, inclusi prezzi e funzionalità, consulta la documentazione GCIP .

Firma:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

Parametri

Ritorna:

Promessa< AuthProviderConfig >

Una promessa che si risolve con la configurazione aggiornata del provider.

BaseAuth.updateUser()

Aggiorna un utente esistente.

Vedi Aggiornare un utente per esempi di codice e documentazione dettagliata.

Firma:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

Parametri

Ritorna:

Promessa< Record utente >

Una promessa mantenuta con i dati utente aggiornati.

BaseAuth.verifyIdToken()

Verifica un token ID Firebase (JWT). Se il token è valido, la promessa viene mantenuta con le affermazioni decodificate del token; in caso contrario, la promessa viene respinta.

Se checkRevoked è impostato su true, verifica innanzitutto se l'utente corrispondente è disabilitato. In caso affermativo, viene generato un errore auth/user-disabled . In caso negativo, verifica se la sessione corrispondente al token ID è stata revocata. Se la sessione dell'utente corrispondente è stata invalidata, viene generato un errore auth/id-token-revoked . Se non specificato il controllo non viene applicato.

Vedi Verifica token ID per esempi di codici e documentazione dettagliata.

Firma:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parametri

Ritorna:

Promessa< DecodedIdToken >

Una promessa mantenuta con le richieste decodificate del token se il token ID è valido; altrimenti, una promessa rifiutata.

BaseAuth.verifySessionCookie()

Verifica un cookie di sessione Firebase. Restituisce una Promise con le attestazioni sui cookie. Rifiuta la promessa se non è stato possibile verificare il cookie.

Se checkRevoked è impostato su true, verifica innanzitutto se l'utente corrispondente è disabilitato: in caso affermativo, viene generato un errore auth/user-disabled . In caso negativo verifica se la sessione corrispondente al cookie di sessione è stata revocata. Se la sessione dell'utente corrispondente è stata invalidata, viene generato un errore auth/session-cookie-revoked . Se non specificato il controllo non viene eseguito.

Consulta Verifica dei cookie di sessione per esempi di codice e documentazione dettagliata

Firma:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parametri

Ritorna:

Promessa< DecodedIdToken >

Una promessa mantenuta con le affermazioni decodificate del cookie di sessione se il cookie di sessione è valido; altrimenti, una promessa rifiutata.