Skip to main content

Detail Encryption by ID

This API returns detailed information about a specific encryption configuration identified by ID.


Endpoint Details

URL /v1/crypto/items/id
Method GET
Authorization Bearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific encryption configuration, use the following request format:

/v1/crypto/items/50c7d4d8-50e5-40da-8b19-b7b77ebb708f

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the encryption configuration

Response

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

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

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 associated group
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


info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing encryption configuration.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.