API

/web_api/auth/me

/web_api/auth/me ​

This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.

Request ​

main-app://schemas/api_auth/me.request.json

GET|POST /web_api/auth/me body

NameTypeRequiredConstraint
*anyNoother fields allowed

Response ​

main-app://schemas/api_auth/me.response.json

GET|POST /web_api/auth/me success

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesno other fields
emptybooleanNo-

Other top-level fields are not allowed.

api_result ​

NameTypeRequiredConstraint
userobjectYesno other fields

api_result.user ​

NameTypeRequiredConstraint
idintegerYesminimum 1
emailstringYesminLength 1
first_namestringYes-
last_namestringYes-

Source schema ​

The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.

Request: main-app://schemas/api_auth/me.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_auth/me.request.json",
  "title": "GET|POST /web_api/auth/me body",
  "type": "object",
  "required": [],
  "additionalProperties": true,
  "properties": []
}
Response: main-app://schemas/api_auth/me.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_auth/me.response.json",
  "title": "GET|POST /web_api/auth/me success",
  "allOf": [
    { "$ref": "main-app://schemas/_shared/envelope-success.json" },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "type": "object",
          "required": ["user"],
          "additionalProperties": false,
          "properties": {
            "user": { "$ref": "main-app://schemas/_shared/auth-user.json" }
          }
        }
      }
    }
  ]
}
Fragment: main-app://schemas/_shared/envelope-success.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/envelope-success.json",
  "title": "Canonical success envelope",
  "type": "object",
  "required": ["api_code", "api_result"],
  "properties": {
    "api_code": { "const": 200 },
    "api_result": true,
    "empty": { "type": "boolean" }
  },
  "additionalProperties": false
}
Fragment: main-app://schemas/_shared/auth-user.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/auth-user.json",
  "title": "User object in /web_api/auth responses",
  "type": "object",
  "required": ["id", "email", "first_name", "last_name"],
  "additionalProperties": false,
  "properties": {
    "id": { "type": "integer", "minimum": 1 },
    "email": { "type": "string", "minLength": 1 },
    "first_name": { "type": "string" },
    "last_name": { "type": "string" }
  }
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?