Ta strona została przetłumaczona przez Cloud Translation API.

firebase-admin.auth package

Uwierzytelnianie Firebase.

Funkcje

Funkcja	Opis
getAuth(aplikacja)	Pobiera usługę Auth dla aplikacji domyślnej lub danej.Aplikacja `getAuth()` może być wywoływana bez argumentów umożliwiających dostęp do usługi Auth w domyślnej aplikacji lub jako `getAuth(app)` w celu uzyskania dostępu do usługi Auth powiązanej z konkretną aplikacją.

Zajęcia

Klasa	Opis
Uwierzytelnianie	Usługa uwierzytelniania powiązana z udostępnioną aplikacją. Instancja Auth może mieć wielu najemców.
AuthClientErrorCode	Kody błędów klienta uwierzytelniania i ich komunikaty domyślne.
BaseAuth	Wspólny interfejs nadrzędny dla interfejsów API `Auth` i `TenantAwareAuth`.
FirebaseAuthError.	Struktura kodu błędu Uwierzytelniania Firebase. Rozszerza ten błąd PrefixedFirebaseError.
MultiFactorInfo	Interfejs przedstawiający typowe właściwości zarejestrowanego przez użytkownika drugiego składnika.
Ustawienia MultiFactor	Ustawienia użytkownika związane z uwierzytelnianiem wielopoziomowym.
PhoneMultiFactorInfo	Interfejs przedstawiający specyficzny dla telefonu drugi składnik zarejestrowany przez użytkownika.
Konfiguracja projektu	Reprezentuje konfigurację projektu.
Menedżer konfiguracji projektu	Zarządza (pobiera i aktualizuje) bieżącą konfigurację projektu.
Dzierżawca	Reprezentuje konfigurację najemcy.Obsługa wielu najemców wymaga Cloud Identity Platform (GCIP). Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.Aby móc używać wielu najemców w projekcie Google Cloud Identity Platform, musisz zezwolić na najemców w tym projekcie w interfejsie 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 pobrania listy skonfigurowanych dostawców tożsamości u najemcy należy używać instancji `TenantAwareAuth` zamiast `Tenant`. Konfigurując tych dostawców, pamiętaj, że najemcy odziedziczą białą listę domen i uwierzytelnione identyfikatory URI przekierowania z projektu nadrzędnego.Wszystkie pozostałe ustawienia najemcy również zostaną odziedziczone. Należy nimi zarządzać z poziomu interfejsu Cloud Console.
TenantAwareAuth	Zorientowany na najemców interfejs `Auth` używany do zarządzania użytkownikami, konfigurowania dostawców SAML/OIDC, generowania linków e-mail do resetowania hasła, weryfikowania adresu e-mail itp. dla określonych najemców.Obsługa wielu najemców wymaga Identity Platform (GCIP) w Google Cloud. Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.Każdy najemca ma własnych dostawców tożsamości, ustawienia i zbiory użytkowników. Za pomocą `TenantAwareAuth` można też zarządzać użytkownikami określonego najemcy i odpowiednimi konfiguracjami OIDC/SAML, weryfikować tokeny identyfikatorów dla użytkowników zalogowanych w określonym najemcy, a także generować linki do działań w e-mailach dla użytkowników należących do najemcy.Wystąpienia `TenantAwareAuth` dla określonego zasobu `tenantId` można tworzyć, wywołując funkcję TenantManager.authForTenant().
najemca	Definiuje menedżera najemcy używanego do zarządzania operacjami związanymi z najemcami. Obejmuje to m.in.: Możliwość tworzenia, aktualizowania, wyświetlania, pobierania i usuwania najemców bazowego projektu. Uzyskiwanie instancji `TenantAwareAuth` na potrzeby operacji związanych z uwierzytelnianiem (zarządzanie użytkownikami, zarządzanie konfiguracją dostawcy, weryfikacja tokenów, generowanie linku e-mail itp.) w kontekście określonego najemcy.
Informacje o użytkowniku	Reprezentuje informacje o użytkowniku pochodzące od zewnętrznego dostawcy tożsamości, takiego jak Google lub Facebook.
UserMetadata	Reprezentuje metadane użytkownika.
Rekord użytkownika	Reprezentuje użytkownika.

Interfejsy

Interfejs	Opis
ActionCodeSettings	Ten interfejs określa wymagany adres URL kontynuacji/stanu z opcjonalnymi identyfikatorami pakietów na Androida i iOS.
AllowByDefault	Definiuje zasadę zezwolenia na każdy region i dodawania niedozwolonych regionów do listy niedozwolonych regionów.
AllowByDefaultWrap	Wzajemna konfiguracja regionów SMS-ów w interfejsie allowByDefault
Tylko lista dozwolonych	Definiuje zasadę zezwalania jedynie na regiony przez dodanie ich do listy dozwolonych.
AllowlistOnlyWrap	Konfiguracja regionu SMS-ów w interfejsie tylko do listy dozwolonych
AuthProviderConfigFilter,	Interfejs filtra używany do wyświetlania listy konfiguracji dostawców. Jest ona używana podczas 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 na potrzeby `CreateRequest`.
BaseUpdateMultiFactorInfoRequest	Interfejs przedstawiający typowe właściwości zarejestrowanego przez użytkownika drugiego składnika na potrzeby `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest	Interfejs przedstawiający specyficzny dla telefonu drugi składnik zarejestrowanych przez użytkownika dla identyfikatora `CreateRequest`.
CreateRequest	Interfejs przedstawiający właściwości do ustawienia w nowym rekordzie użytkownika.
CustomStrengthOptionsConfig	Ograniczenia, które mają być egzekwowane w zasadach dotyczących haseł
DecodedAuthBlockToken
DecodedIdToken	Interfejs reprezentujący zdekodowany token identyfikatora Firebase zwracany przez metodę BaseAuth.verifyIdToken().Tokeny identyfikatorów Firebase to zgodne ze specyfikacją OpenID Connect tokeny internetowe JSON (JWT). Zapoznaj się z [sekcją dotyczącą tokenów identyfikatora w specyfikacji OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken), aby dowiedzieć się więcej o poszczególnych właściwościach poniżej.
DeleteUsersResult	Reprezentuje wynik funkcji BaseAuth.deleteUsers(). API.
EmailIdentifier	Służy do wyszukiwania konta przy użyciu adresu e-mail.Zobacz BaseAuth.getUsers().
EmailPrivacyConfig	Konfiguracja prywatności poczty e-mail projektu lub najemcy.
EmailSignInProviderConfig,	Konfiguracja dostawcy logowania za pomocą adresu e-mail.
GetUsersResult	Reprezentuje wynik interfejsu API BaseAuth.getUsers().
ListProviderConfigResults	Interfejs odpowiedzi wyświetlający listę konfiguracji dostawców. Ta opcja jest dostępna tylko w przypadku wyświetlania listy wszystkich dostawców tożsamości za pomocą metody BaseAuth.listProviderConfigs().
ListTenantsResult	Interfejs reprezentujący obiekt zwrócony w wyniku operacji TenantManager.listTenants(). Zawiera listę najemców bieżącej grupy i token następnej strony, jeśli jest dostępny.
ListUsersResult	Interfejs reprezentujący obiekt zwrócony w wyniku operacji BaseAuth.listUsers(). Zawiera listę użytkowników bieżącej grupy oraz token następnej strony, jeśli jest dostępny.
Konfiguracja MultiFactorConfig	Interfejs przedstawiający konfigurację wielopoziomową. Pozwala określić, czy uwierzytelnianie wielopoziomowe jest włączone, czy wyłączone, oraz wyświetlić listę obsługiwanych testów dwuskładnikowych.
MultiFactorCreateSettings	Ustawienia użytkownika związane z łączeniem czynników wielopoziomowych przy tworzeniu operacji.
MultiFactorProviderConfig	Interfejs przedstawiający konfigurację dostawcy uwierzytelniania wielopoziomowego. Ten interfejs jest używany w przypadku dostawców uwierzytelniania dwuskładnikowego innych niż SMS. Obecnie obsługiwany jest tylko protokół TOTP.
Ustawienia aktualizacji wielu komponentów	Ustawienia użytkownika związane z uwierzytelnianiem wielopoziomowym na potrzeby operacji aktualizacji.
OAuthResponseType (Typ odpowiedzi OAuth).	Interfejs przedstawiający obiekt odpowiedzi dostawcy OIDC na potrzeby procesu autoryzacji OAuth. Wymagane jest jedno z następujących ustawień: Ustaw `code` na `true` dla przepływu kodu. W przepływie tokena identyfikatora ustaw `idToken` na `true`.
OIDCAuthProviderConfig,	Interfejs konfiguracji dostawcy uwierzytelniania [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Dostawcę 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ą BaseAuth.updateProviderConfig().
PasswordPolicyConfig,	Konfiguracja zasad dotyczących haseł dla projektu lub najemcy
PhoneIdentifier,	Służy do wyszukiwania konta według numeru telefonu.Zobacz BaseAuth.getUsers().
ProviderIdentifier,	Służy do wyszukiwania konta według dostawcy sfederowanego.Zobacz BaseAuth.getUsers().
Konfiguracja reCAPTCHA	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 konfiguracyjny dostawcy uwierzytelniania [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) uwierzytelniania. Dostawcę SAML można utworzyć za pomocą metody BaseAuth.createProviderConfig().
SAMLUpdateAuthProviderRequest.	Interfejs żądania aktualizacji dostawcy uwierzytelniania SAML. Jest ona używana podczas aktualizowania konfiguracji dostawcy SAML za pomocą BaseAuth.updateProviderConfig().
SessionCookieOptions.	Interfejs reprezentujący opcje plików cookie sesji wymagane dla metody BaseAuth.createSessionCookie().
TotpMultiFactorProviderConfig	Interfejs przedstawiający ustawienia konfiguracji uwierzytelniania dwuskładnikowego TOTP.
UidIdentifier,	Służy do wyszukiwania konta za pomocą identyfikatora UID.Zobacz BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest	Interfejs przedstawiający specyficzny dla telefonu drugi składnik zarejestrowanych przez użytkownika dla identyfikatora `UpdateRequest`.
UpdateProjectConfigRequest	Interfejs przedstawiający właściwości do zaktualizowania w podanej konfiguracji projektu.
UpdateRequest	Interfejs przedstawiający właściwości do zaktualizowania po podaniu podanego użytkownika.
UpdateTenantRequest	Interfejs reprezentujący właściwości do zaktualizowania na podanym najemcy.
UserImportOptions	Interfejs przedstawiający opcje importowania użytkowników wymagane w przypadku metody BaseAuth.importUsers(). Służy do przekazywania 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ź 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ą zostać uwzględnione podczas importowania użytkownika.

Aliasy typu

Wpisz alias	Opis
AuthFactorType,	Wskazuje typ drugiego czynnika.
AuthProviderConfig,	Typ konfiguracji dostawcy uwierzytelniania. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest	Typ reprezentujący właściwości zarejestrowanego przez użytkownika drugiego składnika w `CreateRequest`.
CreateTenantRequest	Interfejs reprezentujący właściwości do ustawienia dla nowego najemcy.
Typ haszowania
MultiFactorConfigState	Wskazuje stan konfiguracji wielopoziomowej.
PasswordPolicyEnforcementState	Stan egzekwowania zasad dotyczących haseł.
RecaptchaAction (reCAPTCHAAction)	Działania, jakie należy podjąć w przypadku żądań chronionych reCAPTCHA. – „ZABLOKUJ”: żądanie zabezpieczone przez reCAPTCHA zostanie zablokowane.
RecaptchaKeyClientType (Typ RecaptchaKeyClientType)	Typ platformy klucza.
RecaptchaProviderEnforcementState	Stan egzekwowania ochrony reCAPTCHA. – „WYŁĄCZONE”: nieegzekwowane. – „AUDIT”: tworzy ocenę, ale nie wymusza wyników. – „ENFORCE”: tworzy ocenę i egzekwuj jej wyniki.
Konfiguracja regionu SMS-ów	Interfejs żądania aktualizacji konfiguracji regionu SMS-ów. Konfiguruje regiony, z których użytkownicy mogą wysyłać weryfikacyjne SMS-y. który zależy od kodu kierunkowego docelowego numeru telefonu.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	Typ reprezentujący właściwości zarejestrowanego przez użytkownika drugiego składnika w `UpdateRequest`.
UserIdentifier	Identyfikuje użytkownika, którego należy szukać.

getAuth(aplikacja)

Pobiera usługę Auth dla aplikacji domyślnej lub danej.

getAuth() można wywołać bez argumentów umożliwiających dostęp do usługi Auth domyślnej aplikacji lub jako getAuth(app) w celu uzyskania dostępu do usługi Auth powiązanej z konkretną aplikacją.

Podpis:

export declare function getAuth(app?: App): Auth;

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja

Zwroty:

Uwierzytelnianie

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

Wskazuje typ drugiego czynnika.

Podpis:

export type AuthFactorType = 'phone';

Konfiguracja dostawcy AuthProvider

Typ konfiguracji dostawcy uwierzytelniania. BaseAuth.createProviderConfig().

Podpis:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

Typ reprezentujący właściwości zarejestrowanego przez użytkownika drugiego składnika w CreateRequest.

Podpis:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

Utwórz żądanie najemcy

Interfejs reprezentują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';

Stan_konfiguracji wieloskładnikowej

Wskazuje stan konfiguracji wielopoziomowej.

Podpis:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

Stan egzekwowania zasad

Stan egzekwowania zasad dotyczących haseł.

Podpis:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

Działanie reCAPTCHA

Działania, jakie należy podjąć w przypadku żądań chronionych reCAPTCHA. – „ZABLOKUJ”: żądanie zabezpieczone przez reCAPTCHA zostanie zablokowane.

Podpis:

export type RecaptchaAction = 'BLOCK';

Typ klienta RecaptchaKeyClient

Typ platformy klucza.

Podpis:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

Parametr RecaptchaProviderEnforcementState

Stan egzekwowania ochrony reCAPTCHA. – „Wyłączone”: nieegzekwowane. – „AUDIT”: tworzy ocenę, ale nie wymusza wyników. – „ENFORCE”: tworzy ocenę i egzekwuj jej wyniki.

Podpis:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

Konfiguracja regionu Sms

Interfejs żądania aktualizacji konfiguracji regionu SMS-ów. Konfiguruje regiony, z których użytkownicy mogą wysyłać weryfikacyjne SMS-y. który zależy od kodu kierunkowego docelowego numeru telefonu.

Podpis:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

Żądanie UpdateAuthProviderRequest

Podpis:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

Typ reprezentujący właściwości zarejestrowanego przez użytkownika drugiego składnika w UpdateRequest.

Podpis:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Identyfikator użytkownika

Identyfikuje użytkownika, którego należy szukać.

Podpis:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;