PFAuthenticationGetEntityWithSecretKeyAsync
Method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token.
Syntax
HRESULT PFAuthenticationGetEntityWithSecretKeyAsync(
PFServiceConfigHandle serviceConfigHandle,
const char* secretKey,
const PFAuthenticationGetEntityRequest* request,
XAsyncBlock* async
)
Parameters
serviceConfigHandle PFServiceConfigHandle
PFServiceConfigHandle returned from PFServiceConfigCreateHandle call.
secretKey char*
In_z
Title Secret Key used to authenticate the service request.
request PFAuthenticationGetEntityRequest*
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. This API must be called with X-SecretKey, X-Authentication or X-EntityToken headers. An optional EntityKey may be included to attempt to set the resulting EntityToken to a specific entity, however the entity must be a relation of the caller, such as the master_player_account of a character. If sending X-EntityToken the account will be marked as freshly logged in and will issue a new token. If using X-Authentication or X-EntityToken the header must still be valid and cannot be expired or revoked. When the asynchronous task is complete, call PFAuthenticationGetEntityWithSecretKeyGetResult to get the result.
Requirements
Header: PFAuthentication.h