Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

Azure Certificates Management APIs

Recovering Soft-Deleted Azure Certificates

search

Please Note:

Recovering Soft-Deleted Azure Certificates

Use the post /v1/cckm/azure/certificates/{id}/recover to recover a soft-deleted Azure certificate.

Syntax

curl -k '<IP>/api/v1/cckm/azure/certificates/{id}/recover' -X POST -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed

Here, {id} is the resource ID of the certificate on the CipherTrust Manager.

Request Parameter

ParameterTypeDescription
AUTHTOKENstringAuthorization token.

Example Request

curl -k 'https://127.0.0.1/api/v1/cckm/azure/certificates/3b0d3b81-36a9-4987-bf85-8f501418fb4d/recover' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MDIzNTY1Yy0xOWI3LTQyY2UtODZmMi1jNWI3MTA1MTJhZjMiLCJzdWIiOiJsb2NhbHwwMWI4M2EwZS1mY2U1LTQ5MjgtODhiNi0zNTNkMmQ3ZTBiNDMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiZGJlNzU2MWYtZDVhOS00ZGEzLWJiZTEtNjlhMTg0Y2U3YzEzIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjRmMGExN2Y0LWQxOGUtNGE5YS04ZWM2LTU1ZjI2ZjJjNTMzMiIsImlhdCI6MTYwMTQ2MTEwNiwiZXhwIjoxNjAxNDYxNDA2fQ.P_d2ngOq_AlxqXhfG-saEvQRYZCSzQbzR2S6Jzv6Ogs' -H 'accept: application/json' --compressed

Example Response

{
    "id": "3b0d3b81-36a9-4987-bf85-8f501418fb4d",
    "uri": "kylo:kylo:cckm:azure-cert:test-cert-658775c4-b730-420d-814b-f63fb7859a09",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2022-04-13T07:47:40.972965Z",
    "updatedAt": "2022-04-13T07:48:54.467731Z",
    "synced_at": "2022-04-13T07:47:35Z",
    "cloud_name": "AzureCloud",
    "key_vault": "vault-name::260ecbe7-777b-4d3c-84ea-887620498863",
    "key_vault_id": "84340213-a515-43d1-acc4-e2eaa6efbe94",
    "region": "northcentralus",
    "tenant": "781b4642-6e0e-4794-94df-6b0878ab0317",
    "azure_created_at": "2022-04-13T07:47:35Z",
    "azure_expire_at": "2023-04-13T07:47:35Z",
    "azure_updated_at": "2022-04-13T07:47:35Z",
    "backup": "b6d881ae3d7c484893a2bee36dd24d90e567c0d40e1b4ddcbf82ef18e885c457",
    "backup_at": "2022-04-13T07:47:40.967592Z",
    "cert_name": "test-cert",
    "cert_soft_deleted_in_azure": false,
    "deleted": false,
    "gone": false,
    "cert_material_origin": "native",
    "cert_source": "native",
    "operation": "",
    "soft_delete_enabled": true,
    "status": "AVAILABLE",
    "version": "18e8233da6aa454d8db3fb96e3eba65e",
    "azure_param": {
        "cer": "MIIEHTCCAwWgAwIBAgIQEjHOQ3HZR6yHOJ/yQdJBbjANBgkqhkiG9w0BAQsFADBsMRcwFQYDVQQDEw53d3cuY29udG9zby5jbzETMBEGA1UECxMKQ29udG9zbyBIUjEQMA4GA1UEChMHQ29udG9zbzEQMA4GA1UEBxMHUmVkbW9uZDELMAkGA1UECBMCV0ExCzAJBgNVBAYTAlVTMB4XDTIyMDQxMzA3MzczNVoXDTIzMDQxMzA3NDczNVowbDEXMBUGA1UEAxMOd3d3LmNvbnRvc28uY28xEzARBgNVBAsTCkNvbnRvc28gSFIxEDAOBgNVBAoTB0NvbnRvc28xEDAOBgNVBAcTB1JlZG1vbmQxCzAJBgNVBAgTAldBMQswCQYDVQQGEwJVUzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAPkFqEhOo1plQCmmch8CXnHWiM/q4+FS+hu0Q4LknK5FstHbhy5FyzM9LY0ULcREACjhQ7zs8huE77uVQnj9UxERmFKEU3Udi7eeigCYYIjcP5I1wE0lRI9nXRnJaybgSpDeo/oLEjxyXeWz/1TpMKZWRDyU1NxiSODCheC2TpKxHPxT0YZZFPxZeIkDtbGI82RM+fkke8dexmocHwqHz1XLeT8rvI0HnW1x771VGUKQR7+leQcXhJLZ7pW+ouoOZFWn0OYU7tbmACswb1/lsEruQFEQj1Hs6vYrNj5O6v6i93o0+pP2defRt/PH3cLcTE01ZglrpswIqoORvDDxJ7kCAwEAAaOBujCBtzAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwOwYDVR0RBDQwMoERaGVsbG9AY29udG9zby5jb22CDmhyLmNvbnRvc28uY29tgg1tLmNvbnRvc28uY29tMB8GA1UdIwQYMBaAFExotUmG2KYWjdZz91tx8EFAkLnLMB0GA1UdDgQWBBRMaLVJhtimFo3Wc/dbcfBBQJC5yzANBgkqhkiG9w0BAQsFAAOCAQEA75IrnGAo8jnI0zSKydLD7TGbIvzzIoZ1SbIDCGeOKwGiwvFnz78T+yBv1U4XuwepsCzA1EsM3QUWUJOpwXgah1uUUWfYmBNYExyxycQ/vGWi0tKWLM9zGF2mxX3AEaUpJsZeEjYrUfzwa8ccDLFfXxqJajDXE4aNrL8NVl84/nTOTHaytMKUXIyNEpZ2VCwAhc7msO0HG1I1HYQw+r3RB88+3aFjGqMJK7fbAhNk2uyavj2AyNWaYzzovfctGCHx/1ypEvzCLeh8fICYoqf8zYDDc836nKaOcBKMNMkrwy5w92Y9Y01yfDIyZoPysZDQq2zHXTER9RK5F/c5akj1GA==",
        "kid": "https://vault-name.vault.azure.net/keys/test-cert/18e8233da6aa454d8db3fb96e3eba65e",
        "sid": "https://vault-name.vault.azure.net/secrets/test-cert/18e8233da6aa454d8db3fb96e3eba65e",
        "x5t": "nw-bJcepZyG9gQLbrDMz02WYKYI",
        "lifetime_actions": [
            {
                "action": {
                    "action_type": "AutoRenew"
                },
                "trigger": {
                    "days_before_expiry": 80
                }
            }
        ],
        "crv": "",
        "exportable": true,
        "key_size": 2048,
        "kty": "RSA",
        "content_type": "application/x-pkcs12",
        "ekus": [
            "1.3.6.1.5.5.7.3.1",
            "1.3.6.1.5.5.7.3.2"
        ],
        "key_usage": [
            "digitalSignature",
            "keyEncipherment"
        ],
        "sans": {
            "emails": [
                "hello@contoso.com"
            ],
            "dns_names": [
                "hr.contoso.com",
                "m.contoso.com"
            ]
        },
        "subject": "C=US, ST=WA, L=Redmond, O=Contoso, OU=Contoso HR, CN=www.contoso.co",
        "validity_months": 12,
        "issuer_name": "Self",
        "attributes": {
            "created": 1649836055,
            "enabled": true,
            "exp": 1681372055,
            "nbf": 1649835455,
            "recoverable_days": 7,
            "recovery_level": "CustomizedRecoverable+Purgeable",
            "updated": 1649836055
        }
    },
    "version_count": 1
}

The sample output shows that the parameter status becomes AVAILABLE. This indicates that the certificate is recovered.

Response Codes

Response CodeDescription
2xxSuccess
4xxClient errors
5xxServer errors

Refer to HTTP status codes for details.