CZERTAINLY Uncategorized API (2.16.0)
Download OpenAPI specification:Download
Various uncategorized REST APIs of the platform
Get custom OID entry by OID
Authorizations:
path Parameters
| oid required | string OID identifier |
Responses
Response samples
- 200
- 400
- 403
{- "oid": "string",
- "displayName": "string",
- "description": "string",
- "category": "rdnAttributeType",
- "additionalProperties": {
- "code": "string",
- "altCodes": [
- "string"
]
}
}Edit an existing custom OID entry
Authorizations:
path Parameters
| oid required | string OID identifier |
Request Body schema: application/jsonrequired
| displayName required | string Display name of the custom OID entry |
| description | string Description of the custom OID entry |
| category required | string (OidCategory) Enum: "rdnAttributeType" "extendedKeyUsage" "generic" Category of the OID entry. When updating OID entry, this property does not change the category and is instead used to determine type of additional properties. |
RdnAttributeTypeOidPropertiesDto (object) Additional properties depending on OID category |
Responses
Request samples
- Payload
{- "displayName": "string",
- "description": "string",
- "category": "rdnAttributeType",
- "additionalProperties": {
- "code": "string",
- "altCodes": [
- "string"
]
}
}Response samples
- 200
- 400
- 403
{- "oid": "string",
- "displayName": "string",
- "description": "string",
- "category": "rdnAttributeType",
- "additionalProperties": {
- "code": "string",
- "altCodes": [
- "string"
]
}
}Create a new custom OID entry
Authorizations:
Request Body schema: application/jsonrequired
| displayName required | string Display name of the custom OID entry |
| description | string Description of the custom OID entry |
| category required | string (OidCategory) Enum: "rdnAttributeType" "extendedKeyUsage" "generic" Category of the OID entry. When updating OID entry, this property does not change the category and is instead used to determine type of additional properties. |
RdnAttributeTypeOidPropertiesDto (object) Additional properties depending on OID category | |
| oid required | string^[0-2](\.(0|[1-9]\d*)){1,50}$ Object Identifier (OID) in dot notation (e.g., 1.2.840.113549.1.1.1) |
Responses
Request samples
- Payload
{- "displayName": "string",
- "description": "string",
- "category": "rdnAttributeType",
- "additionalProperties": {
- "code": "string",
- "altCodes": [
- "string"
]
}, - "oid": "1.2.840.113549.1.1.1"
}Response samples
- 200
- 400
- 403
{- "oid": "string",
- "displayName": "string",
- "description": "string",
- "category": "rdnAttributeType",
- "additionalProperties": {
- "code": "string",
- "altCodes": [
- "string"
]
}
}List custom OID entries with filtering and pagination
Authorizations:
Request Body schema: application/jsonrequired
Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
Responses
Request samples
- Payload
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}Response samples
- 200
- 400
- 403
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "oidEntries": [
- {
- "oid": "string",
- "displayName": "string",
- "description": "string",
- "category": "rdnAttributeType"
}
]
}Get searchable filter fields for custom OID entries
Authorizations:
Responses
Response samples
- 200
- 400
- 403
[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]List Audit logs
Authorizations:
Request Body schema: application/jsonrequired
Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: "10" Number of entries per page |
| pageNumber | integer <int32> Default: "1" Page number for the request |
Responses
Request samples
- Payload
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": "10",
- "pageNumber": "1"
}Response samples
- 200
- 400
- 403
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "items": [
- {
- "id": 0,
- "version": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "timestamp": "2019-08-24T14:15:22Z",
- "module": "approvals",
- "actor": {
- "type": "anonymous",
- "authMethod": "none",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string"
}, - "source": {
- "method": "string",
- "path": "string",
- "contentType": "string",
- "ipAddress": "string",
- "userAgent": "string"
}, - "resource": {
- "type": "NONE",
- "objects": [
- {
- "name": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
}, - "affiliatedResource": {
- "type": "NONE",
- "objects": [
- {
- "name": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
}, - "operation": "unknown",
- "operationResult": "success",
- "message": "string",
- "operationData": { },
- "additionalData": {
- "property1": { },
- "property2": { }
}
}
]
}Purge Audit logs
Authorizations:
Request Body schema: application/jsonrequired
| fieldSource required | string (FilterFieldSource) Enum: "meta" "custom" "data" "property" Field group of search filter |
| fieldIdentifier required | string Field identifier of search filter. List of available fields with their identifiers can be retrieved from corresponding endpoint |
| condition required | string (FilterConditionOperator) Enum: "EQUALS" "NOT_EQUALS" "GREATER" "GREATER_OR_EQUAL" "LESSER" "LESSER_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" "STARTS_WITH" "ENDS_WITH" "EMPTY" "NOT_EMPTY" "IN_NEXT" "IN_PAST" "MATCHES" "NOT_MATCHES" "COUNT_EQUAL" "COUNT_NOT_EQUAL" "COUNT_GREATER_THAN" "COUNT_LESS_THAN" Condition for the search filter |
| value | object Value to match |
Responses
Request samples
- Payload
[- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]Response samples
- 400
- 403
{- "message": "Error message"
}Export Audit logs
Authorizations:
Request Body schema: application/jsonrequired
| fieldSource required | string (FilterFieldSource) Enum: "meta" "custom" "data" "property" Field group of search filter |
| fieldIdentifier required | string Field identifier of search filter. List of available fields with their identifiers can be retrieved from corresponding endpoint |
| condition required | string (FilterConditionOperator) Enum: "EQUALS" "NOT_EQUALS" "GREATER" "GREATER_OR_EQUAL" "LESSER" "LESSER_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" "STARTS_WITH" "ENDS_WITH" "EMPTY" "NOT_EMPTY" "IN_NEXT" "IN_PAST" "MATCHES" "NOT_MATCHES" "COUNT_EQUAL" "COUNT_NOT_EQUAL" "COUNT_GREATER_THAN" "COUNT_LESS_THAN" Condition for the search filter |
| value | object Value to match |
Responses
Request samples
- Payload
[- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]Response samples
- 200
- 400
- 403
"string"Get Audit logs searchable fields information
Authorizations:
Responses
Response samples
- 200
- 400
- 403
[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]Response samples
- 200
- 400
- 403
{- "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 list of resources with information and settings
Authorizations:
Responses
Response samples
- 200
- 400
- 403
[- {
- "resource": "NONE",
- "hasObjectAccess": true,
- "hasCustomAttributes": true,
- "hasGroups": true,
- "hasOwner": true,
- "hasEvents": true,
- "hasRuleEvaluator": true,
- "complianceSubject": true,
- "hasComplianceProfiles": true
}
]Retrieve filter fields that can be used for creating rule conditions and actions
Authorizations:
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" Resource |
query Parameters
| settable | boolean |
Responses
Response samples
- 200
- 400
- 403
- 404
[- {
- "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
Authorizations:
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" Resource |
Responses
Response samples
- 200
- 400
- 403
[- {
- "event": "certificate_status_changed",
- "producedResource": "NONE"
}
]Retrieve a list of all events that can be triggered by all resources
This endpoint returns a map of resource events, where the key is the event type and the value is a list of event details.
Authorizations:
Responses
Response samples
- 200
- 400
- 403
{- "property1": [
- {
- "event": "certificate_status_changed",
- "producedResource": "NONE"
}
], - "property2": [
- {
- "event": "certificate_status_changed",
- "producedResource": "NONE"
}
]
}Get Dashboard/Statistics Details
Authorizations:
query Parameters
| includeArchived | boolean Default: false Include archived certificates in the statistics |
Responses
Response samples
- 200
- 400
- 403
{- "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
{- "certificates": {
- "validation": {
- "enabled": true,
- "frequency": 1,
- "expiringThreshold": 1
}
}
}Update platform settings
Authorizations:
Request Body schema: application/jsonrequired
object (UtilsSettingsDto) Utils settings of the platform | |
object (CertificateSettingsUpdateDto) Settings applicable to all certificates in inventory by default |
Responses
Request samples
- Payload
{- "certificates": {
- "validation": {
- "enabled": "true",
- "frequency": "1",
- "expiringThreshold": "30"
}
}
}Response samples
- 400
- 403
{- "message": "Error message"
}Response samples
- 200
- 400
- 403
{- "auditLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
], - "output": "NONE",
- "verbose": true
}, - "eventLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
]
}
}Update logging settings
Authorizations:
Request Body schema: application/jsonrequired
required | object (AuditLoggingSettingsDto) Settings of audit logging |
required | object (ResourceLoggingSettingsDto) Settings of event logging |
Responses
Request samples
- Payload
{- "auditLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
], - "output": "NONE",
- "verbose": true
}, - "eventLogs": {
- "logAllModules": true,
- "logAllResources": true,
- "loggedModules": [
- "approvals"
], - "ignoredModules": [
- "approvals"
], - "loggedResources": [
- "NONE"
], - "ignoredResources": [
- "NONE"
]
}
}Response samples
- 400
- 403
{- "message": "Error message"
}Update multiple events settings
Authorizations:
Request Body schema: application/jsonrequired
required | object Map of triggers associated to event where key is resource event enum and value is list of trigger UUIDs | ||
| |||
Responses
Request samples
- Payload
{- "eventsMapping": {
- "property1": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "property2": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}Response samples
- 400
- 403
{- "message": "Error message"
}Update single event settings
Authorizations:
Request Body schema: application/jsonrequired
| event required | string (ResourceEvent) Enum: "certificate_status_changed" "certificate_action_performed" "certificate_discovered" "certificate_expiring" "certificate_not_compliant" "discovery_finished" "approval_requested" "approval_closed" "scheduled_job_finished" Resource event |
| triggerUuids required | Array of strings <uuid> [ items <uuid > ] List of triggers associated with event |
Responses
Request samples
- Payload
{- "event": "certificate_status_changed",
- "triggerUuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Response samples
- 400
- 403
{- "message": "Error message"
}Response samples
- 200
- 400
- 403
{- "disableLocalhostUser": true,
- "oauth2Providers": {
- "property1": {
- "name": "string",
- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m"
}, - "property2": {
- "name": "string",
- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m"
}
}
}Update authentication settings
Authorizations:
Request Body schema: application/jsonrequired
| disableLocalhostUser required | boolean Disable using localhost user for requests from localhost |
Array of objects (OAuth2ProviderSettingsDto) |
Responses
Request samples
- Payload
{- "disableLocalhostUser": true,
- "oauth2Providers": [
- {
- "name": "string",
- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m"
}
]
}Response samples
- 400
- 403
{- "message": "Error message"
}Get OAuth2 Provider settings
Authorizations:
path Parameters
| providerName required | string OAuth2 Provider Name |
Responses
Response samples
- 200
- 400
- 403
{- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m",
- "name": "string",
- "jwkSetKeys": [
- {
- "kid": "string",
- "publicKey": "string",
- "keyType": "string",
- "algorithm": "string",
- "use": "string"
}
]
}Update OAuth2 Provider settings
Authorizations:
path Parameters
| providerName required | string OAuth2 Provider Name |
Request Body schema: application/jsonrequired
| issuerUrl | string URL of issuer issuing authentication tokens. If provided, authentication via JWT token is enabled for this provider. |
| clientId | string The client ID used to identify the client application during the authorization process. |
| clientSecret | string The client secret used by the client application to authenticate with the authorization server. |
| authorizationUrl | string The URL where the authorization server redirects the user for login and authorization. |
| tokenUrl | string The URl used to exchange the authorization code or credentials for an access token. |
| jwkSetUrl | string The URL where the JSON Web Key Set (JWKS) containing the public keys used to verify JWT tokens can be retrieved. |
| jwkSet | string Base64 encoded JWK Set, provided in case JWK Set URL is not available |
| scope | Array of strings The list of scopes that define the access levels and permissions requested by the client application. |
| logoutUrl | string URL to end session on provider side. |
| postLogoutUrl | string URL that user will be redirected after logout from application. |
| userInfoUrl | string The URL containing information about user. |
| audiences | Array of strings A list of expected audiences for validating the issued tokens, used to match the intended recipients of the tokens. |
| skew | integer <int32> The allowed time skew, in seconds, for token validation. This accounts for clock differences between systems. Default value is 30 seconds. |
| sessionMaxInactiveInterval | integer <int32> Default: "15m" Duration in seconds after which will inactive user's session be terminated. |
Responses
Request samples
- Payload
{- "issuerUrl": "string",
- "clientId": "string",
- "clientSecret": "string",
- "authorizationUrl": "string",
- "tokenUrl": "string",
- "jwkSetUrl": "string",
- "jwkSet": "string",
- "scope": [
- "string"
], - "logoutUrl": "string",
- "postLogoutUrl": "string",
- "userInfoUrl": "string",
- "audiences": [
- "string"
], - "skew": 0,
- "sessionMaxInactiveInterval": "15m"
}