authentication

Documentation

Index

• type AuthenticateCustomIdRequestModel
• type AuthenticateCustomIdResultModel
  • func AuthenticateGameServerWithCustomId(settings *playfab.Settings, postData *AuthenticateCustomIdRequestModel, ...) (*AuthenticateCustomIdResultModel, error)
• type DeleteRequestModel
• type EmptyResponseModel
  • func Delete(settings *playfab.Settings, postData *DeleteRequestModel, entityToken string) (*EmptyResponseModel, error)
• type EntityKeyModel
• type EntityLineageModel
• type EntityTokenResponseModel
• 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 IdentifiedDeviceType
• type LoginIdentityProvider
• type ValidateEntityTokenRequestModel
• type ValidateEntityTokenResponseModel
  • func ValidateEntityToken(settings *playfab.Settings, postData *ValidateEntityTokenRequestModel, ...) (*ValidateEntityTokenResponseModel, error)

Types

type AuthenticateCustomIdRequestModel

type AuthenticateCustomIdRequestModel struct {
	// CustomId the customId used to create and retrieve game_server entity tokens. This is unique at the title level. CustomId must be
	// between 32 and 100 characters.
	CustomId string `json:"CustomId,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
}

AuthenticateCustomIdRequest create or return a game_server entity token. Caller must be a title entity.

type AuthenticateCustomIdResultModel

type AuthenticateCustomIdResultModel struct {
	// EntityToken the token generated used to set X-EntityToken for game_server calls.
	EntityToken *EntityTokenResponseModel `json:"EntityToken,omitempty"`
	// NewlyCreated true if the account was newly created on this authentication.
	NewlyCreated bool `json:"NewlyCreated"`
}

AuthenticateCustomIdResult

func AuthenticateGameServerWithCustomId

func AuthenticateGameServerWithCustomId(settings *playfab.Settings, postData *AuthenticateCustomIdRequestModel, entityToken string) (*AuthenticateCustomIdResultModel, error)

AuthenticateGameServerWithCustomId create a game_server entity token and return a new or existing game_server entity. https://api.playfab.com/Documentation/Authentication/method/AuthenticateGameServerWithCustomId

type DeleteRequestModel

type DeleteRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// Entity the game_server entity to be removed.
	Entity *EntityKeyModel `json:"Entity,omitempty"`
}

DeleteRequest delete a game_server entity. The caller can be the game_server entity attempting to delete itself. Or a title entity attempting to delete game_server entities for this title.

type EmptyResponseModel

type EmptyResponseModel struct {
}

EmptyResponse

func Delete

func Delete(settings *playfab.Settings, postData *DeleteRequestModel, entityToken string) (*EmptyResponseModel, error)

Delete delete a game_server entity. https://api.playfab.com/Documentation/Authentication/method/Delete

type EntityKeyModel

type EntityKeyModel struct {
	// Id unique ID of the entity.
	Id string `json:"Id,omitempty"`
	// Type entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types
	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 EntityTokenResponseModel

type EntityTokenResponseModel 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"`
}

EntityTokenResponse

type GetEntityTokenRequestModel

type GetEntityTokenRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// Entity the optional entity to perform this action on. Defaults to the currently logged in entity.
	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 IdentifiedDeviceType

type IdentifiedDeviceType string

IdentifiedDeviceType

const (
	IdentifiedDeviceTypeUnknown  IdentifiedDeviceType = "Unknown"
	IdentifiedDeviceTypeXboxOne  IdentifiedDeviceType = "XboxOne"
	IdentifiedDeviceTypeScarlett IdentifiedDeviceType = "Scarlett"
)

type LoginIdentityProvider

type LoginIdentityProvider string

LoginIdentityProvider

const (
	LoginIdentityProviderUnknown               LoginIdentityProvider = "Unknown"
	LoginIdentityProviderPlayFab               LoginIdentityProvider = "PlayFab"
	LoginIdentityProviderCustom                LoginIdentityProvider = "Custom"
	LoginIdentityProviderGameCenter            LoginIdentityProvider = "GameCenter"
	LoginIdentityProviderGooglePlay            LoginIdentityProvider = "GooglePlay"
	LoginIdentityProviderSteam                 LoginIdentityProvider = "Steam"
	LoginIdentityProviderXBoxLive              LoginIdentityProvider = "XBoxLive"
	LoginIdentityProviderPSN                   LoginIdentityProvider = "PSN"
	LoginIdentityProviderKongregate            LoginIdentityProvider = "Kongregate"
	LoginIdentityProviderFacebook              LoginIdentityProvider = "Facebook"
	LoginIdentityProviderIOSDevice             LoginIdentityProvider = "IOSDevice"
	LoginIdentityProviderAndroidDevice         LoginIdentityProvider = "AndroidDevice"
	LoginIdentityProviderTwitch                LoginIdentityProvider = "Twitch"
	LoginIdentityProviderWindowsHello          LoginIdentityProvider = "WindowsHello"
	LoginIdentityProviderGameServer            LoginIdentityProvider = "GameServer"
	LoginIdentityProviderCustomServer          LoginIdentityProvider = "CustomServer"
	LoginIdentityProviderNintendoSwitch        LoginIdentityProvider = "NintendoSwitch"
	LoginIdentityProviderFacebookInstantGames  LoginIdentityProvider = "FacebookInstantGames"
	LoginIdentityProviderOpenIdConnect         LoginIdentityProvider = "OpenIdConnect"
	LoginIdentityProviderApple                 LoginIdentityProvider = "Apple"
	LoginIdentityProviderNintendoSwitchAccount LoginIdentityProvider = "NintendoSwitchAccount"
	LoginIdentityProviderGooglePlayGames       LoginIdentityProvider = "GooglePlayGames"
)

type ValidateEntityTokenRequestModel

type ValidateEntityTokenRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// EntityToken client EntityToken
	EntityToken string `json:"EntityToken,omitempty"`
}

ValidateEntityTokenRequest given an entity token, validates that it hasn't expired 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"`
	// IdentifiedDeviceType the authenticated device for this entity, for the given login
	IdentifiedDeviceType IdentifiedDeviceType `json:"IdentifiedDeviceType,omitempty"`
	// IdentityProvider the identity provider for this entity, for the given login
	IdentityProvider LoginIdentityProvider `json:"IdentityProvider,omitempty"`
	// IdentityProviderIssuedId the ID issued by the identity provider, e.g. a XUID on Xbox Live
	IdentityProviderIssuedId string `json:"IdentityProviderIssuedId,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