You can use Firebase Authentication to create and use temporary anonymous accounts
to authenticate with Firebase. These temporary anonymous accounts can be used to
allow users who haven't yet signed up to your app to work with data protected
by security rules. If an anonymous user decides to sign up to your app, you can
link their sign-in credentials to the anonymous
account
so that they can continue to work with their protected data in
future sessions.
Before you begin
-
Before you can use
Firebase Authentication
,
you need to 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
.
- If you haven't yet connected your app to your Firebase project, do so from
the
Firebase console
.
- Enable anonymous auth:
- In the
Firebase console
, open the
Auth
section.
- On the
Sign-in Methods
page, enable the
Anonymous
sign-in method.
- Optional
: If you've upgraded your project to
Firebase Authentication with Identity Platform
, you can enable automatic clean-up. When
you enable this setting, anonymous accounts older than 30 days will be automatically
deleted. In projects with automatic clean-up enabled, anonymous authentication will no
longer count toward usage limits or billing quotas. See
Automatic clean-up
.
Authenticate with Firebase anonymously
When a signed-out user uses an app feature that requires authentication with
Firebase, sign in the user anonymously by completing the following steps:
The
FirebaseAuth
class is the gateway for all API calls.
It is accessible through
FirebaseAuth.DefaultInstance
.
Firebase.Auth.FirebaseAuth auth = Firebase.Auth.FirebaseAuth.DefaultInstance;
1. Call
Firebase.Auth.FirebaseAuth.SignInAnonymouslyAsync
.
auth.SignInAnonymouslyAsync().ContinueWith(task => {
if (task.IsCanceled) {
Debug.LogError("SignInAnonymouslyAsync was canceled.");
return;
}
if (task.IsFaulted) {
Debug.LogError("SignInAnonymouslyAsync 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);
});
Convert an anonymous account to a permanent account
When an anonymous user signs up to your app, you might want to allow them to
continue their work with their new account—for example, you might want to
make the items the user added to their shopping cart before they signed up
available in their new account's shopping cart. To do so, complete the following
steps:
- When the user signs up, complete the sign-in flow for the user's
authentication provider up to, but not including, calling one of the
Firebase.Auth.FirebaseAuth.SignInAndRetrieveDataWithCredentialAsync
methods. For example, get the user's Google ID token,
Facebook access token, or email address and password.
Get an
Firebase.Auth.Credential
for the new authentication provider:
Pass the
Firebase.Auth.Credential
object to the sign-in user's
LinkWithCredentialAsync
method:
If the call to
LinkWithCredentialAsync
succeeds, the user's new account can
access the anonymous account's Firebase data.
Automatic clean-up
If you've upgraded your project to
Firebase Authentication with Identity Platform
, you can
enable automatic clean-up in the Firebase console. When you enable this feature you allow
Firebase to automatically delete anonymous accounts older than 30 days. In projects with automatic
clean-up enabled, anonymous authentication will not count toward usage limits or billing quotas.
- Any anonymous accounts created after enabling automatic clean-up might be automatically
deleted any time after 30 days post-creation.
- Existing anonymous accounts will be eligible for automatic deletion 30 days after
enabling automatic clean-up.
- If you turn automatic clean-up off, any anonymous accounts scheduled to be deleted will remain
scheduled to be deleted.
- If you "upgrade" an anonymous account by linking it to any sign-in method, the account will
not get automatically deleted.
If you want to see how many users will be affected before you enable this feature, and you've
upgraded your project to
Firebase Authentication with Identity Platform
, you can filter by
is_anon
in
Cloud
Logging
.
Next steps
Now that users can authenticate with Firebase, you can control their access to
data in your Firebase database using
Firebase rules
.