Download OpenAPI specification:Download
REST API for implementations of custom Compliance Provider
Compliance Provider API. Used to check the compliance of a certificate. The provider contains the list of rules for checking the compliance. The user can choose the list of compliance checks has to be performed. To check for the compliance of a certificate, the Connector accepts certificate content and the list of rule references. Once the values are received, compliance is checked and status will be returned
| kind required | string Connector Kind |
| certificate required | string Base64 encoded Certificate content |
Array of objects (ComplianceRequestRulesDto) List of UUIDs of Compliance rules |
{- "certificate": "string",
- "rules": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "attributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
]
}
]
}{- "status": "not_checked",
- "rules": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Rule1",
- "status": "ok"
}
]
}Connector Information API. Each connector may have multiple functions represented by FunctionGroupCode. For each FunctionGroupCode there is a list of implemented end points. These endpoints must be according the specified interface, this is validated by the core. You can also implement helper end points that are used for callbacks and other relevant operations specific to implementation.
Returns map of functional code and implemented end points
[- {
- "functionGroupCode": "credentialProvider",
- "kinds": [
- "SoftKeyStore",
- "Basic",
- "ApiKey"
], - "endPoints": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "context": "/v1",
- "method": "POST",
- "required": true
}
]
}
]Connector Health check API. Connector returns own status and in some cases can return status of services on which it depends like database, HSM and so on.
Compliance Provider rules API. Used to get the list of rules provided by the connector. These rules will be made available for the users to choose from the list.To check for the compliance of a certificate, the Connector accepts certificate content and the list of rule references. Once the values are received, compliance is checked based on the rules.
| kind required | string Connector kind |
[- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "groupUuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Rule1",
- "certificateType": "X.509",
- "attributes": [
- {
- "name": "Attribute",
- "type": "data",
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "description": "string",
- "version": 0,
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes",
- "required": false,
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "protectionLevel": "none",
- "resource": "certificates",
- "extensibleList": 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": null
}
]
}
}
], - "description": "Sample rule description"
}
]| kind required | string Connector kind |
[- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "RFC",
- "description": "Sample description of the group"
}
]| kind required | string Connector kind |
| uuid required | string Group kind |
[- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "groupUuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Rule1",
- "certificateType": "X.509",
- "attributes": [
- {
- "name": "Attribute",
- "type": "data",
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "description": "string",
- "version": 0,
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes",
- "required": false,
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "protectionLevel": "none",
- "resource": "certificates",
- "extensibleList": 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": null
}
]
}
}
], - "description": "Sample rule description"
}
]Connector Attributes API. Provides information about supported Attributes of the connector. Attributes are specific to implementation and gives information about the data that can be exchanged and properly parsed by the connector. Part of this API is validation of the Attributes.
| functionalGroup required | string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider" Function Group |
| kind required | string Kind |
| uuid required | string <uuid> UUID of the Attribute |
| name required | string Name of the Attribute |
| contentType required | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute |
Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2) | |
| version required | string (AttributeVersion) Version of the Attribute |
[- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
]{- "message": "Error message"
}| functionalGroup required | string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider" Function Group |
| kind required | string Kind |
[- {
- "name": "Attribute",
- "type": "data",
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "description": "string",
- "version": 0,
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes",
- "required": false,
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "protectionLevel": "none",
- "resource": "certificates",
- "extensibleList": 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": null
}
]
}
}
]