Skip to content

BrowserAuthSession ​

Type: object additionalProperties: false

FieldRequiredTypeDescription and constraints
modeYesstringenum: ["api_only","saml","anonymous"]
authenticatedYesboolean
read_accessYesboolean
userYesobject / nulladditionalProperties: false
expires_atYesstring / nullformat: "date-time"

JSON Schema ​

json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "mode",
    "authenticated",
    "read_access",
    "user",
    "expires_at"
  ],
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "api_only",
        "saml",
        "anonymous"
      ]
    },
    "authenticated": {
      "type": "boolean"
    },
    "read_access": {
      "type": "boolean"
    },
    "user": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "display_name"
      ],
      "properties": {
        "display_name": {
          "type": "string"
        }
      }
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

All schemas · HTTP API