AuthMe | neoserver docs

← All schemas

object

api_key_id string

auth_method string required

authenticated boolean required

capabilities object required

manage_global_cache boolean
manage_global_roles boolean
manage_roles boolean
manage_sessions boolean
manage_tile_matrix_sets boolean
manage_workspace boolean
manage_workspaces boolean
read_audit boolean
read_catalog_integrity boolean

console_access boolean required

display_name string

email string

global_role string

presented_claims object

claims object: Additional properties: values must match the following schema

one of

Must match exactly one schema

Schema 1

string

Schema 2

array of string
email string
iss string
sub string

principal string required

session object

expires_at string · date-time
idle_expires_at string · date-time

session_expires_at string · date-time

session_id string

session_idle_expires_at string · date-time

subject string

super_admin boolean required

workspaces array of AuthWorkspace ↗ required

OpenAPI schema definition

{
  "properties": {
    "api_key_id": {
      "type": "string"
    },
    "auth_method": {
      "type": "string"
    },
    "authenticated": {
      "type": "boolean"
    },
    "capabilities": {
      "properties": {
        "manage_global_cache": {
          "type": "boolean"
        },
        "manage_global_roles": {
          "type": "boolean"
        },
        "manage_roles": {
          "type": "boolean"
        },
        "manage_sessions": {
          "type": "boolean"
        },
        "manage_tile_matrix_sets": {
          "type": "boolean"
        },
        "manage_workspace": {
          "type": "boolean"
        },
        "manage_workspaces": {
          "type": "boolean"
        },
        "read_audit": {
          "type": "boolean"
        },
        "read_catalog_integrity": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "console_access": {
      "type": "boolean"
    },
    "display_name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "global_role": {
      "type": "string"
    },
    "presented_claims": {
      "properties": {
        "claims": {
          "additionalProperties": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "items": {
                  "type": "string"
                },
                "type": "array"
              }
            ]
          },
          "type": "object"
        },
        "email": {
          "type": "string"
        },
        "iss": {
          "type": "string"
        },
        "sub": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "principal": {
      "type": "string"
    },
    "session": {
      "properties": {
        "expires_at": {
          "format": "date-time",
          "type": "string"
        },
        "idle_expires_at": {
          "format": "date-time",
          "type": "string"
        }
      },
      "type": "object"
    },
    "session_expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "session_id": {
      "type": "string"
    },
    "session_idle_expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "super_admin": {
      "type": "boolean"
    },
    "workspaces": {
      "items": {
        "$ref": "#/components/schemas/AuthWorkspace"
      },
      "type": "array"
    }
  },
  "required": [
    "authenticated",
    "principal",
    "auth_method",
    "super_admin",
    "console_access",
    "workspaces",
    "capabilities"
  ],
  "type": "object"
}