Skip to main content

Detail Permission by ID

This API returns detailed information about a specific permission set identified by ID.

Endpoint Details

URL/v1/auth/permissions/id
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific permission set, use the following request format:

/v1/auth/permissions/2be1c503-5dd1-4eb0-91c7-36926d81b09e

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the permission set

Response

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

Response
{
"permission": {
"id": "2be1c503-5dd1-4eb0-91c7-36926d81b09e",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Security Config Only",
"data": {
"encryption": {
"read": true,
"create": true,
"update": true,
"rotation_key": true,
"list_rotation_key": true,
"encrypt": true,
"decrypt": true
},
"tokenization": {
"read": true,
"create": true,
"update": true,
"tokenize": true,
"detokenize": true
},
"masking": {
"read": true,
"create": true,
"update": true,
"masking": true
},
"access_token": {},
"group": {},
"users": {},
"audit": {},
"backup_restore": {},
"license": {},
"taka_lock": {},
"decrypt_client": {},
"syslog_log_integration": {},
"splunk_log_integration": {},
"loki_log_integration": {},
"notification": {}
},
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_at": 1784102813,
"updated_at": 1784102813
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the permission set
tenant_idUUIDIdentifier of the tenant that owns the permission set
nameStringName of the permission set
dataObjectObject mapping each module to the actions granted by this permission
created_byUUIDIdentifier of the user who created the permission set
updated_byUUIDIdentifier of the user who last updated the permission set
created_atIntegerCreation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing permission set.
  • Only granted (true) actions are returned in data. Modules with no granted actions are returned as an empty object {}.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.