auth library

Classes

ActionCodeSettings
This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers.
ActionCodeSettingsAndroid
ActionCodeSettingsIos
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.
DecodedIdToken
Interface representing a decoded Firebase ID token, returned from the _BaseAuth.verifyIdToken method.
DeleteUsersResult
Represents the result of the _BaseAuth.deleteUsers. API.
EmailIdentifier
Used for looking up an account by email.
FirebaseTokenInfo
FirebaseTokenVerifier
GetUsersResult
Represents the result of the _BaseAuth.getUsers API.
ListProviderConfigResults
The response interface for listing provider configs. This is only available when listing all identity providers' configurations via _BaseAuth.listProviderConfigs.
ListUsersResult
Interface representing the object returned from a _BaseAuth.listUsers operation. Contains the list of users for the current batch and the next page token if available.
MultiFactorCreateSettings
The multi-factor related user settings for create operations.
MultiFactorInfo
Interface representing the common properties of a user-enrolled second factor.
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.
PhoneIdentifier
Used for looking up an account by phone number.
PhoneMultiFactorInfo
Interface representing a phone specific user-enrolled second factor.
ProviderIdentifier
Used for looking up an account by federated provider.
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.
TokenProvider
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.
UpdateRequest
Interface representing the properties to update on the provided user.
UploadAccountOptions
UserIdentifier
Identifies a user to be looked up.
UserImportHashOptions
UserImportOptions
Interface representing the user import options needed for _BaseAuth.importUsers method. This is used to provide the password hashing algorithm information.
UserImportRecord
Interface representing a user to import to Firebase Auth via the _BaseAuth.importUsers method.
UserImportResult
Interface representing the response from the _BaseAuth.importUsers method 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
MultiFactorId

Constants

authServerToClientCode → const Map<String, AuthClientErrorCode>
Auth server to client enum error codes.

Exceptions / Errors

FirebaseAuthAdminException