Client Certificate V2

APIs.ioEngineeringPlatform

Properties

Name Type Description
certificate_id string UUID of Cloudflare managed certificate.
check_private_key boolean Confirm the certificate was not imported from another device. We recommend keeping this enabled unless the certificate was deployed without a private key.
cn string Common Name that is protected by the client certificate. This may include one or more variables in the ${ } notation. Only ${serial_number} and ${hostname} are valid variables.
extended_key_usage array List of values indicating purposes for which the certificate public key can be used
locations object
operating_system string Operating System
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-teams-devices-client-certificate-v2-input-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/teams-devices_client_certificate_v2_input_request",
  "title": "Client Certificate V2",
  "properties": {
    "certificate_id": {
      "description": "UUID of Cloudflare managed certificate.",
      "example": "b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30",
      "maxLength": 36,
      "type": "string"
    },
    "check_private_key": {
      "description": "Confirm the certificate was not imported from another device. We recommend keeping this enabled unless the certificate was deployed without a private key.",
      "example": true,
      "type": "boolean"
    },
    "cn": {
      "description": "Common Name that is protected by the client certificate. This may include one or more variables in the ${ } notation. Only ${serial_number} and ${hostname} are valid variables.",
      "example": "${hostname}.com.${serial_number}",
      "type": "string"
    },
    "extended_key_usage": {
      "description": "List of values indicating purposes for which the certificate public key can be used",
      "example": [
        "clientAuth",
        "emailProtection"
      ],
      "items": {
        "$ref": "#/components/schemas/teams-devices_extended_key_usage_enum"
      },
      "type": "array"
    },
    "locations": {
      "properties": {
        "paths": {
          "$ref": "#/components/schemas/teams-devices_paths"
        },
        "trust_stores": {
          "$ref": "#/components/schemas/teams-devices_trust_stores"
        }
      },
      "type": "object"
    },
    "operating_system": {
      "description": "Operating System",
      "enum": [
        "windows",
        "mac",
        "linux"
      ],
      "example": "windows",
      "type": "string"
    }
  },
  "required": [
    "certificate_id",
    "check_private_key",
    "operating_system"
  ],
  "type": "object"
}