bridge-node-server/node_server/swagger_api/api_responses.json

{
  "responses": {
    "GeneralError": {
      "description": "General error response format",
      "schema": {
        "$ref": "api_definitions.json#/definitions/ErrorInfo"
      }
    },
    "LoginSuccess": {
      "description": "Log in succeeded",
      "headers": {
        "set-cookie": {
          "description": "Sets the session cookie (secure, http only)",
          "type": "string"
        }
      },
      "schema": {
        "type": "object",
        "properties": {
          "X-XSRF-TOKEN": {
            "description": "New XSRF key for the session",
            "$ref": "api_definitions.json#/definitions/hex256"
          },
          "displayName": {
            "description": "The client's display name",
            "$ref":  "api_definitions.json#/definitions/alphaSpaceNullable"
          },
          "newEULA": {
            "description": "There is a new EULA version that the user will have to accept to continue.",
            "$ref": "api_definitions.json#/definitions/version"
          },
          "emailConfirmNeeded": {
            "description": "This client needs to confirm their email",
            "type": "boolean"
          },
          "isMerchant": {
            "description": "Does this client have merchant status enabled?",
            "type": "boolean"
          },
          "isVATRegistered": {
            "description": "Is this client a merchant with a VAT number?",
            "type": "boolean"
          },
          "featureFlags": {
            "description": "Special enabled features for this client",
            "$ref": "api_definitions.json#/definitions/featureFlags"
          }
        },
        "required": [ "X-XSRF-TOKEN" ]
      }
    },
    "RecoverySuccess": {
      "description": "Recovery process started",
      "headers": {
        "set-cookie": {
          "description": "Sets the session cookie (secure, http only)",
          "type": "string"
        }
      },
      "schema": {
        "type": "object",
        "properties": {
          "X-XSRF-TOKEN": {
            "description": "New XSRF key for the session",
            "$ref": "api_definitions.json#/definitions/hex256"
          }
        },
        "required": [
          "X-XSRF-TOKEN"
        ]
      }
    },
    "Await2FA": {
      "description": "Elevation request ok, but still need to wait for 2FA to complete",
      "headers": {
        "set-cookie": {
          "description": "Sets the session cookie (secure, http only)",
          "type": "string"
        }
      },
      "schema": {
        "type": "object",
        "properties": {
          "X-XSRF-TOKEN": {
            "description": "New XSRF key for the session",
            "$ref": "api_definitions.json#/definitions/hex256"
          }
        },
        "required": [ "X-XSRF-TOKEN" ]
      }
    },
    "LogoutSuccess": {
      "description": "Successful logout",
      "headers": {
        "set-cookie": {
          "description": "Sets the session cookie (secure, http only)",
          "type": "string"
        }
      }
    },
    "ElevationSuccess": {
      "description": "Elevation succeeded",
      "headers": {
        "set-cookie": {
          "description": "Sets the refreshed session cookie (secure, http only)",
          "type": "string"
        }
      },
      "schema": {
        "type": "object",
        "properties": {
          "X-XSRF-TOKEN": {
            "description": "New XSRF key for the elevated session",
            "$ref": "api_definitions.json#/definitions/hex256"
          }
        }
      }
    },
    "DemotionSuccess": {
      "description": "Session demoted back to normal level",
      "headers": {
        "set-cookie": {
          "description": "Sets the refreshed session cookie (secure, http only)",
          "type": "string"
        }
      },
      "schema": {
        "type": "object",
        "properties": {
          "X-XSRF-TOKEN": {
            "description": "New XSRF key for the demoted session",
            "$ref": "api_definitions.json#/definitions/hex256"
          }
        }
      }
    }
  }
}