API
TrainingSupportCommunity

ChangeManagement object

This table aggregates membership for all versions of the ChangeManagement object.

Versioned schema members

Any object member specific to a range of versions is indicated in its description, at what version the member was either introduced or removed. Any listed data member with no version number is common to all versions of the object.

MemberTypeDescription
Change​Management: After you create an enrollment, you can have CPS halt deployment when the certificate becomes available, so that you can test and view the certificate on a staging server prior to deployment in the production network. If you do not want CPS to automatically deploy the certificate to the production network after it receives the signed certificate from the CA, you can turn change management on for the enrollment. This stops CPS from deploying the certificate to the network until you acknowledge that you are ready to deploy the certificate. A version label indicates this member is introduced in that version. A pre-version label indicates this member is removed in that version. No version label indicates this member is present in all versions.
acknowledgement​DeadlineString, NullThe timestamp of the deadline for the user to acknowledge the change management validation result, before CPS automatically proceeds with attempting to deploy the pending state to the live network. The format of the timestamp is ISO-8601. This field is only populated when there's an existing certificate on network for the current enrollment, it's null otherwise.
pending​StateChange​Management.​pending​Staterequired: The snapshot of the pending state for the enrollment when this change takes effect.
validation​ResultChange​Management.​validation​Result, NullThe hash of validation​Result. It always has a value, even when validation​Result is null. The hash result of the validation result as of the time of the most recent validation check. It is used in the change-management-ack API call to further specify the state of the change that is being acknowledged. For best results, use the change-management-info API call, review the validation​Result with its hash, and then acknowledge change-management using the same hash retrieved when running the Change Management Acknowledgement operation.
validation​Result​HashStringrequired: The hash of validation​Result.
Change​Management.pending​State: The snapshot of the pending state for the enrollment when this change takes effect.
pending​CertificateChange​Management.​pending​State.​pending​Certificate, Nullpre-v5. The snapshot of the pending certificate for the enrollment when this change takes effect.
pending​CertificatesChange​Management.​pending​State.​pending​Certificates[]v5. The snapshot of the pending certificate for the enrollment when this change takes effect.
pending​Network​ConfigurationChange​Management.​pending​State.​pending​Network​Configurationrequired: The snapshot of the pending network configuration for the enrollment when this change takes effect.
Change​Management.pending​State.pending​Certificate: The snapshot of the pending certificate for the enrollment when this change takes effect.
certificate​TypeStringpre-v5. Either san, single, wildcard, wildcard-san, or third-party.
full​CertificateStringpre-v5. Displays the contents of the certificate.
ocsp​StapledBoolean, Nullv4 only. OCSP Stapling improves performance by including a valid OCSP response in every TLS handshake. Enable this feature for best performance.
ocsp​UrisArray, Nullv4 only. URI used for OCSP stapling validation.
signature​AlgorithmStringpre-v5. Displays the signature algorithm.
Change​Management.pending​State.pending​Certificates[]: The snapshot of the pending certificate for the enrollment when this change takes effect.
certificate​TypeEnumerationv5. Either san, single, wildcard, wildcard-san, or third-party.
full​CertificateStringv5. Displays the contents of the certificate.
key​AlgorithmEnumeration, Nullv5. Displays the key algorithm of the certificate.
ocsp​StapledBoolean, Nullv5. OCSP Stapling improves performance by including a valid OCSP response in every TLS handshake. Enable this feature for best performance.
ocsp​UrisArray, Nullv5. URI used for OCSP stapling validation.
signature​AlgorithmStringv5. Displays the signature algorithm.
Change​Management.pending​State.pending​Network​Configuration: The snapshot of the pending network configuration for the enrollment when this change takes effect.
disallowed​Tls​VersionsArray, Nullv2. Disallowed TLS protocols.
dns​Name​SettingsChange​Management.​pending​State.​pending​Network​Configuration.​dns​Name​Settings, Nullv4. DNS name settings.
must​HaveCiphersStringrequired: Ciphers that you want to include for your enrollment while deploying it on the network. Defaults to ak-akamai-default when it is not set.
network​TypeString, NullEnrollment network type.
ocsp​StaplingString, Nullv4. OCSP stapling setting for the deployment.
preferred​CiphersStringrequired: Ciphers that you preferably want to include for your enrollment while deploying it on the network. Defaults to ak-akamai-default when it is not set.
quic​EnabledBooleanv4. QUIC transport layer network protocol.
sniChange​Management.​pending​State.​pending​Network​Configuration.​sni, Nullpre-v4. Server Name Indication (SNI) setting for this Enrollment.
sni​OnlyBooleanv4. Server Name Indication (SNI) setting for this Enrollment.
Change​Management.pending​State.pending​Network​Configuration.dns​Name​Settings: DNS name settings.
clone​Dns​NamesBooleanv4. All certificate SANs are included in dns​Names when clone​Dns​Names is true.
dns​NamesArray, Nullv4. Names served by SNI-only enabled enrollments.
Change​Management.pending​State.pending​Network​Configuration.sni: Server Name Indication (SNI) setting for this Enrollment.
clone​Dns​NamesBooleanpre-v4. All certificate SANs are included in dns​Names when clone​Dns​Names is true.
dns​NamesArray, Nullpre-v4. Names served by SNI-only enabled enrollments.
Change​Management.validation​Result: The hash of validation​Result. It always has a value, even when validation​Result is null. The hash result of the validation result as of the time of the most recent validation check. It's used in the change-management-ack API call to further specify the state of the change that is being acknowledged. For best results, use the change-management-info API call, review the validation​Result with its hash, and then acknowledge change-management using the same hash retrieved when running the Change Management Acknowledgement operation.
errorsChange​Management.​validation​Result.​errors[]Validation errors of the current job state. Errors prevent a change from proceeding until you resolve them. They are optional and only appear if there are any errors.
warningsChange​Management.​validation​Result.​warnings[]Validation warnings of the current job state. Warnings suspend the execution of a change. You can acknowledge or deny warnings. If you acknowledge them, the change proceeds with its operation. They are optional and only appear if there are any warnings.
Change​Management.validation​Result.errors[]: Validation errors of the current job state. Errors prevent a change from proceeding until you resolve them. They are optional and only appear if there are any errors.
messageStringrequired: The description of the message.
message​CodeStringrequired: The unique code of the message.
Change​Management.validation​Result.warnings[]: Validation warnings of the current job state. Warnings suspend the execution of a change. You can acknowledge or deny warnings. If you acknowledge them, the change proceeds with its operation. They are optional and only appear if there are any warnings.
messageStringrequired: The description of the message.
message​CodeStringrequired: The unique code of the message.

Sample v2 object

{
    "acknowledgementDeadline": null,
    "pendingState": {
        "pendingCertificate": {
            "certificateType": "third-party",
            "fullCertificate": "-----BEGIN CERTIFICATE-----\nMIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn\nMSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM\nBgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD\nVQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV\nBAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN\nQTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM\nBVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P\nYQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z\nWxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz\nIZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R\nAepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet\niR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU\ndQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv\nbYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz\nYW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG\n9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI\ny8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5\ncrtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v\n0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ\nfFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh\nVQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw==\n-----END CERTIFICATE-----",
            "signatureAlgorithm": "SHA-256"
        },
        "pendingNetworkConfiguration": {
            "disallowedTlsVersions": [
                "TLSv1_2"
            ],
            "mustHaveCiphers": "ak-akamai-default2016q3",
            "networkType": null,
            "preferredCiphers": "ak-akamai-default",
            "sni": null
        }
    },
    "validationResult": {
        "errors": null,
        "warnings": [
            {
                "message": "[SAN name [san9.example.com] has been removed from the certificate. It is still live on the network., SAN name [san8.example.com] has been removed from the certificate. It is still live on the network.]",
                "messageCode": "no-code"
            }
        ]
    },
    "validationResultHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}

Sample v4 object

{
    "acknowledgementDeadline": null,
    "pendingState": {
        "pendingCertificate": {
            "certificateType": "third-party",
            "fullCertificate": "-----BEGIN CERTIFICATE-----\nMIID2DCCAsCgAwIBAgIQ661To2+zTDiFLyyARAaFXTANBgkqhkiG9w0BAQsFADBn\nMSowKAYDVQQDDCFBS0FNQUkgVEVTVCBJTlRFUk1FRElBVEUgQ0VSVCBbMV0xDjAM\nBgNVBAsMBVdlYkV4MQ8wDQYDVQQKDAZBa2FtYWkxCzAJBgNVBAgMAk1BMQswCQYD\nVQQGEwJVUzAeFw0xNzA1MTgyMTEwMTFaFw0xODA1MTkyMTEwMTFaMG0xHDAaBgNV\nBAMME3d3dy5jcHMtZXhhbXBsZS5jb20xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJN\nQTESMBAGA1UEBwwJQ2FtYnJpZGdlMQ8wDQYDVQQKDAZBa2FtYWkxDjAMBgNVBAsM\nBVdlYkV4MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvQeIJ2yfOC8P\nYQp6NjiCYSCkuS0z9a61v+k+KTDYQKIa8jDkwP0OITzvTnjMHuUd8JbSz5jNb22Z\nWxH/1F2p71rlSdBReBkZGLMLcQZPt5ju7ea7ZPz+MOWrwuc6YUafRMQk3qMeo3Sz\nIZQbmLKXkZeYriqy9s9yHJSUnWX1jOa51w6YM/Xar/2pZp2pyguaCNVGp7AAo38R\nAepaGcFwyjJse6dc+7dHOvDnjQ+Cg2lO8DSc12sFLllOhdOULldZRWbtfTLs9uet\niR8ZVpHJ1TtzEz3X9RqBBCvnqykQvMmiQKOkfYEd6LN4Tk6/HJw2/MZhIgAEXtUU\ndQMnD6OMcwIDAQABo3oweDB2BgNVHREEbzBtghRzYW4xLmNwcy1leGFtcGxlLmNv\nbYIUc2FuMi5jcHMtZXhhbXBsZS5jb22CFHNhbjMuY3BzLWV4YW1wbGUuY29tghRz\nYW40LmNwcy1leGFtcGxlLmNvbYITd3d3LmNwcy1leGFtcGxlLmNvbTANBgkqhkiG\n9w0BAQsFAAOCAQEAm9krrTxqDwUaO8J7P7CcrHfwXeWiDG3d9uHqCvHRGrcs46pI\ny8umThgOEba0QHi6CwM6O0+chcHsn6qf+uVKg2u1SKlE6qMIJ1Ppc8MJky1xo0M5\ncrtRpSXjaoF9S2zZZK1lwOJoK93BtC/lNfRc682TxlQ58jtBI6qnmLXUhF8Yo67v\n0UfHiBIv1pZFPIdk90/48vjWM54haNxm/PhxNb6AdzawR4zImUhMKsISP7uOTURQ\nfFfeNgMvHyI8Id1VPLN+e2y4FtnTVdW2e+PTBvOJ1M+YoFU7M04/2SmKJHqnHljh\nVQBpto9JgDmt0yqsdFdLrZlpsIQwpLqdgKZlSw==\n-----END CERTIFICATE-----",
            "ocspStapled": "false",
            "ocspUris": null,
            "signatureAlgorithm": "SHA-256"
        },
        "pendingNetworkConfiguration": {
            "disallowedTlsVersions": [
                "TLSv1_2"
            ],
            "dnsNameSettings": null,
            "mustHaveCiphers": "ak-akamai-default2016q3",
            "networkType": null,
            "ocspStapling": "not-set",
            "preferredCiphers": "ak-akamai-default",
            "quicEnabled": "false",
            "sniOnly": "false"
        }
    },
    "validationResult": {
        "errors": null,
        "warnings": [
            {
                "message": "[SAN name [san9.example.com] has been removed from the certificate. It is still live on the network., SAN name [san8.example.com] has been removed from the certificate. It is still live on the network.]",
                "messageCode": "no-code"
            }
        ]
    },
    "validationResultHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}

Sample v5 object

{
    "acknowledgementDeadline": null,
    "pendingState": {
        "pendingCertificates": [
            {
                "certificateType": "third-party",
                "fullCertificate": "-----BEGIN CERTIFICATE-----\nMIID2 ... <sample - removed for readability> .... KZlSw==\n-----END CERTIFICATE-----",
                "keyAlgorithm": "RSA",
                "ocspStapled": "false",
                "ocspUris": null,
                "signatureAlgorithm": "SHA-256"
            }
        ],
        "pendingNetworkConfiguration": {
            "disallowedTlsVersions": [
                "TLSv1_2"
            ],
            "dnsNameSettings": null,
            "mustHaveCiphers": "ak-akamai-default2016q3",
            "networkType": null,
            "ocspStapling": "not-set",
            "preferredCiphers": "ak-akamai-default",
            "quicEnabled": "false",
            "sniOnly": "false"
        }
    },
    "validationResult": {
        "errors": null,
        "warnings": [
            {
                "message": "[SAN name [san9.example.com] has been removed from the certificate. It is still live on the network., SAN name [san8.example.com] has been removed from the certificate. It is still live on the network.]",
                "messageCode": "no-code"
            }
        ]
    },
    "validationResultHash": "da39a3ee5e6b4b0d3255bfef95601890afd80709"
}