waitingroom_cookie_attributes

Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.

APIs.ioEngineeringPlatform

Properties

Name Type Description
samesite string Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the se
secure string Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will no
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-waitingroom-cookie-attributes-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/waitingroom_cookie_attributes",
  "title": "waitingroom_cookie_attributes",
  "description": "Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.",
  "properties": {
    "samesite": {
      "default": "auto",
      "description": "Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`.",
      "enum": [
        "auto",
        "lax",
        "none",
        "strict"
      ],
      "example": "auto",
      "type": "string"
    },
    "secure": {
      "default": "auto",
      "description": "Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled.",
      "enum": [
        "auto",
        "always",
        "never"
      ],
      "example": "auto",
      "type": "string"
    }
  },
  "type": "object"
}