Skip to main content
Signs the user in using an XBOX Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Syntax

Parameters

serviceConfigHandle   PFServiceConfigHandle PFServiceConfigHandle returned from PFServiceConfigCreateHandle call. request   PFAuthenticationLoginWithXboxRequest* Populated request object. async   XAsyncBlock*
Inout
XAsyncBlock for the async operation.

Return value

Type: HRESULT Result code for this API operation.

Remarks

This API is available on Win32, Linux, and macOS. If this is the first time a user has signed in with the XBOX Live account and CreateAccount is set to true, a new PlayFab account will be created and linked to the XBOX Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the XBOX Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. See also ClientLinkXboxAccountAsync, ClientUnlinkXboxAccountAsync. When the asynchronous task is complete, call PFAuthenticationLoginWithXboxGetResult to get the result.

Requirements

Header: PFAuthentication.h

See also

PFAuthentication members
Last modified on August 20, 2026