CZERTAINLY Client API

Download OpenAPI specification:Download

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

REST API for managing Clients in the platform

Client Management API

Unauthorize Client

path Parameters

uuid required	string Client UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Enable a client

path Parameters

uuid

required

string

Client UUID

Responses

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable a client

path Parameters

uuid

required

string

Client UUID

Responses

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Authorize a client

path Parameters

uuid required	string Client UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Enable multiple client

Request Body schema: application/json

List of client UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable multiple client

Request Body schema: application/json

List of client UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Get the details of a client

path Parameters

uuid

required

string

Client UUID

Responses

Response samples

200
400
404
502
503

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"serialNumber": "string",
"certificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"certificateContent": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"basicConstraints": "string",
"meta": {"property1": { },
"property2": { }
},
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true
},
"fingerprint": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "STRING",
"content": { }
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": {"property1": { },
"property2": { }
},
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"withKey": false
}
],
"metadata": {"property1": { },
"property2": { }
}
}
],
"group": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
},
"owner": "string",
"certificateType": "X509",
"issuerSerialNumber": "string",
"certificateValidationResult": {"property1": {"status": "success",
"message": "string"
},
"property2": {"status": "success",
"message": "string"
}
},
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok"
}
],
"complianceStatus": "ok"
},
"description": "string",
"enabled": true
}

Edit a client

path Parameters

uuid

required

string

Client UUID

Request Body schema: application/json

description	string Description of the client
clientCertificate	string Base64 content of the certificate
certificateUuid	string UUID of the existing certificate in inventory. Required if the Certificate is not provided

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"clientCertificate": "string",
"certificateUuid": "string"
}

Response samples

200
400
404
502
503

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"serialNumber": "string",
"certificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"certificateContent": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"basicConstraints": "string",
"meta": {"property1": { },
"property2": { }
},
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true
},
"fingerprint": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "STRING",
"content": { }
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": {"property1": { },
"property2": { }
},
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"withKey": false
}
],
"metadata": {"property1": { },
"property2": { }
}
}
],
"group": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
},
"owner": "string",
"certificateType": "X509",
"issuerSerialNumber": "string",
"certificateValidationResult": {"property1": {"status": "success",
"message": "string"
},
"property2": {"status": "success",
"message": "string"
}
},
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok"
}
],
"complianceStatus": "ok"
},
"description": "string",
"enabled": true
}

Remove a client

path Parameters

uuid

required

string

Client UUID

Responses

Response samples

400
404
502
503

Content type

application/json

{"message": "Error message"
}

Get the list of all clients

Responses

Response samples

200
400
404
502
503

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"serialNumber": "string",
"certificate": {"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"certificateContent": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"basicConstraints": "string",
"meta": {"property1": { },
"property2": { }
},
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true
},
"fingerprint": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "STRING",
"content": { }
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": {"property1": { },
"property2": { }
},
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": { }
}
],
"withKey": false
}
],
"metadata": {"property1": { },
"property2": { }
}
}
],
"group": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
},
"owner": "string",
"certificateType": "X509",
"issuerSerialNumber": "string",
"certificateValidationResult": {"property1": {"status": "success",
"message": "string"
},
"property2": {"status": "success",
"message": "string"
}
},
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok"
}
],
"complianceStatus": "ok"
},
"description": "string",
"enabled": true
}
]

Add a new client

Request Body schema: application/json

clientCertificate	string Base64 content of the client certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Required if the Certificate is not provided
name required	string Name of the client
description	string Description of the Client
enabled	boolean Default: false Enabled flag. true = enabled, false = disabled

Responses

Request samples

Payload

Content type

application/json

{"clientCertificate": "string",
"certificateUuid": "string",
"name": "string",
"description": "string",
"enabled": false
}

Response samples

200
400
404
502
503

Content type

application/json

{"uuid": "string"
}

Remove multiple client

Request Body schema: application/json

Client UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
404
502
503

Content type

application/json

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

Get Authorized profiles

path Parameters

uuid

required

string

Responses

Response samples

200
400
404
502
503

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true
}
]