GET/api/v1/get-roles-and-perms-detailed

List roles with their permissions

Lists a workspace's roles, each with the permissions currently assigned to it, so you can review the whole access setup in one call.

AccessRequires a permission in the workspaceMANAGE_PERMS

This is the call behind the role management view: one request returns every role in the workspace with the permissions attached to it. Read it before you change anything, and read it again afterwards to confirm the change landed. Because roles are workspace-scoped, the response describes this workspace only, and the same role name in another workspace is a separate role with its own permissions: see Roles and permissions.

Each entry has two parts. Role carries the role's identity, where RoleUID is the id that POST /api/v1/change-user-role takes as role_id and that POST /api/v1/add-perm-to-role takes as role_uid. RulesList.Rules lists the permissions the role holds, using the same UID and RuleName pairs as GET /api/v1/list-all-permissions. Spending limits are not part of this response; read a role's limit with GET /api/v1/get-role-limit.

Query parameters

workspace_idnumberrequired

The workspace whose roles to list. You must hold MANAGE_PERMS in it.

bash

curl "$SQRL_API/api/v1/get-roles-and-perms-detailed?workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({ workspace_id: "342" });
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-roles-and-perms-detailed?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { Roles } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/get-roles-and-perms-detailed", api_base))
    .query(&[("workspace_id", "342")])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"Roles": [
  {
    "Role": {
      "RoleUID": 77,
      "Name": "Approver",
      "Description": "Reviews and signs pending movements"
    },
    "RulesList": {
      "Rules": [
        { "UID": 6, "RuleName": "PAYMENT_APPROVE" },
        { "UID": 8, "RuleName": "VIEW_BALANCES" }
      ]
    }
  },
  {
    "Role": {
      "RoleUID": 78,
      "Name": "Auditor",
      "Description": "Read-only review of balances and logs"
    },
    "RulesList": {
      "Rules": [
        { "UID": 8, "RuleName": "VIEW_BALANCES" },
        { "UID": 9, "RuleName": "VIEW_LOGS" }
      ]
    }
  }
]
}

Was this page helpful?