POST/api/v1/add-perm-to-role

Grant a permission to a role

Adds one permission to a role in a workspace, granting it to every member who holds that role there.

AccessRequires a permission in the workspaceMANAGE_ROLE

Permissions are granted to roles, not to people. This call adds a single permission to a single role, so build a role up by calling it once per permission you want the role to hold. rule_uid identifies the permission and comes from GET /api/v1/list-all-permissions, which returns each permission's UID and key name.

The role must already exist in the workspace you name: create one with POST /api/v1/create-role-for-org, or read the existing roles and what they currently hold with GET /api/v1/get-roles-and-perms-detailed. Roles are workspace-scoped, so granting a permission here changes nothing in any other workspace: see Roles and permissions.

This takes effect immediately

Every member holding this role in this workspace gains the permission as soon as the call returns. There is no review step and no scheduled activation. Check who holds the role with GET /api/v1/get-users-from-workspace and confirm the impact before you grant it, especially for PAYMENT_APPROVE and PAYMENT_INIT, which decide who can approve and who can start a movement.

Body parameters

rule_uidnumberrequired

The permission to grant, as returned in UID by list-all-permissions.

role_uidnumberrequired

The role that receives the permission. It must exist in the workspace you name.

workspace_uidnumberrequired

The workspace the role belongs to. The grant applies only here.

bash

curl -X POST "$SQRL_API/api/v1/add-perm-to-role" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "rule_uid": 6,
        "role_uid": 79,
        "workspace_uid": 342
      }'

const res = await fetch(`${process.env.SQRL_API}/api/v1/add-perm-to-role`, {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.SQRL_TOKEN}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    rule_uid: 6,
    role_uid: 79,
    workspace_uid: 342,
  }),
});
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/add-perm-to-role", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "rule_uid": 6,
        "role_uid": 79,
        "workspace_uid": 342,
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true
}

#What happens next

Read the role back with GET /api/v1/get-roles-and-perms-detailed to confirm the permission is listed under it. Members holding the role see the change on their next read of GET /api/v1/get-user-info, which reports each membership's role and permissions. To take a permission away again, call POST /api/v1/remove-perm-from-role.

Was this page helpful?