Skip to main content

List Encryption

This API returns a list of encryption configurations available within the specified tenant.

Endpoint Details

URL/v1/crypto/items
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Response

Here is an example of a response when viewing a list of data:

Response
{
"items": [
{
"id": "8471d88d-feda-4d0f-bb39-7f45d8976b94",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Dummy",
"algorithm": "RSA1024",
"lock_ring_id": "crypto/8471d88d-feda-4d0f-bb39-7f45d8976b94",
"current_version": 1,
"group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_at": 1782274352,
"updated_at": 1782274352,
"assigned_user_ids": [
"0a937c60-0ed4-4d06-870a-2e284b54287d"
],
"auto_rotate": true,
"rotation_interval": "1d",
"exportable": true
},
{
"id": "ab063593-5dd8-4b9c-a24b-fbd66190cc85",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Test Export 1",
"algorithm": "AES128",
"lock_ring_id": "crypto/ab063593-5dd8-4b9c-a24b-fbd66190cc85",
"current_version": 2,
"group_id": "b81a6c18-a7eb-496a-aa89-e33b9b56e134",
"created_by": "2ecec31b-ed78-4c8d-84b1-0d051e975951",
"updated_by": "2ecec31b-ed78-4c8d-84b1-0d051e975951",
"created_at": 1781247127,
"updated_at": 1782205271,
"assigned_user_ids": [
"08fceb61-6e02-41dd-8b25-caa4293e95f7"
],
"exportable": true
},
{
"id": "74b1d868-4210-41c0-ab20-3cabb574ebca",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Tes Rsa",
"algorithm": "RSA1024",
"lock_ring_id": "crypto/74b1d868-4210-41c0-ab20-3cabb574ebca",
"current_version": 1,
"group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
"created_by": "0a11c692-b992-4d02-8a55-22b005459c50",
"updated_by": "0a11c692-b992-4d02-8a55-22b005459c50",
"created_at": 1781159559,
"updated_at": 1781159559,
"assigned_user_ids": [
"414a45e9-f194-4a8a-9876-97abb990d4d9",
"c777977b-7a32-4040-b7b0-ee51721433fd"
]
},
{
"id": "2cff9b1e-4891-445d-9dbd-38b5b153e09d",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Aes Export",
"algorithm": "AES128",
"lock_ring_id": "crypto/2cff9b1e-4891-445d-9dbd-38b5b153e09d",
"current_version": 1,
"group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
"created_by": "0a11c692-b992-4d02-8a55-22b005459c50",
"updated_by": "0a11c692-b992-4d02-8a55-22b005459c50",
"created_at": 1781151896,
"updated_at": 1781151896,
"assigned_user_ids": [
"7c6126c9-9bc3-4d05-9796-c3c1a7173de2",
"414a45e9-f194-4a8a-9876-97abb990d4d9"
]
},
{
"id": "616c1126-abf5-4e4c-b782-be880e270428",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Member Encrypt",
"algorithm": "AES256",
"lock_ring_id": "crypto/616c1126-abf5-4e4c-b782-be880e270428",
"current_version": 1,
"group_id": "5ff4e1da-3d8d-4fde-9d01-52bde2b3bd3f",
"created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
"updated_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
"created_at": 1780022937,
"updated_at": 1780022937,
"assigned_user_ids": [
"c777977b-7a32-4040-b7b0-ee51721433fd"
]
},
],
"pagination": {
"total": 5,
"page": 1,
"page_size": 5,
"last_page": 1
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the encryption configuration
tenant_idUUIDIdentifier of the tenant that owns the encryption configuration
nameStringName of the encryption configuration
algorithmStringEncryption algorithm used by the configuration
lock_ring_idStringInternal identifier associated with the encryption configuration
current_versionIntegerCurrent version of the encryption configuration
group_idUUIDIdentifier of the group associated with the encryption configuration
created_byUUIDIdentifier of the user who created the configuration
updated_byUUIDIdentifier of the user who last updated the configuration
created_atIntegerCreation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format
assigned_user_idsArrayList of user IDs assigned to the encryption configuration
auto_rotateBooleanIndicates whether automatic key rotation is enabled
rotation_intervalStringConfigured automatic rotation interval
exportableBooleanIndicates whether the encryption key can be exported
totalIntegerTotal number of encryption configurations available
pageIntegerCurrent page number
page_sizeIntegerNumber of records returned per page
last_pageIntegerTotal number of available pages

info
  • A valid Bearer Token is required to access this endpoint.
  • Some fields such as auto_rotate, rotation_interval, and exportable may not be present if those options were not configured when the encryption was created.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.