CZERTAINLY Uncategorized API (2.14.0)

Download OpenAPI specification:Download

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

Various uncategorized REST APIs of the platform

Audit Log

Audit Log API

List Audit logs

Request Body schema: application/json
required

	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

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403
404

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"items": [{"id": 0,
"version": "string",
"loggedAt": "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",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"names": ["string"
]
},
"affiliatedResource": {"type": "NONE",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"names": ["string"
]
},
"operation": "unknown",
"operationResult": "success",
"message": "string",
"operationData": { },
"additionalData": {"property1": { },
"property2": { }
}
}
]
}

Purge Audit logs

Request Body schema: application/json
required

Array

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 `GET /v1/{resource}/search`, e.g.: GET /v1/certificates/search
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" "SUCCESS" "FAILED" "UNKNOWN" "NOT_CHECKED" Condition for the search filter
value	object Value to match

Responses

Request samples

Payload

Content type

application/json

[{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Export Audit logs

Request Body schema: application/json
required

Array

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 `GET /v1/{resource}/search`, e.g.: GET /v1/certificates/search
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" "SUCCESS" "FAILED" "UNKNOWN" "NOT_CHECKED" Condition for the search filter
value	object Value to match

Responses

Request samples

Payload

Content type

application/json

[{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
]

Response samples

200
400
403
404

Content type

application/json

"string"

Get Audit logs searchable fields information

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

Enums

Enums API

Get platform enums

Responses

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

Resource Management

Resource Management API

Retrieve list of resources with information and settings

Responses

Response samples

200
400
403
404

Content type

application/json

[{"resource": "NONE",
"hasObjectAccess": true,
"hasCustomAttributes": true,
"hasGroups": true,
"hasOwner": true,
"hasEvents": true,
"hasRuleEvaluator": true
}
]

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" "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

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" "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
404

Content type

application/json

[{"event": "discoveryFinished",
"producedResource": "NONE"
}
]

Statistics/Dashboard

Statistics/Dashboard API

Get Dashboard/Statistics Details

Responses

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

Settings

Settings API

Get platform settings

Responses

Response samples

200
400
403
404

Content type

application/json

{"utils": {"utilsServiceUrl": "http://util-service:8080"
}
}

Update platform setting

Request Body schema: application/json
required

required

object (UtilsSettingsDto)

Utils settings of the platform

utilsServiceUrl

required

string

URL of the Util Service

Responses

Request samples

Payload

Content type

application/json

{"utils": {"utilsServiceUrl": "http://util-service:8080"
}
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get notification settings

Responses

Response samples

200
400
403
404

Content type

application/json

{"notificationsMapping": {"property1": "string",
"property2": "string"
}
}

Update notifications setting

Request Body schema: application/json
required

required

object

Map of notification instances where key is notification type enum

property name*

additional property

string

Map of notification instances where key is notification type enum

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

Get logging settings

Responses

Response samples

200
400
403
404

Content type

application/json

{"auditLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
],
"output": "NONE",
"resourceLogging": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
]
}
},
"eventLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
]
}
}

Update logging setting

Request Body schema: application/json
required

required	object (AuditLoggingSettingsDto) Settings of audit logging
required	object (ResourceLoggingSettingsDto) Settings of event logging

Responses

Request samples

Payload

Content type

application/json

{"auditLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
],
"output": "NONE",
"resourceLogging": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
]
}
},
"eventLogs": {"logAllModules": true,
"logAllResources": true,
"loggedModules": ["approvals"
],
"ignoredModules": ["approvals"
],
"loggedResources": ["NONE"
],
"ignoredResources": ["NONE"
]
}
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get authentication settings

Responses

Response samples

200
400
403
404

Content type

application/json

{"disableLocalhostUser": true,
"oauth2Providers": {"property1": {"name": "string",
"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 0
},
"property2": {"name": "string",
"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 0
}
}
}

Update authentication settings

Request Body schema: application/json
required

disableLocalhostUser required	boolean Disable using localhost user for requests from localhost
	Array of objects (OAuth2ProviderSettingsDto)

Responses

Request samples

Payload

Content type

application/json

{"disableLocalhostUser": true,
"oauth2Providers": [{"name": "string",
"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 0
}
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get OAuth2 Provider settings

path Parameters

providerName

required

string

OAuth2 Provider Name

Responses

Response samples

200
400
403
404

Content type

application/json

{"name": "string",
"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 0
}

Update OAuth2 Provider settings

path Parameters

providerName

required

string

OAuth2 Provider Name

Request Body schema: application/json
required

issuerUrl	string URL of issuer issuing authentication tokens. If provided, authentication via JWT token is enabled for this provider.
clientId required	string The client ID used to identify the client application during the authorization process.
clientSecret required	string The client secret used by the client application to authenticate with the authorization server.
authorizationUrl required	string The URL where the authorization server redirects the user for login and authorization.
tokenUrl required	string The URl used to exchange the authorization code or credentials for an access token.
jwkSetUrl required	string The URL where the JSON Web Key Set (JWKS) containing the public keys used to verify JWT tokens can be retrieved.
scope	Array of strings The list of scopes that define the access levels and permissions requested by the client application.
logoutUrl required	string URL to end session on provider side.
postLogoutUrl required	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> Duration in seconds after which will inactive user's session be terminated.

Responses

Request samples

Payload

Content type

application/json

{"issuerUrl": "string",
"clientId": "string",
"clientSecret": "string",
"authorizationUrl": "string",
"tokenUrl": "string",
"jwkSetUrl": "string",
"scope": ["string"
],
"logoutUrl": "string",
"postLogoutUrl": "string",
"userInfoUrl": "string",
"audiences": ["string"
],
"skew": 0,
"sessionMaxInactiveInterval": 0
}

Remove OAuth2 Provider

path Parameters

providerName

required

string

OAuth2 Provider Name

CZERTAINLY Uncategorized API (2.14.0)

Audit Log

List Audit logs

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Purge Audit logs

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Export Audit logs

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Audit logs searchable fields information

Responses

Response samples

Enums

Get platform enums

Responses

Response samples

Resource Management

Retrieve list of resources with information and settings

Responses

Response samples

Retrieve filter fields that can be used for creating rule conditions and actions

path Parameters

query Parameters

Responses

Response samples

Retrieve a list of all events that can be triggered by a resource

path Parameters

Responses

Response samples

Statistics/Dashboard

Get Dashboard/Statistics Details

Responses

Response samples

Settings

Get platform settings

Responses

Response samples

Update platform setting

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get notification settings

Responses

Response samples

Update notifications setting

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get logging settings

Responses

Response samples

Update logging setting

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get authentication settings

Responses

Response samples

Update authentication settings

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get OAuth2 Provider settings

path Parameters

Responses

Response samples

Update OAuth2 Provider settings

path Parameters

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