Authenticate with Firebase using Password-Based Accounts using Unity

You can use Firebase Authentication to let your users authenticate with Firebase using their email addresses and passwords, and to manage your app's password-based accounts.

Before you begin

Before you can use Firebase Authentication, you need to:

• Register your Unity project and configure it to use Firebase.

  • If your Unity project already uses Firebase, then it's already registered and configured for Firebase.

  • If you don't have a Unity project, you can download a sample app.

• Add the Firebase Unity SDK (specifically, FirebaseAuth.unitypackage) to your Unity project.

Note that adding Firebase to your Unity project involves tasks both in the Firebase console and in your open Unity project (for example, you download Firebase config files from the console, then move them into your Unity project).

Access the Firebase.Auth.FirebaseAuth class

The FirebaseAuth class is the gateway for all API calls. It is accessable through FirebaseAuth.DefaultInstance.

Firebase.Auth.FirebaseAuth auth = Firebase.Auth.FirebaseAuth.DefaultInstance;

Create a password-based account

To create a new user account with a password, complete the following steps in your app's sign-in code:

1. When a new user signs up using your app's sign-up form, complete any new account validation steps that your app requires, such as verifying that the new account's password was correctly typed and meets your complexity requirements.
2. Create a new account by passing the new user's email address and password to FirebaseAuth.CreateUserWithEmailAndPassword:

   auth.CreateUserWithEmailAndPasswordAsync(email, password).ContinueWith(task => {
     if (task.IsCanceled) {
       Debug.LogError("CreateUserWithEmailAndPasswordAsync was canceled.");
       return;
     }
     if (task.IsFaulted) {
       Debug.LogError("CreateUserWithEmailAndPasswordAsync encountered an error: " + task.Exception);
       return;
     }
   
     // Firebase user has been created.
     Firebase.Auth.FirebaseUser newUser = task.Result;
     Debug.LogFormat("Firebase user created successfully: {0} ({1})",
         newUser.DisplayName, newUser.UserId);
   });
   

Sign in a user with an email address and password

The steps for signing in a user with a password are similar to the steps for creating a new account. In your app's sign-in function, do the following:

1. When a user signs in to your app, pass the user's email address and password to FirebaseAuth.SignInWithEmailAndPassword:

   auth.SignInWithEmailAndPasswordAsync(email, password).ContinueWith(task => {
     if (task.IsCanceled) {
       Debug.LogError("SignInWithEmailAndPasswordAsync was canceled.");
       return;
     }
     if (task.IsFaulted) {
       Debug.LogError("SignInWithEmailAndPasswordAsync encountered an error: " + task.Exception);
       return;
     }
   
     Firebase.Auth.FirebaseUser newUser = task.Result;
     Debug.LogFormat("User signed in successfully: {0} ({1})",
         newUser.DisplayName, newUser.UserId);
   });
   

2. You can also create the credential and sign in like the other workflows:

   Firebase.Auth.Credential credential =
       Firebase.Auth.EmailAuthProvider.GetCredential(email, password);
   auth.SignInWithCredentialAsync(credential).ContinueWith(task => {
     if (task.IsCanceled) {
       Debug.LogError("SignInWithCredentialAsync was canceled.");
       return;
     }
     if (task.IsFaulted) {
       Debug.LogError("SignInWithCredentialAsync encountered an error: " + task.Exception);
       return;
     }
   
     Firebase.Auth.FirebaseUser newUser = task.Result;
     Debug.LogFormat("User signed in successfully: {0} ({1})",
         newUser.DisplayName, newUser.UserId);
   });
   

Next Steps

After a user signs in for the first time, a new user account is created and linked to the credentials—that is, the user name and password, phone number, or auth provider information—the user signed in with. This new account is stored as part of your Firebase project, and can be used to identify a user across every app in your project, regardless of how the user signs in.

• In your apps, you can get the user's basic profile information from the Firebase.Auth.FirebaseUser object:

  Firebase.Auth.FirebaseUser user = auth.CurrentUser;
  if (user != null) {
    string name = user.DisplayName;
    string email = user.Email;
    System.Uri photo_url = user.PhotoUrl;
    // The user's Id, unique to the Firebase project.
    // Do NOT use this value to authenticate with your backend server, if you
    // have one; use User.TokenAsync() instead.
    string uid = user.UserId;
  }
  

• In your Firebase Realtime Database and Cloud Storage Security Rules, you can get the signed-in user's unique user ID from the auth variable, and use it to control what data a user can access.

You can allow users to sign in to your app using multiple authentication providers by linking auth provider credentials to an existing user account.

To sign out a user, call SignOut():

auth.SignOut();