console.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Nakama console API v2",
    "version": "2.0",
    "contact": {
      "name": "The Nakama Authors \u0026 Contributors",
      "url": "https://github.com/heroiclabs/nakama",
      "email": "hello@heroiclabs.com"
    }
  },
  "tags": [
    {
      "name": "Console"
    }
  ],
  "host": "127.0.0.1:7351",
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/v2/console/account": {
      "get": {
        "summary": "List (and optionally filter) accounts.",
        "operationId": "Console_ListAccounts",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleAccountList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "description": "User ID or username filter.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "tombstones",
            "description": "Search only recorded deletes.",
            "in": "query",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "cursor",
            "description": "Cursor to start from",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "delete": {
        "summary": "Delete (non-recorded) all user accounts.",
        "operationId": "Console_DeleteAccounts",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{account_id}/wallet": {
      "get": {
        "summary": "Get a list of the user's wallet transactions.",
        "operationId": "Console_GetWalletLedger",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleWalletLedgerList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "account_id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "limit",
            "description": "Max number of results per page",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "cursor",
            "description": "Cursor to retrieve a page of records from",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}": {
      "get": {
        "summary": "Get detailed account information for a single user.",
        "operationId": "Console_GetAccount",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/nakamaconsoleAccount"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "delete": {
        "summary": "Delete all information stored for a user account.",
        "operationId": "Console_DeleteAccount",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "record_deletion",
            "description": "Record the user deletion - used for GDPR compliance.",
            "in": "query",
            "required": false,
            "type": "boolean"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "post": {
        "summary": "Update one or more fields on a user account.",
        "operationId": "Console_UpdateAccount",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "User ID to update.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "username": {
                  "type": "string",
                  "description": "Username."
                },
                "display_name": {
                  "type": "string",
                  "description": "Display name."
                },
                "metadata": {
                  "type": "string",
                  "description": "Metadata."
                },
                "avatar_url": {
                  "type": "string",
                  "description": "Avatar URL."
                },
                "lang_tag": {
                  "type": "string",
                  "description": "Langtag."
                },
                "location": {
                  "type": "string",
                  "description": "Location."
                },
                "timezone": {
                  "type": "string",
                  "description": "Timezone."
                },
                "custom_id": {
                  "type": "string",
                  "description": "Custom ID."
                },
                "email": {
                  "type": "string",
                  "description": "Email."
                },
                "password": {
                  "type": "string",
                  "description": "Password."
                },
                "device_ids": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  },
                  "description": "Device ID modifications."
                },
                "wallet": {
                  "type": "string",
                  "description": "Wallet."
                }
              },
              "description": "Update user account information."
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/ban": {
      "post": {
        "summary": "Ban a user.",
        "operationId": "Console_BanAccount",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/export": {
      "get": {
        "summary": "Export all information stored about a user account.",
        "operationId": "Console_ExportAccount",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleAccountExport"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/friend": {
      "get": {
        "summary": "Get a user's list of friend relationships.",
        "operationId": "Console_GetFriends",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiFriendList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/friend/{friend_id}": {
      "delete": {
        "summary": "Delete the friend relationship between two users.",
        "operationId": "Console_DeleteFriend",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The user do delete for.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "friend_id",
            "description": "User ID of the friend to remove.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/group": {
      "get": {
        "summary": "Get a list of groups the user is a member of.",
        "operationId": "Console_GetGroups",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiUserGroupList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/group/{group_id}": {
      "delete": {
        "summary": "Remove a user from a group.",
        "operationId": "Console_DeleteGroupUser",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "User to remove.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "group_id",
            "description": "ID of the group to remove them from.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unban": {
      "post": {
        "summary": "Unban a user.",
        "operationId": "Console_UnbanAccount",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/apple": {
      "post": {
        "summary": "Unlink the Apple ID from a user account.",
        "operationId": "Console_UnlinkApple",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/custom": {
      "post": {
        "summary": "Unlink the custom ID from a user account.",
        "operationId": "Console_UnlinkCustom",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/device": {
      "post": {
        "summary": "Unlink the device ID from a user account.",
        "operationId": "Console_UnlinkDevice",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "User ID to unlink from.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "device_id": {
                  "type": "string",
                  "description": "Device ID to unlink."
                }
              },
              "description": "Unlink a particular device ID from a user's account."
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/email": {
      "post": {
        "summary": "Unlink the email from a user account.",
        "operationId": "Console_UnlinkEmail",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/facebook": {
      "post": {
        "summary": "Unlink the Facebook ID from a user account.",
        "operationId": "Console_UnlinkFacebook",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/facebookinstantgame": {
      "post": {
        "summary": "Unlink the Facebook Instant Game ID from a user account.",
        "operationId": "Console_UnlinkFacebookInstantGame",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/gamecenter": {
      "post": {
        "summary": "Unlink the Game Center ID from a user account.",
        "operationId": "Console_UnlinkGameCenter",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/google": {
      "post": {
        "summary": "Unlink the Google ID from a user account.",
        "operationId": "Console_UnlinkGoogle",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/unlink/steam": {
      "post": {
        "summary": "Unlink the Steam ID from a user account.",
        "operationId": "Console_UnlinkSteam",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the user account.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/account/{id}/wallet/{wallet_id}": {
      "delete": {
        "summary": "Delete a wallet ledger item.",
        "operationId": "Console_DeleteWalletLedger",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "User ID to remove wallet ledger item from.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "wallet_id",
            "description": "ID of the wallet ledger item to remove.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/all": {
      "delete": {
        "summary": "Deletes all data",
        "operationId": "Console_DeleteAllData",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/api/endpoints": {
      "get": {
        "summary": "API Explorer - list all endpoints",
        "operationId": "Console_ListApiEndpoints",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleApiEndpointList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/api/endpoints/rpc/{method}": {
      "post": {
        "summary": "API Explorer - call a custom RPC endpoint",
        "operationId": "Console_CallRpcEndpoint",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleCallApiEndpointResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "method",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "body": {
                  "type": "string"
                },
                "user_id": {
                  "type": "string"
                }
              },
              "title": "API Explorer request definition for CallApiEndpoint"
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/api/endpoints/{method}": {
      "post": {
        "summary": "API Explorer - call an endpoint",
        "operationId": "Console_CallApiEndpoint",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleCallApiEndpointResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "method",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "body": {
                  "type": "string"
                },
                "user_id": {
                  "type": "string"
                }
              },
              "title": "API Explorer request definition for CallApiEndpoint"
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/authenticate": {
      "post": {
        "summary": "Authenticate a console user with username and password.",
        "operationId": "Console_Authenticate",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleConsoleSession"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "description": "Authenticate a console user with username and password.",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/consoleAuthenticateRequest"
            }
          }
        ],
        "tags": [
          "Console"
        ],
        "security": [
          {
            "": []
          }
        ]
      }
    },
    "/v2/console/authenticate/logout": {
      "post": {
        "summary": "Log out a session and invalidate the session token.",
        "operationId": "Console_AuthenticateLogout",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "description": "Log out a session and invalidate a session token.",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/consoleAuthenticateLogoutRequest"
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/channel": {
      "get": {
        "summary": "List channel messages with the selected filter",
        "operationId": "Console_ListChannelMessages",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiChannelMessageList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "type",
            "description": "Type of the chat channel",
            "in": "query",
            "required": false,
            "type": "string",
            "enum": [
              "UNKNOWN",
              "ROOM",
              "GROUP",
              "DIRECT"
            ],
            "default": "UNKNOWN"
          },
          {
            "name": "label",
            "description": "Label of the channel, if a standard chat room",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "group_id",
            "description": "Group ID of the channel, if a group chat",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "user_id_one",
            "description": "User IDs, if a direct chat",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "user_id_two",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "cursor",
            "description": "Cursor to start from",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/config": {
      "get": {
        "summary": "Get server config and configuration warnings.",
        "operationId": "Console_GetConfig",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleConfig"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/group": {
      "get": {
        "summary": "List (and optionally filter) groups.",
        "operationId": "Console_ListGroups",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/nakamaconsoleGroupList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "filter",
            "description": "User ID or username filter.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "cursor",
            "description": "Cursor to start from",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/group/{group_id}/account/{id}/demote": {
      "post": {
        "summary": "Demote a user from a group.",
        "operationId": "Console_DemoteGroupMember",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "group_id",
            "description": "ID of the group.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "id",
            "description": "User to change state.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/group/{group_id}/account/{id}/promote": {
      "post": {
        "summary": "Promote a user from a group.",
        "operationId": "Console_PromoteGroupMember",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "group_id",
            "description": "ID of the group.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "id",
            "description": "User to change state.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/group/{group_id}/add": {
      "post": {
        "summary": "Add/join members to a group.",
        "operationId": "Console_AddGroupUsers",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "group_id",
            "description": "ID of the group to add them to.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "ids": {
                  "type": "string",
                  "description": "Users to add/join."
                },
                "join_request": {
                  "type": "boolean",
                  "description": "Whether it is a join request."
                }
              },
              "description": "Add/join users to a group."
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/group/{id}": {
      "get": {
        "summary": "Get detailed group information.",
        "operationId": "Console_GetGroup",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiGroup"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the group.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "delete": {
        "summary": "Remove a group.",
        "operationId": "Console_DeleteGroup",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "ID of the group to delete.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "post": {
        "summary": "Update one or more fields on a group.",
        "operationId": "Console_UpdateGroup",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "Group ID to update.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name."
                },
                "description": {
                  "type": "string",
                  "description": "Description."
                },
                "lang_tag": {
                  "type": "string",
                  "description": "Langtag."
                },
                "metadata": {
                  "type": "string",
                  "description": "Metadata."
                },
                "avatar_url": {
                  "type": "string",
                  "description": "Avatar URL."
                },
                "open": {
                  "type": "boolean",
                  "description": "Anyone can join open groups, otherwise only admins can accept members."
                },
                "max_count": {
                  "type": "integer",
                  "format": "int32",
                  "description": "The maximum number of members allowed."
                }
              },
              "description": "Update group information."
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/group/{id}/export": {
      "get": {
        "summary": "Export all information stored about a group.",
        "operationId": "Console_ExportGroup",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleGroupExport"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the group.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/group/{id}/member": {
      "get": {
        "summary": "Get a list of members of the group.",
        "operationId": "Console_GetMembers",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiGroupUserList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "The unique identifier of the group.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/leaderboard": {
      "get": {
        "summary": "List leaderboards",
        "operationId": "Console_ListLeaderboards",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/nakamaconsoleLeaderboardList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/leaderboard/{id}": {
      "get": {
        "summary": "Get leaderboard.",
        "operationId": "Console_GetLeaderboard",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/nakamaconsoleLeaderboard"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "Leaderboard ID",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "delete": {
        "summary": "Delete leaderboard",
        "operationId": "Console_DeleteLeaderboard",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "Leaderboard ID",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/leaderboard/{id}/owner/{owner_id}": {
      "delete": {
        "summary": "Delete leaderboard record",
        "operationId": "Console_DeleteLeaderboardRecord",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "Leaderboard ID.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "owner_id",
            "description": "Record owner.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/leaderboard/{leaderboard_id}/records": {
      "get": {
        "summary": "List leaderboard records.",
        "operationId": "Console_ListLeaderboardRecords",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiLeaderboardRecordList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "leaderboard_id",
            "description": "The ID of the leaderboard to list for.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "owner_ids",
            "description": "One or more owners to retrieve records for.",
            "in": "query",
            "required": false,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          },
          {
            "name": "limit",
            "description": "Max number of records to return. Between 1 and 100.",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "cursor",
            "description": "A next or previous page cursor.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "expiry",
            "description": "Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "int64"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/match": {
      "get": {
        "summary": "List ongoing matches",
        "operationId": "Console_ListMatches",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/nakamaconsoleMatchList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "limit",
            "description": "Limit the number of returned matches.",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "authoritative",
            "description": "Authoritative or relayed matches, or null for both.",
            "in": "query",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "label",
            "description": "Label filter.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "min_size",
            "description": "Minimum user count.",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "max_size",
            "description": "Maximum user count.",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "name": "match_id",
            "description": "Match ID.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "query",
            "description": "Arbitrary label query.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "node",
            "description": "Node name filter, optional.",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/match/{id}/state": {
      "get": {
        "summary": "Get current state of a running match",
        "operationId": "Console_GetMatchState",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleMatchState"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "description": "Match ID",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/message": {
      "delete": {
        "summary": "Delete messages.",
        "operationId": "Console_DeleteChannelMessages",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleDeleteChannelMessagesResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "before",
            "description": "Timestamp before which messages will be deleted.",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time"
          },
          {
            "name": "ids",
            "description": "IDs of the messages to delete.",
            "in": "query",
            "required": false,
            "type": "array",
            "items": {
              "type": "string"
            },
            "collectionFormat": "multi"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/purchase": {
      "get": {
        "summary": "List validated purchases",
        "operationId": "Console_ListPurchases",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiPurchaseList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "user_id",
            "description": "User ID to filter purchases for",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "description": "Max number of results per page",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "cursor",
            "description": "Cursor to retrieve a page of records from",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/runtime": {
      "get": {
        "summary": "Get runtime info",
        "operationId": "Console_GetRuntime",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleRuntimeInfo"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/status": {
      "get": {
        "summary": "Get current status data for all nodes.",
        "operationId": "Console_GetStatus",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleStatusList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/storage": {
      "get": {
        "summary": "List (and optionally filter) storage data.",
        "operationId": "Console_ListStorage",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleStorageList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "user_id",
            "description": "User ID to filter objects for.",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "key",
            "description": "Key to filter objects for",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "collection",
            "description": "Collection name to filter objects for",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "cursor",
            "description": "Cursor to retrieve a page of records from",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "delete": {
        "summary": "Delete all storage data.",
        "operationId": "Console_DeleteStorage",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/storage/collections": {
      "get": {
        "summary": "List storage collections",
        "operationId": "Console_ListStorageCollections",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleStorageCollectionsList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/storage/{collection}/{key}/{user_id}": {
      "get": {
        "summary": "Get a storage object.",
        "operationId": "Console_GetStorage",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiStorageObject"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "collection",
            "description": "The collection which stores the object.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "key",
            "description": "The key of the object within the collection.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "user_id",
            "description": "The user owner of the object.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "delete": {
        "summary": "Delete a storage object.",
        "operationId": "Console_DeleteStorageObject",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "collection",
            "description": "Collection.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "key",
            "description": "Key.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "user_id",
            "description": "Owner user ID.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "version",
            "description": "Version for OCC.",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "put": {
        "summary": "Write a new storage object or replace an existing one.",
        "operationId": "Console_WriteStorageObject",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiStorageObjectAck"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "collection",
            "description": "Collection.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "key",
            "description": "Key.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "user_id",
            "description": "Owner user ID.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string",
                  "description": "Value."
                },
                "version": {
                  "type": "string",
                  "description": "Version for OCC."
                },
                "permission_read": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Read permission value."
                },
                "permission_write": {
                  "type": "integer",
                  "format": "int32",
                  "description": "Write permission value."
                }
              },
              "description": "Write a new storage object or update an existing one."
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/storage/{collection}/{key}/{user_id}/{version}": {
      "delete": {
        "summary": "Delete a storage object.",
        "operationId": "Console_DeleteStorageObject2",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "collection",
            "description": "Collection.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "key",
            "description": "Key.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "user_id",
            "description": "Owner user ID.",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "version",
            "description": "Version for OCC.",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/subscription": {
      "get": {
        "summary": "List validated subscriptions",
        "operationId": "Console_ListSubscriptions",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/apiSubscriptionList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "user_id",
            "description": "UserID to filter subscriptions for",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "description": "Max number of results per page",
            "in": "query",
            "required": false,
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "cursor",
            "description": "Cursor to retrieve a page of records from",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      }
    },
    "/v2/console/user": {
      "get": {
        "summary": "List (and optionally filter) users.",
        "operationId": "Console_ListUsers",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/consoleUserList"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "tags": [
          "Console"
        ]
      },
      "delete": {
        "summary": "Delete console user.",
        "operationId": "Console_DeleteUser",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "username",
            "description": "The unique username of the user account.",
            "in": "query",
            "required": false,
            "type": "string"
          }
        ],
        "tags": [
          "Console"
        ]
      },
      "post": {
        "summary": "Add a new console user.",
        "operationId": "Console_AddUser",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "type": "object",
              "properties": {}
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/googlerpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/consoleAddUserRequest"
            }
          }
        ],
        "tags": [
          "Console"
        ]
      }
    }
  },
  "definitions": {
    "ConfigWarning": {
      "type": "object",
      "properties": {
        "field": {
          "type": "string",
          "description": "The config field this warning is for in a JSON pointer format."
        },
        "message": {
          "type": "string",
          "description": "Warning message text."
        }
      },
      "description": "A warning for a configuration field."
    },
    "GroupUserListGroupUser": {
      "type": "object",
      "properties": {
        "user": {
          "$ref": "#/definitions/nakamaapiUser",
          "description": "User."
        },
        "state": {
          "type": "integer",
          "format": "int32",
          "description": "Their relationship to the group."
        }
      },
      "description": "A single user-role pair."
    },
    "RuntimeInfoModuleInfo": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string",
          "title": "Module path"
        },
        "mod_time": {
          "type": "string",
          "format": "date-time",
          "title": "Module last modified date"
        }
      },
      "title": "Module information"
    },
    "UserGroupListUserGroup": {
      "type": "object",
      "properties": {
        "group": {
          "$ref": "#/definitions/apiGroup",
          "description": "Group."
        },
        "state": {
          "type": "integer",
          "format": "int32",
          "description": "The user's relationship to the group."
        }
      },
      "description": "A single group-role pair."
    },
    "apiAccountDevice": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "A device identifier. Should be obtained by a platform-specific device API."
        },
        "vars": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Extra information that will be bundled in the session token."
        }
      },
      "description": "Send a device to the server. Used with authenticate/link/unlink and user."
    },
    "apiChannelMessage": {
      "type": "object",
      "properties": {
        "channel_id": {
          "type": "string",
          "description": "The channel this message belongs to."
        },
        "message_id": {
          "type": "string",
          "description": "The unique ID of this message."
        },
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "The code representing a message type or category."
        },
        "sender_id": {
          "type": "string",
          "description": "Message sender, usually a user ID."
        },
        "username": {
          "type": "string",
          "description": "The username of the message sender, if any."
        },
        "content": {
          "type": "string",
          "description": "The content payload."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the message was created."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the message was last updated."
        },
        "persistent": {
          "type": "boolean",
          "description": "True if the message was persisted to the channel's history, false otherwise."
        },
        "room_name": {
          "type": "string",
          "description": "The name of the chat room, or an empty string if this message was not sent through a chat room."
        },
        "group_id": {
          "type": "string",
          "description": "The ID of the group, or an empty string if this message was not sent through a group channel."
        },
        "user_id_one": {
          "type": "string",
          "description": "The ID of the first DM user, or an empty string if this message was not sent through a DM chat."
        },
        "user_id_two": {
          "type": "string",
          "description": "The ID of the second DM user, or an empty string if this message was not sent through a DM chat."
        }
      },
      "description": "A message sent on a channel."
    },
    "apiChannelMessageList": {
      "type": "object",
      "properties": {
        "messages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiChannelMessage"
          },
          "description": "A list of messages."
        },
        "next_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the next page, if any."
        },
        "prev_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the previous page, if any."
        },
        "cacheable_cursor": {
          "type": "string",
          "description": "Cacheable cursor to list newer messages. Durable and designed to be stored, unlike next/prev cursors."
        }
      },
      "description": "A list of channel messages, usually a result of a list operation."
    },
    "apiFriend": {
      "type": "object",
      "properties": {
        "user": {
          "$ref": "#/definitions/nakamaapiUser",
          "description": "The user object."
        },
        "state": {
          "type": "integer",
          "format": "int32",
          "description": "The friend status."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "Time of the latest relationship update."
        }
      },
      "description": "A friend of a user."
    },
    "apiFriendList": {
      "type": "object",
      "properties": {
        "friends": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiFriend"
          },
          "description": "The Friend objects."
        },
        "cursor": {
          "type": "string",
          "description": "Cursor for the next page of results, if any."
        }
      },
      "description": "A collection of zero or more friends of the user."
    },
    "apiGroup": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id of a group."
        },
        "creator_id": {
          "type": "string",
          "description": "The id of the user who created the group."
        },
        "name": {
          "type": "string",
          "description": "The unique name of the group."
        },
        "description": {
          "type": "string",
          "description": "A description for the group."
        },
        "lang_tag": {
          "type": "string",
          "description": "The language expected to be a tag which follows the BCP-47 spec."
        },
        "metadata": {
          "type": "string",
          "description": "Additional information stored as a JSON object."
        },
        "avatar_url": {
          "type": "string",
          "description": "A URL for an avatar image."
        },
        "open": {
          "type": "boolean",
          "description": "Anyone can join open groups, otherwise only admins can accept members."
        },
        "edge_count": {
          "type": "integer",
          "format": "int32",
          "description": "The current count of all members in the group."
        },
        "max_count": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum number of members allowed."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the group was created."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the group was last updated."
        }
      },
      "description": "A group in the server."
    },
    "apiGroupUserList": {
      "type": "object",
      "properties": {
        "group_users": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GroupUserListGroupUser"
          },
          "description": "User-role pairs for a group."
        },
        "cursor": {
          "type": "string",
          "description": "Cursor for the next page of results, if any."
        }
      },
      "description": "A list of users belonging to a group, along with their role."
    },
    "apiLeaderboardRecord": {
      "type": "object",
      "properties": {
        "leaderboard_id": {
          "type": "string",
          "description": "The ID of the leaderboard this score belongs to."
        },
        "owner_id": {
          "type": "string",
          "description": "The ID of the score owner, usually a user or group."
        },
        "username": {
          "type": "string",
          "description": "The username of the score owner, if the owner is a user."
        },
        "score": {
          "type": "string",
          "format": "int64",
          "description": "The score value."
        },
        "subscore": {
          "type": "string",
          "format": "int64",
          "description": "An optional subscore value."
        },
        "num_score": {
          "type": "integer",
          "format": "int32",
          "description": "The number of submissions to this score record."
        },
        "metadata": {
          "type": "string",
          "description": "Metadata."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the leaderboard record was created."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the leaderboard record was updated."
        },
        "expiry_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the leaderboard record expires."
        },
        "rank": {
          "type": "string",
          "format": "int64",
          "description": "The rank of this record."
        },
        "max_num_score": {
          "type": "integer",
          "format": "int64",
          "description": "The maximum number of score updates allowed by the owner."
        }
      },
      "description": "Represents a complete leaderboard record with all scores and associated metadata."
    },
    "apiLeaderboardRecordList": {
      "type": "object",
      "properties": {
        "records": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiLeaderboardRecord"
          },
          "description": "A list of leaderboard records."
        },
        "owner_records": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiLeaderboardRecord"
          },
          "description": "A batched set of leaderboard records belonging to specified owners."
        },
        "next_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the next page, if any."
        },
        "prev_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the previous page, if any."
        }
      },
      "description": "A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records."
    },
    "apiNotification": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the Notification."
        },
        "subject": {
          "type": "string",
          "description": "Subject of the notification."
        },
        "content": {
          "type": "string",
          "description": "Content of the notification in JSON."
        },
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "Category code for this notification."
        },
        "sender_id": {
          "type": "string",
          "description": "ID of the sender, if a user. Otherwise 'null'."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the notification was created."
        },
        "persistent": {
          "type": "boolean",
          "description": "True if this notification was persisted to the database."
        }
      },
      "description": "A notification in the server."
    },
    "apiPurchaseList": {
      "type": "object",
      "properties": {
        "validated_purchases": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiValidatedPurchase"
          },
          "description": "Stored validated purchases."
        },
        "cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the next page, if any."
        },
        "prev_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the previous page, if any."
        }
      },
      "description": "A list of validated purchases stored by Nakama."
    },
    "apiStorageObject": {
      "type": "object",
      "properties": {
        "collection": {
          "type": "string",
          "description": "The collection which stores the object."
        },
        "key": {
          "type": "string",
          "description": "The key of the object within the collection."
        },
        "user_id": {
          "type": "string",
          "description": "The user owner of the object."
        },
        "value": {
          "type": "string",
          "description": "The value of the object."
        },
        "version": {
          "type": "string",
          "description": "The version hash of the object."
        },
        "permission_read": {
          "type": "integer",
          "format": "int32",
          "description": "The read access permissions for the object."
        },
        "permission_write": {
          "type": "integer",
          "format": "int32",
          "description": "The write access permissions for the object."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the object was created."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the object was last updated."
        }
      },
      "description": "An object within the storage engine."
    },
    "apiStorageObjectAck": {
      "type": "object",
      "properties": {
        "collection": {
          "type": "string",
          "description": "The collection which stores the object."
        },
        "key": {
          "type": "string",
          "description": "The key of the object within the collection."
        },
        "version": {
          "type": "string",
          "description": "The version hash of the object."
        },
        "user_id": {
          "type": "string",
          "description": "The owner of the object."
        }
      },
      "description": "A storage acknowledgement."
    },
    "apiStoreEnvironment": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "SANDBOX",
        "PRODUCTION"
      ],
      "default": "UNKNOWN",
      "description": "- UNKNOWN: Unknown environment.\n - SANDBOX: Sandbox/test environment.\n - PRODUCTION: Production environment.",
      "title": "Environment where a purchase/subscription took place,"
    },
    "apiStoreProvider": {
      "type": "string",
      "enum": [
        "APPLE_APP_STORE",
        "GOOGLE_PLAY_STORE",
        "HUAWEI_APP_GALLERY"
      ],
      "default": "APPLE_APP_STORE",
      "description": "- APPLE_APP_STORE: Apple App Store\n - GOOGLE_PLAY_STORE: Google Play Store\n - HUAWEI_APP_GALLERY: Huawei App Gallery",
      "title": "Validation Provider,"
    },
    "apiSubscriptionList": {
      "type": "object",
      "properties": {
        "validated_subscriptions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiValidatedSubscription"
          },
          "description": "Stored validated subscriptions."
        },
        "cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the next page, if any."
        },
        "prev_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the previous page, if any."
        }
      },
      "description": "A list of validated subscriptions stored by Nakama."
    },
    "apiUserGroupList": {
      "type": "object",
      "properties": {
        "user_groups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/UserGroupListUserGroup"
          },
          "description": "Group-role pairs for a user."
        },
        "cursor": {
          "type": "string",
          "description": "Cursor for the next page of results, if any."
        }
      },
      "description": "A list of groups belonging to a user, along with the user's role in each group."
    },
    "apiValidatedPurchase": {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "string",
          "description": "Purchase User ID."
        },
        "product_id": {
          "type": "string",
          "description": "Purchase Product ID."
        },
        "transaction_id": {
          "type": "string",
          "description": "Purchase Transaction ID."
        },
        "store": {
          "$ref": "#/definitions/apiStoreProvider",
          "title": "Store identifier"
        },
        "purchase_time": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the purchase was done."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the receipt validation was stored in DB."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp when the receipt validation was updated in DB."
        },
        "refund_time": {
          "type": "string",
          "format": "date-time",
          "title": "Timestamp when the purchase was refunded. Set to UNIX"
        },
        "provider_response": {
          "type": "string",
          "description": "Raw provider validation response."
        },
        "environment": {
          "$ref": "#/definitions/apiStoreEnvironment",
          "description": "Whether the purchase was done in production or sandbox environment."
        },
        "seen_before": {
          "type": "boolean",
          "description": "Whether the purchase had already been validated by Nakama before."
        }
      },
      "description": "Validated Purchase stored by Nakama."
    },
    "apiValidatedSubscription": {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "string",
          "description": "Subscription User ID."
        },
        "product_id": {
          "type": "string",
          "description": "Purchase Product ID."
        },
        "original_transaction_id": {
          "type": "string",
          "description": "Purchase Original transaction ID (we only keep track of the original subscription, not subsequent renewals)."
        },
        "store": {
          "$ref": "#/definitions/apiStoreProvider",
          "title": "Store identifier"
        },
        "purchase_time": {
          "type": "string",
          "format": "date-time",
          "description": "UNIX Timestamp when the purchase was done."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "UNIX Timestamp when the receipt validation was stored in DB."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "UNIX Timestamp when the receipt validation was updated in DB."
        },
        "environment": {
          "$ref": "#/definitions/apiStoreEnvironment",
          "description": "Whether the purchase was done in production or sandbox environment."
        },
        "expiry_time": {
          "type": "string",
          "format": "date-time",
          "description": "Subscription expiration time. The subscription can still be auto-renewed to extend the expiration time further."
        },
        "refund_time": {
          "type": "string",
          "format": "date-time",
          "description": "Subscription refund time. If this time is set, the subscription was refunded."
        },
        "provider_response": {
          "type": "string",
          "description": "Raw provider validation response body."
        },
        "provider_notification": {
          "type": "string",
          "description": "Raw provider notification body."
        },
        "active": {
          "type": "boolean",
          "description": "Whether the subscription is currently active or not."
        }
      }
    },
    "consoleAccountExport": {
      "type": "object",
      "properties": {
        "account": {
          "$ref": "#/definitions/nakamaapiAccount",
          "description": "The user's account details."
        },
        "objects": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiStorageObject"
          },
          "description": "The user's storage."
        },
        "friends": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiFriend"
          },
          "description": "The user's friends."
        },
        "groups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiGroup"
          },
          "description": "The user's groups."
        },
        "messages": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiChannelMessage"
          },
          "description": "The user's chat messages."
        },
        "leaderboard_records": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiLeaderboardRecord"
          },
          "description": "The user's leaderboard records."
        },
        "notifications": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiNotification"
          },
          "description": "The user's notifications."
        },
        "wallet_ledgers": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/consoleWalletLedger"
          },
          "description": "The user's wallet ledger items."
        }
      },
      "description": "An export of all information stored for a user account."
    },
    "consoleAccountList": {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/nakamaapiUser"
          },
          "description": "A list of users."
        },
        "total_count": {
          "type": "integer",
          "format": "int32",
          "description": "Approximate total number of users."
        },
        "next_cursor": {
          "type": "string",
          "description": "Next cursor."
        }
      },
      "description": "A list of users."
    },
    "consoleAddUserRequest": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "description": "The username of the user."
        },
        "password": {
          "type": "string",
          "description": "The password of the user."
        },
        "email": {
          "type": "string",
          "description": "Email address of the user."
        },
        "role": {
          "$ref": "#/definitions/consoleUserRole",
          "title": "Role of this user;"
        },
        "newsletter_subscription": {
          "type": "boolean",
          "title": "Subscribe to newsletters"
        }
      },
      "title": "Add a new console user"
    },
    "consoleApiEndpointDescriptor": {
      "type": "object",
      "properties": {
        "method": {
          "type": "string"
        },
        "body_template": {
          "type": "string"
        }
      },
      "title": "API Explorer List of Endpoints response message"
    },
    "consoleApiEndpointList": {
      "type": "object",
      "properties": {
        "endpoints": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/consoleApiEndpointDescriptor"
          }
        },
        "rpc_endpoints": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/consoleApiEndpointDescriptor"
          }
        }
      },
      "title": "API Explorer List of Endpoints"
    },
    "consoleAuthenticateLogoutRequest": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "description": "Session token to log out."
        }
      },
      "description": "Log out a session and invalidate a session token."
    },
    "consoleAuthenticateRequest": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "description": "The username of the user."
        },
        "password": {
          "type": "string",
          "description": "The password of the user."
        }
      },
      "description": "Authenticate a console user with username and password."
    },
    "consoleCallApiEndpointResponse": {
      "type": "object",
      "properties": {
        "body": {
          "type": "string"
        },
        "error_message": {
          "type": "string"
        }
      },
      "title": "API Explorer response definition for CallApiEndpoint"
    },
    "consoleConfig": {
      "type": "object",
      "properties": {
        "config": {
          "type": "string",
          "description": "JSON-encoded active server configuration."
        },
        "warnings": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ConfigWarning"
          },
          "description": "Any warnings about the current config."
        },
        "server_version": {
          "type": "string",
          "title": "Server version"
        }
      },
      "description": "The current server configuration and any associated warnings."
    },
    "consoleConsoleSession": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "description": "A session token (JWT) for the console user."
        }
      },
      "description": "A console user session."
    },
    "consoleDeleteChannelMessagesResponse": {
      "type": "object",
      "properties": {
        "total": {
          "type": "string",
          "format": "int64",
          "description": "Total number of messages deleted."
        }
      }
    },
    "consoleGroupExport": {
      "type": "object",
      "properties": {
        "group": {
          "$ref": "#/definitions/apiGroup",
          "description": "The group details."
        },
        "members": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/GroupUserListGroupUser"
          },
          "description": "The group's list of members."
        }
      },
      "description": "An export of all information stored for a group."
    },
    "consoleListChannelMessagesRequestType": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "ROOM",
        "GROUP",
        "DIRECT"
      ],
      "default": "UNKNOWN"
    },
    "consoleMatchListMatch": {
      "type": "object",
      "properties": {
        "api_match": {
          "$ref": "#/definitions/nakamaapiMatch",
          "title": "The API match"
        },
        "node": {
          "type": "string",
          "title": "The node name"
        }
      }
    },
    "consoleMatchState": {
      "type": "object",
      "properties": {
        "presences": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/realtimeUserPresence"
          },
          "description": "Presence list."
        },
        "tick": {
          "type": "string",
          "format": "int64",
          "description": "Current tick number."
        },
        "state": {
          "type": "string",
          "description": "State."
        }
      },
      "title": "Match state"
    },
    "consoleRuntimeInfo": {
      "type": "object",
      "properties": {
        "lua_rpc_functions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "title": "Lua registered RPC functions"
        },
        "go_rpc_functions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "title": "Go registered RPC functions"
        },
        "js_rpc_functions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "title": "JavaScript registered RPC functions"
        },
        "go_modules": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RuntimeInfoModuleInfo"
          },
          "title": "Go loaded modules"
        },
        "lua_modules": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RuntimeInfoModuleInfo"
          },
          "title": "Lua loaded modules"
        },
        "js_modules": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/RuntimeInfoModuleInfo"
          },
          "title": "JavaScript loaded modules"
        }
      },
      "title": "Runtime information"
    },
    "consoleStatusHealth": {
      "type": "string",
      "enum": [
        "STATUS_HEALTH_OK",
        "STATUS_HEALTH_ERROR",
        "STATUS_HEALTH_CONNECTING",
        "STATUS_HEALTH_DISCONNECTING"
      ],
      "default": "STATUS_HEALTH_OK"
    },
    "consoleStatusList": {
      "type": "object",
      "properties": {
        "nodes": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/consoleStatusListStatus"
          },
          "description": "List of nodes and their stats."
        },
        "timestamp": {
          "type": "string",
          "format": "date-time",
          "title": "Timestamp"
        }
      },
      "description": "List of nodes and their stats."
    },
    "consoleStatusListStatus": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Node name."
        },
        "health": {
          "$ref": "#/definitions/consoleStatusHealth",
          "description": "Health score."
        },
        "session_count": {
          "type": "integer",
          "format": "int32",
          "description": "Currently connected sessions."
        },
        "presence_count": {
          "type": "integer",
          "format": "int32",
          "description": "Currently registered live presences."
        },
        "match_count": {
          "type": "integer",
          "format": "int32",
          "description": "Current number of active authoritative matches."
        },
        "goroutine_count": {
          "type": "integer",
          "format": "int32",
          "description": "Current number of running goroutines."
        },
        "avg_latency_ms": {
          "type": "number",
          "format": "double",
          "description": "Average response latency in milliseconds."
        },
        "avg_rate_sec": {
          "type": "number",
          "format": "double",
          "description": "Average number of requests per second."
        },
        "avg_input_kbs": {
          "type": "number",
          "format": "double",
          "description": "Average input bandwidth usage."
        },
        "avg_output_kbs": {
          "type": "number",
          "format": "double",
          "description": "Average output bandwidth usage."
        }
      },
      "description": "The status of a Nakama node."
    },
    "consoleStorageCollectionsList": {
      "type": "object",
      "properties": {
        "collections": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "title": "Available collection names in the whole of the storage"
        }
      }
    },
    "consoleStorageList": {
      "type": "object",
      "properties": {
        "objects": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiStorageObject"
          },
          "description": "List of storage objects matching list/filter operation."
        },
        "total_count": {
          "type": "integer",
          "format": "int32",
          "description": "Approximate total number of storage objects."
        },
        "next_cursor": {
          "type": "string",
          "title": "Next page cursor if any"
        }
      },
      "description": "List of storage objects."
    },
    "consoleUserList": {
      "type": "object",
      "properties": {
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/consoleUserListUser"
          },
          "description": "A list of users."
        }
      },
      "description": "A list of console users."
    },
    "consoleUserListUser": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "title": "Username of the user"
        },
        "email": {
          "type": "string",
          "title": "Email of the user"
        },
        "role": {
          "$ref": "#/definitions/consoleUserRole",
          "title": "Role of the user;"
        }
      },
      "title": "A console user"
    },
    "consoleUserRole": {
      "type": "string",
      "enum": [
        "USER_ROLE_UNKNOWN",
        "USER_ROLE_ADMIN",
        "USER_ROLE_DEVELOPER",
        "USER_ROLE_MAINTAINER",
        "USER_ROLE_READONLY"
      ],
      "default": "USER_ROLE_UNKNOWN"
    },
    "consoleWalletLedger": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier of this wallet change."
        },
        "user_id": {
          "type": "string",
          "description": "The user ID this wallet ledger item belongs to."
        },
        "changeset": {
          "type": "string",
          "description": "The changeset."
        },
        "metadata": {
          "type": "string",
          "description": "Any associated metadata."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the wallet ledger item was created."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the wallet ledger item was updated."
        }
      },
      "description": "An individual update to a user's wallet."
    },
    "consoleWalletLedgerList": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/consoleWalletLedger"
          },
          "description": "A list of wallet ledger items."
        },
        "next_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the next older page, if any."
        },
        "prev_cursor": {
          "type": "string",
          "description": "The cursor to send when retrieving the previous page newer, if any."
        }
      },
      "description": "List of wallet ledger items for a particular user."
    },
    "googlerpcStatus": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/protobufAny"
          }
        }
      }
    },
    "nakamaapiAccount": {
      "type": "object",
      "properties": {
        "user": {
          "$ref": "#/definitions/nakamaapiUser",
          "description": "The user object."
        },
        "wallet": {
          "type": "string",
          "description": "The user's wallet data."
        },
        "email": {
          "type": "string",
          "description": "The email address of the user."
        },
        "devices": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiAccountDevice"
          },
          "description": "The devices which belong to the user's account."
        },
        "custom_id": {
          "type": "string",
          "description": "The custom id in the user's account."
        },
        "verify_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the user's email was verified."
        },
        "disable_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the user's account was disabled/banned."
        }
      },
      "description": "A user with additional account details. Always the current user."
    },
    "nakamaapiMatch": {
      "type": "object",
      "properties": {
        "match_id": {
          "type": "string",
          "description": "The ID of the match, can be used to join."
        },
        "authoritative": {
          "type": "boolean",
          "description": "True if it's an server-managed authoritative match, false otherwise."
        },
        "label": {
          "type": "string",
          "description": "Match label, if any."
        },
        "size": {
          "type": "integer",
          "format": "int32",
          "description": "Current number of users in the match."
        },
        "tick_rate": {
          "type": "integer",
          "format": "int32",
          "title": "Tick Rate"
        },
        "handler_name": {
          "type": "string",
          "title": "Handler name"
        }
      },
      "description": "Represents a realtime match."
    },
    "nakamaapiUser": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id of the user's account."
        },
        "username": {
          "type": "string",
          "description": "The username of the user's account."
        },
        "display_name": {
          "type": "string",
          "description": "The display name of the user."
        },
        "avatar_url": {
          "type": "string",
          "description": "A URL for an avatar image."
        },
        "lang_tag": {
          "type": "string",
          "description": "The language expected to be a tag which follows the BCP-47 spec."
        },
        "location": {
          "type": "string",
          "description": "The location set by the user."
        },
        "timezone": {
          "type": "string",
          "description": "The timezone set by the user."
        },
        "metadata": {
          "type": "string",
          "description": "Additional information stored as a JSON object."
        },
        "facebook_id": {
          "type": "string",
          "description": "The Facebook id in the user's account."
        },
        "google_id": {
          "type": "string",
          "description": "The Google id in the user's account."
        },
        "gamecenter_id": {
          "type": "string",
          "description": "The Apple Game Center in of the user's account."
        },
        "steam_id": {
          "type": "string",
          "description": "The Steam id in the user's account."
        },
        "online": {
          "type": "boolean",
          "description": "Indicates whether the user is currently online."
        },
        "edge_count": {
          "type": "integer",
          "format": "int32",
          "description": "Number of related edges to this user."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the user was created."
        },
        "update_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the user was last updated."
        },
        "facebook_instant_game_id": {
          "type": "string",
          "description": "The Facebook Instant Game ID in the user's account."
        },
        "apple_id": {
          "type": "string",
          "description": "The Apple Sign In ID in the user's account."
        }
      },
      "description": "A user in the server."
    },
    "nakamaconsoleAccount": {
      "type": "object",
      "properties": {
        "account": {
          "$ref": "#/definitions/nakamaapiAccount",
          "description": "The user's account details."
        },
        "disable_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the account was disabled."
        }
      },
      "description": "Account information."
    },
    "nakamaconsoleGroupList": {
      "type": "object",
      "properties": {
        "groups": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/apiGroup"
          },
          "description": "A list of groups."
        },
        "total_count": {
          "type": "integer",
          "format": "int32",
          "description": "Approximate total number of groups."
        },
        "next_cursor": {
          "type": "string",
          "description": "Next cursor."
        }
      },
      "title": "A list of groups"
    },
    "nakamaconsoleLeaderboard": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the leaderboard."
        },
        "title": {
          "type": "string",
          "description": "The title for the leaderboard."
        },
        "description": {
          "type": "string",
          "description": "The description of the leaderboard. May be blank."
        },
        "category": {
          "type": "integer",
          "format": "int64",
          "description": "The category of the leaderboard. e.g. \"vip\" could be category 1."
        },
        "sort_order": {
          "type": "integer",
          "format": "int64",
          "description": "ASC or DESC sort mode of scores in the leaderboard."
        },
        "size": {
          "type": "integer",
          "format": "int64",
          "description": "The current number of players in the leaderboard."
        },
        "max_size": {
          "type": "integer",
          "format": "int64",
          "description": "The maximum number of players for the leaderboard."
        },
        "max_num_score": {
          "type": "integer",
          "format": "int64",
          "description": "The maximum score updates allowed per player for the current leaderboard."
        },
        "operator": {
          "type": "integer",
          "format": "int64",
          "title": "The operator of the leaderboard"
        },
        "end_active": {
          "type": "integer",
          "format": "int64",
          "description": "The UNIX time when the leaderboard stops being active until next reset. A computed value."
        },
        "reset_schedule": {
          "type": "string",
          "description": "Reset cron expression."
        },
        "metadata": {
          "type": "string",
          "description": "Additional information stored as a JSON object."
        },
        "create_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the leaderboard was created."
        },
        "start_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the leaderboard will start."
        },
        "end_time": {
          "type": "string",
          "format": "date-time",
          "description": "The UNIX time when the leaderboard will be stopped."
        },
        "duration": {
          "type": "integer",
          "format": "int64",
          "description": "Duration of the tournament in seconds."
        },
        "start_active": {
          "type": "integer",
          "format": "int64",
          "description": "The UNIX time when the leaderboard start being active. A computed value."
        },
        "join_required": {
          "type": "boolean",
          "description": "Join required."
        },
        "authoritative": {
          "type": "boolean",
          "description": "Authoritative."
        },
        "tournament": {
          "type": "boolean",
          "description": "Tournament."
        }
      },
      "description": "A leaderboard."
    },
    "nakamaconsoleLeaderboardList": {
      "type": "object",
      "properties": {
        "leaderboards": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/nakamaconsoleLeaderboard"
          },
          "description": "The list of leaderboards returned."
        }
      },
      "description": "A list of leaderboards."
    },
    "nakamaconsoleMatchList": {
      "type": "object",
      "properties": {
        "matches": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/consoleMatchListMatch"
          }
        }
      },
      "description": "A list of realtime matches, with their node names."
    },
    "protobufAny": {
      "type": "object",
      "properties": {
        "@type": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "realtimeUserPresence": {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "string",
          "description": "The user this presence belongs to."
        },
        "session_id": {
          "type": "string",
          "description": "A unique session ID identifying the particular connection, because the user may have many."
        },
        "username": {
          "type": "string",
          "description": "The username for display purposes."
        },
        "persistence": {
          "type": "boolean",
          "description": "Whether this presence generates persistent data/messages, if applicable for the stream type."
        },
        "status": {
          "type": "string",
          "description": "A user-set status message for this stream, if applicable."
        }
      },
      "description": "A user session associated to a stream, usually through a list operation or a join/leave event."
    }
  },
  "securityDefinitions": {
    "BasicAuth": {
      "type": "basic"
    },
    "BearerJwt": {
      "type": ""
    }
  },
  "security": [
    {
      "BearerJwt": []
    }
  ],
  "externalDocs": {
    "description": "Nakama server console documentation",
    "url": "https://heroiclabs.com/docs"
  }
}