Skip to content

README.md

Latest commit

 

History

History
295 lines (201 loc) · 62.3 KB

README.md

File metadata and controls

295 lines (201 loc) · 62.3 KB

Changes

(changes)

Overview

Manage changes to an enrollment's network deployment.

Available Operations

get_enrollment_change

Gets the status of a pending change.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/get-enrollment-change

Example Usage

from aktest_se_cps_python import AktestSeCpsPython

s = AktestSeCpsPython()

res = s.changes.get_enrollment_change(change_id=10000, enrollment_id=10000, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
change_id int ✔️ The change for this enrollment on which to perform the desired operation. 10000
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetEnrollmentChangeResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

delete_enrollment_change

Cancels a pending change.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/delete-enrollment-change

Example Usage

from aktest_se_cps_python import AktestSeCpsPython

s = AktestSeCpsPython()

res = s.changes.delete_enrollment_change(change_id=10000, enrollment_id=10000, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
change_id int ✔️ The change for this enrollment on which to perform the desired operation. 10000
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DeleteEnrollmentChangeResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

get_change_deployment_schedule

Gets the current deployment schedule settings describing when a change deploys to the network.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/get-change-deployment-schedule

Example Usage

from aktest_se_cps_python import AktestSeCpsPython

s = AktestSeCpsPython()

res = s.changes.get_change_deployment_schedule(change_id=10000, enrollment_id=10000, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
change_id int ✔️ The change for this enrollment on which to perform the desired operation. 10000
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetChangeDeploymentScheduleResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

get_change_allowed_input_param

Get detailed information of a pending change. Below is a sample where allowedInput[].type has the value third-party-csr. The acceptable Accept header depends on the value of the allowedInput.type for the Change instance. See Change Input Content Type Mapping for details.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/get-change-allowed-input-param

Example Usage

import aktest_se_cps_python
from aktest_se_cps_python import AktestSeCpsPython

s = AktestSeCpsPython()

res = s.changes.get_change_allowed_input_param(allowed_input_type_param=aktest_se_cps_python.AllowedInputTypeParam.THIRD_PARTY_CSR, change_id=10000, enrollment_id=10000, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
allowed_input_type_param models.AllowedInputTypeParam ✔️ Enum Found as the last part of Change.allowedInput[].update hypermedia URL. See Change Input Content Type Mapping for details. Currently supported values include change-management-info, lets-encrypt-challenges, post-verification-warnings, pre-verification-warnings, third-party-csr. third-party-csr
change_id int ✔️ The change for this enrollment on which to perform the desired operation. 10000
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetChangeAllowedInputParamResponse

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

post_change_allowed_input_param

Updates a pending change. Below is a sample where allowedInput[].type has the value third-party-cert-and-trust-chain. The acceptable Content-Type and Accept headers depends on the value of the allowedInput.type for the Change instance. See Change Input Content Type Mapping for details.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/post-change-allowed-input-param

Example Usage

import aktest_se_cps_python
from aktest_se_cps_python import AktestSeCpsPython

s = AktestSeCpsPython()

res = s.changes.post_change_allowed_input_param(request={
    "allowed_input_type_param": aktest_se_cps_python.PathParamAllowedInputTypeParam.THIRD_PARTY_CERT_AND_TRUST_CHAIN,
    "change_id": 10000,
    "enrollment_id": 10000,
    "account_switch_key": "1-5C0YLB:1-8BYUX",
    "request_body": {
        "certificates_and_trust_chains": [
            {
                "certificate": "-----BEGIN CERTIFICATE-----\n" +
                "MIID ... KZlSw==\n" +
                "-----END CERTIFICATE-----",
                "key_algorithm": aktest_se_cps_python.KeyAlgorithm.ECDSA,
                "trust_chain": "-----BEGIN CERTIFICATE-----\n" +
                "MIID ... 4p5mA=\n" +
                "-----END CERTIFICATE-----\n" +
                "-----BEGIN CERTIFICATE-----\n" +
                "MIIDQ ... JuAIQ=\n" +
                "-----END CERTIFICATE-----",
            },
            {
                "certificate": "-----BEGIN CERTIFICATE-----\n" +
                "MIID ... ZKwSl==\n" +
                "-----END CERTIFICATE-----",
                "key_algorithm": aktest_se_cps_python.KeyAlgorithm.RSA,
                "trust_chain": "-----BEGIN CERTIFICATE-----\n" +
                "MIID ... mA45p=\n" +
                "-----END CERTIFICATE-----\n" +
                "-----BEGIN CERTIFICATE-----\n" +
                "MIIDQ ... QuIAJ=\n" +
                "-----END CERTIFICATE-----",
            },
        ],
    },
})

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request models.PostChangeAllowedInputParamRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PostChangeAllowedInputParamResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*

get_history_changes

Change history of an enrollment.

See documentation for this operation in Akamai's Certificate Provisioning System API https://techdocs.akamai.com/cps/reference/get-history-changes

Example Usage

from aktest_se_cps_python import AktestSeCpsPython

s = AktestSeCpsPython()

res = s.changes.get_history_changes(enrollment_id=10000, include_all=True, account_switch_key="1-5C0YLB:1-8BYUX")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
enrollment_id int ✔️ Enrollment on which to perform the desired operation. 10000
include_all Optional[bool] ➖ Retrieve all changes or certificates. true
account_switch_key Optional[str] ➖ For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. 1-5C0YLB:1-8BYUX
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetHistoryChangesResponseBody

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*