CZERTAINLY Certificate API (2.13.1)

Download OpenAPI specification:Download

CZERTAINLY: info@czertainly.com URL: https://www.czertainly.com License: MIT License

REST API for managing Certificates in the platform

Certificate Inventory

Certificate Inventory API

List Certificates

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403
404

Content type

application/json

{"certificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Update Group and/or Owner for multiple Certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json
required

groupUuids	Array of strings Certificate Groups UUIDs (set to empty list to remove certificate from all groups)
ownerUuid	string Certificate owner user UUID (set to empty string to remove owner of certificate)
raProfileUuid	string RA Profile UUID (set to empty string to remove certificate from RA profile)
certificateUuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"groupUuids": ["string"
],
"ownerUuid": "string",
"raProfileUuid": "string",
"certificateUuids": ["string"
],
"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Upload a new Certificate

Request Body schema: application/json
required

certificate required	string Base64 Content of the Certificate
required	Array of objects (RequestAttributeDto) Custom Attributes for the Certificate

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Delete multiple certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json
required

uuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"uuids": ["string"
],
"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

200
400
403
404
501

Content type

application/json

{"status": "SUCCESS",
"failedItem": 0,
"message": "string"
}

Submit certificate request

Request Body schema: application/json
required

raProfileUuid required	string <uuid> RA Profile UUID. Required if CSR is not uploaded
sourceCertificateUuid	string <uuid> Source certificate UUID to specify in case of renew/rekey operation
	Array of objects (RequestAttributeDto) List of attributes to create CSR. Required if CSR is not provided
	Array of objects (RequestAttributeDto) List of attributes to sign the CSR
request	string Certificate signing request encoded as Base64 string
format	string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format
tokenProfileUuid	string <uuid> Token Profile UUID. Required if CSR is not uploaded
keyUuid	string <uuid> Key UUID. Required if CSR is not uploaded
required	Array of objects (RequestAttributeDto) List of RA Profile related Attributes to issue Certificate
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuid": "b9278d9c-f0fb-4571-ad29-d552005d6e12",
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"signatureAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"request": "string",
"format": "pkcs10",
"tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
"keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
"issueAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"subjectType": "endEntity",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"certificateContent": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
],
"sourceObjects": [null
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}
],
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"key": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": null,
"data": null
}
]
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active"
}
],
"associations": 0
},
"certificateRequest": {"certificateType": "X.509",
"certificateRequestFormat": "pkcs10",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"content": "string",
"commonName": "string",
"subjectDn": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"signatureAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
},
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"issueAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"relatedCertificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true
}
],
"protocolInfo": {"protocol": "acme",
"protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
"additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}

Get Certificate Content

Request Body schema: application/json
required

Certificate UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404
422

Content type

application/json

[{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"certificateContent": "string"
}
]

Initiate Certificate Compliance Check

Request Body schema: application/json
required

certificateUuids

Array of strings

List of UUIDs of the Certificates

Responses

Request samples

Payload

Content type

application/json

{"certificateUuids": ["string"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Certificate Details

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"subjectType": "endEntity",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"certificateContent": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
],
"sourceObjects": [null
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}
],
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"key": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": null,
"data": null
}
]
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active"
}
],
"associations": 0
},
"certificateRequest": {"certificateType": "X.509",
"certificateRequestFormat": "pkcs10",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"content": "string",
"commonName": "string",
"subjectDn": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"signatureAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
},
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"issueAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"relatedCertificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true
}
],
"protocolInfo": {"protocol": "acme",
"protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
"additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}

Delete a certificate

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Certificate Objects

path Parameters

uuid

required

string

Certificate UUID

Request Body schema: application/json
required

groupUuids	Array of strings Certificate Groups UUIDs (set to empty list to remove certificate from all groups)
ownerUuid	string Certificate owner user UUID (set to empty string to remove owner of certificate)
raProfileUuid	string RA Profile UUID (set to empty string to remove certificate from RA profile)
trustedCa	boolean Mark CA certificate as trusted

Responses

Request samples

Payload

Content type

application/json

{"groupUuids": ["string"
],
"ownerUuid": "string",
"raProfileUuid": "string",
"trustedCa": true
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Download Certificate

path Parameters

uuid required	string Certificate UUID
certificateFormat required	string (CertificateFormat) Enum: "raw" "pkcs7" Certificate format

query Parameters

encoding

required

string (CertificateFormatEncoding)

Enum: "pem" "der"

Responses

Response samples

200
400
403
404

Content type

application/json

{"format": "raw",
"encoding": "pem",
"content": "string"
}

Get Certificate Validation Result

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"resultStatus": "not_checked",
"validationChecks": {"property1": {"validationCheck": "certificate_chain",
"status": "not_checked",
"message": "string"
},
"property2": {"validationCheck": "certificate_chain",
"status": "not_checked",
"message": "string"
}
}
}

Get Certificate event history

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"certificateUuid": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"event": "Issue Certificate",
"status": "SUCCESS",
"message": "string",
"additionalInformation": {"property1": { },
"property2": { }
}
}
]

Get certificate chain

Get certificate chain for the certificate with the given UUID. The certificate chain is returned in the order of the chain, with the first certificate being the certificate with the given UUID, up to the last identified certificate in the chain. If the certificate with the given UUID has status NEW or REJECTED, an empty list is returned.

path Parameters

uuid

required

string

Certificate UUID

query Parameters

withEndCertificate

boolean

Responses

Response samples

200
400
403
404

Content type

application/json

{"completeChain": true,
"certificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"subjectType": "endEntity",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"certificateContent": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [null
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
],
"sourceObjects": [null
]
}
]
}
]
}
],
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"key": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": null,
"data": null
}
]
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": null,
"name": null,
"label": null,
"type": null,
"contentType": null,
"content": [ ]
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active"
}
],
"associations": 0
},
"certificateRequest": {"certificateType": "X.509",
"certificateRequestFormat": "pkcs10",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"content": "string",
"commonName": "string",
"subjectDn": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"signatureAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
},
"sourceCertificateUuid": "cef92ac9-d5a2-44b4-8d0a-6ae2f850acf7",
"issueAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"relatedCertificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"state": "requested",
"validationStatus": "not_checked",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [null
]
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true
}
],
"protocolInfo": {"protocol": "acme",
"protocolProfileUuid": "a286b9c7-97ed-44c6-a837-e8415ab11bf4",
"additionalProtocolUuid": "bcf08956-ad5e-4c4a-863d-293464f7e308"
}
}
]
}

Download Certificate Chain in chosen format

path Parameters

uuid required	string Certificate UUID
certificateFormat required	string (CertificateFormat) Enum: "raw" "pkcs7" Certificate format

query Parameters

withEndCertificate	boolean
encoding required	string (CertificateFormatEncoding) Enum: "pem" "der"

Responses

Response samples

200
400
403
404

Content type

application/json

{"format": "raw",
"encoding": "pem",
"content": "string",
"completeChain": true
}

List Certificates Approvals

path Parameters

uuid

required

string

Certificate UUID

query Parameters

required

object (PaginationRequestDto)

Responses

Response samples

200
400
403
404

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvals": [{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string"
}
]
}

List of available Locations for the Certificate

path Parameters

certificateUuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"state": "requested",
"validationStatus": "not_checked",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": null,
"data": null
}
],
"sourceObjects": [{"uuid": null,
"name": null
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}
]

Get Certificate searchable fields information

Responses

Response samples

200
400
403
404

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": { },
"multiValue": true
}
]
}
]

Get CSR Generation Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

CZERTAINLY Certificate API (2.13.1)

Certificate Inventory

List Certificates

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Group and/or Owner for multiple Certificates

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Upload a new Certificate

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete multiple certificates

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Submit certificate request

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Certificate Content

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Initiate Certificate Compliance Check

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Certificate Details

path Parameters

Responses

Response samples

Delete a certificate

path Parameters

Responses

Response samples

Update Certificate Objects

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Download Certificate

path Parameters

query Parameters

Responses

Response samples

Get Certificate Validation Result

path Parameters

Responses

Response samples

Get Certificate event history

path Parameters

Responses

Response samples

Get certificate chain

path Parameters

query Parameters

Responses

Response samples

Download Certificate Chain in chosen format

path Parameters

query Parameters

Responses

Response samples

List Certificates Approvals

path Parameters

query Parameters

Responses

Response samples

List of available Locations for the Certificate

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required