Uwierzytelnianie Firebase.
Funkcje
Funkcja | Opis |
---|---|
getAuth(aplikacja), | Pobiera usługę Auth dla domyślnej aplikacji lub danej aplikacji.getAuth() można wywołać bez argumentów, aby uzyskać dostęp do usługi Auth w domyślnej aplikacji, lub jako getAuth(app) , aby uzyskać dostęp do usługi Auth powiązanej z konkretną aplikacją. |
Zajęcia
Klasa | Opis |
---|---|
Uwierzytelnianie | Usługa uwierzytelniania powiązana z podaną aplikacją. Instancja uwierzytelniania może mieć wielu najemców. |
AuthClientErrorCode | Kody błędów klienta uwierzytelniania i ich domyślne komunikaty. |
BaseAuth (Uwierzytelnianie BaseAuth) | Wspólny interfejs nadrzędny interfejsów API Auth i TenantAwareAuth . |
FirebaseAuthError. | Struktura kodu błędu uwierzytelniania Firebase. Rozszerza to błąd PrefixedFirebaseError. |
MultiFactorInfo | Interfejs przedstawiający wspólne właściwości drugiego składnika zarejestrowanego przez użytkownika. |
MultiFactorSettings | Ustawienia użytkownika związane z uwierzytelnianiem wielopoziomowym. |
PhoneMultiFactorInfo | Interfejs reprezentujący drugi składnik uwierzytelniania zarejestrowanego przez użytkownika na telefonie. |
Konfiguracja projektu | Reprezentuje konfigurację projektu. |
ProjectConfigManager | Zarządza bieżącą konfiguracją projektu (pobiera i aktualizuje). |
najemca, | Reprezentuje konfigurację najemcy.Obsługa wielu najemców wymaga korzystania z Google Cloud Identity Platform (GCIP). Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.Zanim w projekcie Google Cloud Identity Platform będzie można korzystać z wielu najemców, musisz zezwolić na najemców w tym projekcie za pomocą interfejsu Cloud Console.Konfiguracja najemcy zawiera takie informacje jak wyświetlana nazwa, identyfikator najemcy i konfiguracja uwierzytelniania poczty e-mail. W przypadku zarządzania konfiguracją dostawcy OIDC/SAML do pobierania listy skonfigurowanych dostawców tożsamości najemcy należy używać instancji TenantAwareAuth zamiast Tenant . Podczas konfigurowania tych dostawców pamiętaj, że najemcy odziedziczą domeny z białej listy i uwierzytelnione identyfikatory URI przekierowania ze swojego projektu nadrzędnego.Wszystkie pozostałe ustawienia najemcy również zostaną odziedziczone. Musisz nimi zarządzać w interfejsie użytkownika Cloud Console. |
Uwierzytelnianie TenantAwareAuth | Zidentyfikowany najemcą interfejs Auth używany do zarządzania użytkownikami, konfigurowania dostawców SAML/OIDC, generowania linków e-mail do resetowania hasła, potwierdzania adresu e-mail itp. dla określonych najemców.Obsługa wielu najemców wymaga korzystania z platformy Identity Platform (GCIP) Google Cloud. Więcej informacji o GCIP, w tym cennik i funkcje, znajdziesz w dokumentacji GCDS.Każdy najemca ma własnych dostawców tożsamości, ustawienia i zbiory użytkowników. Usługa TenantAwareAuth umożliwia zarządzanie użytkownikami konkretnego najemcy i odpowiadającymi im konfiguracjami OIDC/SAML, umożliwia weryfikowanie tokenów identyfikatorów użytkowników zalogowanych w określonym najemcy oraz generowanie linków do działań e-mailowych w przypadku użytkowników należących do najemcy.TenantAwareAuth wystąpienia dla określonego najemcy można utworzyć, wywołując metodę TenantManager.authForTenant().tenantId |
TenantManager | Określa menedżera najemców, który pomaga zarządzać operacjami dotyczącymi najemców. Obejmuje to m.in.:
|
Informacje o użytkowniku | Reprezentuje informacje o użytkowniku pochodzące od zewnętrznego dostawcy tożsamości, takiego jak Google lub Facebook. |
UserMetadata (Metadane użytkownika). | Reprezentuje metadane użytkownika. |
Rekord użytkownika | Reprezentuje użytkownika. |
Interfejsy
Interfejs | Opis |
---|---|
ActionCodeSettings (Ustawienia kodu działania) | To interfejs, który określa wymagany adres URL kontynuowania/stanu z opcjonalnymi identyfikatorami pakietów na Androida i iOS. |
AllowByDefault | Definiuje zasadę, która domyślnie zezwala na każdy region i dodaje niedozwolone regiony do listy zabronionych. |
AllowByDefaultWrap | Konfiguracja regionu SMS-ów na wyłączność w interfejsie allowByDefault |
AllowlistOnly (Tylko lista dozwolonych) | Definiuje zasadę zezwalającą tylko na regiony przez bezpośrednie dodanie ich do listy dozwolonych. |
AllowlistOnlyWrap | Wzajemna konfiguracja regionu SMS dla interfejsu Zezwalaj na listy dozwolonych |
AuthProviderConfigFilter | Interfejs filtra używany do wyświetlania listy konfiguracji dostawców. Jest ona używana do określania sposobu wyświetlania listy skonfigurowanych dostawców tożsamości za pomocą metody BaseAuth.listProviderConfigs(). |
BaseAuthProviderConfig, | Interfejs konfiguracji podstawowego dostawcy uwierzytelniania. |
BaseCreateMultiFactorInfoRequest | Interfejs przedstawiający właściwości podstawowe zarejestrowanego przez użytkownika drugiego składnika dla CreateRequest . |
BaseUpdateMultiFactorInfoRequest | Interfejs przedstawiający wspólne właściwości drugiego składnika zarejestrowanego przez użytkownika UpdateRequest . |
CreatePhoneMultiFactorInfoRequest | Interfejs przedstawiający drugi składnik uwierzytelniania zarejestrowanego przez użytkownika na telefonie CreateRequest . |
CreateRequest (Utwórz żądanie) | Interfejs przedstawiający właściwości do ustawienia w nowym rekordzie użytkownika do utworzenia. |
CustomStrengthOptionsConfig | Ograniczenia, które mają być egzekwowane w zasadach dotyczących haseł |
DecodedAuthTrackingToken | |
DecodedIdToken | Interfejs reprezentujący zdekodowany token identyfikatora Firebase zwrócony z metody BaseAuth.verifyIdToken().Tokeny identyfikatorów Firebase to tokeny internetowe JSON (JWT) zgodne ze specyfikacją OpenID Connect. Więcej informacji na temat poszczególnych właściwości znajdziesz w sekcji dotyczącej [tokena identyfikatora] w specyfikacji OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken). |
DeleteUsersResult | Reprezentuje wynik interfejsu API BaseAuth.deleteUsers(). |
EmailIdentifier (identyfikator e-mail) | Służy do wyszukiwania konta według adresu e-mail.Patrz BaseAuth.getUsers(). |
EmailPrivacyConfig (Konfiguracja prywatności poczty e-mail) | Konfiguracja prywatności poczty e-mail projektu lub najemcy. |
EmailSignInProviderConfig | Konfiguracja dostawcy logowania e-mail. |
GetUsersResult | Reprezentuje wynik użycia interfejsu API BaseAuth.getUsers(). |
ListProviderConfigResults | Interfejs odpowiedzi na potrzeby wyświetlania listy konfiguracji dostawców. Ta opcja jest dostępna tylko w przypadku wyświetlania listy konfiguracji wszystkich dostawców tożsamości za pomocą metody BaseAuth.listProviderConfigs(). |
ListTenantsResult | Interfejs reprezentujący obiekt zwrócony przez operację TenantManager.listTenants(). Zawiera listę najemców dla bieżącego wsadu i token następnej strony, jeśli jest dostępny. |
ListUsersResult | Interfejs reprezentujący obiekt zwrócony przez operację BaseAuth.listUsers(). Zawiera listę użytkowników dla bieżącego wsadu i token następnej strony, jeśli jest dostępny. |
MultiFactorConfig (Konfiguracja MultiFactorConfig) | Interfejs przedstawiający konfigurację wielopoziomową. Możesz tu określić, czy uwierzytelnianie wielopoziomowe ma być włączone, czy wyłączone, oraz określić listę testów zabezpieczających weryfikację dwuetapową, które są obsługiwane. |
MultiFactorCreateSettings (Ustawienia MultiFactorCreateSettings). | Wielopoziomowe ustawienia użytkownika związane z operacjami tworzenia. |
MultiFactorProviderConfig, | Interfejs przedstawiający konfigurację dostawcy uwierzytelniania wielopoziomowego. Ten interfejs jest używany przez dostawców uwierzytelniania dwuskładnikowego innych niż SMS. Obecnie obsługiwany jest tylko typ TOTP. |
MultiFactorUpdateSettings (Ustawienia aktualizacji wielopoziomowych) | Wielopoziomowe ustawienia użytkownika związane z operacjami aktualizacji. |
Typ odpowiedzi OAuth | Interfejs reprezentujący obiekt odpowiedzi dostawcy OIDC dla przepływu autoryzacji OAuth. Wymagane jest jedno z tych ustawień:
|
OIDCAuthProviderConfig | Interfejs konfiguracji dostawcy uwierzytelniania [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Dostawcy OIDC można utworzyć za pomocą metody BaseAuth.createProviderConfig(). |
OIDCUpdateAuthProviderRequest | Interfejs żądania aktualizacji dostawcy uwierzytelniania OIDC. Jest ona używana podczas aktualizowania konfiguracji dostawcy OIDC za pomocą metody BaseAuth.updateProviderConfig(). |
PasswordPolicyConfig (Konfiguracja zasady hasła) | Konfiguracja zasad dotyczących haseł dla projektu lub najemcy |
PhoneIdentifier (Identyfikator telefonu) | Służy do wyszukiwania konta według numeru telefonu.Patrz BaseAuth.getUsers(). |
ProviderIdentifier, | Służy do wyszukiwania konta według dostawcy sfederowanego.Patrz BaseAuth.getUsers(). |
Konfiguracja reCAPTCHAConfig | Interfejs żądania aktualizacji konfiguracji reCAPTCHA. Włączając integrację reCAPTCHA Enterprise, akceptujesz Warunki korzystania z usługi reCAPTCHA Enterprise. |
Klucz Recaptcha | Konfiguracja klucza reCAPTCHA. |
Reguła RecaptchaManagedRule | Konfiguracja reguły działania reCAPTCHA. |
SAMLAuthProviderConfig | Interfejs konfiguracji dostawcy uwierzytelniania [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html). Dostawcę SAML można utworzyć za pomocą metody BaseAuth.createProviderConfig(). |
SAMLUpdateAuthProviderRequest (Żądanie SAMLUpdateAuthProviderRequest) | Interfejs żądania aktualizacji dostawcy uwierzytelniania SAML. Jest ono używane podczas aktualizowania konfiguracji dostawcy SAML za pomocą metody BaseAuth.updateProviderConfig(). |
SessionCookieOptions | Interfejs przedstawiający opcje plików cookie sesji wymagane przez metodę BaseAuth.createSessionCookie(). |
TotpMultiFactorProviderConfig | Interfejs przedstawiający ustawienia konfiguracji uwierzytelniania dwuskładnikowego TOTP. |
Identyfikator UidIdentifier | Służy do wyszukiwania konta według identyfikatora UID.Zobacz BaseAuth.getUsers(). |
UpdatePhoneMultiFactorInfoRequest | Interfejs przedstawiający drugi składnik uwierzytelniania zarejestrowanego przez użytkownika na telefonie UpdateRequest . |
UpdateProjectConfigRequest | Interfejs reprezentujący właściwości do aktualizacji w podanej konfiguracji projektu. |
Prośba o aktualizację | Interfejs przedstawiający właściwości do zaktualizowania w przypadku podanego użytkownika. |
UpdateTenantRequest | Interfejs przedstawiający właściwości do aktualizacji w podanym najemcy. |
UserImportOptions | Interfejs przedstawiający opcje importu użytkowników wymagane w przypadku metody BaseAuth.importUsers(). Służy do dostarczania informacji o algorytmie szyfrowania haseł. |
UserImportRecord | Interfejs reprezentujący użytkownika, który ma zostać zaimportowany do Uwierzytelniania Firebase za pomocą metody BaseAuth.importUsers(). |
UserImportResult | Interfejs reprezentujący odpowiedź z metody BaseAuth.importUsers() do zbiorczego importowania użytkowników do Uwierzytelniania Firebase. |
UserMetadataRequest. | Metadane użytkownika, które mają zostać uwzględnione podczas importowania użytkownika. |
UserProvider. | Reprezentuje dostawcę tożsamości użytkownika, który można powiązać z użytkownikiem Firebase. |
UserProviderRequest | Dane dostawcy użytkownika, które mają być uwzględnione podczas importowania użytkownika. |
Typ aliasów
Typ aliasu | Opis |
---|---|
AuthFactorType. | Określa drugi typ czynnika. |
AuthProviderConfig. | Typ konfiguracji dostawcy uwierzytelniania. BaseAuth.createProviderConfig(). |
CreateMultiFactorInfoRequest | Typ reprezentujący właściwości drugiego składnika zarejestrowanego przez użytkownika dla CreateRequest . |
CreateTenantRequest | Interfejs przedstawiający właściwości do ustawienia dla nowego najemcy. |
Typ haszowania | |
MultiFactorConfigState | Określa stan konfiguracji wielopoziomowej. |
PasswordPolicyEnforcementState (stan egzekwowania zasad haseł), | Stan egzekwowania zasad dotyczących haseł. |
Działanie reCAPTCHA | Działania wykonywane w przypadku żądań chronionych reCAPTCHA. – „ZABLOKUJ”: żądanie chronione przez reCAPTCHA zostanie zablokowane. |
Typ klienta RecaptchaKey | Typ platformy klucza. |
RecaptchaProviderEnforcementState, | Stan egzekwowania ochrony reCAPTCHA. – „WYŁ.”: niewymuszane. – „SPRAWDŹ”: oceniaj wyniki, ale ich nie egzekwuj. – „ENFORCE”: tworzenie oceny i egzekwowanie wyniku. |
Konfiguracja regionu Sms | Interfejs żądania aktualizacji konfiguracji regionu SMS-ów. Konfiguruje regiony, w których użytkownicy mogą wysyłać SMS-y weryfikacyjne. Jest on określany na podstawie numeru kierunkowego z docelowego numeru telefonu. |
UpdateAuthProviderRequest | |
UpdateMultiFactorInfoRequest | Typ reprezentujący właściwości drugiego składnika zarejestrowanego przez użytkownika dla UpdateRequest . |
UserIdentifier | Identyfikuje użytkownika, którego należy szukać. |
getAuth(aplikacja)
Pobiera usługę Auth dla domyślnej lub danej aplikacji.
getAuth()
można wywołać bez argumentów, aby uzyskać dostęp do usługi Auth w domyślnej aplikacji, lub jako getAuth(app)
, aby uzyskać dostęp do usługi Auth powiązanej z konkretną aplikacją.
Podpis:
export declare function getAuth(app?: App): Auth;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja |
Zwroty:
Przykład 1
// Get the Auth service for the default app
const defaultAuth = getAuth();
Przykład 2
// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);
Typ AuthFactor
Określa drugi typ czynnika.
Podpis:
export type AuthFactorType = 'phone';
Konfiguracja AuthProviderConfig
Typ konfiguracji dostawcy uwierzytelniania. BaseAuth.createProviderConfig().
Podpis:
export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;
CreateMultiFactorInfoRequest
Typ reprezentujący właściwości drugiego składnika zarejestrowanego przez użytkownika dla CreateRequest
.
Podpis:
export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;
Utwórz żądanie najemcy
Interfejs przedstawiający właściwości do ustawienia dla nowego najemcy.
Podpis:
export type CreateTenantRequest = UpdateTenantRequest;
Typ algorytmu haszowania
Podpis:
export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';
MultiFactorConfigState
Określa stan konfiguracji wielopoziomowej.
Podpis:
export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';
Stan egzekwowania zasad haseł
Stan egzekwowania zasad dotyczących haseł.
Podpis:
export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';
Działanie reCAPTCHA
Działania wykonywane w przypadku żądań chronionych reCAPTCHA. – „ZABLOKUJ”: żądanie chronione przez reCAPTCHA zostanie zablokowane.
Podpis:
export type RecaptchaAction = 'BLOCK';
TypKlienta RecaptchaKey
Typ platformy klucza.
Podpis:
export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';
Wartość RecaptchaProviderEnforcementState
Stan egzekwowania ochrony reCAPTCHA. – „WYŁ.”: niewymuszane. – „SPRAWDŹ”: oceniaj wyniki, ale ich nie egzekwuj. – „ENFORCE”: tworzenie oceny i egzekwowanie wyniku.
Podpis:
export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';
Konfiguracja regionu Sms
Interfejs żądania aktualizacji konfiguracji regionu SMS-ów. Konfiguruje regiony, w których użytkownicy mogą wysyłać SMS-y weryfikacyjne. Jest on określany na podstawie numeru kierunkowego z docelowego numeru telefonu.
Podpis:
export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;
Żądanie UpdateAuthProviderRequest
Podpis:
export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;
Żądanie UpdateMultiFactorInfoRequest
Typ reprezentujący właściwości drugiego składnika zarejestrowanego przez użytkownika dla UpdateRequest
.
Podpis:
export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;
UserIdentifier (identyfikator użytkownika)
Identyfikuje użytkownika, którego należy szukać.
Podpis:
export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;