CZERTAINLY Client Operations API

Download OpenAPI specification:Download

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

REST API for Client Operations

Legacy Client Operations API

Client API for managing End Entities and Certificates

Reset password for End Entity

path Parameters

raProfileName required	string RA Profile name
username required	string Username

Responses

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Get End Entity information

path Parameters

raProfileName required	string RA Profile name
username required	string Username

Responses

Response samples

200
400
404
502
503

Content type

application/json

{"subjectDN": "string",
"email": "string",
"extensionData": [{"name": "string",
"value": "string"
}
],
"subjectAltName": "string",
"status": "NEW",
"username": "string"
}

Edit End Entity

path Parameters

raProfileName required	string RA Profile name
username required	string Username

Request Body schema: application/json

required	object (RaProfileDto) RA profile related to End Entity
email	string End Entity email
	Array of objects (EndEntityExtendedInfoDto) End Entity extension data
password required	string End Entity password
subjectAltName	string End Entity Subject alternative name
subjectDN required	string End Entity subject domain name
status required	string Enum: "NEW" "FAILED" "INITIALIZED" "IN_PROCESS" "GENERATED" "REVOKED" "HISTORICAL" "KEY_RECOVERY" "WAITING_FOR_ADD_APPROVAL" End Entity Subject domain name

Responses

Request samples

Payload

Content type

application/json

{"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "STRING",
"content": { }
}
],
"enabled": true,
"enabledProtocols": ["string"
],
"complianceProfileName": "Compliance Profile 1",
"complianceProfileUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003"
},
"email": "string",
"extensionData": [{"name": "string",
"value": "string"
}
],
"password": "string",
"subjectAltName": "string",
"subjectDN": "string",
"status": "NEW"
}

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Revoke all Certificates and delete End Entity

path Parameters

raProfileName required	string RA Profile name
username required	string Username

Responses

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

List all End Entities

path Parameters

raProfileName

required

string

RA Profile name

Responses

Response samples

200
400
404
502
503

Content type

application/json

[{"subjectDN": "string",
"email": "string",
"extensionData": [{"name": "string",
"value": "string"
}
],
"subjectAltName": "string",
"status": "NEW",
"username": "string"
}
]

Add End Entity

path Parameters

raProfileName

required

string

RA Profile name

Request Body schema: application/json

required	object (RaProfileDto) RA profile related to End Entity
email	string End Entity email
	Array of objects (EndEntityExtendedInfoDto) End Entity extension data
password required	string End Entity password
subjectAltName	string End Entity Subject alternative name
subjectDN required	string End Entity subject domain name
username required	string End Entity name

Responses

Request samples

Payload

Content type

application/json

{"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "STRING",
"content": { }
}
],
"enabled": true,
"enabledProtocols": ["string"
],
"complianceProfileName": "Compliance Profile 1",
"complianceProfileUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003"
},
"email": "string",
"extensionData": [{"name": "string",
"value": "string"
}
],
"password": "string",
"subjectAltName": "string",
"subjectDN": "string",
"username": "string"
}

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Revoke Certificate

path Parameters

raProfileName

required

string

RA Profile name

Request Body schema: application/json

reason required	string Enum: "UNSPECIFIED" "KEY_COMPROMISE" "CA_COMPROMISE" "AFFILIATION_CHANGED" "SUPERSEDED" "CESSATION_OF_OPERATION" "CERTIFICATE_HOLD" "REMOVE_FROM_CRL" "PRIVILEGES_WITHDRAWN" "AA_COMPROMISE" Reason for revocation
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate

Responses

Request samples

Payload

Content type

application/json

{"reason": "UNSPECIFIED",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
]
}

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Issue Certificate

path Parameters

raProfileName

required

string

RA Profile name

Request Body schema: application/json

pkcs10 required	string Certificate sign request (PKCS#10) encoded as Base64 string
required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate

Responses

Request samples

Payload

Content type

application/json

{"pkcs10": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
]
}

Response samples

200
400
404
502
503

Content type

application/json

{"certificateData": "string"
}

v2 Client Operations API

Revoke Certificate

path Parameters

raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json

reason required	string Enum: "UNSPECIFIED" "KEY_COMPROMISE" "CA_COMPROMISE" "AFFILIATION_CHANGED" "SUPERSEDED" "CESSATION_OF_OPERATION" "CERTIFICATE_HOLD" "REMOVE_FROM_CRL" "PRIVILEGES_WITHDRAWN" "AA_COMPROMISE" Reason for revocation
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate

Responses

Request samples

Payload

Content type

application/json

{"reason": "UNSPECIFIED",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
]
}

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Renew Certificate

path Parameters

raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json

pkcs10 required	string Certificate sign request (PKCS#10) encoded as Base64 string
replaceInLocations	boolean Default: false True to replace renewed certificate in the associated locations

Responses

Request samples

Payload

Content type

application/json

{"pkcs10": "string",
"replaceInLocations": false
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Validate revocation Attributes

path Parameters

raProfileUuid

required

string

RA Profile UUID

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
content required	object Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
]

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Validate issue Certificate Attributes

path Parameters

raProfileUuid

required

string

RA Profile UUID

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
content required	object Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
]

Response samples

400
404
422
502
503

Content type

application/json

{"message": "Error message"
}

Issue Certificate

path Parameters

raProfileUuid

required

string

RA Profile UUID

Request Body schema: application/json

pkcs10 required	string Certificate sign request (PKCS#10) encoded as Base64 string
required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate

Responses

Request samples

Payload

Content type

application/json

{"pkcs10": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
]
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Get revocation Attributes

path Parameters

raProfileUuid

required

string

RA Profile UUID

Responses

Response samples

200
400
404
502
503

Content type

application/json

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

Get issue Certificate Attributes

path Parameters

raProfileUuid

required

string

RA Profile UUID

Responses

Response samples

Content type

application/json

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