CertificateAuthorityVersion

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-certificate-authority-version-schema.json",
  "title": "CertificateAuthorityVersion",
  "description": "The metadata details of the certificate authority (CA) version. This object does not contain the CA contents.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-certificatesmanagement-api-openapi.yml#/components/schemas/CertificateAuthorityVersion",
  "properties": {
    "certificateAuthorityId": {
      "description": "The OCID of the CA.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "csrPem": {
      "default": null,
      "description": "The certificate signing request (in PEM format).",
      "maxLength": 10240,
      "minLength": 1,
      "type": "string"
    },
    "issuerCaVersionNumber": {
      "description": "The version number of the issuing CA.",
      "format": "int64",
      "minimum": 1,
      "type": "integer"
    },
    "revocationStatus": {
      "$ref": "#/$defs/RevocationStatus"
    },
    "serialNumber": {
      "description": "A unique certificate identifier used in certificate revocation tracking, formatted as octets.\nExample: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`\n",
      "maxLength": 59,
      "minLength": 2,
      "type": "string"
    },
    "stages": {
      "description": "A list of rotation states for this CA version.",
      "items": {
        "$ref": "#/$defs/VersionStage"
      },
      "type": "array"
    },
    "subjectAlternativeNames": {
      "default": null,
      "description": "A list of subject alternative names. A subject alternative name specifies the domain names, including subdomains, and IP addresses covered by the certificates issued by this CA.",
      "items": {
        "$ref": "#/$defs/CertificateSubjectAlternativeName"
      },
      "maxItems": 100,
      "type": "array"
    },
    "timeCreated": {
      "description": "A optional property indicating when the CA version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-04-03T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "timeOfDeletion": {
      "default": null,
      "description": "An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-04-03T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "validity": {
      "$ref": "#/$defs/Validity"
    },
    "versionName": {
      "default": null,
      "description": "The name of the CA version. When the value is not null, a name is unique across versions for a given CA.\n",
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "versionNumber": {
      "description": "The version number of this CA.",
      "format": "int64",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "certificateAuthorityId",
    "timeCreated",
    "versionNumber",
    "stages"
  ],
  "type": "object",
  "x-example": "{\n    \"certificateAuthorityId\": \"ocid1.certificateauthority.oc1.iad.exampleae47ajxyaovlvo7eycvb6jgblgmvdaixez2rrfauxov2v6wplhjiq\",\n    \"issuerCaVersionNumber\": null,\n    \"serialNumber\": \"1234567894183178072847116123235304931087123456789\",\n    \"timeCreated\": \"2021-04-06T22:11:58.288Z\",\n    \"versionNumber\": 1,\n    \"versionName\": null,\n    \"timeOfDeletion\": null,\n    \"validity\": {\n       \"timeOfValidityNotBefore\": \"2021-04-06T22:11:58.008Z\",\n       \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n    },\n    \"stages\": [\n       \"CURRENT\",\n       \"LATEST\"\n    ]\n    ,\"revocationStatus\": null,\n    \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----<var>&lt;certificateContents&gt;</var>-----END CERTIFICATE REQUEST-----\"\n }\n",
  "$defs": {
    "CertificateSubjectAlternativeName": {
      "description": "A subject alternative name for the certificate that binds additional or alternate names to the subject of the certificate. In the certificate, the alternate subject name format is \"type:name\".\n",
      "properties": {
        "type": {
          "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.",
          "enum": [
            "DNS",
            "IP"
          ],
          "type": "string"
        },
        "value": {
          "description": "The subject alternative name.",
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "type": "object"
    },
    "RevocationStatus": {
      "description": "The current revocation status of the entity.",
      "properties": {
        "revocationReason": {
          "description": "The reason the certificate or certificate authority (CA) was revoked.",
          "enum": [
            "UNSPECIFIED",
            "KEY_COMPROMISE",
            "CA_COMPROMISE",
            "AFFILIATION_CHANGED",
            "SUPERSEDED",
            "CESSATION_OF_OPERATION",
            "PRIVILEGE_WITHDRAWN",
            "AA_COMPROMISE"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/RevocationReason"
        },
        "timeOfRevocation": {
          "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-04-03T21:10:29.600Z`\n",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "timeOfRevocation",
        "revocationReason"
      ],
      "type": "object",
      "x-example": "{\n  \"timeOfRevocation\": \"2021-04-07T23:03:12.211Z\",\n  \"revocationReason\": \"CESSATION_OF_OPERATION\"\n}\n"
    },
    "Validity": {
      "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n",
      "properties": {
        "timeOfValidityNotAfter": {
          "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-04-03T21:10:29.600Z`\n",
          "format": "date-time",
          "type": "string"
        },
        "timeOfValidityNotBefore": {
          "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\nExample: `2019-04-03T21:10:29.600Z`\n",
          "format": "date-time",
          "type": "string",
          "x-default-description": "defaults to the current time"
        }
      },
      "required": [
        "timeOfValidityNotAfter"
      ],
      "x-example": "{\n  \"timeOfValidityNotBefore\": \"2021-04-06T22:11:58.008Z\",\n  \"timeOfValidityNotAfter\": \"2031-05-06T00:00:00.000Z\"\n}\n"
    },
    "VersionStage": {
      "description": "A list of possible rotation states for the certificate version. A certificate version marked `CURRENT` is currently in use. A certificate version marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated\ninto current, active use. The certificate most recently uploaded to the service is always marked `LATEST`. (The first version of a certificate is always marked as both `CURRENT` and `LATEST`.) A certificate version marked `PREVIOUS` is the certificate version that was most recently marked `CURRENT`, before the last certificate version rotation.\nA certificate version marked `DEPRECATED` is neither current, pending, nor the previous one in use. Only certificate versions marked `DEPRECATED` can be scheduled for deletion.\nA certificate version marked `PENDING_ACTIVATION` is issued by an externally managed CA and stays in that rotation state until you successfully sign the certificate signing request (CSR) externally and then import the signed certificate to the Certificates service.\n",
      "enum": [
        "CURRENT",
        "PENDING",
        "LATEST",
        "PREVIOUS",
        "DEPRECATED",
        "FAILED",
        "PENDING_ACTIVATION"
      ],
      "type": "string",
      "x-example": "{\n  \"stages\": [\n   \"CURRENT\",\n   \"LATEST\"\n  ],\n}\n"
    }
  }
}