CZERTAINLY Compliance Profile API (2.13.1)
Download OpenAPI specification:Download
REST API for managing Compliance Profiles in the platform
Add Compliance Profile
Request Body schema: application/jsonrequired
| name required | string Name of the Compliance Profile |
| description | string Description of the Compliance Profile |
Array of objects (ComplianceProfileRulesRequestDto) Rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later | |
Array of objects (RequestAttributeDto) List of Custom Attributes |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "Profile 1",
- "description": "Profile 1",
- "rules": [
- {
- "connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120005",
- "kind": "x509",
- "rules": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "groups": [
- "string"
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}Response samples
- 201
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "uuid": "string"
}Delete multiple Compliance Profiles
Request Body schema: application/jsonrequired
Compliance 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
- 502
- 503
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]Add rule to a Compliance Profile
path Parameters
| uuid required | string Compliance Profile UUID |
Request Body schema: application/jsonrequired
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| ruleUuid required | string UUID of the rule |
Array of objects (RequestAttributeDto) Attributes for the rule |
Responses
Request samples
- Payload
Content type
application/json
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}Response samples
- 200
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "Sample rule description",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "groupUuid": "string",
- "certificateType": "X509",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "complianceProfileUuid": "string",
- "complianceProfileName": "string"
}Delete rule from a Compliance Profile
path Parameters
| uuid required | string Compliance Profile UUID |
Request Body schema: application/jsonrequired
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| ruleUuid required | string UUID of the rule |
Responses
Request samples
- Payload
Content type
application/json
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}Response samples
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Add group to a Compliance Profile
path Parameters
| uuid required | string Compliance Profile UUID |
Request Body schema: application/jsonrequired
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| groupUuid required | string UUID of the group |
Responses
Request samples
- Payload
Content type
application/json
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}Response samples
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Delete group from a Compliance Profile
path Parameters
| uuid required | string Compliance Profile UUID |
Request Body schema: application/jsonrequired
| connectorUuid required | string UUID of the Compliance Provider |
| kind required | string Kind of the Compliance Provider |
| groupUuid required | string UUID of the group |
Responses
Request samples
- Payload
Content type
application/json
{- "connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
- "kind": "default",
- "groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}Response samples
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Initiate Certificate Compliance Check
Request Body schema: application/jsonrequired
RA 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
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Disassociate Compliance Profile to RA Profile
path Parameters
| uuid required | string Compliance Profile UUID |
Request Body schema: application/jsonrequired
| raProfileUuids required | Array of strings List of UUIDs of RA Profiles to be associated |
Responses
Request samples
- Payload
Content type
application/json
{- "raProfileUuids": [
- "18324af0-e95c-11ec-8fea-0242ac120002",
- "18324c94-e95c-11ec-8fea-0242ac120002"
]
}Response samples
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Associate Compliance Profile to RA Profile
path Parameters
| uuid required | string Compliance Profile UUID |
Request Body schema: application/jsonrequired
| raProfileUuids required | Array of strings List of UUIDs of RA Profiles to be associated |
Responses
Request samples
- Payload
Content type
application/json
{- "raProfileUuids": [
- "18324af0-e95c-11ec-8fea-0242ac120002",
- "18324c94-e95c-11ec-8fea-0242ac120002"
]
}Response samples
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Details of a Compliance Profiles
path Parameters
| uuid required | string Compliance Profile UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "rules": [
- {
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "rules": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "Sample rule description",
- "certificateType": "X509",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
]
}
], - "groups": [
- {
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "Sample group description"
}
]
}
], - "raProfiles": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}Get Compliance rules
query Parameters
| complianceProvider | string |
| kind | string |
| certificateType | Array of strings (CertificateType) Items Enum: "X.509" "SSH" Example: certificateType=X509 |
Responses
Response samples
- 200
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
[- {
- "connectorName": "Provider1",
- "connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
- "kind": "Kind1",
- "rules": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Rule1",
- "certificateType": "X509",
- "attributes": [
- {
- "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": [
- null
], - "value": { }
}
]
}
}
], - "description": "Sample rule description"
}
]
}
]Response samples
- 200
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
[- {
- "connectorName": "Provider1",
- "connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
- "kind": "Kind1",
- "groups": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "RFC",
- "description": "Sample description of the group"
}
]
}
]Force delete Compliance Profiles
Request Body schema: application/jsonrequired
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "string"
]Response samples
- 200
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]