FirebaseAdmin.Auth

Summary

Enumerations
`AuthErrorCode{ CertificateFetchFailed, EmailAlreadyExists, ExpiredIdToken, InvalidIdToken, PhoneNumberAlreadyExists, UidAlreadyExists, UnexpectedResponse, UserNotFound, InvalidDynamicLinkDomain, InvalidHostingLinkDomain, RevokedIdToken, InvalidSessionCookie, ExpiredSessionCookie, RevokedSessionCookie, ConfigurationNotFound, TenantNotFound, TenantIdMismatch, EmailNotFound }`	enum Error codes that can be raised by the Firebase Auth APIs.

Classes
FirebaseAdmin.Auth.AbstractFirebaseAuth	Exposes Firebase Auth operations that are available in both tenant-aware and tenant-unaware contexts.
FirebaseAdmin.Auth.ActionCodeSettings	Defines the required continue/state URL with optional Android and iOS settings.
FirebaseAdmin.Auth.DeleteUsersResult	Represents the result of the AbstractFirebaseAuth.DeleteUsersAsync(IReadOnlyList{string}) API.
FirebaseAdmin.Auth.EmailIdentifier	Used for looking up an account by email.
FirebaseAdmin.Auth.ErrorInfo	Represents an error encountered while performing a batch operation such as AbstractFirebaseAuth.ImportUsersAsync(IEnumerable{ImportUserRecordArgs}) or AbstractFirebaseAuth.DeleteUsersAsync(IReadOnlyList{string}).
FirebaseAdmin.Auth.ExportedUserRecord	Contains metadata associated with a Firebase user account, along with password hash and salt.
FirebaseAdmin.Auth.ExportedUserRecords	Contains a collection of Firebase user accounts.
FirebaseAdmin.Auth.FirebaseAuth	This is the entry point to all server-side Firebase Authentication operations.
FirebaseAdmin.Auth.FirebaseAuthException	Exception type raised by Firebase Auth APIs.
FirebaseAdmin.Auth.FirebaseToken	Represents a valid, decoded Firebase ID token.
FirebaseAdmin.Auth.GetUsersResult	Represents the result of the AbstractFirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier}) API.
FirebaseAdmin.Auth.ImportUserRecordArgs	Represents a user account to be imported to Firebase Auth via the AbstractFirebaseAuth.ImportUsersAsync(IEnumerable{ImportUserRecordArgs}) API.
FirebaseAdmin.Auth.ListUsersOptions	Options for the AbstractFirebaseAuth.ListUsersAsync(ListUsersOptions) API.
FirebaseAdmin.Auth.PhoneIdentifier	Used for looking up an account by phone number.
FirebaseAdmin.Auth.ProviderIdentifier	Used for looking up an account by provider.
FirebaseAdmin.Auth.SessionCookieOptions	Options for the FirebaseAuth.CreateSessionCookieAsync(string, SessionCookieOptions) API.
FirebaseAdmin.Auth.UidIdentifier	Used for looking up an account by uid.
FirebaseAdmin.Auth.UserIdentifier	Identifies a user to be looked up.
FirebaseAdmin.Auth.UserImportHash	Represents a hash algorithm and the related configuration parameters used to hash user passwords.
FirebaseAdmin.Auth.UserImportOptions	A collection of options that can be passed to the FirebaseAuth.ImportUsersAsync API.
FirebaseAdmin.Auth.UserImportResult	Represents the result of the AbstractFirebaseAuth.ImportUsersAsync(IEnumerable{ImportUserRecordArgs}) API.
FirebaseAdmin.Auth.UserMetadata	Contains additional metadata associated with a user account.
FirebaseAdmin.Auth.UserProvider	Represents a user identity provider that can be associated with a Firebase user.
FirebaseAdmin.Auth.UserRecord	Contains metadata associated with a Firebase user account.
FirebaseAdmin.Auth.UserRecordArgs	A specification for creating or updating user accounts.

Interfaces
FirebaseAdmin.Auth.IUserInfo	A collection of standard profile information for a user.

Namespaces
FirebaseAdmin.Auth.Hash
FirebaseAdmin.Auth.Jwt
FirebaseAdmin.Auth.Multitenancy
FirebaseAdmin.Auth.Providers
FirebaseAdmin.Auth.Users

Enumerations

AuthErrorCode

 AuthErrorCode

Error codes that can be raised by the Firebase Auth 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 in ActionCodeSettings 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.

FirebaseAdmin.Auth

Summary

Enumerations

Classes

Interfaces

Namespaces

Enumerations

AuthErrorCode