Skip to content

revoke_dashboard_share

Revoke a dashboard’s active share, if any, removing authenticated team access. Idempotent: calling this on a dashboard that is already unshared (or was never shared) succeeds and reports was_shared=false rather than raising an error, so retries are safe. Requires at least Editor access to the model.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
dashboard_nameAnnotated[str, Field(description='Name of the dashboard to revoke sharing for.')]Yes

Returns a structured object. Top-level fields:

  • dashboard_id (string)
  • dashboard_name (string)
  • model (string)
  • was_shared (boolean)
  • is_shared (boolean)

See the response example below for the full payload shape.

{
"name": "revoke_dashboard_share",
"arguments": {
"model_name": "forecasts",
"dashboard_name": "ARR Bridge"
}
}
{
"dashboard_id": "77777777-7777-7777-7777-777777777777",
"dashboard_name": "ARR Bridge",
"model": "forecasts",
"was_shared": true,
"is_shared": false
}
  • Module: Dashboards
  • Requires authentication via API token or Auth0 JWT.