API methods - roles

Get role by ID

To access this endpoint you must have roles.read permission.

GET /roles/{roleId}

Responses:

Status: 200 - a role and its aligned permissions are returned

Response body example:

{
  "id": "87e9402a-7661-45e1-a039-d20d756b7ded",
  "name": "ADMIN_USER",
  "description": "Admin user for user and attribute management",
  "priority": 300,
  "active": true,
  "systemRole": false,
  "createdAt": "2025-11-19T12:09:26.401364",
  "updatedAt": "2025-11-19T12:09:26.401365",
  "permissions": [
    {
      "id": "3ef2d811-7292-46be-81eb-3d651a88106c",
      "name": "attributes.read",
      "description": "Read the user attributes",
      "resource": "core",
      "action": "read",
      "active": true,
      "defaultForRole": true
    }
  ]
}

Status: 404 - role not found

Get roles

To access this endpoint you must have roles.read permission.

GET /roles

Responses:

Status: 200 - all roles and their aligned permissions are returned

{
  "count": 1,
  "roles": [
    {
      "id": "33118966-7462-4f99-beb5-39943b2e303b",
      "name": "USER",
      "description": "Standard user of the platform with data access to apps and APIs",
      "priority": 100,
      "active": true,
      "systemRole": false,
      "createdAt": "2025-11-19T12:09:26.401003",
      "updatedAt": "2025-11-19T12:09:26.401008",
      "permissions": [
        {
          "id": "1a4238c7-7afc-4034-bc9e-e90b82b90d07",
          "name": "api.ontology.read",
          "description": "Read from the ontology dataset",
          "resource": "core",
          "action": "read",
          "active": true,
          "defaultForRole": true
        }
      ]
    }
  ]
}