Authenticate with Firebase using a custom authentication system and Unity (2024)

• Firebase
• Docs
• Build

You can integrate Firebase Authentication with a custom authentication system bymodifying your authentication server to produce custom signed tokens when a usersuccessfully signs in. Your app receives this token and uses it to authenticatewith Firebase.

Before you begin

1. Before you can use Firebase Authentication, you need to:

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

   Find detailed instructions for these initial setup steps in Add Firebase to your Unity project.

2. Get your project's server keys:
   1. Go to the Service Accounts page in your project's settings.
   2. Click Generate New Private Key at the bottom of the Firebase Admin SDK section of the Service Accounts page.
   3. The new service account's public/private key pair is automatically saved on your computer. Copy this file to your authentication server.

Authenticate with Firebase

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

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

Call Firebase.Auth.FirebaseAuth.SignInWithCustomTokenAsync with the token fromyour authentication server.

1. When users sign in to your app, send their sign-in credentials (forexample, their username and password) to your authentication server. Yourserver checks the credentials and returns acustom tokenif they are valid.
2. After you receive the custom token from your authentication server, passit to Firebase.Auth.FirebaseAuth.SignInWithCustomTokenAsync to sign in theuser:

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

Next steps

After a user signs in for the first time, a new user account is created andlinked to the credentials—that is, the user name and password, phonenumber, or auth provider information—the user signed in with. This newaccount is stored as part of your Firebase project, and can be used to identifya 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 theFirebase.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 authenticationproviders by linking auth provider credentials to anexisting user account.

To sign out a user, call SignOut():

auth.SignOut();