Skip to main content
GET
/
v1
/
roles
List Roles
curl --request GET \
  --url https://api.truthlocks.com/v1/roles \
  --header 'X-API-Key: <api-key>'
{
  "roles": [
    {
      "id": "role_admin",
      "name": "Administrator",
      "permissions": ["*"],
      "is_system": true
    },
    {
      "id": "role_reviewer",
      "name": "Reviewer",
      "permissions": ["audit:read", "issuers:read", "applications:review"],
      "is_system": false
    }
  ]
}
Returns a list of all available roles and their associated permissions within the tenant. Used for RBAC configuration.

​
Parameters

​
Responses

{
  "roles": [
    {
      "id": "role_admin",
      "name": "Administrator",
      "permissions": ["*"],
      "is_system": true
    },
    {
      "id": "role_reviewer",
      "name": "Reviewer",
      "permissions": ["audit:read", "issuers:read", "applications:review"],
      "is_system": false
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Response

200 - application/json

List of roles

​
id
string<uuid>
​
name
string
​
permissions
string[]