API

Sign-In API

  • AuthenticationService.Instance.SignedIn
    • This is an event to which you can subscribe to be notified when the sign-in process has completed successfully.
  • AuthenticationService.Instance.SignInFailed
    • This is an event to which you can subscribe to be notified when the sign-in process has failed for some reason.
  • AuthenticationService.Instance.SignedOut
    • This is an event to which you can subscribe to be notified when the user has been signed out.
  • AuthenticationService.Instance.Expired
    • This is an event to which you can subscribe to be notified when the user session expires. The session is normally refreshed automatically, but if a session fails to refresh until the expiration time, this event will trigger.
  • AuthenticationService.Instance.SignInAnonymouslyAsync()
    • This triggers the anonymous sign-in processes, which may take some seconds to finish.
    • This requires no parameters.
    • To create a new anonymous account, use AuthenticationService.Instance.ClearSessionToken() while being signed out to clear the session token before signing in.
    • If you attempt to sign in while already signed in or currently signing in, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.SignInWithSessionTokenAsync()
    • This triggers the sign-in of the user with the session token stored on the device.
    • If there is no cached session token, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientNoActiveSession.
    • If you attempt to sign in while already signed in or currently signing in, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.SignInWithAppleAsync(string idToken)
    • This triggers the sign-in of the user with an ID token from Apple.
    • Game developer is responsible for installing the necessary SDK and get the token from Apple.
    • This method will create an account if no account is currently linked.
    • If you attempt to sign in while already signed in or currently signing in, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.SignInWithGoogleAsync(string idToken)
    • This triggers the sign-in of the user with an ID token from Google.
    • Game developer is responsible for installing the necessary SDK and get the token from Google.
    • This method will create an account if no account is currently linked.
    • If you attempt to sign in while already signed in or currently signing in, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.SignInWithFacebookAsync(string accessToken)
    • This triggers the sign-in of the user with an access token from Facebook.
    • Game developer is responsible for installing the necessary SDK and get the token from Facebook.
    • This method will create an account if no account is currently linked.
    • If this method is called while already signed in or currently signing in, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.LinkWithAppleAsync(string idToken)
    • This function links the current user with an ID token from Apple. The user can later sign-in with the linked Apple account.
    • Game developer is responsible for installing the necessary SDK and get the token from Apple.
    • If you attempt to link with an account that is already linked with another user, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountAlreadyLinked.
    • If you attempt to link when there is already an apple account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to link without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.LinkWithGoogleAsync(string idToken)
    • This function links the current user with an ID token from Google. The user can later sign-in with the linked Google account.
    • Game developer is responsible for installing the necessary SDK and get the token from Google.
    • If you attempt to link with an account that is already linked with another user, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountAlreadyLinked.
    • If you attempt to link when there is already a google account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to link without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.LinkWithFacebookAsync(string accessToken)
    • This function links the current user with an access token from Facebook. The user can later sign-in with the linked Facebook account.
    • Game developer is responsible for installing the necessary SDK and get the token from Facebook.
    • If you attempt to link with an account that is already linked with another user, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountAlreadyLinked.
    • If you attempt to link when there is already a facebook account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to link without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.LinkWithSteamAsync(string accessToken)
    • This function links the current user with an access token from Steam. The user can later sign-in with the linked Steam account.
    • Game developer is responsible for installing the necessary SDK and get the token from Steam.
    • If you attempt to link with an account that is already linked with another user, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountAlreadyLinked.
    • If you attempt to link when there is already a steam account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to link without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.UnlinkWithAppleAsync()
    • This function attempts to unlink the Apple account using the external id from the player's UserInfo.
    • Use AuthenticationService.Instance.GetUserInfoAsync() to load all of your user's external ids.
    • If you attempt to link when there is already an Apple account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to unlink without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
    • If you attempt to unlink without having an Apple external id in the player's UserInfo, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientUnlinkExternalIdNotFound.
  • AuthenticationService.Instance.UnlinkWithGoogleAsync()
    • This function attempts to unlink the Google account using the external id from the player's UserInfo.
    • If you attempt to link when there is already a Google account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to unlink without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
    • If you attempt to unlink without having a Google external id in the player's UserInfo, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientUnlinkExternalIdNotFound.
  • AuthenticationService.Instance.UnlinkWithFacebookAsync()
    • This function attempts to unlink the Facebook account using the external id from the player's UserInfo.
    • If you attempt to link when there is already a Facebook account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to unlink without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
    • If you attempt to unlink without having a Facebook external id in the player's UserInfo, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientUnlinkExternalIdNotFound.
  • AuthenticationService.Instance.UnlinkWithSteamAsync()
    • This function attempts to unlink the Steam account using the external id from the player's UserInfo.
    • If you attempt to link when there is already a Steam account linked to this account, this method will throw an AuthenticationException with AuthenticationErrorCodes.AccountLinkLimitExceeded.
    • If you attempt to unlink without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
    • If you attempt to unlink without having a Steam external id in the player's UserInfo, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientUnlinkExternalIdNotFound.
  • AuthenticationService.Instance.DeleteAccountAsync()
    • This function attempts to permanently delete the current player account.
    • If you attempt to delete without being authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.GetUserInfoAsync()
    • This function returns the PlayerId, CreatedAt, ExternalIds and IdDomain properties for an authorized player
    • If you are not authorized, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.SignOut()
    • This triggers the sign-out process, which will reset the session’s access token and player id. The session token is preserved to allow the user to sign in to the same account.
    • If you are not signed in, this method will do nothing.
  • AuthenticationService.Instance.ClearSessionToken()
    • Clears the session token from the local cache if it exists.
    • If you are not signed out, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
  • AuthenticationService.Instance.SwitchProfile(string profile)
    • Switches the current profile.
    • A profile isolates the Session Token in the PlayerPrefs.
    • This allows managing multiple accounts locally.
    • The profile may only contain alphanumeric values, -, _, and must be no longer than 30 characters.
    • If you are not signed out, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidUserState.
    • If the profile is invalid, this method will throw an AuthenticationException with AuthenticationErrorCodes.ClientInvalidProfile.
  • AuthenticationService.Instance.IsSignedIn
    • Returns true if the player is signed in.
    • The player is still considered signed in even if the access token expires, until AuthenticationService.Instance.SignOut() is explicitly called.
  • AuthenticationService.Instance.IsAuthorized
    • Returns true if the player is signed in and the access token is valid.
  • AuthenticationService.Instance.IsExpired
    • Returns true if the access token has expired.
  • AuthenticationService.Instance.PlayerId
    • This property exposes the ID of the player when they are signed in, or null if they are not.
  • AuthenticationService.Instance.Profile
    • This property exposes the current profile.
    • A profile isolates the Session Token in the PlayerPrefs.
    • This allows managing multiple accounts locally.
    • Profiles are not persisted and are optional.
  • AuthenticationService.Instance.AccessToken
    • Returns the raw string of the current access token, or null if no valid token is available (e.g. the player is signed in but the token has expired and could not be refreshed).
    • This value is updated automatically by the refresh process, so consumers should NOT cache this value.
  • AuthenticationService.Instance.SessionTokenExists
    • Returns True if there is a cached session token.
    • The session token is updated after each login and preserved locally on the device.
    • It can be used to authenticate the user to the same account in the future.
    • You can use AuthenticationService.Instance.ClearSessionToken() to clear the token from the local cache.
  • AuthenticationService.Instance.UserInfo
    • Returns the current player's user info, such as account creation time and linked external ids.
    • This is only partially loaded during sign in operations.
    • Use AuthenticationService.Instance.GetUserInfoAsync() to load the all the user info.