Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

EndpointAuthentication

Type: object

EndpointAuthentication describes credential issuance without publishing a token. local sockets cannot advertise bearer credential transports scoped bearer discovery states the five-minute credential lifetime; local sockets carry no token lifetime
credentialTransports

Type: array

Omission retains Authorization-header clients; browsers require an explicit subprotocol offer.
Array item

Schema: EndpointCredentialTransport

All schema constraints and annotations
{
  "description": "Omission retains Authorization-header clients; browsers require an explicit subprotocol offer.",
  "items": {
    "$ref": "#/components/schemas/EndpointCredentialTransport"
  },
  "type": "array",
  "uniqueItems": true
}
defaultTtl

Schema: Duration

default_ttl and max_ttl describe CreateEndpointCredential's provider policy.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Duration",
  "description": "default_ttl and max_ttl describe CreateEndpointCredential's provider policy."
}
maxTtl

Schema: Duration

scheme · required

Schema: EndpointAuthenticationScheme

All schema constraints and annotations
{
  "$ref": "#/components/schemas/EndpointAuthenticationScheme",
  "not": {
    "enum": [
      "unspecified"
    ]
  }
}
All schema constraints and annotations
{
  "dependentSchemas": {
    "credentialTransports": {
      "allOf": [
        {
          "if": {
            "properties": {
              "scheme": {
                "const": "localSocket"
              }
            }
          },
          "then": {
            "properties": {
              "credentialTransports": {
                "maxItems": 0
              }
            }
          }
        }
      ]
    },
    "scheme": {
      "allOf": [
        {
          "oneOf": [
            {
              "properties": {
                "defaultTtl": {
                  "pattern": "^300([.]0{1,9})?s$"
                },
                "maxTtl": {
                  "pattern": "^300([.]0{1,9})?s$"
                },
                "scheme": {
                  "const": "scopedBearer"
                }
              },
              "required": [
                "defaultTtl",
                "maxTtl"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "defaultTtl"
                    ]
                  },
                  {
                    "required": [
                      "maxTtl"
                    ]
                  }
                ]
              },
              "properties": {
                "scheme": {
                  "const": "localSocket"
                }
              }
            }
          ]
        }
      ]
    }
  },
  "description": "EndpointAuthentication describes credential issuance without publishing a token.\nlocal sockets cannot advertise bearer credential transports\nscoped bearer discovery states the five-minute credential lifetime; local sockets carry no token lifetime",
  "properties": {
    "credentialTransports": {
      "description": "Omission retains Authorization-header clients; browsers require an explicit subprotocol offer.",
      "items": {
        "$ref": "#/components/schemas/EndpointCredentialTransport"
      },
      "type": "array",
      "uniqueItems": true
    },
    "defaultTtl": {
      "$ref": "#/components/schemas/Duration",
      "description": "default_ttl and max_ttl describe CreateEndpointCredential's provider policy."
    },
    "maxTtl": {
      "$ref": "#/components/schemas/Duration"
    },
    "scheme": {
      "$ref": "#/components/schemas/EndpointAuthenticationScheme",
      "not": {
        "enum": [
          "unspecified"
        ]
      }
    }
  },
  "required": [
    "scheme"
  ],
  "title": "EndpointAuthentication",
  "type": "object"
}