POST/api/v1/remove-user-from-workspace

Remove a member from a workspace

Ends a member's access to a workspace, leaving their account, their registered keys, and their place in any vault's signer set unchanged.

AccessRequires a permission in the workspaceMANAGE_USERS

The call removes one member's membership of one workspace. It does not touch their account, their registered signing keys, or their membership of any other workspace: work through the vault consequences below before you call it.

Removal is not the same as taking someone out of a vault. A vault's address is derived from its signer set, so the signers are fixed when the vault is created and are not changed by this call, as Creating a vault explains. A removed member's key stays in every vault it was part of, and the vault still counts it towards n while the person is no longer there to sign with it.

Check every vault's threshold first

Confirm that the remaining active signers can still meet each vault's threshold before you remove someone. A 2-of-3 vault that loses one of its signers effectively becomes 2-of-2 and has no redundancy left; a 2-of-2 vault that loses a signer can no longer reach its threshold at all. Since signers cannot be changed after a vault is created, work out the effect on every vault the member signs for first.

Body parameters

workspace_idnumberrequired

The workspace to remove the member from. You must hold MANAGE_USERS in it.

user_uuidnumberrequired

The id of the member to remove, as returned in the UUID field of get-users-from-workspace.

bash

curl -X POST "$SQRL_API/api/v1/remove-user-from-workspace" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "workspace_id": 342,
        "user_uuid": 4088
      }'

const res = await fetch(
  `${process.env.SQRL_API}/api/v1/remove-user-from-workspace`,
  {
    method: "POST",
    headers: {
      authorization: `Bearer ${process.env.SQRL_TOKEN}`,
      "content-type": "application/json",
    },
    body: JSON.stringify({
      workspace_id: 342,
      user_uuid: 4088,
    }),
  },
);
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/remove-user-from-workspace", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "workspace_id": 342,
        "user_uuid": 4088,
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true
}

#What happens next

The member stops appearing in GET /api/v1/get-users-from-workspace and loses the permissions their role carried in that workspace. To bring them back you add the membership again with POST /api/v1/add-workspace-to-user, which is gated on MANAGE_WORKSPACE.

Was this page helpful?