List Roles
Get all roles in the system.Response
Array of role objects
Get Role Details
Get a specific role with its associated permission sets.Path Parameters
The role ID to retrieve
Response
Unique role identifier (UUID as string)
Role name
Role description
Array of permission sets assigned to this role
Create Role
Create a new role with optional permission sets.Body Parameters
The name of the role (must be unique)
A description of the role
Array of permission set UUIDs to assign to the role
Response
Unique role identifier (UUID as string)
Role name
Role description
Update Role
Update an existing role’s name, description, or permission sets.Path Parameters
The role ID to update
Body Parameters
The new name for the role
The new description for the role
Array of permission set UUIDs to replace existing permission sets
Response
Unique role identifier (UUID as string)
Role name
Role description
Delete Role
Soft delete a role from the system.Path Parameters
The role ID to delete
Response
Returns 204 No Content on success.List All Roles (Permissions API)
List all roles with their permission sets (from permissions router).Response
Array of role objects
Create Role (Permissions API)
Create a new role with permission set codes.Body Parameters
The name of the role (must be unique)
A description of the role
Array of permission set codes (e.g., [“admin”, “user.view”]) to assign to the role
Response
Same as List All Roles individual role object.Get Role (Permissions API)
Get a specific role by ID with permission sets.Path Parameters
The role ID to retrieve
Response
Same as List All Roles individual role object.Update Role (Permissions API)
Update an existing role.Path Parameters
The role ID to update
Body Parameters
The new name for the role
The new description for the role
Array of permission set codes to replace existing permission sets
Response
Same as List All Roles individual role object.Delete Role (Permissions API)
Delete a role from the system.Path Parameters
The role ID to delete
Response
Returns 204 No Content on success.Get Role Effective Permissions
Get all effective permissions for a role (aggregated from all permission sets).Path Parameters
The role ID to query
Response
The role identifier
The role name
Array of permission codes (e.g., [“user.view”, “user.edit”])