Delete Users From Workspace

The deleteUsersFromWorkspace mutation removes one or more users from a workspace.

This action is irreversible. Deleted users lose all role assignments, attributes, and access to the workspace. Make sure you have the correct user IDs before calling this mutation.

Signature

deleteUsersFromWorkspace(ids: [ID!]!, workspaceID: ID!): DeleteUsersFromWorkspaceResponse!

Arguments

ids · [ID!]! · required

The IDs of the users to delete. Use listUsers to find user IDs.

workspaceID · ID! · required

The workspace to remove the users from.

Permissions

Requires iam:delete scoped to the target workspace.

Response

status · ResponseStatus!

Indicates whether the operation succeeded. See ResponseStatus.

Usage example

mutation DeleteUsersFromWorkspace($ids: [ID!]!, $workspaceID: ID!) {
  deleteUsersFromWorkspace(ids: $ids, workspaceID: $workspaceID) {
    status {
      code
      message
    }
  }
}

Request

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
    "query": "mutation DeleteUsersFromWorkspace($ids: [ID!]!, $workspaceID: ID!) { deleteUsersFromWorkspace(ids: $ids, workspaceID: $workspaceID) { status { code message } } }",
    "variables": {
      "ids": ["user_abc123", "user_def456"],
      "workspaceID": "workspace_123"
    }
  }' \
  https://{ACCOUNT}.askwisdom.ai/graphql

Success

{
  "data": {
    "deleteUsersFromWorkspace": {
      "status": {
        "code": "OK",
        "message": "Users deleted successfully"
      }
    }
  }
}

Related articles

List users

Query users before deleting them

Create users

Provision new users in a workspace