List roles assigned to a group

curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/roles/groups/{group_name}/roles \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": 1,
    "name": "data_analyst:read",
    "description": "Data analysis and reporting access"
  },
  {
    "id": 2,
    "name": "team_lead:manage",
    "description": "Team leadership and management permissions"
  }
]

roles

List roles assigned to a group

List all roles assigned to a specific group.

Authorization: Users can view roles of groups they have permission to access. Permissions are checked via Cerbos policies.

Role Information: Returns each role’s ID, name, and description.

Use Cases:

View group permissions and capabilities
Audit group role assignments
Administrative oversight of access control
Verify role inheritance for group members

Sorting: Roles are returned sorted by name (alphabetical order).

GET

api

roles

groups

{group_name}

roles

List roles assigned to a group

curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/roles/groups/{group_name}/roles \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": 1,
    "name": "data_analyst:read",
    "description": "Data analysis and reporting access"
  },
  {
    "id": 2,
    "name": "team_lead:manage",
    "description": "Team leadership and management permissions"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_name

string

required

Response

List of group roles retrieved successfully

integer

required

Unique identifier for the role

Example:

1

name

string

required

Role name

Example:

"data_analyst:read"

description

string

required

Role description

Example:

"Data analysts with read access to analytics dashboards"

created_by

string | null

CPF of the user who created this role (null for system roles)

Example:

"12345678901"

created_at

string | null

ISO timestamp when the role was created (null for system roles)

Example:

"2024-01-15T10:30:00Z"

Create Role Assign Role To Group