FirebaseAdmin. Auth
Summary
Enumerations | |
|---|---|
AuthErrorCode{ | enum Error codes that can be raised by the FirebaseAuth APIs. |
Classes | |
|---|---|
| FirebaseAdmin. | Exposes FirebaseAuth operations that are available in both tenant-aware and tenant-unaware contexts. |
| FirebaseAdmin. | Defines the required continue/state URL with optional Android and iOS settings. |
| FirebaseAdmin. | Represents the result of the AbstractFirebaseAuth.DeleteUsersAsync(IReadOnlyList{string}) API. |
| FirebaseAdmin. | Used for looking up an account by email. |
| FirebaseAdmin. | Represents an error encountered while performing a batch operation such as AbstractFirebaseAuth.ImportUsersAsync(IEnumerable{ImportUserRecordArgs}) or AbstractFirebaseAuth.DeleteUsersAsync(IReadOnlyList{string}). |
| FirebaseAdmin. | Contains metadata associated with a Firebase user account, along with password hash and salt. |
| FirebaseAdmin. | Contains a collection of Firebase user accounts. |
| FirebaseAdmin. | This is the entry point to all server-side Firebase Authentication operations. |
| FirebaseAdmin. | Exception type raised by FirebaseAuth APIs. |
| FirebaseAdmin. | Represents a valid, decoded Firebase ID token. |
| FirebaseAdmin. | Represents the result of the AbstractFirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier}) API. |
| FirebaseAdmin. | Represents a user account to be imported to FirebaseAuth via the AbstractFirebaseAuth.ImportUsersAsync(IEnumerable{ImportUserRecordArgs}) API. |
| FirebaseAdmin. | Options for theAbstractFirebaseAuth.ListUsersAsync(ListUsersOptions) API. |
| FirebaseAdmin. | Used for looking up an account by phone number. |
| FirebaseAdmin. | Used for looking up an account by provider. |
| FirebaseAdmin. | Options for theFirebaseAuth.CreateSessionCookieAsync(string, SessionCookieOptions) API. |
| FirebaseAdmin. | Used for looking up an account by uid. |
| FirebaseAdmin. | Identifies a user to be looked up. |
| FirebaseAdmin. | Represents a hash algorithm and the related configuration parameters used to hash user passwords. |
| FirebaseAdmin. | A collection of options that can be passed to theFirebaseAuth.ImportUsersAsync API. |
| FirebaseAdmin. | Represents the result of the AbstractFirebaseAuth.ImportUsersAsync(IEnumerable{ImportUserRecordArgs}) API. |
| FirebaseAdmin. | Contains additional metadata associated with a user account. |
| FirebaseAdmin. | Represents a user identity provider that can be associated with a Firebase user. |
| FirebaseAdmin. | Contains metadata associated with a Firebase user account. |
| FirebaseAdmin. | A specification for creating or updating user accounts. |
Interfaces | |
|---|---|
| FirebaseAdmin. | A collection of standard profile information for a user. |
Namespaces | |
|---|---|
| FirebaseAdmin. | |
| FirebaseAdmin. | |
| FirebaseAdmin. | |
| FirebaseAdmin. | |
| FirebaseAdmin. | |
Enumerations
AuthErrorCode
AuthErrorCode
Error codes that can be raised by the FirebaseAuth APIs.
| Properties | |
|---|---|
CertificateFetchFailed | Failed to retrieve required public key certificates. |
ConfigurationNotFound | No identity provider configuration found for the given identifier. |
EmailAlreadyExists | The user with the provided email already exists. |
EmailNotFound | No user record found for the given email, typically raised when generating a password reset link using an email for a user that is not already registered. |
ExpiredIdToken | The specified ID token is expired. |
ExpiredSessionCookie | The specified session cookie is expired. |
InvalidDynamicLinkDomain | Dynamic link domain specified inActionCodeSettings is not authorized. |
InvalidHostingLinkDomain | The provided hosting link domain is not configured in Firebase Hosting or is not owned by the current project. |
InvalidIdToken | The specified ID token is invalid. |
InvalidSessionCookie | The specified session cookie is invalid. |
PhoneNumberAlreadyExists | The user with the provided phone number already exists. |
RevokedIdToken | The specified ID token has been revoked. |
RevokedSessionCookie | The specified session cookie has been revoked. |
TenantIdMismatch | Tenant ID in a token does not match. |
TenantNotFound | No tenant found for the given identifier. |
UidAlreadyExists | The user with the provided uid already exists. |
UnexpectedResponse | Backend API responded with an unexpected message. |
UserNotFound | No user record found for the given identifier. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-08 UTC.