BaseAuth class

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

Podpis:

export declare abstract class BaseAuth

Metody

Metoda Modyfikatory Opis
createCustomToken(uid, developerClaims) Tworzy nowy token niestandardowy Firebase (JWT), który można odesłać z powrotem na urządzenie klienckie w celu logowania się za pomocą jego pakietów SDK signInWithCustomToken() metody. (W instancjach niestandardowych najemca będzie też umieszczany identyfikator najemcy).Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Tworzenie tokenów niestandardowych.
createProviderConfig(config) Zwraca obietnicę realizowaną przez nowo utworzony AuthProviderConfig po utworzeniu nowej konfiguracji dostawcy.Obsługa SAML i dostawców OIDC wymaga Google Cloud Identity Platform (GCIP). Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.
createSessionCookie(idToken, sessionCookieOptions) Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT może być ustawiony jako plik cookie sesji po stronie serwera z niestandardową zasadą dotyczącą plików cookie i może być używany do zarządzania sesją. Token JWT pliku cookie sesji będzie miał ten sam ładunek ładunku co podany token identyfikatora.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Zarządzanie plikami cookie sesji.
createUser(properties) Tworzy nowego użytkownika.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Tworzenie użytkownika.
deleteProviderConfig(providerId) Usuwa konfigurację dostawcy odpowiadającą przekazanemu identyfikatorowi dostawcy. Jeśli podany identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found.Obsługa SAML i dostawców OIDC wymaga Identity Platform (GCIP) w Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.
deleteUser(uid), Usuwa istniejącego użytkownika.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Usuwanie użytkownika.
deleteUsers(uids) Usuwa użytkowników określonych przez podane identyfikatory UID.Usunięcie nieistniejącego użytkownika nie spowoduje błędu (tj. ta metoda jest idempotentna). Uznaje się, że nieistniejące konta użytkowników zostały usunięte i dlatego są zliczane w wartości DeleteUsersResult.successCount.Można podać maksymalnie 1000 identyfikatorów. Jeśli podano więcej niż 1000 identyfikatorów, ta metoda zgłasza FirebaseAuthError.Częstotliwość tego interfejsu API jest obecnie ograniczona na serwerze do 1 zapytań na sekundę. Jeśli przekroczysz ten limit, może wystąpić błąd przekroczenia limitu. Jeśli więc chcesz usunąć więcej niż 1000 użytkowników, musisz dodać opóźnienie, aby nie przekroczyć tego limitu.
generateEmailverificationLink(e-mail, actionCodeSettings) Generuje pozapasmowy link do działania w e-mailu pozwalającym zweryfikować, czy użytkownik jest właścicielem tego adresu. Obiekt ActionCodeSettings dostarczany jako argument dla tej metody określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym linku itp.
generatePasswordResetLink(e-mail, actionCodeSettings) Generuje zewnętrzny link do działania w e-mailu, który pozwala zresetować hasło użytkownika. Link zostanie wygenerowany dla użytkownika o podanym adresie e-mail. Opcjonalny obiekt ActionCodeSettings określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, oraz dodatkowe informacje o stanie, które mają być przekazywane w precyzyjnym linku itp.
generateSignInWithEmailLink(email, actionCodeSettings) Generuje pozapasmowy link do działania w e-mailu pozwalającym zweryfikować, czy użytkownik jest właścicielem tego adresu. Obiekt ActionCodeSettings dostarczany jako argument dla tej metody określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym linku itp.
generateVerifyAndChangeEmailLink(e-mail, newEmail, actionCodeSettings) Generuje zewnętrzny link do działania w e-mailu, aby zweryfikować własność użytkownika podanego adresu e-mail. Obiekt ActionCodeSettings dostarczany jako argument dla tej metody określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym linku itp.
getProviderConfig(providerId) Wyszukuje konfigurację dostawcy uwierzytelniania według podanego identyfikatora. Zwraca obietnicę, której konfiguracja odpowiada określonemu identyfikatorowi dostawcy. Jeśli podany identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found.Obsługa SAML i dostawców OIDC wymaga Identity Platform (GCIP) w Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.
getUser(uid), Pobiera dane użytkownika odpowiadające określonemu uid.Przykładowe dane i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.
getUserByEmail(adres e-mail) Pobiera dane użytkownika odpowiadające danemu adresowi e-mail.Przykładowe dane i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.
getUserByPhoneNumber(phoneNumber), Pobiera dane użytkownika odpowiadające danemu numerowi telefonu. Numer telefonu musi być zgodny ze specyfikacją E.164.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.
getUserByProviderUid(providerId, uid) Pobiera dane użytkownika odpowiadające danemu identyfikatorowi dostawcy.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.
getUsers(identyfikatory) Pobiera dane użytkownika odpowiadające określonym identyfikatorom.Nie ma gwarancji kolejności; W szczególności n-ty wpis na liście wyników nie musi odpowiadać n-tej pozycji na liście parametrów wejściowych.Można podać tylko maksymalnie 100 identyfikatorów. Jeśli podano więcej niż 100 identyfikatorów, ta metoda powoduje zgłoszenie FirebaseAuthError.
importUsers(użytkownicy, opcje) Importuje podaną listę użytkowników do Uwierzytelniania Firebase. Jednocześnie można zaimportować maksymalnie 1000 użytkowników. Podczas importowania użytkowników z hasłami należy określić UserImportOptions. Ta operacja jest zoptymalizowana pod kątem importu zbiorczego i zignoruje sprawdzanie unikatowości uid, email i innej unikatowości identyfikatorów, co może spowodować powstanie duplikatów.
listProviderConfigs(options), Zwraca listę istniejących konfiguracji dostawców pasujących do podanego filtra. Jednocześnie może być wyświetlanych maksymalnie 100 konfiguracji dostawców.Obsługa dostawców SAML i OIDC wymaga Identity Platform (GCIP) w Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.
listUsers(maxResults, pageToken) Pobiera listę użytkowników (tylko pojedyncza wsad) o rozmiarze maxResults, zaczynając od przesunięcia określonego przez pageToken. Służy do pobierania partiami wszystkich użytkowników określonego projektu.Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Lista wszystkich użytkowników.
revokeRefreshTokens(uid), Unieważnia wszystkie tokeny odświeżania istniejącego użytkownika.Ten interfejs API zaktualizuje wartość UserRecord.tokensValidAfterTime użytkownika na aktualny czas UTC. Zegar serwera, na którym ta czynność jest wywoływana, musi być ustawiony prawidłowo i zsynchronizowany.Spowoduje to cofnięcie wszystkich sesji określonego użytkownika i wyłączenie możliwości generowania nowych tokenów tożsamości istniejących sesji. Istniejące tokeny mogą pozostać aktywne do ich naturalnego wygaśnięcia (1 godzina). Aby sprawdzić, czy tokeny tożsamości zostały unieważnione, użyj BaseAuth.verifyIdToken(), gdzie checkRevoked ma wartość true (prawda).
setCustomUserClaims(uid, customUserClaims). Ustawia dodatkowe roszczenia dewelopera do istniejącego użytkownika identyfikowanego przez podany uid. Zwykle jest to używane do definiowania ról użytkownika i poziomów dostępu. Deklaracje te powinny obowiązywać na wszystkich urządzeniach, na których użytkownik jest już zalogowany (po wygaśnięciu tokena lub w przypadku wymuszenia odświeżenia tokena) oraz przy następnym logowaniu użytkownika. W przypadku użycia zarezerwowanej nazwy deklaracji OIDC (sub, iat, iss itp.) zgłaszany jest błąd. Są one ustawiane w tokenie JWT tokena identyfikatora uwierzytelnionego użytkownika.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Definiowanie ról i poziomów dostępu użytkowników.
updateProviderConfig(providerId, updatedConfig) Zwraca obietnicę, której realizacja wymaga zaktualizowanej wartości AuthProviderConfig odpowiadającej określonemu identyfikatorowi dostawcy. Jeśli podany identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found.Obsługa SAML i dostawców OIDC wymaga Identity Platform (GCIP) w Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.
updateUser(uid; właściwości) Aktualizuje istniejącego użytkownika.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Aktualizowanie użytkownika.
verifyIdToken(idToken, checkUnieważniony) Sprawdza token identyfikatora Firebase (JWT). Jeśli token jest prawidłowy, obietnica jest realizowana za pomocą zdekodowanych deklaracji. w przeciwnym razie obietnica jest odrzucana.Jeśli zasada checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, jest zgłaszany błąd auth/user-disabled. Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi tożsamości 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 tego ustawienia, kontrola nie zostanie zastosowana.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Weryfikacja tokenów tożsamości.
verifySessionCookie(sessionCookie, checkUnsubscribe) Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z żądaniami dotyczącymi plików cookie. Odrzuca obietnicę, jeśli nie można zweryfikować pliku cookie.Jeśli zasada checkRevoked ma wartość Prawda, najpierw sprawdza, czy dany użytkownik jest wyłączony. Jeśli tak, jest zgłaszany 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 tego ustawienia, sprawdzanie nie jest wykonywane.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Sprawdzanie plików cookie sesji.

BaseAuth.createCustomToken()

Tworzy nowy token niestandardowy Firebase (JWT), który można odesłać z powrotem na urządzenie klienckie w celu logowania się za pomocą jego pakietów SDK signInWithCustomToken() metody. W instancjach współpracujących z najemcą będzie też osadzony identyfikator najemcy w tokenie.

Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Tworzenie tokenów niestandardowych.

Podpis:

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

Parametry

Parametr Typ Opis
uid ciąg znaków uid, który ma być używany jako temat tokena niestandardowego.
Deklaracje deweloperów Obiekt Opcjonalne dodatkowe żądania do uwzględnienia w ładunku tokena niestandardowego.

Zwroty:

Obietnica<ciąg>

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

BaseAuth.createProviderConfig()

Zwraca obietnicę, która jest realizowana z nowo utworzonym obiektem AuthProviderConfig po utworzeniu nowej konfiguracji dostawcy.

Obsługa dostawców SAML i OIDC wymaga usługi Identity Platform (GCIP) Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.

Podpis:

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

Parametry

Parametr Typ Opis
konfiguracja AuthProviderConfig, Konfiguracja dostawcy do utworzenia.

Zwroty:

Promise<AuthProviderConfig>

Obietnica, która zostaje zrealizowana z utworzoną konfiguracją dostawcy.

BaseAuth.createSessionCookie()

Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT może być ustawiony jako plik cookie sesji po stronie serwera z niestandardową zasadą dotyczącą plików cookie i może być używany do zarządzania sesją. Token JWT pliku cookie sesji będzie miał taki sam ładunek jak podany token identyfikatora.

Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Zarządzanie plikami cookie sesji.

Podpis:

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

Parametry

Parametr Typ Opis
idToken ciąg znaków Token identyfikatora Firebase, który ma zostać zastąpiony przez plik cookie sesji.
sessionCookieOptions SessionCookieOptions. Opcje plików cookie sesji, które obejmują niestandardowy czas trwania sesji.

Zwroty:

Obietnica<ciąg>

Obietnica, która kończy się po zrealizowaniu za pomocą utworzonego pliku cookie sesji.

BaseAuth.createUser()

Tworzy nowego użytkownika.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Tworzenie konta użytkownika.

Podpis:

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

Parametry

Parametr Typ Opis
właściwości CreateRequest Właściwości, które zostaną ustawione w rekordzie nowego użytkownika.

Zwroty:

Obietnica<UserRecord>

Obietnicę wypełnioną danymi użytkownika odpowiadającymi nowo utworzonemu użytkownikowi.

BaseAuth.deleteProviderConfig()

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

Obsługa dostawców SAML i OIDC wymaga usługi Identity Platform (GCIP) Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.

Podpis:

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

Parametry

Parametr Typ Opis
Identyfikator dostawcy ciąg znaków Identyfikator dostawcy odpowiadający konfiguracji dostawcy do usunięcia.

Zwroty:

Obietnica<void>

Obietnica, której realizacja kończy się w momencie realizacji.

BaseAuth.deleteUser()

Usuwa istniejącego użytkownika.

Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Usuwanie użytkownika.

Podpis:

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

Parametry

Parametr Typ Opis
uid ciąg znaków Pole uid odpowiadające użytkownikowi, którego chcesz usunąć.

Zwroty:

Obietnica<void>

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

BaseAuth.deleteUsers()

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

Usunięcie nieistniejącego użytkownika nie spowoduje błędu (tj. ta metoda jest idempotentna). Uznaje się, że nieistniejące konta użytkowników zostały usunięte i są zliczane w wartości DeleteUsersResult.successCount.

Można podać maksymalnie 1000 identyfikatorów. Jeśli podano więcej niż 1000 identyfikatorów, ta metoda powoduje zgłoszenie FirebaseAuthError.

Częstotliwość wysyłania tego interfejsu API na serwerze jest obecnie ograniczona do 1 zapytań na sekundę. Jeśli przekroczysz ten limit, może wystąpić błąd przekroczenia limitu. Jeśli więc chcesz usunąć więcej niż 1000 użytkowników, musisz dodać opóźnienie, aby nie przekroczyć tego limitu.

Podpis:

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

Parametry

Parametr Typ Opis
identyfikatory UID ciąg znaków[] Wartość uids odpowiadająca użytkownikom do usunięcia.

Zwroty:

Obietnica<DeleteUsersResult>

Obietnica odnosząca się do łącznej liczby udanych lub nieudanych usunięć oraz tablicy błędów odpowiadających nieudanym usunięciu.

Generuje pozapasmowy link do działania w e-mailu pozwalającym zweryfikować, czy użytkownik jest właścicielem tego adresu. Obiekt ActionCodeSettings dostarczany jako argument dla tej metody określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym linku itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail ciąg znaków Konto e-mail do weryfikacji.
Ustawienia kodu akcji ActionCodeSettings Ustawienia kodu działań. Jeśli zostanie podany, adres URL stanu/kontynuacji będzie miał wartość „continueUrl”. w linku do weryfikacji e-maila. Będzie ona używana na domyślnej stronie docelowej weryfikacji adresu e-mail do wyświetlania linku umożliwiającego powrót do zainstalowanej aplikacji. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dodawany żaden adres URL. Podany adres URL stanu musi należeć do domeny, która deweloper umieścił na białej liście w konsoli. W przeciwnym razie pojawia się błąd. Przekierowania do aplikacji mobilnych działają tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z Linków dynamicznych Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są respektowane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase.

Zwroty:

Obietnica<ciąg>

Obietnica wiążąca się 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 zewnętrzny link do działania w e-mailu, który pozwala zresetować hasło użytkownika. Link zostanie wygenerowany dla użytkownika o podanym adresie e-mail. Opcjonalny obiekt ActionCodeSettings określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, oraz dodatkowe informacje o stanie, które mają być przekazywane w precyzyjnym linku itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail ciąg znaków Adres e-mail użytkownika, którego hasło ma zostać zresetowane.
Ustawienia kodu akcji ActionCodeSettings Ustawienia kodu działań. Jeśli zostanie podany, adres URL stanu/kontynuacji będzie miał wartość „continueUrl”. w linku do resetowania hasła. Domyślna strona docelowa resetowania hasła będzie go używać do wyświetlania linku umożliwiającego powrót do aplikacji, jeśli jest zainstalowana. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dodawany żaden adres URL. Podany adres URL stanu musi należeć do domeny, która deweloper umieścił na białej liście w konsoli. W przeciwnym razie pojawia się błąd. Przekierowania do aplikacji mobilnych działają tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z Linków dynamicznych Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są respektowane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase.

Zwroty:

Obietnica<ciąg>

Obietnica wiążąca się 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 pozapasmowy link do działania w e-mailu pozwalającym zweryfikować, czy użytkownik jest właścicielem tego adresu. Obiekt ActionCodeSettings dostarczany jako argument dla tej metody określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym linku itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail ciąg znaków Konto e-mail do weryfikacji.
Ustawienia kodu akcji ActionCodeSettings Ustawienia kodu działań. Jeśli zostanie podany, adres URL stanu/kontynuacji będzie miał wartość „continueUrl”. w linku do weryfikacji e-maila. Będzie ona używana na domyślnej stronie docelowej weryfikacji adresu e-mail do wyświetlania linku umożliwiającego powrót do zainstalowanej aplikacji. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dodawany żaden adres URL. Podany adres URL stanu musi należeć do domeny, która deweloper umieścił na białej liście w konsoli. W przeciwnym razie pojawia się błąd. Przekierowania do aplikacji mobilnych działają tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z Linków dynamicznych Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są respektowane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase.

Zwroty:

Obietnica<ciąg>

Obietnica wiążąca się 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 zewnętrzny link do działania w e-mailu, aby zweryfikować własność użytkownika podanego adresu e-mail. Obiekt ActionCodeSettings dostarczany jako argument dla tej metody określa, czy link ma być obsługiwany przez aplikację mobilną lub przeglądarkę, wraz z dodatkowymi informacjami o stanie, które mają być przekazywane w precyzyjnym linku itp.

Podpis:

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

Parametry

Parametr Typ Opis
e-mail ciąg znaków Bieżące konto e-mail.
nowyAdres e-mail ciąg znaków Adres e-mail, na który aktualizujesz konto.
Ustawienia kodu akcji ActionCodeSettings Ustawienia kodu działań. Jeśli zostanie podany, adres URL stanu/kontynuacji będzie miał wartość „continueUrl”. w linku do weryfikacji e-maila. Będzie ona używana na domyślnej stronie docelowej weryfikacji adresu e-mail do wyświetlania linku umożliwiającego powrót do zainstalowanej aplikacji. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dodawany żaden adres URL. Podany URL stanu musi należeć do domeny, która jest autoryzowana w konsoli. W przeciwnym razie wystąpi błąd. Przekierowania do aplikacji mobilnych działają tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z Linków dynamicznych Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są respektowane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase.

Zwroty:

Obietnica<ciąg>

Obietnica wiążąca się z wygenerowanym linkiem.

BaseAuth.getProviderConfig()

Wyszukuje konfigurację dostawcy uwierzytelniania według podanego identyfikatora. Zwraca obietnicę, której konfiguracja odpowiada określonemu identyfikatorowi dostawcy. Jeśli podany identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found.

Obsługa dostawców SAML i OIDC wymaga usługi Identity Platform (GCIP) Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.

Podpis:

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

Parametry

Parametr Typ Opis
Identyfikator dostawcy ciąg znaków Identyfikator dostawcy odpowiadający konfiguracji dostawcy do zwrócenia.

Zwroty:

Promise<AuthProviderConfig>

Obietnica, która spełnia wymagania konfiguracji odpowiadającej podanemu identyfikatorowi.

BaseAuth.getUser()

Pobiera dane użytkownika odpowiadające określonemu uid.

Przykłady kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.

Podpis:

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

Parametry

Parametr Typ Opis
uid ciąg znaków Pole uid odpowiadające użytkownikowi, którego dane mają zostać pobrane.

Zwroty:

Obietnica<UserRecord>

Obietnica zrealizowana z użyciem danych użytkownika podanych w dokumencie uid.

BaseAuth.getUserByEmail()

Pobiera dane użytkownika odpowiadające danemu adresowi e-mail.

Przykłady kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.

Podpis:

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

Parametry

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

Zwroty:

Obietnica<UserRecord>

Obietnicę wypełnioną danymi użytkownika powiązanymi z podanym adresem e-mail.

BaseAuth.getUserByPhoneNumber()

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

Przykłady kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.

Podpis:

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

Parametry

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

Zwroty:

Obietnica<UserRecord>

Obietnicę wypełnioną danymi użytkownika powiązanymi z podanym numerem telefonu.

BaseAuth.getUserByProviderUid(),

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

Przykłady kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkownika.

Podpis:

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

Parametry

Parametr Typ Opis
Identyfikator dostawcy ciąg znaków Identyfikator dostawcy, np. „google.com” dla dostawcy Google.
uid ciąg znaków Identyfikator użytkownika danego dostawcy.

Zwroty:

Obietnica<UserRecord>

Obietnica zrealizowana z użyciem danych użytkownika odpowiadających danemu identyfikatorowi dostawcy.

BaseAuth.getUsers()

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

Nie ma gwarancji zamówienia. w szczególności nie ma gwarancji, że n-ty wpis na liście wyników będzie odpowiadać n-tej pozycji na liście parametrów wejściowych.

Można podać maksymalnie 100 identyfikatorów. Jeśli podano więcej niż 100 identyfikatorów, ta metoda powoduje zgłoszenie FirebaseAuthError.

Podpis:

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

Parametry

Parametr Typ Opis
identyfikatory UserIdentifier[] Identyfikatory używane do określania, które rekordy użytkownika mają zostać zwrócone. Nie może być więcej niż 100 pozycji.

Zwroty:

Obietnica<GetUsersResult>

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

Wyjątki

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

BaseAuth.importUsers()

Importuje podaną listę użytkowników do Uwierzytelniania Firebase. Jednocześnie można zaimportować maksymalnie 1000 użytkowników. Podczas importowania użytkowników z hasłami należy określić UserImportOptions. Ta operacja jest zoptymalizowana pod kątem importu zbiorczego i ignoruje weryfikację uid, email i innej unikatowości identyfikatorów, co może skutkować duplikatami.

Podpis:

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

Parametry

Parametr Typ Opis
użytkownicy UserImportRecord[] Lista rekordów użytkowników do zaimportowania do Uwierzytelniania Firebase.
opcje UserImportOptions Opcje importowania użytkowników, wymagane, gdy podani użytkownicy podają dane logowania do hasła.

Zwroty:

Obietnica<UserImportResult>

Obietnica, której ważność zostaje zrealizowana, gdy operacja się zakończy po zakończeniu importu. Obejmuje to liczbę udanych i nieudanych importów oraz odpowiadające im błędy.

BaseAuth.listProviderConfigs()

Zwraca listę istniejących konfiguracji dostawców pasujących do podanego filtra. Jednocześnie może być wyświetlanych maksymalnie 100 konfiguracji dostawców.

Obsługa dostawców SAML i OIDC wymaga usługi Identity Platform (GCIP) Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.

Podpis:

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

Parametry

Parametr Typ Opis
opcje AuthProviderConfigFilter, Filtr konfiguracji dostawcy, który ma zostać zastosowany.

Zwroty:

Obietnica<ListProviderConfigResults>

Obietnica spełniająca warunki listy konfiguracji dostawców spełniających wymagania filtra.

BaseAuth.listUsers()

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

Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Lista wszystkich użytkowników.

Podpis:

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

Parametry

Parametr Typ Opis
maxResults liczba Rozmiar strony (1000), jeśli nie został zdefiniowany. Jest to również maksymalny dozwolony limit.
pageToken ciąg znaków Token następnej strony. Jeśli nie określono tego ustawienia, zwraca użytkowników bez przesunięcia.

Zwroty:

Obietnica<ListUsersResult>

Obietnica, która kończy się z bieżącą grupą pobranych użytkowników i tokenem następnej strony.

BaseAuth.revokeRefreshTokens()

Unieważnia wszystkie tokeny odświeżania istniejącego użytkownika.

Ten interfejs API zaktualizuje pole UserRecord.tokensValidAfterTime użytkownika na bieżący czas UTC. Ważne jest, aby zegar serwera, na którym ta funkcja została wywołana, był prawidłowo ustawiony i zsynchronizowany.

Spowoduje to cofnięcie wszystkich sesji określonego użytkownika i wyłączenie nowych tokenów tożsamości istniejących sesji. Istniejące tokeny mogą pozostać aktywne do momentu ich naturalnego wygaśnięcia (godziny). Aby sprawdzić, czy tokeny tożsamości zostały unieważnione, użyj BaseAuth.verifyIdToken(), gdzie checkRevoked ma wartość true (prawda).

Podpis:

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

Parametry

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

Zwroty:

Obietnica<void>

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

BaseAuth.setCustomUserClaims()

Ustawia dodatkowe roszczenia dewelopera do istniejącego użytkownika określonego przez uid. Zwykle służy do definiowania ról użytkownika i poziomów dostępu. Deklaracje te powinny zostać rozpowszechnione na wszystkich urządzeniach, na których użytkownik jest już zalogowany (po wygaśnięciu tokena lub w przypadku wymuszenia odświeżenia tokena) oraz przy następnym logowaniu użytkownika. W przypadku użycia zarezerwowanej nazwy deklaracji OIDC (sub, iat, iss itp.) zgłaszany jest błąd. Są one ustawiane w tokenie JWT tokena identyfikatora uwierzytelnionego użytkownika.

Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Definiowanie ról użytkowników i poziomów dostępu.

Podpis:

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

Parametry

Parametr Typ Opis
uid ciąg znaków uid użytkownika, którego uprawnienia chcesz edytować.
customUserClaims obiekt | wartość null Deweloper deklaruje, że musi ustawić. Jeśli zostanie podana wartość null, istniejące roszczenia niestandardowe zostaną usunięte. Przekazywanie niestandardowego ładunku deklaracji o rozmiarze większym niż 1000 bajtów spowoduje błąd. Żądania niestandardowe są dodawane do tokena identyfikatora użytkownika, który jest przesyłany w przypadku każdego uwierzytelnionego żądania. W przypadku atrybutów użytkownika, które nie mają dostępu do profilu, użyj bazy danych lub innych systemów pamięci masowej.

Zwroty:

Obietnica<void>

Obietnica, która zostaje zrealizowana po pomyślnym zakończeniu operacji.

BaseAuth.updateProviderConfig()

Zwraca obietnicę, której realizacja wymaga zaktualizowanej wartości AuthProviderConfig odpowiadającej określonemu identyfikatorowi dostawcy. Jeśli podany identyfikator nie istnieje, zgłaszany jest błąd auth/configuration-not-found.

Obsługa dostawców SAML i OIDC wymaga usługi Identity Platform (GCIP) Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.

Podpis:

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

Parametry

Parametr Typ Opis
Identyfikator dostawcy ciąg znaków Identyfikator dostawcy odpowiadający konfiguracji dostawcy do zaktualizowania.
updatedConfig UpdateAuthProviderRequest Zaktualizowana konfiguracja.

Zwroty:

Promise<AuthProviderConfig>

Obietnica, która zostaje zrealizowana po zaktualizowanej konfiguracji dostawcy.

BaseAuth.updateUser()

Aktualizuje istniejącego użytkownika.

Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Aktualizowanie użytkownika.

Podpis:

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

Parametry

Parametr Typ Opis
uid ciąg znaków Pole uid odpowiadające użytkownikowi, którego dotyczy aktualizacja.
właściwości UpdateRequest Właściwości, które mają zostać zaktualizowane po podaniu podanego użytkownika.

Zwroty:

Obietnica<UserRecord>

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

BaseAuth.verifyIdToken()

Sprawdza token identyfikatora Firebase (JWT). Jeśli token jest prawidłowy, obietnica jest realizowana za pomocą zdekodowanych deklaracji. w przeciwnym razie obietnica zostanie odrzucona.

Jeśli checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, jest zgłaszany błąd auth/user-disabled. Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi tożsamości 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 tej opcji, kontrola nie zostanie zastosowana.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Weryfikowanie tokenów tożsamości.

Podpis:

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

Parametry

Parametr Typ Opis
idToken ciąg znaków Token identyfikatora do zweryfikowania.
sprawdzanieUnieważnione wartość logiczna Określa, czy sprawdzić, czy token identyfikatora został unieważniony. Wymaga to przesłania dodatkowego żądania do backendu Uwierzytelniania Firebase, aby sprawdzić czas tokensValidAfterTime dla odpowiedniego użytkownika. Jeśli jej nie określisz, dodatkowa kontrola nie będzie stosowana.

Zwroty:

Obietnica<DecodedIdToken>

Obietnica spełniona z zdekodowanymi deklaracjami tokena, jeśli token identyfikatora jest prawidłowy. w przeciwnym razie odrzucono.

BaseAuth.verifySessionCookie()

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

Jeśli checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, jest zgłaszany 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 tej opcji, kontrola nie zostanie przeprowadzona.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Weryfikowanie plików cookie sesji

Podpis:

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

Parametry

Parametr Typ Opis
sessionCookie ciąg znaków Plik cookie sesji do weryfikacji.
sprawdzanieUnieważnione wartość logiczna

Zwroty:

Obietnica<DecodedIdToken>

Obietnica zrealizowana z odkodowanymi deklaracjami z pliku cookie sesji, jeśli plik cookie sesji jest prawidłowy. w przeciwnym razie odrzucono.