auth library
Classes
- ActionCodeSettings
- This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers.
- ActionCodeSettingsAndroid
- ActionCodeSettingsIos
- AllowByDefaultSmsRegionConfig
- Defines a policy of allowing every region by default and adding disallowed regions to a disallow list.
- AllowlistOnlySmsRegionConfig
- Defines a policy of only allowing regions by explicitly adding them to an allowlist.
- Auth
- Auth service bound to the provided app. An Auth instance can have multiple tenants.
- AuthProviderConfig
- AuthProviderConfigFilter
-
The filter interface used for listing provider configurations. This is used
when specifying how to list configured identity providers via
_BaseAuth.listProviderConfigs. - CreateMultiFactorInfoRequest
-
Interface representing base properties of a user-enrolled second factor for a
CreateRequest. - CreatePhoneMultiFactorInfoRequest
-
Interface representing a phone specific user-enrolled second factor for a
CreateRequest. - CreateRequest
- Interface representing the properties to set on a new user record to be created.
- CustomStrengthOptionsConfig
- Constraints to be enforced on the password policy
- DecodedIdToken
-
Interface representing a decoded Firebase ID token, returned from the
_BaseAuth.verifyIdTokenmethod. - DeleteUsersResult
-
Represents the result of the
_BaseAuth.deleteUsers. API. - EmailIdentifier
- Used for looking up an account by email.
- EmailPrivacyConfig
- The email privacy configuration of a project or tenant.
- EmailSignInProviderConfig
- The email sign in provider configuration.
- FirebaseTokenInfo
- FirebaseTokenVerifier
- GetUsersResult
-
Represents the result of the
_BaseAuth.getUsersAPI. - ListProviderConfigResults
-
The response interface for listing provider configs. This is only available
when listing all identity providers' configurations via
_BaseAuth.listProviderConfigs. - ListTenantsResult
- Interface representing the object returned from a TenantManager.listTenants operation. Contains the list of tenants for the current batch and the next page token if available.
- ListUsersResult
-
Interface representing the object returned from a
_BaseAuth.listUsersoperation. Contains the list of users for the current batch and the next page token if available. - MobileLinksConfig
- Configuration for mobile links (app links and universal links).
- MultiFactorConfig
- Interface representing a multi-factor configuration.
- MultiFactorCreateSettings
- The multi-factor related user settings for create operations.
- MultiFactorInfo
- Interface representing the common properties of a user-enrolled second factor.
- MultiFactorProviderConfig
- Interface representing a multi-factor auth provider configuration. This interface is used for second factor auth providers other than SMS. Currently, only TOTP is supported.
- MultiFactorSettings
- MultiFactorUpdateSettings
- The multi-factor related user settings for update operations.
- OAuthResponseType
- The interface representing OIDC provider's response object for OAuth authorization flow. One of the following settings is required:
- OIDCAuthProviderConfig
-
The OIDC Auth
provider configuration interface. An OIDC provider can be created via
_BaseAuth.createProviderConfig. - OIDCUpdateAuthProviderRequest
-
The request interface for updating an OIDC Auth provider. This is used
when updating an OIDC provider's configuration via
_BaseAuth.updateProviderConfig. - PasswordPolicyConfig
- A password policy configuration for a project or tenant
- PhoneIdentifier
- Used for looking up an account by phone number.
- PhoneMultiFactorInfo
- Interface representing a phone specific user-enrolled second factor.
- ProjectConfig
- Represents a project configuration.
- ProjectConfigManager
- Manages (gets and updates) the current project config.
- ProviderIdentifier
- Used for looking up an account by federated provider.
- RecaptchaConfig
- The request interface for updating a reCAPTCHA Config. By enabling reCAPTCHA Enterprise Integration you are agreeing to reCAPTCHA Enterprise Terms of Service.
- RecaptchaKey
- The reCAPTCHA key config.
- RecaptchaManagedRule
- The config for a reCAPTCHA action rule.
- RecaptchaTollFraudManagedRule
- The managed rules for toll fraud provider, containing the enforcement status. The toll fraud provider contains all SMS related user flows.
- SAMLAuthProviderConfig
-
The
SAML
Auth provider configuration interface. A SAML provider can be created via
_BaseAuth.createProviderConfig. - SAMLUpdateAuthProviderRequest
-
The request interface for updating a SAML Auth provider. This is used
when updating a SAML provider's configuration via
_BaseAuth.updateProviderConfig. - SessionCookieOptions
-
Interface representing the session cookie options needed for the
_BaseAuth.createSessionCookiemethod. - SmsRegionConfig
- The request interface for updating a SMS Region Config. Configures the regions where users are allowed to send verification SMS. This is based on the calling code of the destination phone number.
- Tenant
- Represents a tenant configuration.
- TenantAwareAuth
-
Tenant-aware
Authinterface used for managing users, configuring SAML/OIDC providers, generating email links for password reset, email verification, etc for specific tenants. - TenantManager
- Defines the tenant manager used to help manage tenant related operations. This includes:
- TokenProvider
- TotpInfo
- Represents TOTP (Time-based One-time Password) information for second factor authentication. This class is used with authenticator apps like Google Authenticator, Authy, etc. It serves as a marker class with no additional properties beyond what's inherited from MultiFactorInfo.
- TotpMultiFactorInfo
- Interface representing a TOTP specific user-enrolled second factor.
- TotpMultiFactorProviderConfig
- Interface representing configuration settings for TOTP second factor auth.
- UidIdentifier
- Used for looking up an account by uid.
- UpdateAuthProviderRequest
- UpdateMultiFactorInfoRequest
-
Interface representing common properties of a user-enrolled second factor
for an
UpdateRequest. - UpdatePhoneMultiFactorInfoRequest
-
Interface representing a phone specific user-enrolled second factor
for an
UpdateRequest. - UpdateProjectConfigRequest
- Interface representing the properties to update on the provided project config.
- UpdateRequest
- Interface representing the properties to update on the provided user.
- UpdateTenantRequest
- Interface representing the properties to update on the provided tenant.
- UploadAccountOptions
- UserIdentifier
- Identifies a user to be looked up.
- UserImportHashOptions
- UserImportOptions
-
Interface representing the user import options needed for
_BaseAuth.importUsersmethod. This is used to provide the password hashing algorithm information. - UserImportRecord
-
Interface representing a user to import to Firebase Auth via the
_BaseAuth.importUsersmethod. - UserImportResult
-
Interface representing the response from the
_BaseAuth.importUsersmethod for batch importing users to Firebase Auth. - UserInfo
- UserMetadata
- Metadata information about when a user was created and last signed in.
- UserMetadataRequest
- User metadata to include when importing a user.
- UserProvider
- Represents a user identity provider that can be associated with a Firebase user.
- UserProviderRequest
- User provider data to include when importing a user.
- UserRecord
Enums
- AuthClientErrorCode
- Auth client error codes and their default messages.
- HashAlgorithmType
- MobileLinksDomain
- Open code in app domain to use for app links and universal links.
- MultiFactorConfigState
- Identifies a multi-factor configuration state.
- MultiFactorId
- PasswordPolicyEnforcementState
- A password policy's enforcement state.
- RecaptchaAction
- The actions to take for reCAPTCHA-protected requests.
- RecaptchaKeyClientType
- The key's platform type.
- RecaptchaProviderEnforcementState
- Enforcement state of reCAPTCHA protection.
Constants
- authFactorTypePhone → const String
- The 'phone' auth factor type constant.
Typedefs
- AuthFactorType = String
- Identifies a second factor type.
- CreateTenantRequest = UpdateTenantRequest
- Interface representing the properties to set on a new tenant.