api-shield_auth_id_characteristic

Auth ID Characteristic

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
name	string	The name of the characteristic field, i.e., the header or cookie name.
type	string	The type of characteristic.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api-shield_auth_id_characteristic",
  "title": "api-shield_auth_id_characteristic",
  "description": "Auth ID Characteristic",
  "properties": {
    "name": {
      "description": "The name of the characteristic field, i.e., the header or cookie name.",
      "example": "authorization",
      "maxLength": 128,
      "type": "string"
    },
    "type": {
      "description": "The type of characteristic.",
      "enum": [
        "header",
        "cookie"
      ],
      "example": "header",
      "type": "string"
    }
  },
  "required": [
    "type",
    "name"
  ]
}