Cryptographic Key API (2.17.0)

Download OpenAPI specification:Download

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

REST API for managing keys in the platform

Cryptographic Key Management

Cryptographic Key Management API

Update Key Usage with Token Instance Deprecated

If the request body provided, only those key items will be updated. If the request body is not provided or given empty, then the entire key will be updated

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Cryptographic Key Detail

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

UUID of the Key

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

Edit Key

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json
required

tokenProfileUuid	string UUID of the token profile
name required	string Name of the Cryptographic Key
description required	string Description of the Cryptographic Key
ownerUuid	string Key Owner UUID
groupUuids	Array of strings UUIDs of the groups to associate with key
	Array of objects (RequestAttribute) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"tokenProfileUuid": "string",
"name": "string",
"description": "string",
"ownerUuid": "string",
"groupUuids": ["string"
],
"customAttributes": [{"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",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

Delete Cryptographic Key

If the request body provided, only those key items will be deleted. If the request body is not provided or given empty, then the entire key will be destroyed

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Key Usage

If the request body provided, only those key items will be updated. If the request body is not provided or given empty, then the entire key will be updated

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Key Usages for Multiple Keys

Update the key usages for multiple keys and all the items inside it

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids required	Array of strings <uuid> [ items <uuid > ] Key UUIDs

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Update Key Usages for Multiple Key Items

Update the key usages for multiple keys Items

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

usage required	Array of strings (KeyUsage) Items Enum: "sign" "verify" "encrypt" "decrypt" "wrap" "unwrap" Usages for the Key
uuids required	Array of strings <uuid> [ items <uuid > ] Key Item UUIDs

Responses

Request samples

Payload

Content type

application/json

{"usage": ["sign"
],
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Create a new Cryptographic Key

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string UUID of the Token Instance
tokenProfileUuid required	string UUID of the Token Profile
type required	string (KeyRequestType) Enum: "secret" "keyPair" Type of the key to be created

Request Body schema: application/json
required

name required	string Name of the Cryptographic Key
description required	string Description of the Cryptographic Key
groupUuids	Array of strings UUIDs of the groups to associate with key
required	Array of objects (RequestAttribute) List of Attributes to create a Key
	Array of objects (RequestAttribute) Custom Attributes for the key
enabled	boolean Default: false Enabled status of created key. True = Enabled, False = Disabled

Responses

Request samples

Payload

Content type

application/json

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

Response samples

201
400
403
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

List cryptographic keys

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403

Content type

application/json

{"cryptographicKeys": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Delete Multiple Cryptographic Key

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Sync Keys from connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid

required

string

Token Instance UUID

Responses

Enable Key with Token Instance Deprecated

If the request body provided, only those key items will be enabled. If the request body is not provided or given empty, then the entire key will be enabled

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable Key with Token Instance Deprecated

If the request body provided, only those key items will be disabled. If the request body is not provided or given empty, then the entire key will be disabled

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Destroy Cryptographic Key with Token Instance Deprecated

If the request body provided, only those key items will be destroyed. If the request body is not provided or given empty, then the entire key will be destroyed

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Mark Key and its Items as Compromised with Token Instance Deprecated

If the request body is provided with the UUID of the items of Key, then only those itemswill be compromised. Else all the sub items of the key will be compromised

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Cryptographic Key Detail

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string UUID of the Key
keyItemUuid required	string UUID of the Key Item

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}

Edit Key Item

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Request Body schema: application/json
required

name

required

string

Name of the key item

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

422

Content type

*/*

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

Enable Key

If the request body provided, only those key items will be enabled. If the request body is not provided or given empty, then the entire key will be enabled

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable Key

If the request body provided, only those key items will be disabled. If the request body is not provided or given empty, then the entire key will be disabled

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Destroy Cryptographic Key

If the request body provided, only those key items will be destroyed. If the request body is not provided or given empty, then the entire key will be destroyed

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Mark Key and its Items as Compromised

If the request body is provided with the UUID of the items of Key, then only those itemswill be compromised. Else all the sub items of the key will be compromised

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Key UUID

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the key Items. If not provided, the usage will be updated to all the itemsin the key

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple Key Items

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Disable multiple Key Items

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Destroy Multiple Cryptographic Key items

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Mark Multiple Key Items as Compromised

This API can be used to mark multiple keys items to be marked as compromised.

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of Key Item UUID

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Enable multiple Keys

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Disable multiple Keys

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Destroy Multiple Cryptographic Key and its items

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Mark Multiple Key and all its Items as Compromised

This API can be used to mark multiple keys and its sub items to be marked as compromised.Specific part of the key cannot be mentioned in this API

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

reason required	string (KeyCompromiseReason) Enum: "disclosure" "modification" "substitution" "use_of_sensitive_data" Usages for the Key
uuids	Array of strings <uuid> [ items <uuid > ] List of UUIDs of the keys. This will mark all the items inside the selected key as compromised

Responses

Request samples

Payload

Content type

application/json

{"reason": "disclosure",
"uuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

List of Attributes to create a Key

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string Token Instance UUID
tokenProfileUuid required	string Token Profile UUID
type required	string (KeyRequestType) Enum: "secret" "keyPair" Type of the key to be created

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 Cryptographic Key Detail with Token Instance Deprecated

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string UUID of the Token Instance
uuid required	string UUID of the Key

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"attributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}
],
"associations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"resource": "NONE"
}
],
"complianceStatus": "not_checked"
}

Delete Cryptographic Key with Token Instance Deprecated

If the request body provided, only those key items will be deleted. If the request body is not provided or given empty, then the entire key will be destroyed

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string Token Instance UUID
uuid required	string Key UUID

Request Body schema: application/json

Key Item UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Cryptographic Key Detail with Token Instance Deprecated

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

tokenInstanceUuid required	string UUID of the Token Instance
uuid required	string UUID of the Key
keyItemUuid required	string UUID of the Key Item

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"keyData": "string",
"length": 0,
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
],
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"reason": "disclosure",
"complianceStatus": "not_checked"
}

Get Key Item event history with Token Instance Deprecated

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

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

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"keyUuid": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"event": "Create Key",
"status": "SUCCESS",
"message": "string",
"additionalInformation": {"property1": null,
"property2": null
}
}
]

Get Key Item event history

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string Key UUID
keyItemUuid required	string Key Item UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"keyUuid": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"event": "Create Key",
"status": "SUCCESS",
"message": "string",
"additionalInformation": {"property1": null,
"property2": null
}
}
]

Get CryptographicKey searchable fields information

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

200
400
403

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": null,
"multiValue": true
}
]
}
]

List Cryptographic Keys with full Key Pairs

This API contains the logic to get the keys that contains the full key pair (private and public Key)

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

tokenProfileUuid

string

Responses

Response samples

200
400
403

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"creationTime": "2019-08-24T14:15:22Z",
"keyWrapperUuid": "string",
"tokenProfileUuid": "string",
"tokenProfileName": "string",
"tokenInstanceUuid": "string",
"tokenInstanceName": "string",
"owner": "string",
"ownerUuid": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"email": "string",
"customAttributes": [{"content": [{"reference": null,
"data": null
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"associations": 0,
"keyReferenceUuid": "string",
"type": "Secret",
"keyAlgorithm": "RSA",
"format": "Raw",
"length": 0,
"usage": ["sign"
],
"enabled": true,
"state": "pre-active",
"complianceStatus": "not_checked"
}
],
"associations": 0,
"complianceStatus": "not_checked"
}
]

Delete Multiple Cryptographic Key Items

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Key Items UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

400
403

Content type

application/json

{"message": "Error message"
}

Cryptographic Key API (2.17.0)

Cryptographic Key Management

Update Key Usage with Token Instance Deprecated

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Cryptographic Key Detail

Authorizations:

path Parameters

Responses

Response samples

Edit Key

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Cryptographic Key

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Update Key Usage

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Key Usages for Multiple Keys

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update Key Usages for Multiple Key Items

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create a new Cryptographic Key

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List cryptographic keys

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Multiple Cryptographic Key

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Sync Keys from connector

Authorizations:

path Parameters

Responses

Enable Key with Token Instance Deprecated

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Disable Key with Token Instance Deprecated

Authorizations:

path Parameters

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