authentication

Documentation

Index

• type EntityKeyModel
• type EntityLineageModel
• type GetEntityTokenRequestModel
• type GetEntityTokenResponseModel
  • func GetEntityToken(settings *playfab.Settings, postData *GetEntityTokenRequestModel, ...) (*GetEntityTokenResponseModel, error)
  • func GetEntityTokenWithEntityToken(settings *playfab.Settings, postData *GetEntityTokenRequestModel, ...) (*GetEntityTokenResponseModel, error)
  • func GetEntityTokenWithSecretKey(settings *playfab.Settings, postData *GetEntityTokenRequestModel, ...) (*GetEntityTokenResponseModel, error)
  • func GetEntityTokenWithSessionTicket(settings *playfab.Settings, postData *GetEntityTokenRequestModel, ...) (*GetEntityTokenResponseModel, error)
• type ValidateEntityTokenRequestModel
• type ValidateEntityTokenResponseModel
  • func ValidateEntityToken(settings *playfab.Settings, postData *ValidateEntityTokenRequestModel, ...) (*ValidateEntityTokenResponseModel, error)

Types

type EntityKeyModel

type EntityKeyModel struct {
	// Id unique ID of the entity.
	Id string `json:"Id,omitempty"`
	// Type entity type. See https://api.playfab.com/docs/tutorials/entities/entitytypes
	Type string `json:"Type,omitempty"`
}

EntityKey combined entity type and ID structure which uniquely identifies a single entity.

type EntityLineageModel

type EntityLineageModel struct {
	// CharacterId the Character Id of the associated entity.
	CharacterId string `json:"CharacterId,omitempty"`
	// GroupId the Group Id of the associated entity.
	GroupId string `json:"GroupId,omitempty"`
	// MasterPlayerAccountId the Master Player Account Id of the associated entity.
	MasterPlayerAccountId string `json:"MasterPlayerAccountId,omitempty"`
	// NamespaceId the Namespace Id of the associated entity.
	NamespaceId string `json:"NamespaceId,omitempty"`
	// TitleId the Title Id of the associated entity.
	TitleId string `json:"TitleId,omitempty"`
	// TitlePlayerAccountId the Title Player Account Id of the associated entity.
	TitlePlayerAccountId string `json:"TitlePlayerAccountId,omitempty"`
}

EntityLineage

type GetEntityTokenRequestModel

type GetEntityTokenRequestModel struct {
	// Entity the entity to perform this action on.
	Entity EntityKeyModel `json:"Entity,omitempty"`
}

GetEntityTokenRequest 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.

type GetEntityTokenResponseModel

type GetEntityTokenResponseModel struct {
	// Entity the entity id and type.
	Entity EntityKeyModel `json:"Entity,omitempty"`
	// EntityToken the token used to set X-EntityToken for all entity based API calls.
	EntityToken string `json:"EntityToken,omitempty"`
	// TokenExpiration the time the token will expire, if it is an expiring token, in UTC.
	TokenExpiration time.Time `json:"TokenExpiration,omitempty"`
}

GetEntityTokenResponse

func GetEntityToken

func GetEntityToken(settings *playfab.Settings, postData *GetEntityTokenRequestModel, entityToken string, clientSessionTicket string, developerSecretKey string) (*GetEntityTokenResponseModel, error)

GetEntityToken method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token. https://api.playfab.com/Documentation/Authentication/method/GetEntityToken

func GetEntityTokenWithEntityToken

func GetEntityTokenWithEntityToken(settings *playfab.Settings, postData *GetEntityTokenRequestModel, entityToken string) (*GetEntityTokenResponseModel, error)

GetEntityToken method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token. https://api.playfab.com/Documentation/Authentication/method/GetEntityToken

func GetEntityTokenWithSecretKey

func GetEntityTokenWithSecretKey(settings *playfab.Settings, postData *GetEntityTokenRequestModel, developerSecretKey string) (*GetEntityTokenResponseModel, error)

GetEntityToken method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token. https://api.playfab.com/Documentation/Authentication/method/GetEntityToken

func GetEntityTokenWithSessionTicket

func GetEntityTokenWithSessionTicket(settings *playfab.Settings, postData *GetEntityTokenRequestModel, clientSessionTicket string) (*GetEntityTokenResponseModel, error)

GetEntityToken method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token. https://api.playfab.com/Documentation/Authentication/method/GetEntityToken

type ValidateEntityTokenRequestModel

type ValidateEntityTokenRequestModel struct {
	// EntityToken client EntityToken
	EntityToken string `json:"EntityToken,omitempty"`
}

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

type ValidateEntityTokenResponseModel

type ValidateEntityTokenResponseModel struct {
	// Entity the entity id and type.
	Entity EntityKeyModel `json:"Entity,omitempty"`
	// Lineage the lineage of this profile.
	Lineage EntityLineageModel `json:"Lineage,omitempty"`
}

ValidateEntityTokenResponse

func ValidateEntityToken

func ValidateEntityToken(settings *playfab.Settings, postData *ValidateEntityTokenRequestModel, entityToken string) (*ValidateEntityTokenResponseModel, error)

ValidateEntityToken method for a server to validate a client provided EntityToken. Only callable by the title entity. https://api.playfab.com/Documentation/Authentication/method/ValidateEntityToken