Update dashboard access

Prev Next
Put
/v1alpha/dashboards/{dashboard_id}/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.

Security
HTTP
Type bearer
Path parameters
dashboard_id
stringRequired

The ID of the dashboard to update.

Body parameters
Expand All
object
access_type
string Required

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.

Exampleselected
access_entries
Array of object (v1alphaAccessEntry)

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.

object

Contains a user, group, or workspace that can see a dashboard.

type
string Required

The kind of entry. The possible values are: user, group, workspace. Only user and group can be set through Update dashboard access.

Exampleuser
value
string Required

The user's email address, the group ID, or the workspace ID.

Exampledana@example.com
owner
string

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.

Exampledana@example.com
Responses
200

A successful response.

Expand All
object
dashboard
object (v1alphaDashboard)

A dashboard in the workspace.

id
string

The unique identifier of the dashboard.

Example0f8fad5b-d9cb-469f-a165-70867728950e
title
string

The dashboard title.

ExampleSOC overview
description
string

The dashboard description.

ExampleOpen cases by severity and assignee
is_org_dashboard
boolean

Whether this is an organization dashboard, shared from the organization to its workspaces.

access_type
string

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.

Exampleselected
access_entries
Array of object (v1alphaAccessEntry)

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.

object

Contains a user, group, or workspace that can see a dashboard.

type
string

The kind of entry. The possible values are: user, group, workspace. Only user and group can be set through Update dashboard access.

Exampleuser
value
string

The user's email address, the group ID, or the workspace ID.

Exampledana@example.com
widget_count
integer (int32)

The number of widgets on the dashboard.

Example6
created_at
string (date-time)

The timestamp when the dashboard was created.

created_by
object (apidashboardsv1alphaActor)

Contains the user, API key, workflow, integration, agent, or system that performed an action.

type
string

The kind of actor. The possible values are: user, service_api_key, workflow, integration, agent, system.

Exampleuser
email
string

The user's email address. Set when type is user.

Exampledana@example.com
name
string

The user's full name, the API key name, the workflow name or the integration type, when known.

ExampleDana Levi
id
string

The API key client ID, the workflow ID, the integration ID or the agent ID, when applicable.

updated_at
string (date-time)

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.

updated_by
object (apidashboardsv1alphaActor)

Contains the user, API key, workflow, integration, agent, or system that performed an action.

type
string

The kind of actor. The possible values are: user, service_api_key, workflow, integration, agent, system.

Exampleuser
email
string

The user's email address. Set when type is user.

Exampledana@example.com
name
string

The user's full name, the API key name, the workflow name or the integration type, when known.

ExampleDana Levi
id
string

The API key client ID, the workflow ID, the integration ID or the agent ID, when applicable.

url
string

A link that opens the dashboard in Torq.

Examplehttps://app.torq.io/v3/dashboards/0f8fad5b-d9cb-469f-a165-70867728950e?account=my-account
401

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.

object
403

You don't have permission to access this resource.

object