id from any user row’s role
(list_users, get_user, get_identity), or from list_roles.
permissions lists grants only, not the raw matrix: a category the role is
denied is absent, and inside an allowed one a yes-or-no permission the role does
not hold is absent too. An absence is therefore meaningful: a category missing
from the result is one the role cannot reach, which is often the answer to “why
can’t this user see X”. A category’s scope says whose records the role
reaches on statements, requests and commission letters, independently of those
grants.
shared_resources are the resources shared with the role itself (saved views,
reports and dashboards), which reach past its category permissions. A role
denied a whole category can still read specific resources through a share, so
read the two together. Only live-environment shares are listed.
This tool needs the company-settings roles permission (READ on the Role
company setting).
Parameters
Body
Body
string
required
Id from list_roles, or the
role id of a user row.Response
Body
Body
string
string
Deep link to open this role in the Qobra web app.
string
string
boolean
Whether new users get this role unless another is picked.
boolean
Whether this is the company’s built-in Admin role (not editable).
integer
Number of non-archived users currently holding this role.
object[]
One entry per category the role is allowed. A denied category is absent: the
role cannot reach it.
Resources shared with this role itself, on top of
permissions: a role
denied a category can still reach them. Empty when none. Live environment
only.