Authenticate
v1.0.0

Event represents when Game Function wish to authenticate a player.

Details

This event is triggered when a Game Function calls the https://fireball.readme.io/reference/authenticate endpoint

Consumer / Producer Diagram

Authenticate Schema (json)
{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "The players token"
    },
    "name": {
      "type": "string",
      "description": "The name of the message",
      "const": "authenticate"
    },
    "actionId": {
      "type": "string",
      "description": "The ID of the specific action"
    },
    "environment": {
      "type": "string",
      "description": "The environment used",
      "enum": ["development", "staging", "production"]
    },
    "operatorId": {
      "type": "string",
      "description": "The ID of the Operator",
      "format": "uuid"
    },
    "gameMode": {
      "type": "string",
      "description": "The game mode being played",
      "enum": ["money", "coins"]
    },
    "gameId": {
      "type": "string",
      "description": "The ID of the game",
      "format": "uuid"
    },
    "currency": {
      "type": "string",
      "description": "The ISO currency code"
    },
    "replayId": {
      "type": "string",
      "description": "The replayId used for history/replay feature"
    },
    "connectionId": {
      "type": "string",
      "description": "The websocket connectionId of the player"
    },
    "extra": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "A map/dictionary of string pairs containing custom information between launch, integrations etc"
    }
  },
  "required": ["token", "name", "actionId", "environment", "operatorId", "gameMode", "gameId", "currency", "connectionId"]
}

Model

1public class Authenticate
2{
3    public string Name { get; set; } = "authenticate";
4    public Dictionary<string, string> Extra { get; set; }
5    public string GameMode { get; set; }
6    public string Environment { get; set; }
7    public Guid OperatorId { get; set; }
8    public string ActionId { get; set; }
9    public Guid GameId { get; set; }
10    public string Currency { get; set; }
11    public string? ReplayId { get; set; }
12    public string Token { get; set; }
13    public string ConnectionId { get; set; }
14}
Last updated on 2023/11/14