Add Scope Role Assignments for Sharing

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <jwt_token>" \
  -d '{
    "query": "mutation AddScopeRoleAssignments($scopeId: ID!, $scopeRoleAssignments: [ScopeRoleAssignmentInput!]!, $scopeType: ScopeType!, $message: String) { addScopeRoleAssignmentsForSharing(scopeId: $scopeId, scopeRoleAssignments: $scopeRoleAssignments, scopeType: $scopeType, message: $message) { code message } }",
    "variables": {
      "scopeId": "story_123456789",
      "scopeRoleAssignments": [
        {
          "roleId": "00000000-0000-0000-0000-000000000009",
          "principalId": "user_987654321"
        }
      ],
      "scopeType": "DASHBOARD",
      "message": "Please review and edit this sales dashboard"
    }
  }' \
  https://{ACCOUNT}.askwisdom.ai/graphql

{
  "data": {
    "addScopeRoleAssignmentsForSharing": {
      "code": "OK",
      "message": "Role added successfully"
    }
  }
}

The addScopeRoleAssignmentsForSharing mutation grants access to a specific resource (like a Dashboard) by assigning roles to users. This allows you to share Dashboards with individual team members or groups.

Signature

addScopeRoleAssignmentsForSharing(
  scopeId: ID!
  scopeRoleAssignments: [ScopeRoleAssignmentInput!]!
  scopeType: ScopeType!
  message: String
): ResponseStatus!

Arguments

ID!

required

The unique identifier of the resource you want to share (e.g., a Dashboard ID).

[ScopeRoleAssignmentInput!]!

required

Array of user-role assignments defining who gets access and what level of access they receive. See ScopeRoleAssignmentInput for the input structure.

ScopeType!

required

The type of resource being shared. For Dashboards, this should be DASHBOARD.

String

Optional personal message to include in the sharing notification email sent to recipients.

Response

Returns a ResponseStatus object indicating the success or failure of the operation:

{
  "code": "OK",
  "message": "Role added successfully"
}

Usage example

The following example shows how to share a Dashboard with a colleague:

mutation AddScopeRoleAssignments($scopeId: ID!, $scopeRoleAssignments: [ScopeRoleAssignmentInput!]!, $scopeType: ScopeType!, $message: String) {
  addScopeRoleAssignmentsForSharing(
    scopeId: $scopeId
    scopeRoleAssignments: $scopeRoleAssignments
    scopeType: $scopeType
    message: $message
  ) {
    code
    message
  }
}

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <jwt_token>" \
  -d '{
    "query": "mutation AddScopeRoleAssignments($scopeId: ID!, $scopeRoleAssignments: [ScopeRoleAssignmentInput!]!, $scopeType: ScopeType!, $message: String) { addScopeRoleAssignmentsForSharing(scopeId: $scopeId, scopeRoleAssignments: $scopeRoleAssignments, scopeType: $scopeType, message: $message) { code message } }",
    "variables": {
      "scopeId": "story_123456789",
      "scopeRoleAssignments": [
        {
          "roleId": "00000000-0000-0000-0000-000000000009",
          "principalId": "user_987654321"
        }
      ],
      "scopeType": "DASHBOARD",
      "message": "Please review and edit this sales dashboard"
    }
  }' \
  https://{ACCOUNT}.askwisdom.ai/graphql

{
  "data": {
    "addScopeRoleAssignmentsForSharing": {
      "code": "OK",
      "message": "Role added successfully"
    }
  }
}

Next steps

Remove Scope Role Assignments for Sharing

Remove sharing access from users

Create Dashboard

Create a new Dashboard to share

Dashboard Object

Dashboard object schema and properties

Refresh Dashboard Remove Scope Role Assignments for Sharing

⌘I

Overview

User Management

Embeddings

GraphQL API

Deployment

Add Scope Role Assignments for Sharing

Signature

Arguments

Response

Usage example

Next steps

Remove Scope Role Assignments for Sharing

Create Dashboard

Dashboard Object

​Signature

​Arguments

​Response

​Usage example

​Next steps

Remove Scope Role Assignments for Sharing

Create Dashboard

Dashboard Object

Signature

Arguments

Response

Usage example

Next steps