Wspólny interfejs nadrzędny interfejsów API Auth i TenantAwareAuth.
Podpis:
export declare abstract class BaseAuth
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| createCustomToken(uid, developerClaims) | Tworzy nowy niestandardowy token Firebase (JWT), który można odsyłać z powrotem na urządzenie klienckie, aby logować się za pomocą metod signInWithCustomToken() z pakietów SDK klientów. W przypadku instancji wykorzystujących najemcę identyfikator najemcy zostanie umieszczony również w tokenie.Przykładowy kod i szczegółową dokumentację znajdziesz w sekcji Tworzenie tokenów niestandardowych. |
|
| createProviderConfig(config) | Zwraca obietnicę, która znika z nowo utworzonym elementem AuthProviderConfig po utworzeniu nowej konfiguracji dostawcy.Obsługa dostawców SAML i OIDC wymaga usługi Identity Platform (GCIP) w Google Cloud. 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żna ustawić jako plik cookie sesji po stronie serwera z użyciem niestandardowych zasad dotyczących plików cookie i można go używać do zarządzania sesją. JWT pliku cookie sesji będzie zawierać te same deklaracje ładunku co podany token identyfikatora.Przykłady kodu i szczegółową dokumentację znajdziesz w artykule Zarządzanie plikami cookie sesji. | |
| createUser(properties) | Tworzy nowego użytkownika.Przykładowe fragmenty kodu 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 dostawców SAML i OIDC wymaga usługi Google Cloud Identity Platform (GCIP). Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS. |
|
| deleteUser(uid) | Usuwa istniejącego użytkownika.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Usuwanie konta użytkownika. | |
| deleteUsers(uid) | Usuwa użytkowników określonych przez dane identyfikatory UID.Usunięcie nieistniejącego użytkownika nie spowoduje błędu (tj. ta metoda jest idempotentna). Nieistniejący użytkownicy są uznawani za usuniętych i są wliczani w wartość DeleteUsersResult.successCount.Można podać maksymalnie 1000 identyfikatorów. Jeśli podasz więcej niż 1000 identyfikatorów, ta metoda spowoduje wystąpienie błędu FirebaseAuthError.Szybkość dział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 kont użytkowników, musisz dodać opóźnienie, aby zapobiec przekroczeniu limitu. |
|
| generateEmailVerifyLink(e-mail, ActionCodeSettings) | Generuje link z wezwaniem do działania poza zespołem w celu potwierdzenia, że użytkownik należy do określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument 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ą zostać przekazane w precyzyjnym linku itp. | |
| generatePasswordResetLink(e-mail; ustawieniakodu akcji) | Generuje link do działania e-mailowego spoza zespołu, który pozwala zresetować hasło 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ą lub przeglądarkę, a także dodatkowe informacje o stanie, które mają zostać przekazane w precyzyjnym linku itp. | |
| generateSignInWithEmailLink(e-mail, actionCodeSettings) | Generuje link z wezwaniem do działania poza zespołem w celu potwierdzenia, że użytkownik należy do określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument 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ą zostać przekazane w precyzyjnym linku itp. | |
| generateVerifyAndChangeEmailLink(e-mail, nowy adres e-mail, ustawieniakodu akcji) | Generuje zewnętrzny link do działania e-mail, który pozwala zweryfikować własność określonego e-maila. Obiekt ActionCodeSettings podany jako argument 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ą zostać przekazane w precyzyjnym linku itp. | |
| getProviderConfig(providerId) | Wyszukuje konfigurację dostawcy uwierzytelniania według podanego identyfikatora. Zwraca obietnicę, która zniknie z konfiguracją dostawcy odpowiadającą podanemu 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 Google Cloud Identity Platform (GCIP). Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS. |
|
| getUser(uid). | Pobiera dane użytkownika odpowiadające danemu elementowi uid.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkowników. |
|
| getUserByEmail(e-mail) | Pobiera dane użytkownika odpowiadające określonemu adresowi e-mail.Zobacz Pobieranie danych użytkowników, aby zobaczyć przykłady kodu i szczegółową dokumentację. | |
| 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żytkowników. | |
| getUserByProviderUid(providerId, uid) | Pobiera dane użytkownika odpowiadające podanemu identyfikatorowi dostawcy.Zobacz Pobieranie danych użytkownika, aby zobaczyć przykłady kodu i szczegółową dokumentację. | |
| getUsers(identifiers), | Pobiera dane użytkownika odpowiadające określonym identyfikatorami.Nie ma gwarancji kolejności; w szczególności nie ma gwarancji, że n-ta pozycja 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 podanych jest więcej niż 100 identyfikatorów, ta metoda zgłasza 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 kont użytkowników z hasłami należy określić parametr UserImportOptions. Ta operacja jest zoptymalizowana pod kątem importowania zbiorczego i ignoruje sprawdzanie unikalności identyfikatorów uid, email oraz innych identyfikatorów, które mogą skutkować duplikatami. |
|
| listProviderConfigs(options) | Zwraca listę istniejących konfiguracji dostawcy pasujących do podanego filtra. Jednocześnie można wyświetlać maksymalnie 100 konfiguracji dostawców.Obsługa dostawców SAML i OIDC wymaga usługi 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 jedna wsad) o rozmiarze maxResults, zaczynając od przesunięcia określonego przez pageToken. Służy ona do pobierania partiami wszystkich użytkowników określonego projektu.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Lista wszystkich użytkowników. |
|
| revokeOdświeżTokens(uid) | Unieważnia wszystkie tokeny odświeżania istniejącego użytkownika.Ten interfejs API zaktualizuje wartość UserRecord.tokensValidAfterTime użytkownika na aktualną strefę czasową UTC. Ważne jest, aby na serwerze, na którym jest to wywołanie, zegar był prawidłowo ustawiony i zsynchronizowany.Spowoduje to unieważnienie wszystkich sesji określonego użytkownika i wyłączenie generowania nowych tokenów tożsamości w istniejących sesjach, ale istniejące tokeny tożsamości mogą pozostawać aktywne do czasu ich naturalnego wygaśnięcia (1 godziny). Aby sprawdzić, czy tokeny tożsamości zostały unieważnione, użyj funkcji BaseAuth.verifyIdToken(), gdzie checkRevoked ma wartość Prawda. |
|
| setCustomUserClaims(uid, customUserClaims) | Ustawia dodatkowe deklaracje dewelopera dotyczące obecnego użytkownika zidentyfikowanego przez podany uid. Zwykle są one używane do definiowania ról użytkowników i poziomów dostępu. Te deklaracje powinny zostać rozpowszechnione na wszystkie urządzenia, na których użytkownik jest już zalogowany (po wygaśnięciu tokena lub po wymuszeniu odświeżania tokena) i przy następnym logowaniu użytkownika. Jeśli zostanie użyta zarezerwowana nazwa deklaracji OIDC (sub, iat, iss itp.), wystąpi błąd. Są one ustawiane w tokenie JWT uwierzytelnionego użytkownika.Przykłady kodu i szczegółowa dokumentacja są opisane w artykule Definiowanie ról użytkowników i poziomów dostępu. |
|
| updateProviderConfig(providerId, updatedConfig) | Zwraca obietnicę, która rozwiązuje się za pomocą zaktualizowanego parametru AuthProviderConfig odpowiadającego 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 Google Cloud Identity Platform (GCIP). 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ładowy kod i szczegółową dokumentację znajdziesz w artykule Aktualizowanie użytkownika. | |
| verifyIdToken(idToken, checkUnieważniony) | Weryfikuje token identyfikatora Firebase (JWT). Jeśli token jest prawidłowy, obietnica zostanie zrealizowana za pomocą zdekodowanych deklaracji tokena. W przeciwnym razie zostanie odrzucona.Jeśli checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, zgłaszany jest błąd auth/user-disabled. Jeśli nie, sprawdź, czy sesja odpowiadająca tokenowi identyfikatora 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 inaczej, kontrola nie zostanie zastosowana.Przykładowe fragmenty kodu i szczegółową dokumentację można znaleźć w sekcji Weryfikowanie tokenów tożsamości. |
|
| verifySessionCookie(sessionCookie, checkAuthenticationd) | Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z deklaracjami 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, zostanie zgłoszony błąd auth/user-disabled. Jeśli nie, sprawdź, 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ślisz żadnej wartości, kontrola nie zostanie przeprowadzona.Przykłady kodu i szczegółowa dokumentacja znajdują się w artykule Weryfikowanie plików cookie sesji. |
BaseAuth.createCustomToken()
Tworzy nowy niestandardowy token Firebase (JWT), który można odsyłać z powrotem na urządzenie klienckie, aby logować się za pomocą metod signInWithCustomToken() z pakietów SDK klientów. W przypadku instancji wykorzystujących najemcę również identyfikator najemcy zostanie umieszczony w tokenie.
Przykładowy kod i szczegółową dokumentację znajdziesz na stronie Tworzenie tokenów niestandardowych.
Podpis:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| UID | string, | uid, który ma być używany jako temat tokena niestandardowego. |
| Twierdzenia deweloperów | obiekt | Opcjonalne dodatkowe deklaracje do uwzględnienia w ładunku tokena niestandardowego. |
Zwroty:
Obietnica<string>
Zrealizowano obietnicę za pomocą niestandardowego tokena dla podanego elementu uid i ładunku.
BaseAuth.createProviderConfig()
Zwraca obietnicę, która znika z nowo utworzonym elementem AuthProviderConfig po utworzeniu nowej konfiguracji dostawcy.
Obsługa dostawców SAML i OIDC wymaga platformy Google Cloud Identity Platform (GCIP). 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:
Obietnica<AuthProviderConfig>
Obietnica, która zniknie po utworzeniu konfiguracji 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 użyciem niestandardowych zasad dotyczących plików cookie i można go używać do zarządzania sesją. JWT pliku cookie sesji będzie zawierać te same deklaracje ładunku co podany token identyfikatora.
Przykłady kodu 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. | string, | Token identyfikatora Firebase, który ma zostać wymieniony na plik cookie sesji. |
| sessionCookieOptions | SessionCookieOptions | Opcje plików cookie sesji, które obejmują niestandardowy czas trwania sesji. |
Zwroty:
Obietnica<string>
Obietnica, która zniknie po utworzeniu 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 (Utwórz żądanie) | Właściwości, które zostaną ustawione dla nowego rekordu użytkownika do utworzenia. |
Zwroty:
Obietnica<UserRecord>
Obietnica została spełniona dzięki danym użytkownika powiązanym z nowo utworzonym użytkownikiem.
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 platformy Google Cloud Identity Platform (GCIP). 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 | string, | Identyfikator dostawcy odpowiadający konfiguracji dostawcy do usunięcia. |
Zwroty:
Obietnica<void>
Obietnica, która znika po zrealizowaniu usługi.
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 | string, | Wartość uid odpowiadająca użytkownikowi, którego chcesz usunąć. |
Zwroty:
Obietnica<void>
Pusta obietnica została zrealizowana po usunięciu użytkownika.
BaseAuth.deleteUsers()
Usuwa konta użytkowników określonych przez podane identyfikatory UID.
Usunięcie nieistniejącego użytkownika nie spowoduje błędu (tj. ta metoda jest idempotentna). Nieistniejący użytkownicy są uznawani za usuniętych i są wliczani w wartości DeleteUsersResult.successCount.
Można podać maksymalnie 1000 identyfikatorów. Jeśli podanych jest więcej niż 1000 identyfikatorów, ta metoda zgłasza FirebaseAuthError.
Szybkość tego interfejsu API jest obecnie na serwerze 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 kont użytkowników, musisz dodać opóźnienie, aby zapobiec przekroczeniu limitu.
Podpis:
deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| UID | string[] | Wartość uids odpowiadająca użytkownikom, których chcesz usunąć. |
Zwroty:
Obietnica<DeleteUsersResult>
Obietnica, która przedstawia łączną liczbę udanych/nieudanych usunięć oraz tablicę błędów, które się nie udało.
BaseAuth.generateEmailVerifyLink()
Generuje link z wezwaniem do działania poza zespołem w celu potwierdzenia, że użytkownik należy do określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument 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ą zostać przekazane w precyzyjnym linku itp.
Podpis:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| string, | Konto e-mail do weryfikacji. | |
| Ustawieniakodu działań | ActionCodeSettings (Ustawienia kodu działania) | Ustawienia kodu działania. Adres URL stanu/kontynuacji jest ustawiony jako parametr „continueUrl” w linku weryfikacyjnym adresu e-mail, jeśli został podany. Domyślna strona docelowa potwierdzania adresu e-mail będzie używać go do wyświetlania linku umożliwiającego powrót do aplikacji, jeśli jest ona zainstalowana. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dołączany żaden adres URL. Podany URL stanu musi należeć do domeny umieszczonej na białej liście przez dewelopera w konsoli. W przeciwnym razie zostanie zgłoszony błąd. Przekierowania aplikacji mobilnych mają zastosowanie tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z usługi Linki dynamiczne Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są uwzględniane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase. |
Zwroty:
Obietnica<string>
Obietnica, która zniknie dzięki wygenerowanemu linkowi.
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
});
BaseAuth.generatePasswordResetLink()
Generuje link do działania e-mailowego spoza zespołu, który pozwala zresetować hasło 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ą lub przeglądarkę, a także dodatkowe informacje o stanie, które mają zostać przekazane w precyzyjnym linku itp.
Podpis:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| string, | Adres e-mail użytkownika, którego hasło ma zostać zresetowane. | |
| Ustawieniakodu działań | ActionCodeSettings (Ustawienia kodu działania) | Ustawienia kodu działania. Jeśli adres URL stanu/kontynuowania jest ustawiony, jest ustawiony jako parametr „continueUrl” w linku do resetowania hasła. Domyślna strona docelowa do resetowania hasła będzie używać go do wyświetlania linku umożliwiającego powrót do aplikacji, jeśli jest ona zainstalowana. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dołączany żaden adres URL. Podany URL stanu musi należeć do domeny umieszczonej na białej liście przez dewelopera w konsoli. W przeciwnym razie zostanie zgłoszony błąd. Przekierowania aplikacji mobilnych mają zastosowanie tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z usługi Linki dynamiczne Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są uwzględniane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase. |
Zwroty:
Obietnica<string>
Obietnica, która zniknie dzięki wygenerowanemu linkowi.
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
});
BaseAuth.generateSignInWithEmailLink()
Generuje link z wezwaniem do działania poza zespołem w celu potwierdzenia, że użytkownik należy do określonego adresu e-mail. Obiekt ActionCodeSettings podany jako argument 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ą zostać przekazane w precyzyjnym linku itp.
Podpis:
generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| string, | Konto e-mail do weryfikacji. | |
| Ustawieniakodu działań | ActionCodeSettings (Ustawienia kodu działania) | Ustawienia kodu działania. Adres URL stanu/kontynuacji jest ustawiony jako parametr „continueUrl” w linku weryfikacyjnym adresu e-mail, jeśli został podany. Domyślna strona docelowa potwierdzania adresu e-mail będzie używać go do wyświetlania linku umożliwiającego powrót do aplikacji, jeśli jest ona zainstalowana. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dołączany żaden adres URL. Podany URL stanu musi należeć do domeny umieszczonej na białej liście przez dewelopera w konsoli. W przeciwnym razie zostanie zgłoszony błąd. Przekierowania aplikacji mobilnych mają zastosowanie tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z usługi Linki dynamiczne Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są uwzględniane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase. |
Zwroty:
Obietnica<string>
Obietnica, która zniknie dzięki wygenerowanemu linkowi.
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
});
BaseAuth.generateVerifyAndChangeEmailLink(),
Generuje zewnętrzny link do działania e-mail, który pozwala zweryfikować własność określonego e-maila. Obiekt ActionCodeSettings podany jako argument 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ą zostać przekazane w precyzyjnym linku itp.
Podpis:
generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| string, | Bieżące konto e-mail. | |
| nowy e-mail | string, | Adres e-mail, na który aktualizujesz konto. |
| Ustawieniakodu działań | ActionCodeSettings (Ustawienia kodu działania) | Ustawienia kodu działania. Adres URL stanu/kontynuacji jest ustawiony jako parametr „continueUrl” w linku weryfikacyjnym adresu e-mail, jeśli został podany. Domyślna strona docelowa potwierdzania adresu e-mail będzie używać go do wyświetlania linku umożliwiającego powrót do aplikacji, jeśli jest ona zainstalowana. Jeśli parametr actionCodeSettings nie jest określony, do adresu URL działania nie jest dołączany żaden adres URL. Podany URL stanu musi należeć do domeny autoryzowanej w konsoli. W przeciwnym razie zostanie zgłoszony błąd. Przekierowania aplikacji mobilnych mają zastosowanie tylko wtedy, gdy deweloper skonfiguruje i zaakceptuje Warunki korzystania z usługi Linki dynamiczne Firebase. Nazwa pakietu na Androida i identyfikator pakietu na iOS są uwzględniane tylko wtedy, gdy są skonfigurowane w tym samym projekcie Uwierzytelniania Firebase. |
Zwroty:
Obietnica<string>
Obietnica, która zniknie dzięki wygenerowanemu linkowi.
BaseAuth.getProviderConfig()
Wyszukuje konfigurację dostawcy uwierzytelniania według podanego identyfikatora. Zwraca obietnicę, która zniknie z konfiguracją dostawcy odpowiadającą podanemu 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 platformy Google Cloud Identity Platform (GCIP). 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 | string, | Identyfikator dostawcy odpowiadający konfiguracji dostawcy do zwrócenia. |
Zwroty:
Obietnica<AuthProviderConfig>
Obietnica, która zniknie dzięki konfiguracji odpowiadającej podanemu identyfikatorowi.
BaseAuth.getUser()
Pobiera dane użytkownika odpowiadające danemu uid.
Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkowników.
Podpis:
getUser(uid: string): Promise<UserRecord>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| UID | string, | Wartość uid odpowiadająca użytkownikowi, którego dane mają zostać pobrane. |
Zwroty:
Obietnica<UserRecord>
Udało się spełnić obietnicę dzięki danym użytkownika odpowiadającym podanym uid.
BaseAuth.getUserByEmail()
Pobiera dane użytkownika odpowiadające danemu adresowi e-mail.
Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkowników.
Podpis:
getUserByEmail(email: string): Promise<UserRecord>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| string, | Adres e-mail odpowiadający użytkownikowi, którego dane mają zostać pobrane. |
Zwroty:
Obietnica<UserRecord>
Udało się spełnić obietnicę, przesyłając dane użytkownika powiązane 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ładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkowników.
Podpis:
getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Numer telefonu | string, | Numer telefonu odpowiadający użytkownikowi, którego dane mają zostać pobrane. |
Zwroty:
Obietnica<UserRecord>
Dane użytkownika z podanego numeru telefonu zostały spełnione.
BaseAuth.getUserByProviderUid(),
Pobiera dane użytkownika odpowiadające podanemu identyfikatorowi dostawcy.
Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Pobieranie danych użytkowników.
Podpis:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Identyfikator dostawcy | string, | Identyfikator dostawcy Google, na przykład „google.com”. |
| UID | string, | Identyfikator użytkownika danego dostawcy. |
Zwroty:
Obietnica<UserRecord>
Obietnica została spełniona dzięki danym użytkownika powiązanym z podanym identyfikatorem dostawcy.
BaseAuth.getUsers()
Pobiera dane użytkownika odpowiadające określonym identyfikatorom.
Nie ma gwarancji kolejności. W szczególności nie ma gwarancji, że n-ta pozycja 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 podanych jest więcej niż 100 identyfikatorów, ta metoda zgłasza FirebaseAuthError.
Podpis:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| identyfikatory | UserIdentifier[] | Identyfikatory określające, które rekordy użytkownika powinny zostać zwrócone. Nie może mieć 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óryś z identyfikatorów jest nieprawidłowy lub określono 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 kont użytkowników z hasłami należy określić parametr UserImportOptions. Ta operacja jest zoptymalizowana pod kątem importowania zbiorczego i ignoruje sprawdzanie poprawności identyfikatorów uid, email oraz innych identyfikatorów, które mogą skutkować duplikatami.
Podpis:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownicy | UserImportRecord[] | Lista rekordów użytkownika do zaimportowania do Uwierzytelniania Firebase. |
| opcje | UserImportOptions | Opcje importowania użytkowników, które są wymagane, gdy użytkownicy podają dane logowania. |
Zwroty:
Obietnica<UserImportResult>
Obietnica, która wygasa po zakończeniu operacji i wynikiem importu. Dane te obejmują liczbę udanych importów, liczbę nieudanych importów i odpowiadające im błędy.
BaseAuth.listProviderConfigs()
Zwraca listę istniejących konfiguracji dostawcy pasujących do podanego filtra. Jednocześnie można wyświetlać maksymalnie 100 konfiguracji dostawców.
Obsługa dostawców SAML i OIDC wymaga platformy Google Cloud Identity Platform (GCIP). 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:
Promise<ListProviderConfigResults>
Obietnica, która zniknie dzięki liście konfiguracji dostawcy spełniających wymagania dotyczące filtrów.
BaseAuth.listUsers()
Pobiera listę użytkowników (tylko w ramach pojedynczej partii) o rozmiarze maxResults, zaczynając od przesunięcia określonego przez pageToken. Służy do pobierania partiami wszystkich użytkowników z określonego projektu.
Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Lista wszystkich użytkowników.
Podpis:
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| maxResults (Maksymalna liczba wyników) | Liczba | Rozmiar strony (1000, jeśli nie jest określony). Jest to też maksymalna dopuszczalna wartość. |
| pageToken (token_strony) | string, | Token następnej strony. Jeśli nie podasz żadnej wartości, funkcja zwróci użytkowników rozpoczynających się bez przesunięcia. |
Zwroty:
Obietnica<ListUsersResult>
Obietnica, która zniknie wraz z bieżącą grupą pobranych użytkowników i tokenem następnej strony.
BaseAuth.revokeOdświeżTokens()
Unieważnia wszystkie tokeny odświeżania istniejącego użytkownika.
Ten interfejs API zaktualizuje wartość UserRecord.tokensValidAfterTime użytkownika do bieżącej strefy czasowej UTC. Ważne jest, aby zegar serwera, na którym jest wywoływany, był prawidłowo ustawiony i zsynchronizowany.
Chociaż spowoduje to cofnięcie wszystkich sesji określonego użytkownika i wyłączenie generowania nowych tokenów tożsamości w istniejących sesjach, istniejące tokeny tożsamości mogą pozostać aktywne do czasu ich naturalnego wygaśnięcia (1 godziny). Aby sprawdzić, czy tokeny tożsamości zostały unieważnione, użyj funkcji BaseAuth.verifyIdToken(), gdzie checkRevoked ma wartość Prawda.
Podpis:
revokeRefreshTokens(uid: string): Promise<void>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| UID | string, | uid odpowiadający użytkownikowi, którego tokeny odświeżania mają zostać unieważnione. |
Zwroty:
Obietnica<void>
Pusta obietnica została zrealizowana po unieważnieniu tokenów odświeżania użytkownika.
BaseAuth.setCustomUserClaims()
Ustawia dodatkowe deklaracje dewelopera dotyczące obecnego użytkownika zidentyfikowanego przez podany uid. Zwykle są one używane do definiowania ról użytkowników i poziomów dostępu. Te deklaracje powinny zostać rozpowszechnione na wszystkie urządzenia, na których użytkownik jest już zalogowany (po wygaśnięciu tokena lub po wymuszeniu odświeżania tokena) i przy następnym logowaniu użytkownika. Jeśli zostanie użyta zarezerwowana nazwa deklaracji OIDC (sub, iat, iss itp.), wystąpi błąd. Są one ustawione w tokenie JWT uwierzytelnionego użytkownika.
Przykładowe fragmenty kodu 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 | string, | Nazwa uid użytkownika, którego konto chcesz edytować. |
| customClaims | obiekt | wartość null | Deweloper twierdzi, że ustawia. Jeśli zostanie przekazana wartość null, istniejące roszczenia niestandardowe zostaną usunięte. Przesłanie ładunku deklaracji niestandardowych większych niż 1000 bajtów spowoduje błąd. Deklaracje 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 innego oddzielnego systemu pamięci masowej. |
Zwroty:
Obietnica<void>
Obietnica znika po pomyślnym ukończeniu operacji.
BaseAuth.updateProviderConfig()
Zwraca obietnicę, która rozwiązuje się za pomocą zaktualizowanego parametru AuthProviderConfig odpowiadającego 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 platformy Google Cloud Identity Platform (GCIP). 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 | string, | Identyfikator dostawcy odpowiadający konfiguracji dostawcy do zaktualizowania. |
| updateConfig (aktualizacja konfiguracji) | UpdateAuthProviderRequest | Zaktualizowana konfiguracja. |
Zwroty:
Obietnica<AuthProviderConfig>
Obietnica, która zniknie po zaktualizowanej konfiguracji dostawcy.
BaseAuth.updateUser()
Aktualizuje istniejącego użytkownika.
Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Aktualizowanie konta użytkownika.
Podpis:
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| UID | string, | uid odpowiadający użytkownikowi, który ma zostać zaktualizowany. |
| właściwości | Prośba o aktualizację | Właściwości do zaktualizowania w przypadku podanego użytkownika. |
Zwroty:
Obietnica<UserRecord>
Udało się spełnić obietnicę dzięki zaktualizowanym danym użytkownika.
BaseAuth.verifyIdToken()
Weryfikuje token identyfikatora Firebase (JWT). Jeśli token jest prawidłowy, obietnica zostanie zrealizowana dzięki zdekodowanym deklaracjom. W przeciwnym razie zostanie odrzucona.
Jeśli checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, zgłaszany jest błąd auth/user-disabled. Jeśli nie, sprawdź, czy sesja odpowiadająca tokenowi identyfikatora 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 podasz żadnej wartości, kontrola nie zostanie zastosowana.
Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Weryfikacja tokenów identyfikatorów.
Podpis:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| idToken. | string, | Token tożsamości do weryfikacji. |
| znacznik wyboru Unieważniony | boolean, | Określa, czy należy sprawdzić, czy token tożsamości został unieważniony. Wymaga to wysłania dodatkowego żądania do backendu Uwierzytelniania Firebase w celu sprawdzenia czasu tokensValidAfterTime odpowiedniego użytkownika. Jeśli nie podasz żadnej wartości, dodatkowe sprawdzenie nie będzie stosowane. |
Zwroty:
Promise<DecodedIdToken>
Obietnica zrealizowana przez zdekodowane żądania tokena, jeśli token identyfikatora jest prawidłowy. W przeciwnym razie zostanie odrzucona.
BaseAuth.verifySessionCookie()
Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z deklaracjami 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, zostanie zgłoszony błąd auth/user-disabled. Jeśli nie, sprawdź, 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 podasz żadnej wartości, kontrola nie zostanie przeprowadzona.
Przykłady 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 |
|---|---|---|
| plik cookie_sesji | string, | Plik cookie sesji do weryfikacji. |
| znacznik wyboru Unieważniony | boolean, |
Zwroty:
Promise<DecodedIdToken>
Obietnica została zrealizowana dzięki zdekodowanym deklaracjom pliku cookie sesji, jeśli plik cookie sesji jest prawidłowy. W przeciwnym razie obietnica zostanie odrzucona.