Authentication - Validate Entity Token

Reference

Service:: Authentication

API Version:: 240412

Method for a server to validate a client provided EntityToken. Only callable by the title entity.

POST https://titleId.playfabapi.com/Authentication/ValidateEntityToken

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
EntityToken	True	string	Client EntityToken
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	ValidateEntityTokenResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
EntityLineage
IdentifiedDeviceType
LoginIdentityProvider
ValidateEntityTokenRequest	Given an entity token, validates that it hasn't expired or been revoked and will return details of the owner.
ValidateEntityTokenResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

EntityLineage

Name	Type	Description
CharacterId	string	The Character Id of the associated entity.
GroupId	string	The Group Id of the associated entity.
MasterPlayerAccountId	string	The Master Player Account Id of the associated entity.
NamespaceId	string	The Namespace Id of the associated entity.
TitleId	string	The Title Id of the associated entity.
TitlePlayerAccountId	string	The Title Player Account Id of the associated entity.

IdentifiedDeviceType

Name	Type	Description
Scarlett	string
Unknown	string
XboxOne	string

LoginIdentityProvider

Name	Type	Description
AndroidDevice	string
Apple	string
Custom	string
CustomServer	string
Facebook	string
FacebookInstantGames	string
GameCenter	string
GameServer	string
GooglePlay	string
GooglePlayGames	string
IOSDevice	string
Kongregate	string
NintendoSwitch	string
NintendoSwitchAccount	string
OpenIdConnect	string
PSN	string
PlayFab	string
Steam	string
Twitch	string
Unknown	string
WindowsHello	string
XBoxLive	string

ValidateEntityTokenRequest

Given an entity token, validates that it hasn't expired or been revoked and will return details of the owner.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EntityToken	string	Client EntityToken

ValidateEntityTokenResponse

Name	Type	Description
Entity	EntityKey	The entity id and type.
IdentifiedDeviceType	IdentifiedDeviceType	The authenticated device for this entity, for the given login
IdentityProvider	LoginIdentityProvider	The identity provider for this entity, for the given login
IdentityProviderIssuedId	string	The ID issued by the identity provider, e.g. a XUID on Xbox Live
Lineage	EntityLineage	The lineage of this profile.