> ## Documentation Index > Fetch the complete documentation index at: https://developers.torq.io/llms.txt > Use this file to discover all available pages before exploring further. # Update dashboard access > Sets who can see a dashboard. Every call replaces the whole access list, so include every entry to keep. The API key must be able to see the dashboard, as described in `List dashboards`. ## OpenAPI ````json PUT /v1alpha/dashboards/{dashboard_id}/access { "openapi": "3.0.1", "info": { "contact": { "email": "support@torq.io", "name": "torq.io", "url": "https://torq.io" }, "title": "Torq Public API[production]", "version": "${DH_DEPLOY_VERSION}" }, "servers": [ { "url": "https://api.torq.io/public", "description": "US Environment" }, { "url": "https://api.eu.torq.io/public", "description": "European Enviornment" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Files" }, { "name": "ActivityLogs" }, { "name": "AgentsHubService" }, { "name": "Users" }, { "name": "ApiKeys" }, { "name": "AuditLogs" }, { "name": "ContextGraph" }, { "name": "DashboardsService" }, { "name": "Executions" }, { "name": "ShareRequests" }, { "name": "StepRunners" }, { "name": "Integrations" }, { "name": "IPAccessService" }, { "name": "RolesService" }, { "name": "ScheduledReportsService" }, { "name": "Secrets" }, { "name": "SecuritySettingsService" }, { "name": "ClaimMappings" }, { "name": "IdpSsoService" }, { "name": "Workflows" }, { "name": "Workspaces" }, { "name": "WorkspaceVariables" }, { "name": "Auto Triage Alerts" }, { "name": "Auto Triage Guidance" }, { "name": "Auto Triage Alert History" }, { "name": "Auto Triage Rules" }, { "name": "Auto Triage Verdict Actions" }, { "name": "Cases" }, { "name": "Cases Custom Fields" }, { "name": "Cases Notes" }, { "name": "ExtendedCaseService" }, { "name": "Cases Attachments" }, { "name": "Observables" }, { "name": "Cases Observables" }, { "name": "CaseSearchService" }, { "name": "Cases Tasks" }, { "name": "Cases Task Templates" }, { "name": "Cases Links" }, { "name": "Cases Events" }, { "name": "Cases Runbooks" } ], "externalDocs": { "description": "Torq Documentation", "url": "https://learn.torq.io" }, "x-original-swagger-version": "2.0", "paths": { "/v1alpha/dashboards/{dashboard_id}/access": { "put": { "description": "Sets who can see a dashboard. Every call replaces the whole access list, so include every entry to keep. The API key must be able to see the dashboard, as described in `List dashboards`.", "operationId": "updateDashboardAccess", "parameters": [ { "description": "The ID of the dashboard to update.", "in": "path", "name": "dashboard_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Update_dashboard_access_request" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1alphaUpdateDashboardAccessResponse" } } }, "description": "A successful response." }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token." }, "403": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "You don't have permission to access this resource." } }, "summary": "Update dashboard access", "tags": [ "Dashboards" ], "x-codegen-request-body-name": "body" } } }, "components": { "schemas": { "Update_dashboard_access_request": { "properties": { "access_type": { "description": "Who can see the dashboard. The possible values are: `all_users` for everyone in the workspace, `private` for only the owner, and `selected` for only the users and groups in `access_entries`.", "example": "selected", "type": "string" }, "access_entries": { "description": "The users and groups who can see the dashboard. Required when `access_type` is `selected`, and not allowed otherwise. For a `user` entry, `value` is the email address, matched case-insensitively. For a `group` entry, `value` is the group ID. An entry with both fields empty is ignored. All users and groups are checked first: if any is unknown or not in the workspace, nothing changes and the error lists every invalid entry.", "items": { "$ref": "#/components/schemas/v1alphaAccessEntry" }, "type": "array" }, "owner": { "description": "The email address of the user who owns a private dashboard, matched case-insensitively. Only allowed when `access_type` is `private`. If omitted, the dashboard is private to the owner of the API key used. If that owner is a service account, this can mean that no user can see the dashboard until its access is changed again.", "example": "dana@example.com", "type": "string" } }, "required": [ "access_type" ], "title": "Update dashboard access request", "type": "object" }, "v1alphaUpdateDashboardAccessResponse": { "properties": { "dashboard": { "$ref": "#/components/schemas/v1alphaDashboard" } }, "title": "Update dashboard access response", "type": "object" }, "v1alphaAccessEntry": { "description": "Contains a user, group, or workspace that can see a dashboard.", "properties": { "type": { "description": "The kind of entry. The possible values are: `user`, `group`, `workspace`. Only `user` and `group` can be set through `Update dashboard access`.", "example": "user", "type": "string" }, "value": { "description": "The user's email address, the group ID, or the workspace ID.", "example": "dana@example.com", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "v1alphaDashboard": { "description": "A dashboard in the workspace.", "properties": { "id": { "description": "The unique identifier of the dashboard.", "example": "0f8fad5b-d9cb-469f-a165-70867728950e", "readOnly": true, "type": "string" }, "title": { "description": "The dashboard title.", "example": "SOC overview", "readOnly": true, "type": "string" }, "description": { "description": "The dashboard description.", "example": "Open cases by severity and assignee", "readOnly": true, "type": "string" }, "is_org_dashboard": { "description": "Whether this is an organization dashboard, shared from the organization to its workspaces.", "readOnly": true, "type": "boolean" }, "access_type": { "description": "Who can see the dashboard. The possible values are: `all_users` for everyone in the workspace, `private` for only its owner, `selected` for the users, groups, or workspaces in `access_entries`, and `organization` for every workspace in the organization.", "example": "selected", "readOnly": true, "type": "string" }, "access_entries": { "description": "The users, groups, and workspaces the dashboard is shared with. For a private dashboard, the owner. Returned only by `List dashboards` when filtering by `id`, and by `Update dashboard access`.", "items": { "$ref": "#/components/schemas/v1alphaAccessEntry" }, "readOnly": true, "type": "array" }, "widget_count": { "description": "The number of widgets on the dashboard.", "example": 6, "format": "int32", "readOnly": true, "type": "integer" }, "created_at": { "description": "The timestamp when the dashboard was created.", "format": "date-time", "readOnly": true, "type": "string" }, "created_by": { "$ref": "#/components/schemas/apidashboardsv1alphaActor" }, "updated_at": { "description": "The timestamp when the dashboard was last updated. If the dashboard has never been updated, this is its creation time and `updated_by` is not returned.", "format": "date-time", "readOnly": true, "type": "string" }, "updated_by": { "$ref": "#/components/schemas/apidashboardsv1alphaActor" }, "url": { "description": "A link that opens the dashboard in Torq.", "example": "https://app.torq.io/v3/dashboards/0f8fad5b-d9cb-469f-a165-70867728950e?account=my-account", "readOnly": true, "type": "string" } }, "type": "object" }, "apidashboardsv1alphaActor": { "description": "Contains the user, API key, workflow, integration, agent, or system that performed an action.", "properties": { "type": { "description": "The kind of actor. The possible values are: `user`, `service_api_key`, `workflow`, `integration`, `agent`, `system`.", "example": "user", "readOnly": true, "type": "string" }, "email": { "description": "The user's email address. Set when `type` is `user`.", "example": "dana@example.com", "readOnly": true, "type": "string" }, "name": { "description": "The user's full name, the API key name, the workflow name or the integration type, when known.", "example": "Dana Levi", "readOnly": true, "type": "string" }, "id": { "description": "The API key client ID, the workflow ID, the integration ID or the agent ID, when applicable.", "readOnly": true, "type": "string" } }, "type": "object" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "64fb4b65-44d8-4304-881c-b1f8b6b3100a" } } } } ````