BaseAuth class

Wspólny interfejs nadrzędny dla interfejsów API Auth i TenantAwareAuth .

Podpis:

export declare abstract class BaseAuth 

Metody

metoda Modyfikatory Opis
utwórzCustomToken(uid, deweloperClaims) Tworzy nowy token niestandardowy Firebase (JWT), który można odesłać z powrotem do urządzenia klienckiego w celu użycia go do zalogowania się przy użyciu metod signInWithCustomToken() zestawu SDK klienta. (Instancje obsługujące dzierżawę będą również osadzać identyfikator dzierżawy w tokenie). Zobacz Tworzenie tokenów niestandardowych , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.
utwórzProviderConfig(config) Zwraca obietnicę, która zostanie rozwiązana z nowo utworzoną AuthProviderConfig po utworzeniu nowej konfiguracji dostawcy. Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .
utwórzSessionCookie(idToken, sessionCookieOptions) Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT można ustawić jako plik cookie sesji po stronie serwera z niestandardowymi zasadami dotyczącymi plików cookie i używać go do zarządzania sesją. Sesyjny plik cookie JWT będzie zawierał te same oświadczenia dotyczące ładunku, co dostarczony token identyfikacyjny. Zobacz Zarządzanie plikami cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.
utwórzUżytkownika(właściwości) Tworzy nowego użytkownika. Zobacz Tworzenie użytkownika , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.
usuńProviderConfig(identyfikator dostawcy) Usuwa konfigurację dostawcy odpowiadającą przekazanemu identyfikatorowi dostawcy. Jeśli określony identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found . Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .
usuń użytkownika (uid) Usuwa istniejącego użytkownika. Zobacz usuwanie użytkownika , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.
usuńUsers(uids) Usuwa użytkowników określonych przez podane uidy. Usunięcie nieistniejącego użytkownika nie spowoduje błędu (tzn. ta metoda jest idempotentna). Nieistniejących użytkowników uważa się za usuniętych pomyślnie i dlatego są oni uwzględniani w wartości DeleteUsersResult.successCount . Można dostarczyć maksymalnie 1000 identyfikatorów. Jeśli podano więcej niż 1000 identyfikatorów, ta metoda zgłasza błąd FirebaseAuthError. Ten interfejs API jest obecnie ograniczony na serwerze do 1 QPS. Jeśli przekroczysz tę wartość, może pojawić się błąd przekroczenia limitu. Dlatego jeśli chcesz usunąć więcej niż 1000 użytkowników, może być konieczne dodanie opóźnienia, aby mieć pewność, że nie przekroczysz tego limitu.
generujEmailVerificationLink(e-mail, actionCodeSettings) Generuje link do akcji e-mail poza pasmem, aby zweryfikować własność użytkownika określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument tej metody określa, czy łącze ma być obsługiwane przez aplikację mobilną, czy przeglądarkę wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym łączu itp.
generujPasswordResetLink(e-mail, actionCodeSettings) Generuje link do akcji e-mail poza pasmem, umożliwiający zresetowanie hasła użytkownika. Link jest generowany dla użytkownika o podanym adresie e-mail. Opcjonalny obiekt ActionCodeSettings określa, czy link ma być obsługiwany przez aplikację mobilną, czy przeglądarkę oraz jakie dodatkowe informacje o stanie mają być przekazywane w precyzyjnym łączu itp.
generujSignInWithEmailLink(e-mail, actionCodeSettings) Generuje link do akcji e-mail poza pasmem, aby zweryfikować własność użytkownika określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument tej metody określa, czy łącze ma być obsługiwane przez aplikację mobilną, czy przeglądarkę wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym łączu itp.
generujVerifyAndChangeEmailLink(e-mail, nowy e-mail, actionCodeSettings) Generuje link do akcji e-mail poza pasmem, aby zweryfikować własność użytkownika określonej wiadomości e-mail. Obiekt ActionCodeSettings podany jako argument tej metody określa, czy łącze ma być obsługiwane przez aplikację mobilną, czy przeglądarkę wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym łączu itp.
getProviderConfig(identyfikator dostawcy) Wyszukuje konfigurację dostawcy uwierzytelniania według podanego identyfikatora. Zwraca obietnicę, która jest rozpoznawana w przypadku konfiguracji dostawcy odpowiadającej określonemu identyfikatorowi dostawcy. Jeśli określony identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found . Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .
pobierz użytkownika (uid) Pobiera dane użytkownika odpowiadające danemu uid . Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.
getUserByEmail(e-mail) Pobiera dane użytkownika odpowiadającego podanemu e-mailowi. Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.
getUserByPhoneNumber(numer telefonu) Pobiera dane użytkownika odpowiadającego podanemu numerowi telefonu. Numer telefonu musi być zgodny ze specyfikacją E.164. Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.
getUserByProviderUid(identyfikator dostawcy, uid) Pobiera dane użytkownika odpowiadające danemu identyfikatorowi dostawcy. Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.
getUsers(identyfikatory) Pobiera dane użytkownika odpowiadające określonym identyfikatorom. Nie ma żadnych gwarancji dotyczących zamówienia; w szczególności nie ma gwarancji, że n-ty wpis na liście wyników będzie odpowiadał n-temu wpisowi na liście parametrów wejściowych. Można dostarczyć maksymalnie 100 identyfikatorów. Jeśli podano więcej niż 100 identyfikatorów, ta metoda zgłasza błąd FirebaseAuthError.
importUsers(użytkownicy, opcje) Importuje podaną listę użytkowników do Firebase Auth. Jednorazowo można zaimportować maksymalnie 1000 użytkowników. Podczas importowania użytkowników z hasłami należy określić opcję UserImportOptions . Ta operacja jest zoptymalizowana pod kątem importu masowego i ignoruje sprawdzanie unikalności identyfikatora uid , email i innych identyfikatorów, co mogłoby skutkować duplikacjami.
listProviderConfigs(opcje) Zwraca listę istniejących konfiguracji dostawców pasujących do podanego filtru. Jednocześnie można wyświetlić maksymalnie 100 konfiguracji dostawców. Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .
listUsers(maxResults, pageToken) Pobiera listę użytkowników (tylko pojedyncza partia) o rozmiarze maxResults , zaczynając od przesunięcia określonego przez pageToken . Służy do pobierania wszystkich użytkowników określonego projektu partiami. Zobacz listę wszystkich użytkowników , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.
unieważnijRefreshTokens(uid) Odwołuje wszystkie tokeny odświeżania dla istniejącego użytkownika. Ten interfejs API zaktualizuje wartość UserRecord.tokensValidAfterTime użytkownika do bieżącego czasu UTC. Ważne jest, aby serwer, na którym to się dzieje, miał ustawiony prawidłowo i zsynchronizowany zegar. Chociaż spowoduje to unieważnienie wszystkich sesji określonego użytkownika i uniemożliwi wybicie nowych tokenów identyfikacyjnych dla istniejących sesji, istniejące tokeny identyfikacyjne mogą pozostać aktywne aż do ich naturalnego wygaśnięcia (jednej godziny). Aby sprawdzić, czy tokeny identyfikacyjne zostały unieważnione, użyj metody BaseAuth.verifyIdToken() , gdzie checkRevoked ma wartość true.
setCustomUserClaims(uid, niestandardoweUserClaims) Ustawia dodatkowe oświadczenia programisty dla istniejącego użytkownika identyfikowanego przez podany uid , zwykle używane do definiowania ról użytkowników i poziomów dostępu. Oświadczenia te powinny zostać rozprzestrzenione na wszystkie urządzenia, na których użytkownik jest już zalogowany (po wygaśnięciu tokena lub wymuszeniu odświeżenia tokenu) i przy następnym logowaniu użytkownika. Jeśli używana jest zastrzeżona nazwa oświadczenia OIDC (sub, iat, iss itp.) ), zgłaszany jest błąd. Są one ustawiane na tokenie identyfikatora uwierzytelnionego użytkownika JWT. Zobacz Definiowanie ról użytkowników i poziomów dostępu, aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.
updateProviderConfig(identyfikator dostawcy, zaktualizowana konfiguracja) Zwraca obietnicę, która jest rozpoznawana ze zaktualizowaną konfiguracją AuthProviderConfig odpowiadającą określonemu identyfikatorowi dostawcy. Jeśli określony identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found . Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .
updateUser(uid, właściwości) Aktualizuje istniejącego użytkownika. Zobacz Aktualizowanie użytkownika , aby uzyskać próbki kodu i szczegółową dokumentację.
zweryfikowaćIdToken(idToken, checkRevoked) Weryfikuje token identyfikatora Firebase (JWT). Jeśli token jest ważny, obietnica zostaje spełniona dzięki zdekodowanym żądaniom tokena; w przeciwnym razie obietnica zostanie odrzucona. Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, zgłaszany jest błąd auth/user-disabled . Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi ID została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/id-token-revoked . Jeśli nie określono, kontrola nie jest stosowana. Zobacz Weryfikacja tokenów identyfikacyjnych , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.
zweryfikujSessionCookie(sessionCookie, sprawdźUnieważnione) Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z oświadczeniami dotyczącymi plików cookie. Odrzuca obietnicę, jeśli nie można zweryfikować pliku cookie. Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony: Jeśli tak, zgłaszany jest błąd auth/user-disabled . Jeśli nie, sprawdza, czy sesja odpowiadająca plikowi cookie sesji została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/session-cookie-revoked . Jeśli nie określono, kontrola nie jest wykonywana. Zobacz Weryfikacja plików cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją

BaseAuth.createCustomToken()

Tworzy nowy token niestandardowy Firebase (JWT), który można odesłać z powrotem do urządzenia klienckiego w celu użycia go do zalogowania się przy użyciu metod signInWithCustomToken() zestawu SDK klienta. (Instancje obsługujące dzierżawę będą również osadzać identyfikator dzierżawy w tokenie).

Zobacz Tworzenie tokenów niestandardowych , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.

Podpis:

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

Parametry

Parametr Typ Opis
uid strunowy uid będzie używany jako temat tokenu niestandardowego.
Roszczenia dewelopera obiekt Opcjonalne dodatkowe oświadczenia do uwzględnienia w ładunku tokenu niestandardowego.

Zwroty:

Obietnica<string>

Obietnica spełniona za pomocą niestandardowego tokena dla dostarczonego uid i ładunku.

BaseAuth.createProviderConfig()

Zwraca obietnicę, która zostanie rozwiązana z nowo utworzoną AuthProviderConfig po utworzeniu nowej konfiguracji dostawcy.

Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .

Podpis:

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

Parametry

Parametr Typ Opis
konfiguracja Konfiguracja dostawcy uwierzytelniania Konfiguracja dostawcy do utworzenia.

Zwroty:

Obietnica< AuthProviderConfig >

Obietnica, która rozwiązuje się wraz z utworzoną konfiguracją dostawcy.

BaseAuth.createSessionCookie()

Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT można ustawić jako plik cookie sesji po stronie serwera z niestandardowymi zasadami dotyczącymi plików cookie i używać go do zarządzania sesją. Sesyjny plik cookie JWT będzie zawierał te same oświadczenia dotyczące ładunku, co dostarczony token identyfikacyjny.

Zobacz Zarządzanie plikami cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.

Podpis:

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

Parametry

Parametr Typ Opis
idToken strunowy Token identyfikatora Firebase do wymiany na plik cookie sesji.
Opcje plików cookie sesji Opcje plików cookie sesji Opcje plików cookie sesji, które obejmują niestandardowy czas trwania sesji.

Zwroty:

Obietnica<string>

Obietnica, która gwarantuje sukces dzięki utworzonemu plikowi cookie sesji.

BaseAuth.createUser()

Tworzy nowego użytkownika.

Zobacz Tworzenie użytkownika , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.

Podpis:

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

Parametry

Parametr Typ Opis
nieruchomości Utwórz żądanie Właściwości, które należy ustawić dla nowego rekordu użytkownika, który ma zostać utworzony.

Zwroty:

Obietnica< Rekord użytkownika >

Obietnica spełniona danymi użytkownika odpowiadającymi nowo utworzonemu użytkownikowi.

BaseAuth.deleteProviderConfig()

Usuwa konfigurację dostawcy odpowiadającą przekazanemu identyfikatorowi dostawcy. Jeśli określony identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found .

Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .

Podpis:

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

Parametry

Parametr Typ Opis
identyfikator dostawcy strunowy Identyfikator dostawcy odpowiadający konfiguracji dostawcy do usunięcia.

Zwroty:

Obietnica<pusta>

Obietnica, która rozwiązuje się po ukończeniu.

BaseAuth.deleteUser()

Usuwa istniejącego użytkownika.

Zobacz usuwanie użytkownika , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.

Podpis:

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

Parametry

Parametr Typ Opis
uid strunowy uid odpowiadający użytkownikowi do usunięcia.

Zwroty:

Obietnica<pusta>

Pusta obietnica spełniona po usunięciu użytkownika.

BaseAuth.deleteUsers()

Usuwa użytkowników określonych przez podane uidy.

Usunięcie nieistniejącego użytkownika nie spowoduje błędu (tzn. ta metoda jest idempotentna). Nieistniejących użytkowników uważa się za usuniętych pomyślnie i dlatego są oni uwzględniani w wartości DeleteUsersResult.successCount .

Można dostarczyć maksymalnie 1000 identyfikatorów. Jeśli podano więcej niż 1000 identyfikatorów, ta metoda zgłasza błąd FirebaseAuthError.

Ten interfejs API jest obecnie ograniczony na serwerze do 1 QPS. Jeśli przekroczysz tę wartość, może pojawić się błąd przekroczenia limitu. Dlatego jeśli chcesz usunąć więcej niż 1000 użytkowników, może być konieczne dodanie opóźnienia, aby mieć pewność, że nie przekroczysz tego limitu.

Podpis:

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

Parametry

Parametr Typ Opis
płyny strunowy[] uids odpowiadające użytkownikom do usunięcia.

Zwroty:

Obietnica < UsuńUsersResult >

Obietnica, która określa całkowitą liczbę udanych/nieudanych usunięć, a także tablicę błędów odpowiadającą nieudanym usunięciom.

Generuje link do akcji e-mail poza pasmem, aby zweryfikować własność użytkownika określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument tej metody określa, czy łącze ma być obsługiwane przez aplikację mobilną, czy przeglądarkę wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym łączu itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail strunowy Konto e-mail do zweryfikowania.
Ustawienia kodu akcji Ustawienia kodu akcji Ustawienia kodu akcji. Jeśli jest określony, adres URL stanu/kontynuacji jest ustawiany jako parametr „continueUrl” w łączu weryfikacyjnym e-mailem. Domyślna strona docelowa weryfikacji adresu e-mail użyje tego do wyświetlenia linku umożliwiającego powrót do aplikacji, jeśli jest zainstalowana. Jeśli nie określono actionCodeSettings, do adresu URL akcji nie zostanie dołączony żaden adres URL. Podany stanowy adres URL musi należeć do domeny umieszczonej na białej liście programisty w konsoli. W przeciwnym razie zgłaszany jest błąd. Przekierowania aplikacji mobilnej mają zastosowanie tylko wtedy, gdy programista skonfiguruje i zaakceptuje warunki korzystania z usługi Firebase Dynamic Links. Nazwa pakietu Android i identyfikator pakietu iOS są przestrzegane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Firebase Auth.

Zwroty:

Obietnica<string>

Obietnica, która rozwiązuje się wraz z wygenerowanym linkiem.

Przykład

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
    });

Generuje link do akcji e-mail poza pasmem, umożliwiający zresetowanie hasła użytkownika. Link jest generowany dla użytkownika o podanym adresie e-mail. Opcjonalny obiekt ActionCodeSettings określa, czy link ma być obsługiwany przez aplikację mobilną, czy przeglądarkę oraz jakie dodatkowe informacje o stanie mają być przekazywane w precyzyjnym łączu itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail strunowy Adres e-mail użytkownika, którego hasło ma zostać zresetowane.
Ustawienia kodu akcji Ustawienia kodu akcji Ustawienia kodu akcji. Jeśli jest określony, adres URL stanu/kontynuacji jest ustawiany jako parametr „continueUrl” w łączu resetowania hasła. Domyślna strona docelowa resetowania hasła użyje tego do wyświetlenia linku umożliwiającego powrót do aplikacji, jeśli jest zainstalowana. Jeśli nie określono actionCodeSettings, do adresu URL akcji nie zostanie dołączony żaden adres URL. Podany stanowy adres URL musi należeć do domeny umieszczonej na białej liście programisty w konsoli. W przeciwnym razie zgłaszany jest błąd. Przekierowania aplikacji mobilnej mają zastosowanie tylko wtedy, gdy programista skonfiguruje i zaakceptuje warunki korzystania z usługi Firebase Dynamic Links. Nazwa pakietu Android i identyfikator pakietu iOS są przestrzegane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Firebase Auth.

Zwroty:

Obietnica<string>

Obietnica, która rozwiązuje się wraz z wygenerowanym linkiem.

Przykład

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
    });

Generuje link do akcji e-mail poza pasmem, aby zweryfikować własność użytkownika określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument tej metody określa, czy łącze ma być obsługiwane przez aplikację mobilną, czy przeglądarkę wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym łączu itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail strunowy Konto e-mail do zweryfikowania.
Ustawienia kodu akcji Ustawienia kodu akcji Ustawienia kodu akcji. Jeśli jest określony, adres URL stanu/kontynuacji jest ustawiany jako parametr „continueUrl” w łączu weryfikacyjnym e-mailem. Domyślna strona docelowa weryfikacji adresu e-mail użyje tego do wyświetlenia linku umożliwiającego powrót do aplikacji, jeśli jest zainstalowana. Jeśli nie określono actionCodeSettings, do adresu URL akcji nie zostanie dołączony żaden adres URL. Podany stanowy adres URL musi należeć do domeny umieszczonej na białej liście programisty w konsoli. W przeciwnym razie zgłaszany jest błąd. Przekierowania aplikacji mobilnej mają zastosowanie tylko wtedy, gdy programista skonfiguruje i zaakceptuje warunki korzystania z usługi Firebase Dynamic Links. Nazwa pakietu Android i identyfikator pakietu iOS są przestrzegane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Firebase Auth.

Zwroty:

Obietnica<string>

Obietnica, która rozwiązuje się wraz z wygenerowanym linkiem.

Przykład

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
    });

Generuje link do akcji e-mail poza pasmem, aby zweryfikować własność użytkownika określonej wiadomości e-mail. Obiekt ActionCodeSettings podany jako argument tej metody określa, czy łącze ma być obsługiwane przez aplikację mobilną, czy przeglądarkę wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym łączu itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail strunowy Bieżące konto e-mail.
nowy e-mail strunowy Adres e-mail, na który konto jest aktualizowane.
Ustawienia kodu akcji Ustawienia kodu akcji Ustawienia kodu akcji. Jeśli jest określony, adres URL stanu/kontynuacji jest ustawiany jako parametr „continueUrl” w łączu weryfikacyjnym e-mailem. Domyślna strona docelowa weryfikacji adresu e-mail użyje tego do wyświetlenia linku umożliwiającego powrót do aplikacji, jeśli jest zainstalowana. Jeśli nie określono actionCodeSettings, do adresu URL akcji nie zostanie dołączony żaden adres URL. Podany stan URL musi należeć do domeny autoryzowanej w konsoli, w przeciwnym razie zostanie zgłoszony błąd. Przekierowania aplikacji mobilnej mają zastosowanie tylko wtedy, gdy programista skonfiguruje i zaakceptuje warunki korzystania z usługi Firebase Dynamic Links. Nazwa pakietu Android i identyfikator pakietu iOS są przestrzegane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Firebase Auth.

Zwroty:

Obietnica<string>

Obietnica, która rozwiązuje się wraz z wygenerowanym linkiem.

BaseAuth.getProviderConfig()

Wyszukuje konfigurację dostawcy uwierzytelniania według podanego identyfikatora. Zwraca obietnicę, która jest rozpoznawana w przypadku konfiguracji dostawcy odpowiadającej określonemu identyfikatorowi dostawcy. Jeśli określony identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found .

Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .

Podpis:

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

Parametry

Parametr Typ Opis
identyfikator dostawcy strunowy Identyfikator dostawcy odpowiadający konfiguracji dostawcy do zwrócenia.

Zwroty:

Obietnica< AuthProviderConfig >

Obietnica, która rozwiązuje się za pomocą konfiguracji odpowiadającej podanemu identyfikatorowi.

BaseAuth.getUser()

Pobiera dane użytkownika odpowiadające danemu uid .

Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.

Podpis:

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

Parametry

Parametr Typ Opis
uid strunowy uid odpowiadający użytkownikowi, którego dane mają zostać pobrane.

Zwroty:

Obietnica< Rekord użytkownika >

Obietnica spełniona z danymi użytkownika odpowiadającymi podanemu uid .

BaseAuth.getUserByEmail()

Pobiera dane użytkownika odpowiadającego podanemu e-mailowi.

Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail strunowy Adres e-mail odpowiadający użytkownikowi, którego dane mają zostać pobrane.

Zwroty:

Obietnica< Rekord użytkownika >

Obietnica spełniona danymi użytkownika odpowiadającymi podanemu e-mailowi.

BaseAuth.getUserByPhoneNumber()

Pobiera dane użytkownika odpowiadającego podanemu numerowi telefonu. Numer telefonu musi być zgodny ze specyfikacją E.164.

Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.

Podpis:

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

Parametry

Parametr Typ Opis
numer telefonu strunowy Numer telefonu odpowiadający użytkownikowi, którego dane mają zostać pobrane.

Zwroty:

Obietnica< Rekord użytkownika >

Obietnica spełniona danymi użytkownika odpowiadającymi podanemu numerowi telefonu.

BaseAuth.getUserByProviderUid()

Pobiera dane użytkownika odpowiadające danemu identyfikatorowi dostawcy.

Zobacz pobieranie danych użytkownika w celu uzyskania przykładów kodu i szczegółowej dokumentacji.

Podpis:

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

Parametry

Parametr Typ Opis
identyfikator dostawcy strunowy Identyfikator dostawcy Google, np. „google.com”.
uid strunowy Identyfikator użytkownika dla danego dostawcy.

Zwroty:

Obietnica< Rekord użytkownika >

Obietnica spełniona danymi użytkownika odpowiadającymi podanemu identyfikatorowi dostawcy.

BaseAuth.getUsers()

Pobiera dane użytkownika odpowiadające określonym identyfikatorom.

Nie ma żadnych gwarancji dotyczących zamówienia; w szczególności nie ma gwarancji, że n-ty wpis na liście wyników będzie odpowiadał n-temu wpisowi na liście parametrów wejściowych.

Można dostarczyć maksymalnie 100 identyfikatorów. Jeśli podano więcej niż 100 identyfikatorów, ta metoda zgłasza błąd FirebaseAuthError.

Podpis:

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

Parametry

Parametr Typ Opis
identyfikatory Identyfikator użytkownika [] Identyfikatory używane do wskazania, które rekordy użytkownika powinny zostać zwrócone. Nie może zawierać więcej niż 100 wpisów.

Zwroty:

Obietnica < GetUsersResult >

Obietnica, która odnosi się do odpowiednich rekordów użytkownika.

Wyjątki

FirebaseAuthError Jeśli którykolwiek z identyfikatorów jest nieprawidłowy lub określono więcej niż 100 identyfikatorów.

BaseAuth.importUsers()

Importuje podaną listę użytkowników do Firebase Auth. Jednorazowo można zaimportować maksymalnie 1000 użytkowników. Podczas importowania użytkowników z hasłami należy określić opcję UserImportOptions . Ta operacja jest zoptymalizowana pod kątem importu zbiorczego i ignoruje sprawdzanie identyfikatora uid , email i innych identyfikatorów, które mogą powodować duplikacje.

Podpis:

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

Parametry

Parametr Typ Opis
użytkownicy Rekord importu użytkownika [] Lista rekordów użytkowników do zaimportowania do Firebase Auth.
opcje Opcje importu użytkownika Opcje importowania użytkowników, wymagane, jeśli podani użytkownicy zawierają dane uwierzytelniające hasła.

Zwroty:

Obietnica< UserImportResult >

Obietnica, która zostaje rozwiązana po zakończeniu operacji z wynikiem importu. Obejmuje to liczbę udanych importów, liczbę nieudanych importów i odpowiadające im błędy.

BaseAuth.listProviderConfigs()

Zwraca listę istniejących konfiguracji dostawców pasujących do podanego filtru. Jednocześnie można wyświetlić maksymalnie 100 konfiguracji dostawców.

Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .

Podpis:

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

Parametry

Parametr Typ Opis
opcje Filtr AuthProviderConfig Filtr konfiguracji dostawcy do zastosowania.

Zwroty:

Obietnica< ListProviderConfigResults >

Obietnica, która rozwiązuje się wraz z listą konfiguracji dostawców spełniających wymagania filtra.

BaseAuth.listUsers()

Pobiera listę użytkowników (tylko pojedyncza partia) o rozmiarze maxResults , zaczynając od przesunięcia określonego przez pageToken . Służy do pobierania wszystkich użytkowników określonego projektu partiami.

Zobacz listę wszystkich użytkowników , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.

Podpis:

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

Parametry

Parametr Typ Opis
maxWyniki numer Rozmiar strony, 1000, jeśli nieokreślony. Jest to również maksymalny dozwolony limit.
token strony strunowy Żeton następnej strony. Jeśli nie określono, zwraca użytkowników rozpoczynających się bez żadnego przesunięcia.

Zwroty:

Obietnica< ListUsersResult >

Obietnica, która rozwiązuje się wraz z bieżącą partią pobranych użytkowników i tokenem następnej strony.

BaseAuth.revokeRefreshTokens()

Odwołuje wszystkie tokeny odświeżania dla istniejącego użytkownika.

Ten interfejs API zaktualizuje wartość UserRecord.tokensValidAfterTime użytkownika do bieżącego czasu UTC. Ważne jest, aby serwer, na którym to się dzieje, miał ustawiony prawidłowo i zsynchronizowany zegar.

Chociaż spowoduje to unieważnienie wszystkich sesji określonego użytkownika i uniemożliwi wybicie nowych tokenów identyfikacyjnych dla istniejących sesji, istniejące tokeny identyfikacyjne mogą pozostać aktywne aż do ich naturalnego wygaśnięcia (jednej godziny). Aby sprawdzić, czy tokeny identyfikacyjne zostały unieważnione, użyj metody BaseAuth.verifyIdToken() , gdzie checkRevoked ma wartość true.

Podpis:

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

Parametry

Parametr Typ Opis
uid strunowy uid odpowiadający użytkownikowi, którego tokeny odświeżania mają zostać unieważnione.

Zwroty:

Obietnica<pusta>

Pusta obietnica spełniona po unieważnieniu tokenów odświeżania użytkownika.

BaseAuth.setCustomUserClaims()

Ustawia dodatkowe roszczenia programisty dla istniejącego użytkownika identyfikowanego przez podany uid , zwykle używane do definiowania ról użytkowników i poziomów dostępu. Oświadczenia te powinny zostać rozprzestrzenione na wszystkie urządzenia, na których użytkownik jest już zalogowany (po wygaśnięciu tokena lub wymuszeniu odświeżenia tokenu) i przy następnym logowaniu użytkownika. Jeśli używana jest zastrzeżona nazwa oświadczenia OIDC (sub, iat, iss itp.) ), zgłaszany jest błąd. Są one ustawiane na tokenie identyfikatora uwierzytelnionego użytkownika JWT.

Zobacz Definiowanie ról użytkowników i poziomów dostępu, aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.

Podpis:

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

Parametry

Parametr Typ Opis
uid strunowy uid użytkownika do edycji.
niestandardowe roszczenia użytkownika obiekt | zero Deweloper twierdzi, że ustawia. Jeśli wartość null zostanie przekazana, istniejące oświadczenia niestandardowe zostaną usunięte. Przekazanie niestandardowego ładunku oświadczeń większego niż 1000 bajtów spowoduje zgłoszenie błędu. Oświadczenia niestandardowe są dodawane do tokena identyfikacyjnego użytkownika, który jest przesyłany przy każdym uwierzytelnionym żądaniu. W przypadku atrybutów użytkownika niezwiązanych z dostępem do profilu użyj bazy danych lub innych oddzielnych systemów przechowywania.

Zwroty:

Obietnica<pusta>

Obietnica, która zostaje rozwiązana po pomyślnym zakończeniu operacji.

BaseAuth.updateProviderConfig()

Zwraca obietnicę, która jest rozpoznawana ze zaktualizowaną konfiguracją AuthProviderConfig odpowiadającą określonemu identyfikatorowi dostawcy. Jeśli określony identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found .

Obsługa dostawców SAML i OIDC wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .

Podpis:

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

Parametry

Parametr Typ Opis
identyfikator dostawcy strunowy Identyfikator dostawcy odpowiadający konfiguracji dostawcy do aktualizacji.
zaktualizowana konfiguracja UpdateAuthProviderRequest Zaktualizowana konfiguracja.

Zwroty:

Obietnica< AuthProviderConfig >

Obietnica, która rozwiązuje się wraz ze zaktualizowaną konfiguracją dostawcy.

BaseAuth.updateUser()

Aktualizuje istniejącego użytkownika.

Zobacz Aktualizowanie użytkownika , aby uzyskać próbki kodu i szczegółową dokumentację.

Podpis:

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

Parametry

Parametr Typ Opis
uid strunowy uid odpowiadający użytkownikowi, który ma zostać zaktualizowany.
nieruchomości Żądanie aktualizacji Właściwości do zaktualizowania dla podanego użytkownika.

Zwroty:

Obietnica< Rekord użytkownika >

Obietnica spełniona dzięki zaktualizowanym danym użytkownika.

BaseAuth.verifyIdToken()

Weryfikuje token identyfikatora Firebase (JWT). Jeśli token jest ważny, obietnica zostaje spełniona dzięki zdekodowanym żądaniom tokena; w przeciwnym razie obietnica zostanie odrzucona.

Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, zgłaszany jest błąd auth/user-disabled . Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi ID została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/id-token-revoked . Jeśli nie określono, kontrola nie jest stosowana.

Zobacz Weryfikacja tokenów identyfikacyjnych , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.

Podpis:

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

Parametry

Parametr Typ Opis
idToken strunowy Token identyfikacyjny do sprawdzenia.
sprawdźUnieważnione wartość logiczna Określa, czy sprawdzać, czy token identyfikacyjny został unieważniony. Wymaga to dodatkowego żądania do zaplecza Firebase Auth w celu sprawdzenia czasu tokensValidAfterTime dla odpowiedniego użytkownika. Jeżeli nie określono inaczej, to dodatkowe sprawdzenie nie jest stosowane.

Zwroty:

Obietnica < DecodedIdToken >

Obietnica spełniona dzięki zdekodowanym żądaniom tokena, jeśli token identyfikacyjny jest ważny; w przeciwnym razie odrzucona obietnica.

BaseAuth.verifySessionCookie()

Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z oświadczeniami dotyczącymi plików cookie. Odrzuca obietnicę, jeśli nie można zweryfikować pliku cookie.

Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony: Jeśli tak, zgłaszany jest błąd auth/user-disabled . Jeśli nie, sprawdza, czy sesja odpowiadająca plikowi cookie sesji została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/session-cookie-revoked . Jeśli nie określono, kontrola nie jest wykonywana.

Zobacz Weryfikacja plików cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją

Podpis:

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

Parametry

Parametr Typ Opis
plik cookie sesji strunowy Plik cookie sesji do sprawdzenia.
sprawdźUnieważnione wartość logiczna

Zwroty:

Obietnica < DecodedIdToken >

Obietnica spełniona w przypadku zdekodowanych roszczeń sesyjnego pliku cookie, jeśli sesyjny plik cookie jest ważny; w przeciwnym razie odrzucona obietnica.