CZERTAINLY Certificate API

Download OpenAPI specification:Download

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

REST API for managing Certificates in the platform

CZERTAINLY Documentation

Certificate Group API

Group details

path Parameters

uuid

required

string

Responses

Response samples

200
400
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
}

Update Group

path Parameters

uuid

required

string

Group UUID

Request Body schema: application/json

name required	string Name of the Certificate Group
description	string Description of the Certificate Group

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
400
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
}

Remove Group

path Parameters

uuid

required

string

Group UUID

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

List Groups

Responses

Response samples

200
400
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
}
]

Create Group

Request Body schema: application/json

name required	string Name of the Certificate Group
description	string Description of the Certificate Group

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

201
400
404

Content type

application/json

{"uuid": "string"
}

Remove multiple Groups

Request Body schema: application/json

Group UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Certificate Inventory API

Update RA Profile for a Certificate

path Parameters

uuid

required

string

Certificate UUID

Request Body schema: application/json

raProfileUuid

required

string

RA Profile UUID

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuid": "string"
}

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Update Owner for a Certificate

path Parameters

uuid

required

string

Certificate UUID

Request Body schema: application/json

owner

required

string

Owner of the certificate

Responses

Request samples

Payload

Content type

application/json

{"owner": "string"
}

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Update Group for a Certificate

path Parameters

uuid

required

string

Certificate UUID

Request Body schema: application/json

groupUuid

required

string

Group UUID

Responses

Request samples

Payload

Content type

application/json

{"groupUuid": "string"
}

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Validate Certificates of Status Unknown

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Update RA Profile 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

uuid required	string UUID of the 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

{"uuid": "string",
"certificateUuids": ["string"
],
"filters": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Update 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

owner required	string Owner of the Certificates
certificateUuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"owner": "string",
"certificateUuids": ["string"
],
"filters": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Update Group 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

uuid required	string UUID of the Group
certificateUuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"certificateUuids": ["string"
],
"filters": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Upload a new Certificate

Request Body schema: application/json

certificate

required

string

Base64 Content of the Certificate

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string"
}

Response samples

201
400
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

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": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

200
400
404

Content type

application/json

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

Initiate Certificate Compliance Check

Request Body schema: application/json

certificateUuids

Array of strings

List of UUIDs of the Certificates

Responses

Request samples

Payload

Content type

application/json

{"certificateUuids": ["string"
]
}

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

List Certificates

Request Body schema: application/json

	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": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
404

Content type

application/json

{"certificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"certificateContent": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"basicConstraints": "string",
"meta": {"property1": { },
"property2": { }
},
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true
},
"fingerprint": "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": "STRING",
"content": { }
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": {"property1": { },
"property2": { }
},
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"withKey": false
}
],
"metadata": {"property1": { },
"property2": { }
}
}
],
"group": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
},
"owner": "string",
"certificateType": "X509",
"issuerSerialNumber": "string",
"certificateValidationResult": {"property1": {"status": "success",
"message": "string"
},
"property2": {"status": "success",
"message": "string"
}
},
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok"
}
],
"complianceStatus": "ok"
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Initiate Certificate validation

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Get Certificate event history

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
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 Details

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
404

Content type

application/json

{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"certificateContent": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"basicConstraints": "string",
"meta": {"property1": { },
"property2": { }
},
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true
},
"fingerprint": "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": "STRING",
"content": { }
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": {"property1": { },
"property2": { }
},
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"withKey": false
}
],
"metadata": {"property1": { },
"property2": { }
}
}
],
"group": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
},
"owner": "string",
"certificateType": "X509",
"issuerSerialNumber": "string",
"certificateValidationResult": {"property1": {"status": "success",
"message": "string"
},
"property2": {"status": "success",
"message": "string"
}
},
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok"
}
],
"complianceStatus": "ok"
}

Remove a certificate

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

List of available Locations for the Certificate

path Parameters

certificateUuid

required

string

Certificate UUID

Responses

Response samples

200
400
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": "STRING",
"content": { }
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": {"property1": { },
"property2": { }
},
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"withKey": false
}
],
"metadata": {"property1": { },
"property2": { }
}
}
]

Get Certificate searchable fields information

Responses

Response samples

200
400
404

Content type

application/json

[{"field": "commonName",
"label": "string",
"type": "string",
"conditions": ["EQUALS"
],
"value": { },
"multiValue": true
}
]