Cryptography Provider API (2.17.0)

Download OpenAPI specification:Download

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for implementations of custom Cryptography Provider

Connector Info

Connector Information API. Each connector may have multiple functions represented by FunctionGroupCode. For each FunctionGroupCode there is a list of implemented end points. These endpoints must be according the specified interface, this is validated by the core. You can also implement helper end points that are used for callbacks and other relevant operations specific to implementation.

List supported functions of the connector

Returns map of functional code and implemented end points

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
]
}
]

Cryptographic Operations

Cryptographic Operations API defines operations that can be executed on existing cryptographic Keys.

Verify data using a Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid required	string Token instance UUID
keyUuid required	string Key UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) 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": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"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": null
}
]
}

Sign data using a Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid required	string Token instance UUID
keyUuid required	string Key UUID

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

{"signatureAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"data": [{"data": "string",
"identifier": "customId"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

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

Encrypt data using a Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid required	string Token instance UUID
keyUuid required	string Key UUID

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

{"cipherAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"cipherData": [{"data": "string",
"identifier": "customId"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

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

Decrypt data using a Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid required	string Token instance UUID
keyUuid required	string Key UUID

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

{"cipherAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"cipherData": [{"data": "string",
"identifier": "customId"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

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

Generate random data

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

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

Responses

Request samples

Payload

Content type

application/json

{"length": 0,
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"data": "string"
}

Validate random generator Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

List of random generator Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Health check

Connector Health check API. Connector returns own status and in some cases can return status of services on which it depends like database, HSM and so on.

Health check

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
400
403
404

Content type

application/json

{"status": "ok",
"description": "string",
"parts": {"property1": { },
"property2": { }
}
}

Token Management

Token Management API is used to manage Token instance created from Cryptography Providers. Token represents connection with key stores that can perform cryptographic operations. It can manage one or more key stores, or it can be used with external key stores, such as vaults, hardware security modules, etc. Token Profile represents particular key store that can be used to execute cryptographic operations and key management through the Token instance.

List Token instances

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}
]

Create Token instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

name required	string Token instance name
kind required	string Kind of Token instance
required	Array of objects (RequestAttribute) List of Token instance Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Get Token instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Update Token instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

name required	string Token instance name
kind required	string Kind of Token instance
required	Array of objects (RequestAttribute) List of Token instance Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Remove Token instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Validate Token Profile Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate Token activation Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Deactivate Token

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Activate Token

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Token Profile Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get Token instance status

Returns the connection status of the Token instance including additional information that might be useful

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"status": "Connected",
"components": {"property1": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "Connected",
"details": {"property1": null,
"property2": null
}
}
}
}

List Token activation Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Key Management

Key Management API for cryptographic key management operations. Each key is managed by a specific token that is connected through the Token instance.

Create a Secret Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of Token Profile Attributes
required	Array of objects (RequestAttribute) List of Attributes to create a Key

Responses

Request samples

Payload

Content type

application/json

{"tokenProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"createKeyAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"association": "string",
"keyData": {"type": "Secret",
"algorithm": "RSA",
"format": "Raw",
"value": {"values": {"property1": "string",
"property2": "string"
}
},
"length": 0,
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}
}

Validate list of Attributes to create a Secret Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

Create a Key Pair, Public and Private Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of Token Profile Attributes
required	Array of objects (RequestAttribute) List of Attributes to create a Key

Responses

Request samples

Payload

Content type

application/json

{"tokenProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"createKeyAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"publicKeyData": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"association": "string",
"keyData": {"type": "Secret",
"algorithm": "RSA",
"format": "Raw",
"value": {"values": {"property1": "string",
"property2": "string"
}
},
"length": 0,
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}
},
"privateKeyData": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"association": "string",
"keyData": {"type": "Secret",
"algorithm": "RSA",
"format": "Raw",
"value": {"values": {"property1": "string",
"property2": "string"
}
},
"length": 0,
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}
}
}

Validate list of Attributes to create a Key Pair

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

List Keys for the Token instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404
422

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"association": "string",
"keyData": {"type": "Secret",
"algorithm": "RSA",
"format": "Raw",
"value": {"values": {"property1": "string",
"property2": "string"
}
},
"length": 0,
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}
}
]

Get details about the Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid required	string Token instance UUID
keyUuid required	string Key UUID

Responses

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"association": "string",
"keyData": {"type": "Secret",
"algorithm": "RSA",
"format": "Raw",
"value": {"values": {"property1": "string",
"property2": "string"
}
},
"length": 0,
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}
}

Destroy a Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid required	string Token instance UUID
keyUuid required	string Key UUID

Responses

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

List of Attributes to create a Secret Key

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

List of Attributes to create a Key Pair

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Token instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Connector Attributes

Connector Attributes API. Provides information about supported Attributes of the connector. Attributes are specific to implementation and gives information about the data that can be exchanged and properly parsed by the connector. Part of this API is validation of the Attributes.

Validate Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

functionalGroup required	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider" Function Group
kind required	string Kind

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

List available Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

functionalGroup required	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider" Function Group
kind required	string Kind

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Cryptography Provider API (2.17.0)

Connector Info

List supported functions of the connector

Authorizations:

Responses

Response samples

Cryptographic Operations

Verify data using a Key

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sign data using a Key

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Encrypt data using a Key

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Decrypt data using a Key

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Generate random data

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate random generator Attributes

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List of random generator Attributes

Authorizations:

path Parameters

Responses

Response samples

Health check

Health check

Authorizations:

Responses

Response samples

Token Management

List Token instances

Authorizations:

Responses

Response samples

Create Token instance

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Token instance

Authorizations:

path Parameters

Responses

Response samples

Update Token instance

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

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

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

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required