CZERTAINLY Authority API (2.13.1)

Download OpenAPI specification:Download

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

REST API for managing Authorities in the platform

CZERTAINLY Documentation

Authority Management

Authority Management API

Details of an Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}

Edit Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttributeDto) List of Authority instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}

Delete Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List of available Authority instances

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}
]

Add Authority instance

Request Body schema: application/json
required

name required	string Authority instance name
required	Array of objects (RequestAttributeDto) List of Authority instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes
connectorUuid required	string UUID of Authority provider
kind required	string Authority instance Kind

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"connectorUuid": "string",
"kind": "LegacyEjbca, ADCS, etc"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Authority instances

Request Body schema: application/json
required

Authority Instance UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Validate RA Profile Attributes

path Parameters

uuid

required

string

Authority instance UUID

Request Body schema: application/json
required

Array

uuid required	string 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" Type of the attribute content.
required	Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

listEntityProfiles

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

listCertificateProfiles

path Parameters

uuid required	string Authority instance UUID
endEntityProfileId required	integer <int32>

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

listCAsInProfile

path Parameters

uuid required	string Authority instance UUID
endEntityProfileId required	integer <int32>

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

List RA Profile Attributes

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Force delete multiple Authority instances

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

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

CZERTAINLY Authority API (2.13.1)

Authority Management

Details of an Authority instance

path Parameters

Responses

Response samples

Edit Authority instance

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Authority instance

path Parameters

Responses

Response samples

List of available Authority instances

Responses

Response samples

Add Authority instance

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete multiple Authority instances

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate RA Profile Attributes

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

listEntityProfiles

path Parameters

Responses

Response samples

listCertificateProfiles

path Parameters

Responses

Response samples

listCAsInProfile

path Parameters

Responses

Response samples

List RA Profile Attributes

path Parameters

Responses

Response samples

Force delete multiple Authority instances

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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