CZERTAINLY Authority API
Download OpenAPI specification:Download
REST API for managing Authorities in the platform
Validate RA Profile Attributes
path Parameters
uuid required | string Authority instance UUID |
Request Body schema: application/json
Array
uuid | string UUID of the Attribute |
name required | string Name of the Attribute |
content required | object Content of the Attribute |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "content": { }
}
]
Response samples
- 400
- 404
- 502
- 503
Content type
application/json
{- "message": "Error message"
}
Details of an Authority instance
path Parameters
uuid required | string Authority instance UUID |
Responses
Response samples
- 200
- 400
- 404
- 502
- 503
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": "STRING",
- "content": { }
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "LegacyEjbca, ADCS, etc."
}
Update Authority instance
path Parameters
uuid required | string Authority instance UUID |
Request Body schema: application/json
required | Array of objects (RequestAttributeDto) List of Authority instance Attributes | ||||||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "content": { }
}
]
}
Response samples
- 200
- 400
- 404
- 422
- 502
- 503
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": "STRING",
- "content": { }
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "LegacyEjbca, ADCS, etc."
}
Response samples
- 200
- 400
- 404
- 502
- 503
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": "STRING",
- "content": { }
}
], - "status": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "LegacyEjbca, ADCS, etc."
}
]
Add Authority instance
Request Body schema: application/json
name required | string Authority instance name |
required | Array of objects (RequestAttributeDto) List of Authority instance 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",
- "content": { }
}
], - "connectorUuid": "string",
- "kind": "LegacyEjbca, ADCS, etc"
}
Response samples
- 201
- 400
- 404
- 422
- 502
- 503
Content type
application/json
{- "uuid": "string"
}
Delete multiple Authority instances
Request Body schema: application/json
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
- 200
- 400
- 404
- 422
- 502
- 503
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]
Response samples
- 200
- 400
- 404
- 502
- 503
Content type
application/json
[- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "content": { },
- "label": "Attribute Name",
- "type": "STRING",
- "required": false,
- "readOnly": false,
- "visible": true,
- "list": false,
- "description": "string",
- "validationRegex": "string",
- "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "STRING",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}, - "multiSelect": false,
- "group": "requiredAttributes"
}
]