BaseAuth class

Gemeinsame übergeordnete Schnittstelle für Auth und TenantAwareAuth APIs.

Unterschrift:

export declare abstract class BaseAuth 

Methoden

BaseAuth.createCustomToken()

Erstellt ein neues benutzerdefiniertes Firebase-Token (JWT), das an ein Clientgerät zurückgesendet werden kann, um es für die Anmeldung mit den signInWithCustomToken() Methoden des Client-SDKs zu verwenden. (Mandantenfähige Instanzen betten auch die Mandanten-ID in das Token ein.)

Codebeispiele und eine ausführliche Dokumentation finden Sie unter Erstellen benutzerdefinierter Token .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das mit einem benutzerdefinierten Token für die bereitgestellte uid und Nutzlast erfüllt wird.

BaseAuth.createProviderConfig()

Gibt ein Versprechen zurück, das mit der neu erstellten AuthProviderConfig aufgelöst wird, wenn die neue Anbieterkonfiguration erstellt wird.

Für die Unterstützung von SAML- und OIDC-Anbietern ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< AuthProviderConfig >

Ein Versprechen, das mit der erstellten Anbieterkonfiguration aufgelöst wird.

BaseAuth.createSessionCookie()

Erstellt ein neues Firebase-Sitzungscookie mit den angegebenen Optionen. Der erstellte JWT-String kann als serverseitiges Sitzungscookie mit einer benutzerdefinierten Cookie-Richtlinie festgelegt und für die Sitzungsverwaltung verwendet werden. Das Sitzungscookie-JWT hat die gleichen Nutzlastansprüche wie das bereitgestellte ID-Token.

Codebeispiele und eine ausführliche Dokumentation finden Sie unter Sitzungscookies verwalten .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das bei Erfolg mit dem erstellten Sitzungscookie aufgelöst wird.

BaseAuth.createUser()

Erstellt einen neuen Benutzer.

Codebeispiele und ausführliche Dokumentation finden Sie unter „Benutzer erstellen“ .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< UserRecord >

Ein Versprechen, das mit den Benutzerdaten erfüllt wird, die dem neu erstellten Benutzer entsprechen.

BaseAuth.deleteProviderConfig()

Löscht die Providerkonfiguration entsprechend der übergebenen Provider-ID. Wenn die angegebene ID nicht vorhanden ist, wird ein auth/configuration-not-found Fehler ausgegeben.

Für die Unterstützung von SAML- und OIDC-Anbietern ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein Versprechen, das sich bei Vollendung einlöst.

BaseAuth.deleteUser()

Löscht einen vorhandenen Benutzer.

Codebeispiele und ausführliche Dokumentation finden Sie unter „Benutzer löschen“ .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein leeres Versprechen, das erfüllt wird, sobald der Benutzer gelöscht wurde.

BaseAuth.deleteUsers()

Löscht die durch die angegebenen UIDs angegebenen Benutzer.

Das Löschen eines nicht vorhandenen Benutzers erzeugt keinen Fehler (dh diese Methode ist idempotent). Nicht vorhandene Benutzer gelten als erfolgreich gelöscht und werden daher im Wert DeleteUsersResult.successCount gezählt.

Es dürfen maximal 1000 Identifier angegeben werden. Wenn mehr als 1000 Bezeichner angegeben werden, löst diese Methode einen FirebaseAuthError aus.

Die Rate dieser API ist derzeit auf dem Server auf 1 QPS begrenzt. Wenn Sie diesen Wert überschreiten, erhalten Sie möglicherweise die Fehlermeldung „Kontingent überschritten“. Wenn Sie mehr als 1.000 Benutzer löschen möchten, müssen Sie daher möglicherweise eine Verzögerung hinzufügen, um sicherzustellen, dass Sie dieses Limit nicht überschreiten.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< DeleteUsersResult >

Ein Versprechen, das die Gesamtzahl der erfolgreichen/fehlgeschlagenen Löschvorgänge sowie die Fehlergruppe auflöst, die den fehlgeschlagenen Löschvorgängen entspricht.

BaseAuth.generateEmailVerificationLink()

Erzeugt den Out-of-Band-E-Mail-Aktionslink, um die Inhaberschaft des Benutzers für die angegebene E-Mail zu überprüfen. Das als Argument für diese Methode bereitgestellte ActionCodeSettings- Objekt definiert, ob der Link von einer mobilen App oder einem Browser verarbeitet werden soll, zusammen mit zusätzlichen Statusinformationen, die im Deep Link usw. übergeben werden sollen.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das mit dem generierten Link eingelöst wird.

Beispiel

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()

Generiert den Out-of-Band-E-Mail-Aktionslink zum Zurücksetzen des Passworts eines Benutzers. Der Link wird für den Benutzer mit der angegebenen E-Mail-Adresse generiert. Das optionale ActionCodeSettings- Objekt definiert, ob der Link von einer mobilen App oder einem Browser verarbeitet werden soll und welche zusätzlichen Statusinformationen im Deep Link usw. übergeben werden sollen.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das mit dem generierten Link eingelöst wird.

Beispiel

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()

Erzeugt den Out-of-Band-E-Mail-Aktionslink, um die Inhaberschaft des Benutzers für die angegebene E-Mail zu überprüfen. Das als Argument für diese Methode bereitgestellte ActionCodeSettings- Objekt definiert, ob der Link von einer mobilen App oder einem Browser verarbeitet werden soll, zusammen mit zusätzlichen Statusinformationen, die im Deep Link usw. übergeben werden sollen.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das mit dem generierten Link eingelöst wird.

Beispiel

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()

Erzeugt einen Out-of-Band-E-Mail-Aktionslink, um den Besitz des Benutzers für die angegebene E-Mail zu überprüfen. Das als Argument für diese Methode bereitgestellte ActionCodeSettings- Objekt definiert, ob der Link von einer mobilen App oder einem Browser verarbeitet werden soll, zusammen mit zusätzlichen Statusinformationen, die im Deep Link usw. übergeben werden sollen.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das mit dem generierten Link eingelöst wird.

BaseAuth.getProviderConfig()

Sucht anhand der bereitgestellten ID nach einer Authentifizierungsanbieterkonfiguration. Gibt ein Versprechen zurück, das mit der Anbieterkonfiguration aufgelöst wird, die der angegebenen Anbieter-ID entspricht. Wenn die angegebene ID nicht vorhanden ist, wird ein auth/configuration-not-found Fehler ausgegeben.

Für die Unterstützung von SAML- und OIDC-Anbietern ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< AuthProviderConfig >

Ein Versprechen, das mit der Konfiguration aufgelöst wird, die der bereitgestellten ID entspricht.

BaseAuth.getUser()

Ruft die Benutzerdaten für den Benutzer ab, der einer bestimmten uid entspricht .

Codebeispiele und ausführliche Dokumentation finden Sie unter Benutzerdaten abrufen .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< UserRecord >

Ein Versprechen, das mit den Benutzerdaten erfüllt wird, die der bereitgestellten uid entsprechen .

BaseAuth.getUserByEmail()

Ruft die Benutzerdaten für den Benutzer ab, der einer bestimmten E-Mail entspricht.

Codebeispiele und ausführliche Dokumentation finden Sie unter Benutzerdaten abrufen .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< UserRecord >

Ein Versprechen, das mit den Benutzerdaten erfüllt wird, die der angegebenen E-Mail entsprechen.

BaseAuth.getUserByPhoneNumber()

Ruft die Benutzerdaten für den Benutzer ab, der einer bestimmten Telefonnummer entspricht. Die Telefonnummer muss der E.164-Spezifikation entsprechen.

Codebeispiele und ausführliche Dokumentation finden Sie unter Benutzerdaten abrufen .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< UserRecord >

Ein Versprechen, das mit den Benutzerdaten erfüllt wird, die der angegebenen Telefonnummer entsprechen.

BaseAuth.getUserByProviderUid()

Ruft die Benutzerdaten für den Benutzer ab, der einer bestimmten Anbieter-ID entspricht.

Codebeispiele und ausführliche Dokumentation finden Sie unter Benutzerdaten abrufen .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< UserRecord >

Ein Versprechen, das mit den Benutzerdaten erfüllt wird, die der angegebenen Anbieter-ID entsprechen.

BaseAuth.getUsers()

Ruft die Benutzerdaten ab, die den angegebenen Bezeichnern entsprechen.

Es gibt keine Bestellgarantien; Insbesondere kann nicht garantiert werden, dass der n-te Eintrag in der Ergebnisliste mit dem n-ten Eintrag in der Eingabeparameterliste übereinstimmt.

Es dürfen maximal 100 Identifikatoren angegeben werden. Wenn mehr als 100 Bezeichner angegeben werden, löst diese Methode einen FirebaseAuthError aus.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< GetUsersResult >

Ein Versprechen, das in die entsprechenden Benutzerdatensätze aufgelöst wird.

Ausnahmen

FirebaseAuthError Wenn einer der Bezeichner ungültig ist oder wenn mehr als 100 Bezeichner angegeben sind.

BaseAuth.importUsers()

Importiert die bereitgestellte Benutzerliste in Firebase Auth. Es dürfen maximal 1000 Benutzer einzeln importiert werden. Beim Importieren von Benutzern mit Passwörtern müssen UserImportOptions angegeben werden. Dieser Vorgang ist für Massenimporte optimiert und ignoriert uid Prüfungen , email und andere eindeutige Kennungen, was zu Duplikaten führen könnte.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< UserImportResult >

Ein Versprechen, das aufgelöst wird, wenn der Vorgang mit dem Ergebnis des Imports abgeschlossen ist. Dazu gehören die Anzahl erfolgreicher Importe, die Anzahl fehlgeschlagener Importe und die entsprechenden Fehler.

BaseAuth.listProviderConfigs()

Gibt die Liste der vorhandenen Anbieterkonfigurationen zurück, die dem bereitgestellten Filter entsprechen. Es können höchstens 100 Anbieterkonfigurationen gleichzeitig aufgelistet werden.

Für die Unterstützung von SAML- und OIDC-Anbietern ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< ListProviderConfigResults >

Ein Versprechen, das mit der Liste der Anbieterkonfigurationen aufgelöst wird, die die Filteranforderungen erfüllen.

BaseAuth.listUsers()

Ruft eine Liste von Benutzern (nur Einzelbatch) mit einer Größe von maxResults ab, beginnend mit dem durch pageToken angegebenen Offset . Dies wird verwendet, um alle Benutzer eines bestimmten Projekts stapelweise abzurufen.

Codebeispiele und ausführliche Dokumentation finden Sie unter „Alle Benutzer auflisten“ .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< ListUsersResult >

Ein Versprechen, das mit dem aktuellen Stapel heruntergeladener Benutzer und dem Token für die nächste Seite aufgelöst wird.

BaseAuth.revokeRefreshTokens()

Widerruft alle Aktualisierungstoken für einen vorhandenen Benutzer.

Diese API aktualisiert die UserRecord.tokensValidAfterTime des Benutzers auf die aktuelle UTC. Wichtig ist, dass die Uhr des Servers, auf dem dies aufgerufen wird, korrekt eingestellt und synchronisiert ist.

Während dadurch alle Sitzungen für einen bestimmten Benutzer widerrufen werden und keine neuen ID-Tokens für bestehende Sitzungen erstellt werden, können vorhandene ID-Tokens bis zu ihrem natürlichen Ablauf (eine Stunde) aktiv bleiben. Um zu überprüfen, ob ID-Tokens widerrufen wurden, verwenden Sie BaseAuth.verifyIdToken() , wobei checkRevoked auf true gesetzt ist.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein leeres Versprechen, das erfüllt wird, sobald die Aktualisierungstoken des Benutzers widerrufen wurden.

BaseAuth.setCustomUserClaims()

Legt zusätzliche Entwickleransprüche für einen vorhandenen Benutzer fest, der durch die bereitgestellte uid identifiziert wird , wird normalerweise zum Definieren von Benutzerrollen und Zugriffsebenen verwendet. Diese Ansprüche sollten auf alle Geräte übertragen werden, auf denen der Benutzer bereits angemeldet ist (nach Ablauf des Tokens oder wenn die Aktualisierung des Tokens erzwungen wird) und bei der nächsten Anmeldung des Benutzers. Wenn ein reservierter OIDC-Anspruchsname verwendet wird (sub, iat, iss usw ), wird ein Fehler ausgegeben. Sie werden auf dem ID-Token-JWT des authentifizierten Benutzers festgelegt.

Codebeispiele und ausführliche Dokumentation finden Sie unter Definieren von Benutzerrollen und Zugriffsebenen .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<void>

Ein Versprechen, das aufgelöst wird, wenn der Vorgang erfolgreich abgeschlossen wird.

BaseAuth.updateProviderConfig()

Gibt ein Versprechen zurück, das mit der aktualisierten AuthProviderConfig aufgelöst wird, die der angegebenen Anbieter-ID entspricht. Wenn die angegebene ID nicht vorhanden ist, wird ein auth/configuration-not-found Fehler ausgegeben.

Für die Unterstützung von SAML- und OIDC-Anbietern ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< AuthProviderConfig >

Ein Versprechen, das mit der aktualisierten Anbieterkonfiguration eingelöst wird.

BaseAuth.updateUser()

Aktualisiert einen vorhandenen Benutzer.

Codebeispiele und ausführliche Dokumentation finden Sie unter „Benutzer aktualisieren“ .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< UserRecord >

Ein Versprechen, das mit den aktualisierten Benutzerdaten eingelöst wird.

BaseAuth.verifyIdToken()

Verifiziert ein Firebase-ID-Token (JWT). Wenn der Token gültig ist, wird das Versprechen mit den entschlüsselten Ansprüchen des Tokens erfüllt; andernfalls wird das Versprechen abgelehnt.

Wenn checkRevoked auf true gesetzt ist, wird zunächst überprüft, ob der entsprechende Benutzer deaktiviert ist. Wenn ja, wird ein auth/user-disabled ausgegeben. Wenn nein, wird überprüft, ob die Sitzung, die dem ID-Token entspricht, widerrufen wurde. Wenn die Sitzung des entsprechenden Benutzers ungültig gemacht wurde, wird ein auth/id-token-revoked Fehler ausgegeben. Wenn nicht angegeben, wird die Prüfung nicht angewendet.

Codebeispiele und ausführliche Dokumentation finden Sie unter „ID-Tokens überprüfen“ .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< DecodedIdToken >

Ein Versprechen, das mit den entschlüsselten Ansprüchen des Tokens erfüllt wird, wenn das ID-Token gültig ist; andernfalls ein abgelehntes Versprechen.

BaseAuth.verifySessionCookie()

Überprüft ein Firebase-Sitzungscookie. Gibt ein Versprechen mit den Cookie-Ansprüchen zurück. Lehnt das Versprechen ab, wenn das Cookie nicht überprüft werden konnte.

Wenn checkRevoked auf true gesetzt ist, wird zunächst überprüft, ob der entsprechende Benutzer deaktiviert ist: Wenn ja, wird ein auth/user-disabled Fehler ausgegeben. Wenn nein, wird überprüft, ob die Sitzung, die dem Sitzungscookie entspricht, widerrufen wurde. Wenn die Sitzung des entsprechenden Benutzers ungültig gemacht wurde, wird ein auth/session-cookie-revoked Fehler ausgegeben. Wenn nicht angegeben, wird die Prüfung nicht durchgeführt.

Codebeispiele und eine ausführliche Dokumentation finden Sie unter „Sitzungscookies überprüfen“.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< DecodedIdToken >

Ein Versprechen, das mit den entschlüsselten Ansprüchen des Sitzungscookies erfüllt wird, wenn das Sitzungscookie gültig ist; andernfalls ein abgelehntes Versprechen.