CZERTAINLY Uncategorized API (2.13.1)
Download OpenAPI specification:Download
Various uncategorized REST APIs of the platform
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "items": [
- {
- "id": 0,
- "uuid": "string",
- "author": "string",
- "created": "2019-08-24T14:15:22Z",
- "operationStatus": "SUCCESS",
- "origination": "ACCESS",
- "affected": "ACCESS",
- "objectIdentifier": "string",
- "operation": "CREATE",
- "additionalData": "string"
}
]
}Response samples
- 200
- 400
- 404
Content type
application/json
{- "property1": {
- "property1": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}, - "property2": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}
}, - "property2": {
- "property1": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}, - "property2": {
- "code": "X509",
- "label": "X.509",
- "description": "X.509 Certificate type"
}
}
}Retrieve filter fields that can be used for creating rule conditions and actions
path Parameters
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" Example: certificates Resource |
query Parameters
| settable | boolean |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]Retrieve a list of all events that can be triggered by a resource
path Parameters
| resource required | string (Resource) Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" Example: certificates Resource |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
[- {
- "event": "discoveryFinished",
- "producedResource": "certificates"
}
]Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "totalCertificates": 0,
- "totalGroups": 0,
- "totalDiscoveries": 0,
- "totalConnectors": 0,
- "totalRaProfiles": 0,
- "totalCredentials": 0,
- "totalAuthorities": 0,
- "totalAdministrators": 0,
- "totalClients": 0,
- "groupStatByCertificateCount": {
- "property1": 0,
- "property2": 0
}, - "raProfileStatByCertificateCount": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByType": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByExpiry": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByKeySize": {
- "property1": 0,
- "property2": 0
}, - "certificateStatBySubjectType": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByState": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByValidationStatus": {
- "property1": 0,
- "property2": 0
}, - "certificateStatByComplianceStatus": {
- "property1": 0,
- "property2": 0
}, - "connectorStatByStatus": {
- "property1": 0,
- "property2": 0
}, - "raProfileStatByStatus": {
- "property1": 0,
- "property2": 0
}, - "administratorStatByStatus": {
- "property1": 0,
- "property2": 0
}, - "clientStatByStatus": {
- "property1": 0,
- "property2": 0
}
}Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{
}Update platform setting
Request Body schema: application/jsonrequired
required | object (UtilsSettingsDto) Utils settings of the platform | ||
| |||
Responses
Request samples
- Payload
Content type
application/json
{
}Response samples
- 400
- 403
- 404
Content type
application/json
{- "message": "Error message"
}Update notifications setting
Request Body schema: application/jsonrequired
required | object Type settings of the notification | ||
| |||
Responses
Request samples
- Payload
Content type
application/json
{- "notificationsMapping": {
- "property1": "string",
- "property2": "string"
}
}Response samples
- 400
- 403
- 404
Content type
application/json
{- "message": "Error message"
}