FirebaseUser

fun delete(): Task<Void!>

Deletes the user record from your Firebase project's database. If the operation is successful, the user will be signed out.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate.

• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid
• FirebaseAuthRecentLoginRequiredException thrown if the user's last sign-in time does not meet the security threshold. Use reauthenticate to resolve. This does not apply if the user is anonymous.

abstract fun getDisplayName(): String?

Returns the main display name of this user from the Firebase project's user database. Unlike the display name property from instances of UserInfo corresponding to authentication providers (like Google Sign-In), which is not modifiable, this name can be updated at any time by calling updateProfile.

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential contained such information.

abstract fun getEmail(): String?

Returns the main email address of the user, as stored in the Firebase project's user database. Unlike the email property from instances of UserInfo corresponding to authentication providers (like GitHub), which is not modifiable, this email address can be updated at any time by calling updateEmail.

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential contained such information, or if the account was created with createUserWithEmailAndPassword. However, this is not true if the setting "Multiple Accounts per Email" is enabled in the Firebase Console - in that case this will be null unless the account was created with createUserWithEmailAndPassword or updateEmail has been called.

If the user also has a password, this email address can be used to sign in into the account using signInWithEmailAndPassword.

This email address is displayed in the Users section of the Firebase console.

fun getIdToken(forceRefresh: Boolean): Task<GetTokenResult!>

Fetches a Firebase Auth ID Token for the user; useful when authenticating against your own backend. Use our server SDKs or follow the official documentation to securely verify the integrity and validity of this token.

• FirebaseAuthInvalidUserException if forceRefresh == true, thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid

abstract fun getMetadata(): FirebaseUserMetadata?

Returns the FirebaseUserMetadata associated with this user.

abstract fun getMultiFactor(): MultiFactor

Returns a MultiFactor instance which is the main entry point for multi-factor related operations on this user.

abstract fun getPhoneNumber(): String?

Returns the phone number of the user, as stored in the Firebase project's user database, or null if none exists. This can be updated at any time by calling updatePhoneNumber.

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential contained such information. This phone number is displayed in the Users section of the Firebase console.

abstract fun getPhotoUrl(): Uri?

Returns the URL of this user's main profile picture, as stored in the Firebase project's user database. Unlike the profile URL property from instances of UserInfo corresponding to authentication providers (like Facebook Login), which is not modifiable, this URL can be updated at any time by calling updateProfile.

This field will be automatically populated on account creation if the AuthCredential used on signInWithCredential contained such information.

abstract fun getProviderData(): (Mutable)List<UserInfo!>

Returns a List of UserInfo objects that represents the linked identities of the user using different authentication providers that may be linked to their account. Use this to access, for example, your user's basic profile information retrieved from Facebook whether or not the user used Facebook Login to sign in to the current session.

abstract fun getProviderId(): String

Always returns PROVIDER_ID.

abstract fun getTenantId(): String?

Returns the tenant ID of the current user or null if this user isn't associated with a tenant project.

abstract fun getUid(): String

Returns a string used to uniquely identify your user in your Firebase project's user database. Use it when storing information in Firebase Database or Storage, or even in your own backend.

This identifier is opaque and does not correspond necessarily to the user's email address or any other field.

abstract fun isAnonymous(): Boolean

Returns true if the user is anonymous; that is, the user account was created with signInAnonymously and has not been linked to another account with linkWithCredential.

fun linkWithCredential(credential: AuthCredential): Task<AuthResult!>

Attaches the given AuthCredential to the user. This allows the user to sign in to this account in the future with credentials for such provider.

• FirebaseAuthWeakPasswordException thrown if credential instanceof EmailAuthCredential and the password is not strong enough
• FirebaseAuthInvalidCredentialsException thrown if the credential is malformed or expired
• FirebaseAuthUserCollisionException thrown if there is another user account associated with the given credential
• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid
• FirebaseAuthRecentLoginRequiredException thrown if credential instanceof EmailAuthCredential and if the user's last sign-in time does not meet the security threshold. Use reauthenticate to resolve. This does not apply if the user is anonymous.
• FirebaseAuthException thrown if there is an attempt to link a provider that is already linked to this account or if an internal error occurs

fun reauthenticate(credential: AuthCredential): Task<Void!>

Reauthenticates the user with the given credential. This is useful for operations that require a recent sign-in, to prevent or resolve a FirebaseAuthRecentLoginRequiredException.

• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled or deleted
• FirebaseAuthInvalidCredentialsException thrown if the credential is malformed or has expired, or if it corresponds to another existing user's account. Inspect the error code to desambiguate.

fun reauthenticateAndRetrieveData(credential: AuthCredential): Task<AuthResult!>

Reauthenticates the user with the given credential, and returns the profile data for that account. This is useful for operations that require a recent sign-in, to prevent or resolve a FirebaseAuthRecentLoginRequiredException.

• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled or deleted
• FirebaseAuthInvalidCredentialsException thrown if the credential is malformed or has expired, or if it corresponds to another existing user's account. Inspect the error code to desambiguate.

fun reload(): Task<Void!>

Manually refreshes the data of the current user (for example, attached providers, display name, and so on).

• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid

fun sendEmailVerification(): Task<Void!>

Calls sendEmailVerification with null actionCodeSettings.

fun sendEmailVerification(actionCodeSettings: ActionCodeSettings): Task<Void!>

Initiates email verification for the user. Takes in an ActionCodeSettings to allow linking back to your app in the email.

fun startActivityForLinkWithProvider(
    activity: Activity,
    federatedAuthProvider: FederatedAuthProvider
): Task<AuthResult!>

Links the user using the mobile browser (either a Custom Chrome Tab or the device's default browser) to the given provider. If the calling activity dies during this operation, use getPendingAuthResult to get the outcome of this operation.

Note: this call has a UI associated with it, unlike the majority of calls in FirebaseAuth.

• FirebaseAuthInvalidCredentialsException thrown if the credential generated from the flow is malformed or expired.
• FirebaseAuthInvalidUserException thrown if the user has been disabled by an administrator.
• FirebaseAuthUserCollisionException thrown if the email that keys the user that is signing in is already in use.
• FirebaseAuthWebException thrown if there is an operation already in progress, the pending operation was canceled, there is a problem with 3rd party cookies in the browser, or some other error in the web context has occurred.
• FirebaseAuthException thrown if signing in via this method has been disabled in the Firebase Console, or if the provider passed is configured improperly.

fun startActivityForReauthenticateWithProvider(
    activity: Activity,
    federatedAuthProvider: FederatedAuthProvider
): Task<AuthResult!>

Reauthenticates the user using the mobile browser (either a Custom Chrome Tab or the device's default browser) using the given provider. If the calling activity dies during this operation, use getPendingAuthResult to get the outcome of this operation.

Note: this call has a UI associated with it, unlike the majority of calls in FirebaseAuth.

• FirebaseAuthInvalidCredentialsException thrown if the credential generated from the flow is malformed or expired.
• FirebaseAuthInvalidUserException thrown if the user has been disabled by an administrator.
• FirebaseAuthUserCollisionException thrown if the email that keys the user that is signing in is already in use.
• FirebaseAuthWebException thrown if there is an operation already in progress, the pending operation was canceled, there is a problem with 3rd party cookies in the browser, or some other error in the web context has occurred.
• FirebaseAuthException thrown if signing in via this method has been disabled in the Firebase Console, or if the provider passed is configured improperly.

fun unlink(provider: String): Task<AuthResult!>

Detaches credentials from a given provider type from this user. This prevents the user from signing in to this account in the future with credentials from such provider.

• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid

fun updateEmail(email: String): Task<Void!>

Updates the email address of the user.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate.

In addition, note that the original email address recipient will receive an email that allows them to revoke the email address change, in order to protect them from account hijacking.

• FirebaseAuthInvalidCredentialsException thrown if the email address is malformed
• FirebaseAuthUserCollisionException thrown if there already exists an account with the given email address
• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid
• FirebaseAuthRecentLoginRequiredException thrown if the user's last sign-in time does not meet the security threshold. Use reauthenticate to resolve. This does not apply if the user is anonymous.
• FirebaseAuthException thrown with code OPERATION_NOT_ALLOWED if Email Enumeration Protection is enabled.

fun updatePassword(password: String): Task<Void!>

Updates the password of the user.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate.

Anonymous users who update both their email and password will no longer be anonymous. They will be able to log in with these credentials.

• FirebaseAuthWeakPasswordException thrown if the password is not strong enough
• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid
• FirebaseAuthRecentLoginRequiredException thrown if the user's last sign-in time does not meet the security threshold. Use reauthenticate to resolve. This does not apply if the user is anonymous.

fun updatePhoneNumber(credential: PhoneAuthCredential): Task<Void!>

Updates the phone number of the user.

Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and later call reauthenticate.

• FirebaseAuthUserCollisionException thrown if there already exists an account with the given phone number
• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid
• FirebaseAuthRecentLoginRequiredException thrown if the user's last sign-in time does not meet the security threshold. Use reauthenticate to resolve. This does not apply if the user is anonymous.

fun updateProfile(request: UserProfileChangeRequest): Task<Void!>

Updates the user profile information. Use UserProfileChangeRequest.Builder to construct the request.

• FirebaseAuthInvalidUserException thrown if the current user's account has been disabled, deleted, or its credentials are no longer valid

fun verifyBeforeUpdateEmail(newEmail: String): Task<Void!>

Calls verifyBeforeUpdateEmail without any actionCodeSettings.

fun verifyBeforeUpdateEmail(
    newEmail: String,
    actionCodeSettings: ActionCodeSettings?
): Task<Void!>

Sends a verification email to newEmail. Upon redemption of the link in the email, this user's email will be changed to newEmail and that email will be marked verified.