CZERTAINLY Cryptographic Operations API (2.13.1)

Download OpenAPI specification:Download

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

REST API for Cryptographic Operations

Cryptographic Operations Controller

Cryptographic Operations Controller API

Verify data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttributeDto) List of signature Attributes
required	Array of objects (SignatureRequestData) Data to be signed
required	Array of objects (SignatureRequestData) Signatures to verify

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
404
422

Content type

application/json

{"verifications": [{"result": true,
"identifier": "customId",
"details": { }
}
]
}

Sign data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttributeDto) List of signature Attributes
required	Array of objects (SignatureRequestData) Data to be signed

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
404
422

Content type

application/json

{"signatures": [{"data": "string",
"identifier": "customId",
"details": { }
}
]
}

Encrypt data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttributeDto) List of cipher Attributes
required	Array of objects (CipherRequestData) Encrypted/decrypted data

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
404
422

Content type

application/json

{"encryptedData": [{"data": "string",
"identifier": "customId",
"details": { }
}
]
}

Decrypt data using a Key

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttributeDto) List of cipher Attributes
required	Array of objects (CipherRequestData) Encrypted/decrypted data

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
404
422

Content type

application/json

{"decryptedData": [{"data": "string",
"identifier": "customId",
"details": { }
}
]
}

Generate random data

path Parameters

tokenInstanceUuid

required

string

Token Instance UUID

Request Body schema: application/json
required

length required	integer <int32> Number of random bytes to generate
	Array of objects (RequestAttributeDto) Random generator Attributes

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
404
422

Content type

application/json

{"data": "string"
}

List of signature Attributes

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key instance UUID
keyItemUuid required	string Key Item UUID
algorithm required	string (KeyAlgorithm) Enum: "RSA" "ECDSA" "FALCON" "CRYSTALS-Dilithium" "SPHINCS+" Cryptographic algorithm

Responses

Response samples

200
400
403
404

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": { }
}
]
}
}
]

List of cipher Attributes

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
uuid required	string Key UUID
keyItemUuid required	string Key Item UUID
algorithm required	string (KeyAlgorithm) Enum: "RSA" "ECDSA" "FALCON" "CRYSTALS-Dilithium" "SPHINCS+" Cryptographic algorithm

Responses

Response samples

200
400
403
404

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": { }
}
]
}
}
]

List of random generator Attributes

path Parameters

tokenInstanceUuid

required

string

Token Instance UUID

Responses

Response samples

200
400
403
404

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": { }
}
]
}
}
]

CZERTAINLY Cryptographic Operations API (2.13.1)

Cryptographic Operations Controller

Verify data using a Key

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign data using a Key

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Encrypt data using a Key

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Decrypt data using a Key

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Generate random data

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List of signature Attributes

path Parameters

Responses

Response samples

List of cipher Attributes

path Parameters

Responses

Response samples

List of random generator Attributes

path Parameters

Responses

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