CZERTAINLY Administrator API

Download OpenAPI specification:Download

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

REST API for managing Administrators in the platform

Admin Management API

Admin Management API. Provides to Information regarding the Administrators in the platform With the Admin API, operations like addition, removal, enable etc... operations can be performed

Enable Administrator

path Parameters

uuid

required

string

Administrator UUID

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Disable Administrator

path Parameters

uuid

required

string

Administrator UUID

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Enable Multiple Administrator

Request Body schema: application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

Disable Multiple Administrator

Request Body schema: application/json

Admin 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

Content type

application/json

{"message": "Error message"
}

Get details of an Administrator

path Parameters

uuid

required

string

Administrator UUID

Responses

Response samples

200
400
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"username": "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"
},
"role": "administrator",
"email": "string",
"serialNumber": "string",
"description": "string",
"enabled": true,
"surname": "string"
}

Edit Administrator

path Parameters

uuid

required

string

Administrator UUID

Request Body schema: application/json

adminCertificate	string Base64 Content of the certificate
certificateUuid	string UUID of the existing certificate in inventory. Mandatory if the certificate is not provided.
name	string Name of the administrator
surname	string Administrator Surname
email	string Email Id of the admin
role	string Enum: "administrator" "superAdministrator" Role of the admin
description	string Description for the administrator

Responses

Request samples

Payload

Content type

application/json

{"adminCertificate": "string",
"certificateUuid": "string",
"name": "string",
"surname": "string",
"email": "string",
"role": "administrator",
"description": "string"
}

Response samples

200
400
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"username": "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"
},
"role": "administrator",
"email": "string",
"serialNumber": "string",
"description": "string",
"enabled": true,
"surname": "string"
}

Remove Administrator

path Parameters

uuid

required

string

Administrator UUID

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

List available administrators

Responses

Response samples

200
400
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"username": "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"
},
"role": "administrator",
"email": "string",
"serialNumber": "string",
"description": "string",
"enabled": true,
"surname": "string"
}
]

Create a new Administrator

Request Body schema: application/json

adminCertificate	string Base64 Content of the admin certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided
username required	string Username of the administrator
name required	string Name of the administrator
surname required	string Surname of the administrator
email required	string Email of the administrator
role required	string Enum: "administrator" "superAdministrator" Role of the administrator
enabled	boolean Default: false Enabled flag. true = enabled, false = disabled
description	string Description for the administrator

Responses

Request samples

Payload

Content type

application/json

{"adminCertificate": "string",
"certificateUuid": "string",
"username": "string",
"name": "string",
"surname": "string",
"email": "string",
"role": "administrator",
"enabled": false,
"description": "string"
}

Response samples

201
400
404
422

Content type

application/json

{"uuid": "string"
}

Remove Multiple Administrator

Request Body schema: application/json

Admin 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

Content type

application/json

{"message": "Error message"
}