Skip to main content

UgsAuth

19 tools in this family (folder Editor/Tools/UgsAuth/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
ugs_auth_export_setupread-onlyExport the current UGS auth configuration as a JSON snapshot — environment, mock_mode,
ugs_auth_get_player_inforead-onlyFetch full player info for the currently signed-in player — player_id, display name, created
ugs_auth_initwritesInitialize Unity Gaming Services (UGS) for an environment. This must be called BEFORE any other
ugs_auth_link_identitywritesLink an external identity to the currently signed-in player. Used to upgrade an anonymous
ugs_auth_sign_in_anonymouswritesSign in anonymously. Unity allocates a fresh player id on the first call, then re-uses it on
ugs_auth_sign_in_applewritesSign in with Apple. The id_token is obtained by your iOS/macOS app from Sign in with Apple.
ugs_auth_sign_in_custom_tokenwritesSign in with a custom token issued by your own backend. Use this when you already have an
ugs_auth_sign_in_facebookwritesSign in with Facebook. The access_token is obtained by your app from the Facebook SDK
ugs_auth_sign_in_googlewritesSign in with Google. Pass either an id_token from Google Identity Services (web/iOS) or, by
ugs_auth_sign_in_oculuswritesSign in with Oculus. Pass both the nonce (single-use challenge token from Oculus Platform
ugs_auth_sign_in_session_tokenwritesSilently restore the previous session using the locally-persisted session token. Returns the
ugs_auth_sign_in_steamwritesSign in with Steam. If session_ticket is omitted, Buril reflectively pulls one from the
ugs_auth_sign_in_usernamewritesSign in with a Unity-managed username + password pair. With auto_sign_up=true, the account
ugs_auth_sign_outwritesSign out of UGS. With clear_credentials=true (default), the persisted session token is also
ugs_auth_statusread-onlyQuery the current UGS Authentication state — is_initialized, is_signed_in, is_authorized,
ugs_auth_unlink_identitywritesUnlink an external identity from the currently signed-in player. After unlinking, that
ugs_auth_upa_sign_inwritesStart the Unity Player Accounts (UPA) browser OAuth flow. In real mode Unity opens the system
ugs_auth_upa_statusread-onlyQuery Unity Player Accounts state — whether the user is signed into UPA, the current UPA
ugs_auth_update_player_namewritesUpdate the display name of the currently signed-in player. UGS appends a discriminator