Skip to main content
The removeScopeRoleAssignmentsForSharing mutation removes access to a specific resource (like a Story) by revoking roles from users. This allows you to stop sharing Stories with individuals or groups.

Signature

removeScopeRoleAssignmentsForSharing(
  scopeId: ID!
  scopeRoleAssignments: [ScopeRoleAssignmentInput!]!
  scopeType: ScopeType!
): ResponseStatus!

Arguments

scopeId
ID!
required
The unique identifier of the resource you want to remove sharing from (e.g., a Story ID).
scopeRoleAssignments
[ScopeRoleAssignmentInput!]!
required
Array of user-role assignments to remove. See ScopeRoleAssignmentInput for the input structure.
scopeType
ScopeType!
required
The type of resource being unshared. For Stories, this should be DASHBOARD.

Response

Returns a ResponseStatus object indicating the success or failure of the operation:
{
  "code": "OK",
  "message": "Role removed successfully"
}

Usage Example

The following example shows how to remove sharing access from a colleague:
mutation RemoveScopeRoleAssignments($scopeId: ID!, $scopeRoleAssignments: [ScopeRoleAssignmentInput!]!, $scopeType: ScopeType!) {
  removeScopeRoleAssignmentsForSharing(
    scopeId: $scopeId
    scopeRoleAssignments: $scopeRoleAssignments
    scopeType: $scopeType
  ) {
    code
    message
  }
}
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <jwt_token>" \
  -d '{
    "query": "mutation RemoveScopeRoleAssignments($scopeId: ID!, $scopeRoleAssignments: [ScopeRoleAssignmentInput!]!, $scopeType: ScopeType!) { removeScopeRoleAssignmentsForSharing(scopeId: $scopeId, scopeRoleAssignments: $scopeRoleAssignments, scopeType: $scopeType) { code message } }",
    "variables": {
      "scopeId": "story_123456789",
      "scopeRoleAssignments": [
        {
          "roleId": "00000000-0000-0000-0000-000000000009",
          "principalId": "user_987654321"
        }
      ],
      "scopeType": "DASHBOARD"
    }
  }' \
  https://{ACCOUNT}.askwisdom.ai/graphql
{
  "data": {
    "removeScopeRoleAssignmentsForSharing": {
      "code": "OK",
      "message": "Role removed successfully"
    }
  }
}