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 Windows, Linux, and macOS. This API must be called with X-SecretKey, X-Authentication or X-EntityToken headers. The header must still be valid and cannot be expired or revoked.If successful, it will issue a new entity token and emit the 'entity_logged_in' PlayStream event. When the asynchronous task is complete, call PFAuthenticationGetEntityWithSecretKeyGetResult to get the result.

Requirements

Header: PFAuthentication.h

See also

PFAuthentication members