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 accessible 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:
- 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.
- 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.AuthResult result = task.Result;
Debug.LogFormat("Firebase user created successfully: {0} ({1})",
result.User.DisplayName, result.User.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:
- 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.AuthResult result = task.Result;
Debug.LogFormat("User signed in successfully: {0} ({1})",
result.User.DisplayName, result.User.UserId);
});
- You can also create the credential and sign in like the other workflows:
Firebase.Auth.Credential credential =
Firebase.Auth.EmailAuthProvider.GetCredential(email, password);
auth.SignInAndRetrieveDataWithCredentialAsync(credential).ContinueWith(task => {
if (task.IsCanceled) {
Debug.LogError("SignInAndRetrieveDataWithCredentialAsync was canceled.");
return;
}
if (task.IsFaulted) {
Debug.LogError("SignInAndRetrieveDataWithCredentialAsync 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);
});
Recommended: Enable email enumeration protection
Some Firebase Authentication methods that take email addresses as parameters throw
specific errors if the email address is unregistered when it must be registered
(for example, when signing in with an email address and password), or registered
when it must be unused (for example, when changing a user's email address).
While this can be helpful for suggesting specific remedies to users, it can also
be abused by malicious actors to discover the email addresses registered by your
users.
To mitigate this risk, we recommend you
enable email enumeration protection
for your project using the Google Cloud
gcloud
tool. Note that enabling this
feature changes Firebase Authentication's error reporting behavior: be sure your app
doesn't rely on the more specific errors.
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();