CZERTAINLY CMP API (2.13.1)

Download OpenAPI specification:Download

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

REST API for managing CMP Profiles in the platform

CZERTAINLY Documentation

CMP Profile Management

CMP Profile Management API

Get details of CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile",
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"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
}
]
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"signingCertificate": {"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
}
}

Edit CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Request Body schema: application/json
required

description	string Description of the CMP Profile
raProfileUuid	string RA Profile UUID that the CMP Profile is associated with
	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttributeDto) List of Custom Attributes for CMP Profile
requestProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response
responseProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response
sharedSecret	string Shared secret for the CMP Request. Required when requestProtectionMethod is sharedSecret
signingCertificateUuid	string UUID of the Certificate to be used as signing certificate for CMP responses. Required when responseProtectionMethod is signature
name required	string Name of the CMP Profile
variant required	string Enum: "v2" "v2_3gpp" "v3" Variant of the CMP Profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample text description",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"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
}
]
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"sharedSecret": "string",
"signingCertificateUuid": "string",
"name": "Example CMP Profile",
"variant": "v2"
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile",
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"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
}
]
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"signingCertificate": {"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
}
}

Delete CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of CMP Profiles

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile"
}
]

Create CMP Profile

Request Body schema: application/json
required

description	string Description of the CMP Profile
raProfileUuid	string RA Profile UUID that the CMP Profile is associated with
	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate for the associated RA Profile. Required when raProfileUuid is provided
	Array of objects (RequestAttributeDto) List of Custom Attributes for CMP Profile
requestProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response
responseProtectionMethod required	string (ProtectionMethod) Enum: "sharedSecret" "signature" Protection Method for the CMP Response
sharedSecret	string Shared secret for the CMP Request. Required when requestProtectionMethod is sharedSecret
signingCertificateUuid	string UUID of the Certificate to be used as signing certificate for CMP responses. Required when responseProtectionMethod is signature
name required	string Name of the CMP Profile
variant required	string Enum: "v2" "v2_3gpp" "v3" Variant of the CMP Profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample text description",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"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
}
]
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"sharedSecret": "string",
"signingCertificateUuid": "string",
"name": "Example CMP Profile",
"variant": "v2"
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"variant": "v2",
"description": "Sample text description",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"cmpUrl": "https://your-domain.com/api/v1/protocols/cmp/cmpProfile",
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"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
}
]
}
],
"requestProtectionMethod": "sharedSecret",
"responseProtectionMethod": "sharedSecret",
"signingCertificate": {"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
}
}

Update RA Profile for CMP Profile

path Parameters

cmpProfileUuid required	string CMP Profile UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable CMP Profile

path Parameters

cmpProfileUuid

required

string

CMP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple CMP Profiles

Request Body schema: application/json
required

CMP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple CMP Profile

Request Body schema: application/json
required

CMP Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of certificates eligible for signing of CMP responses

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
}
]

Delete multiple CMP Profiles

Request Body schema: application/json
required

CMP Profile 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

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Force delete multiple CMP Profiles

Request Body schema: application/json
required

CMP Profile 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": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

CZERTAINLY CMP API (2.13.1)

CMP Profile Management

Get details of CMP Profile

path Parameters

Responses

Response samples

Edit CMP Profile

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete CMP Profile

path Parameters

Responses

Response samples

Get list of CMP Profiles

Responses

Response samples

Create CMP Profile

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update RA Profile for CMP Profile

path Parameters

Responses

Response samples

Enable CMP Profile

path Parameters

Responses

Response samples

Disable CMP Profile

path Parameters

Responses

Response samples

Enable multiple CMP Profiles

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Disable multiple CMP Profile

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get list of certificates eligible for signing of CMP responses

Responses

Response samples

Delete multiple CMP Profiles

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Force delete multiple CMP Profiles

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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