Skip to main content
Version: 4.24

Online Identity Subsystem

This API reference documents what methods and events are supported by Online Subsystem Blueprints. For full documentation on this API, refer to the Unreal Engine documentation.

Need to use a method or event that's not currently supported? Please reach out to support.

Supported Events#

EventSupported?Unreal Engine DocsParameters
OnLoginChanged✔Detailsint32 LocalUserNum
OnLoginStatusChanged✔DetailsELoginStatus::Type OldStatus
ELoginStatus::Type NewStatus
const FUniqueNetId& NewId
OnControllerPairingChanged✔Detailsint LocalUserNum
const FUniqueNetId& PreviousUser
const FUniqueNetId& NewUser
OnLoginComplete✔Detailsbool bWasSuccessful
const FUniqueNetId& UserId
const FString& Error
OnLogoutComplete✔Detailsbool bWasSuccessful
OnLoginFlowLogout✔Detailsconst TArray<FString>& LoginDomains

Supported Functions#

FunctionSupported?Unreal Engine DocsParameters
Login✔ 🕔Detailsint32 LocalUserNum
const FOnlineAccountCredentials& AccountCredentials
Logout✔ 🕔Detailsint32 LocalUserNum
AutoLogin✔ 🕔Detailsint32 LocalUserNum
GetUserAccount✔Detailsconst FUniqueNetId& UserId
GetAllUserAccounts✔Details
GetUniquePlayerId✔Detailsint32 LocalUserNum
GetSponsorUniquePlayerId✔Detailsint32 LocalUserNum
CreateUniquePlayerId✔Detailsconst FString& Str
GetLoginStatus✔Detailsint32 LocalUserNum
GetLoginStatus〰Detailsconst FUniqueNetId& UserId
GetPlayerNickname〰Detailsint32 LocalUserNum
GetPlayerNickname✔Detailsconst FUniqueNetId& UserId
GetAuthToken✔Detailsint32 LocalUserNum
RevokeAuthToken✔ 🕔Detailsconst FUniqueNetId& LocalUserId
GetUserPrivilege✔ 🕔Detailsconst FUniqueNetId& LocalUserId
EUserPrivileges::Type Privilege
GetPlatformUserIdFromUniqueNetId✔Detailsconst FUniqueNetId& UniqueNetId
GetAuthType✔Details