Authentication provider entity id, if needed by the provider
Email
String
User's email
InvitationId
String
Id of the invitation record if user needed to register
PlayFabId
String
PlayFab ID for this user
StudioPermissions
[]
Array of studio permissions that were be granted to the user
TitlePermissions
Object
Dictionary of title id, title permissions that were granted to the user
Common Properties
All PlayStream events are formatted as JSON objects and share the following common properties:
Name
Type
Description
CustomTags
Object
Key-Value pair storage. Any provider of this event schema is allowed to send additional values in this property.
EntityId
String
The identifier for the entity (title, player, etc) to which this event applies.
EntityType
String
The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either 'player', 'character', or 'title'. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like 'com.mygame.guild') as PlayFab may begin to parse root entities at any time.
EventId
String
PlayFab-assigned unique identifier for this event.
EventName
String
The name of this event.
EventNamespace
String
The assigned namespacing for this event. For example: 'com.myprogram.ads'