Unity Player Accounts#

Overview#

Unity Player Accounts is Unity’s comprehensive sign-in solution that supports persistence across games, devices and platforms. It’s an end-to-end account system that includes a user flow UX, email and password, social sign-in options, and data access and deletion flows.

Unity Player Accounts is integrated with Unity Gaming Services and is one more identity provider that Authentication supports, in addition to Anonymous, Apple, Google, Facebook, Steam, with benefits such as SSO, organization level player pool, and cross-game, cross-device or cross-platform gameplay.

Get started#

Install the SDK#

To install the latest Authentication package for Unity:

1. In the Unity Editor, open Window > Package Manager.
2. In the Package Manager, select the Unity Registry list view.
3. Search for Authentication, or locate it in the package list.
4. Select the package, then select Install.

For more information, see the Package Manager documentation.

Set up Unity Player Accounts#

You can set up Unity Player Accounts directly in the Unity Cloud Dashboard.

Before using Unity Player Accounts, make sure you have the following:

Before you publish your game#

Review Unity’s compliance and branding guidelines:

• You must provide a way for players to request data deletion and disclosure requests for your application and their Unity Player Account.
• Include a link to the Unity Player Accounts account deletion page.
• Include a link to the Unity Player Accounts privacy support email for data disclosure or other privacy requests.
• Include a link to the email for data disclosure or other privacy requests.
• You must always ensure compliance with Unity Terms of Service.
• You must always maintain, display, and abide by a conspicuously placed Privacy Policy that makes appropriate disclosure to end-users, complies with all applicable privacy and data protection laws and regulations, and grants Unity the necessary rights required for the use of the Unity Player Accounts service.

Term of Service and Privacy#

Make sure the Terms of Service and Privacy link are provided in the Unity Cloud Dashboard.

SDK integration#

Set up Unity Player Accounts sign-in#

After installing the package, in the Editor menu select Services > Authentication > Player Account Settings.

Add the following values, received after onboarding:

• Client ID
• Scope (Optional. All or Empty means all permitted scopes)
• Use Custom Deep Link Uri (Optional. Overrides the default deep link URI)

Unity Player Accounts sample#

• Select Window > Package Manager to import the sample. Look for Authentication and select Import under Samples.

• Open the sample scene under Assets > Samples > Authentication > [Package-Version] > UI Example > UnityPlayerAccountsUIExample.

Integrate with Unity Authentication Service#

Configure a Unity Player Account ID Provider for Unity Authentication:

1. In the Unity Editor menu, go to Edit > Project Settings..., then select Services > Authentication from the navigation menu.
2. Select Go to Dashboard to open the Authentication Identity providers web page.
3. On the web page, select Add Identity Provider and select Unity Player Accounts.
4. Set up the provider and select Add provider in the pop-up window.
5. Return to Services > Authentication in the Unity editor and select Refresh. This displays the Unity Player Accounts ID provider.
6. In the Unity editor, navigate to Services > Authentication > Player Account Settings and ensure the Client ID is correctly set.
7. Run the package sample scene UnityPlayerAccountsUIExample that you imported earlier.

void Awake()
{
   PlayerAccountService.Instance.SignedIn += SignInWithUnity;
}

Sign in a returning player or create new player#

Use the SignInWithUnityAsync method to either:

• Create a new Unity Authentication player with the Unity Player Accounts credentials.
• Sign in an existing player using the Unity Player Accounts credentials.

async Task SignInWithUnityAsync(string accessToken)
        {
            try
            {
                await AuthenticationService.Instance.SignInWithUnityAsync(accessToken);
                Debug.Log("SignIn is successful.");
            }
            catch (AuthenticationException ex)
            {
                // Compare error code to AuthenticationErrorCodes
                // Notify the player with the proper error message
                Debug.LogException(ex);
            }
            catch (RequestFailedException ex)
            {
                // Compare error code to CommonErrorCodes
                // Notify the player with the proper error message
                Debug.LogException(ex);
            }
        }

Update a player from anonymous to a Unity Player Account#

After you’ve set up anonymous authentication, if the player wants to upgrade from being anonymous to creating a Unity Player Account and sign in, your game should prompt the player to trigger the Unity Player Accounts sign-in and get the Access token from Unity Player Accounts. Then, call the LinkWithUnityAsync API to link the player to the Unity Player Account Access token.

If a cached player exists on the SDK, you can link the cached player to the Unity Player Account.

1. Sign into the cached player's account using SignInAnonymouslyAsync.
2. Link the cached player's account to the Unity Player account with LinkWithUnityAsync.

For more information about cached players, refer to Sign In a Cached User.

async Task LinkWithUnityAsync(string accessToken)
        {
            try
            {
                await AuthenticationService.Instance.LinkWithUnityAsync(accessToken);
                Debug.Log("Link is successful.");
            }
            catch (AuthenticationException ex) when (ex.ErrorCode == AuthenticationErrorCodes.AccountAlreadyLinked)
            {
                // Prompt the player with an error message.
                Debug.LogError("This user is already linked with another account. Log in instead.");
            }

            catch (AuthenticationException ex)
            {
                // Compare error code to AuthenticationErrorCodes
                // Notify the player with the proper error message
                Debug.LogException(ex);
            }
            catch (RequestFailedException ex)
            {
                // Compare error code to CommonErrorCodes
                // Notify the player with the proper error message
                Debug.LogException(ex);
            }
        }

Unlink Unity Player Account#

Use the UnlinkUnityAsync API so your players can unlink their Unity Player account. Once unlinked, if their account isn’t linked to any additional identity, it transitions to an anonymous account.

async Task UnlinkUnityAsync(string idToken)
{
   try
   {
       await AuthenticationService.Instance.UnlinkUnityAsync(idToken);
       Debug.Log("Unlink is successful.");
   }
   catch (AuthenticationException ex)
   {
       // Compare error code to AuthenticationErrorCodes
       // Notify the player with the proper error message
       Debug.LogException(ex);
   }
   catch (RequestFailedException ex)
   {
       // Compare error code to CommonErrorCodes
       // Notify the player with the proper error message
       Debug.LogException(ex);
   }
}