List Permissions

This API returns a list of permission sets available within the tenant.

Endpoint Details

URL	/v1/auth/permissions
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Response

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

Response

{
    "permissions": [
        {
            "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
        },
        {
            "id": "f07f9e5d-25a9-4a93-bd72-7861ccf59e03",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Notification",
            "data": {
                "encryption": {},
                "tokenization": {},
                "masking": {},
                "access_token": {},
                "group": {},
                "users": {},
                "audit": {},
                "backup_restore": {},
                "license": {},
                "taka_lock": {},
                "decrypt_client": {},
                "syslog_log_integration": {},
                "splunk_log_integration": {},
                "loki_log_integration": {},
                "notification": {
                    "backup_recovery": true
                }
            },
            "created_by": "0a11c692-b992-4d02-8a55-22b005459c50",
            "updated_by": "0a11c692-b992-4d02-8a55-22b005459c50",
            "created_at": 1783579291,
            "updated_at": 1783579291
        },
        {
            "id": "63c29ee2-b444-4780-910b-0878b99db6be",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Log Integration",
            "data": {
                "encryption": {},
                "tokenization": {},
                "masking": {},
                "access_token": {},
                "group": {},
                "users": {},
                "audit": {},
                "backup_restore": {},
                "license": {},
                "taka_lock": {},
                "decrypt_client": {},
                "syslog_log_integration": {
                    "read": true
                },
                "splunk_log_integration": {
                    "read": true
                },
                "loki_log_integration": {
                    "sync": true,
                    "read": true,
                    "update": true,
                    "test_connection": true
                },
                "notification": {}
            },
            "created_by": "0a11c692-b992-4d02-8a55-22b005459c50",
            "updated_by": "0a11c692-b992-4d02-8a55-22b005459c50",
            "created_at": 1783579124,
            "updated_at": 1783579252
        }
    ],
    "pagination": {
        "total": 3,
        "page": 1,
        "page_size": 3,
        "last_page": 1
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the permission set
tenant_id	UUID	Identifier of the tenant that owns the permission set
name	String	Name of the permission set
data	Object	Object mapping each module to the actions granted by this permission
created_by	UUID	Identifier of the user who created the permission set
updated_by	UUID	Identifier of the user who last updated the permission set
created_at	Integer	Creation timestamp in Unix format
updated_at	Integer	Last update timestamp in Unix format
total	Integer	Total number of permission sets available
page	Integer	Current page number
page_size	Integer	Number of records returned per page
last_page	Integer	Total number of available pages

---

info

• A valid Bearer Token is required to access this endpoint.
• The response returns all permission sets available within the tenant.
• 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.