CZERTAINLY Compliance v2 API (2.16.0)

Download OpenAPI specification:Download

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

REST API for managing Compliance Profiles v2 and check compliance v2

CZERTAINLY Documentation

Compliance Profile Management v2

Compliance Profile Management v2 API

Details of a Compliance Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"internalRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"rules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
],
"groups": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE"
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Update Compliance Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Request Body schema: application/json
required

description	string Description of the Compliance Profile
internalRules	Array of strings <uuid> unique [ items <uuid > ] UUIDs of internal rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later.
	Array of objects (ProviderComplianceRulesRequestDto) Provider 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

{"description": "Profile 1",
"internalRules": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"rules": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"groups": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"internalRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"rules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
],
"groups": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE"
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete Compliance Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Responses

Update Compliance internal rule

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

internalRuleUuid

required

string <uuid>

Compliance internal rule UUID

Request Body schema: application/json
required

name required	string Name of the compliance internal rule
description	string Description of the compliance internal rule
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the compliance internal rule
required	Array of objects (ConditionItemRequestDto) List of the condition items to add to compliance internal rule

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"version": "2",
"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": "true",
"group": "requiredAttributes",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}

Delete Compliance internal rule

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

internalRuleUuid

required

string <uuid>

Compliance internal rule UUID

Responses

List of available Compliance Profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"providerRulesCount": 0,
"providerGroupsCount": 0,
"internalRulesCount": 0,
"associations": 0
}
]

Add Compliance Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

description	string Description of the Compliance Profile
internalRules	Array of strings <uuid> unique [ items <uuid > ] UUIDs of internal rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later.
	Array of objects (ProviderComplianceRulesRequestDto) Provider 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
name required	string Name of the Compliance Profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Profile 1",
"internalRules": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"rules": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"groups": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"name": "Profile 1"
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"internalRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
],
"providerRules": [{"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"rules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
],
"groups": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"availabilityStatus": "available",
"updatedReason": "string",
"resource": "NONE"
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete multiple Compliance Profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

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

Content type

application/json

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

Get Compliance rules

Lists compliance rules. If provider UUID is sent (also kind is required) then provider rules are listed, otherwise lists internal rules

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

connectorUuid	string <uuid>
kind	string
resource	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"
type	string
format	string

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"version": "2",
"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": "true",
"group": "requiredAttributes",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
]

Create Compliance internal rule

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the compliance internal rule
description	string Description of the compliance internal rule
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Resource associated with the compliance internal rule
required	Array of objects (ConditionItemRequestDto) List of the condition items to add to compliance internal rule

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"resource": "NONE",
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"version": "2",
"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": "true",
"group": "requiredAttributes",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}

Add/remove compliance rule to/from Compliance Profile

If provider UUID is sent (also kind is required) then provider rules is handled, otherwise handling internal rule

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Request Body schema: application/json
required

removal required	boolean Indicates if removing or adding rule with UUID specified in request
ruleUuid required	string <uuid> UUID of the rule
connectorUuid	string <uuid> UUID of the Compliance Provider
kind	string Kind of the Compliance Provider
	Array of objects (RequestAttributeDto) Attributes for the rule

Responses

Request samples

Payload

Content type

application/json

{"removal": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"kind": "default",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Add/remove group to/from Compliance Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Request Body schema: application/json
required

removal required	boolean Indicates if removing or adding group with UUID specified in request
groupUuid required	string <uuid> UUID of the group
connectorUuid required	string <uuid> UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider

Responses

Request samples

Payload

Content type

application/json

{"removal": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"kind": "default"
}

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Disassociate Compliance Profile from specified resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string <uuid> Compliance Profile UUID
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Example: raProfiles Resource
associationObjectUuid required	string <uuid> Association object UUID

Responses

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Associate Compliance Profile to specified resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string <uuid> Compliance Profile UUID
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" Example: raProfiles Resource
associationObjectUuid required	string <uuid> Association object UUID

Responses

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Get associations of Compliance Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Compliance Profile UUID

Responses

Response samples

Content type

application/json

[{"resource": "NONE",
"objectUuid": "2dcc528b-9e16-46c6-877e-74eae258173f",
"name": "Name"
}
]

Get Compliance groups

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

connectorUuid required	string <uuid>
kind required	string
resource	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample group description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"resource": "NONE"
}
]

Get Compliance group rules

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

groupUuid

required

string <uuid>

query Parameters

connectorUuid required	string <uuid>
kind required	string

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"kind": "string",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"resource": "NONE",
"type": "X.509",
"format": "pkcs7",
"attributes": [{"version": "2",
"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": "true",
"group": "requiredAttributes",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"conditionItems": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"operator": "EQUALS",
"value": { }
}
]
}
]

Get associated Compliance Profiles for resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

associationObjectUuid

required

string <uuid>

Association object UUID

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"providerRulesCount": 0,
"providerGroupsCount": 0,
"internalRulesCount": 0,
"associations": 0
}
]

Force delete Compliance Profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type

application/json

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

Compliance Management v2

Compliance Management v2 API

Initiate compliance check for requested compliance profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

resource

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Filter objects checked by compliance based on its resource and evaluate only rules applicable to that resource

type

string

Example: type=X.509

Filter objects checked by compliance based on its type and evaluate only rules applicable to that resource type

Request Body schema: application/json
required

Compliance Profile UUIDs

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Initiate compliance Check for requested resource objects

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

Request Body schema: application/json
required

Resource object UUIDs

Array

string <uuid>

Responses

Request samples

Payload

Content type

application/json

["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Get the latest compliance check result for the specified resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

objectUuid

required

string <uuid>

Object UUID

Responses

Response samples

Content type

application/json

{"status": "not_checked",
"timestamp": "2019-08-24T14:15:22Z",
"message": "string",
"failedRules": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "Sample rule description",
"status": "ok",
"connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
"connectorName": "string",
"kind": "string",
"resource": "NONE",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
]
}

Initiate compliance Check for requested resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Example: raProfiles

Resource

objectUuid

required

string <uuid>

Object UUID

CZERTAINLY Compliance v2 API (2.16.0)

Compliance Profile Management v2

Details of a Compliance Profile

Authorizations:

path Parameters

Responses

Response samples

Update Compliance Profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Compliance Profile

Authorizations:

path Parameters

Responses

Update Compliance internal rule

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Compliance internal rule

Authorizations:

path Parameters

Responses

List of available Compliance Profiles

Authorizations:

Responses

Response samples

Add Compliance Profile

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete multiple Compliance Profiles

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Compliance rules

Authorizations:

query Parameters

Responses

Response samples

Create Compliance internal rule

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Add/remove compliance rule to/from Compliance Profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Add/remove group to/from Compliance Profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Disassociate Compliance Profile from specified resource object

Authorizations:

path Parameters

Responses

Response samples

Associate Compliance Profile to specified resource object

Authorizations:

path Parameters

Responses

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

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required