Heroic Labs · Schema

apiSession

A user's session used to authenticate messages.

Game BackendMultiplayerReal-TimeWebSocketMatchmakingLeaderboardsSocial GamingOpen SourceLiveOpsgRPC

Properties

Name	Type	Description
created	boolean	True if the corresponding account was just created, false otherwise.
token	string	Authentication credentials.
refreshToken	string	Refresh token that can be used for session token renewal.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/heroiclabs/json-schema/apiSession.json",
  "title": "apiSession",
  "type": "object",
  "properties": {
    "created": {
      "type": "boolean",
      "description": "True if the corresponding account was just created, false otherwise."
    },
    "token": {
      "type": "string",
      "description": "Authentication credentials."
    },
    "refreshToken": {
      "type": "string",
      "description": "Refresh token that can be used for session token renewal."
    }
  },
  "description": "A user's session used to authenticate messages."
}