Skip to content

AuthSession ​

Type: object additionalProperties: false

FieldRequiredTypeDescription and constraints
modeYesstringenum: ["api_only","anonymous","saml"]
authenticatedYesboolean
read_accessYesboolean
write_accessYesbooleanCan create schedules and modify those available to this caller. SAML users without an email cannot write.
can_manage_allYesbooleanCan manage all schedules and assign or clear their owners. True for configured SAML admins, valid Bearer keys and anonymous mode.
userYesobject / nulladditionalProperties: false
expires_atYesstring / nullformat: "date-time"

JSON Schema ​

json
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "mode",
    "authenticated",
    "read_access",
    "write_access",
    "can_manage_all",
    "user",
    "expires_at"
  ],
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "api_only",
        "anonymous",
        "saml"
      ]
    },
    "authenticated": {
      "type": "boolean"
    },
    "read_access": {
      "type": "boolean"
    },
    "write_access": {
      "type": "boolean",
      "description": "Can create schedules and modify those available to this caller. SAML users without an email cannot write."
    },
    "can_manage_all": {
      "type": "boolean",
      "description": "Can manage all schedules and assign or clear their owners. True for configured SAML admins, valid Bearer keys and anonymous mode."
    },
    "user": {
      "type": "object",
      "nullable": true,
      "additionalProperties": false,
      "required": [
        "subject",
        "display_name",
        "email"
      ],
      "properties": {
        "subject": {
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "nullable": true,
          "description": "Normalized email from the SAML identity, or null when unavailable."
        }
      }
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  }
}

All schemas · HTTP API