Updating dashboard permissions

Use this request to grant or revoke dashboard permissions. You need the GRANT permission to make the request.

PATCH

https://api.tracker.yandex.net/v3/dashboards/{dashboard_ID}/permissions?version=DASHBOARD_VERSION

Request format

Before making a request, get permission to access the API. Specify the current dashboard version in the version parameter or the If-Match header.

PATCH /v3/dashboards/{dashboard_ID}/permissions?version=DASHBOARD_VERSION
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID

{
  "grant": {
    "READ": {"users": [{"id": "USER_ID"}], "groups": [], "roles": []}
  },
  "revoke": {
    "WRITE": {"users": [], "groups": [{"id": "GROUP_ID"}], "roles": []}
  }
}
Headers

  • Host: address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth OAUTH_TOKEN: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer IAM_TOKEN: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. Learn more

  • ID types

    X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Identity Hub.

    Finding the ID

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource

Parameter

Description

Data type

dashboard_ID

Dashboard ID.

Number
Request parameters

Pass the dashboard version in the version parameter or the If-Match header.

Parameter

Description

Data type

version

Current dashboard version. Specify it if you did not pass the If-Match header.

Number
Additional headers

Header

Description

If-Match

Current dashboard version in double quotes, for example "4". Specify it if you did not pass the version parameter.
Request body parameters

Parameter

Description

Data type

grant

Permissions to grant.

Object

revoke

Permissions to revoke.

Object

Fields of the grant and revoke objects

Parameter

Description

Data type

READ

Read access.

Object

WRITE

Write access.

Object

GRANT

Access management.

Object

Fields of the READ, WRITE, and GRANT objects

Parameter

Description

Data type

users

Users with the permission. Each object contains an id.

Array of objects

groups

Groups with the permission. Each object contains an id.

Array of objects

roles

System roles with the permission. Pass an array of strings, for example ["OWNER"].

Array of strings

Response format

If the request is successful, the API returns a response with code 200 OK.

On success, the API returns the updated permissions object.

{
  "acl": {
    "READ": {
      "users": [],
      "groups": [
        {
          "self": "https://api.tracker.yandex.net/v3/groups/3",
          "id": "3",
          "display": "All employees"
        }
      ],
      "roles": []
    },
    "WRITE": {
      "users": [
        {
          "self": "https://api.tracker.yandex.net/v3/users/1234567890",
          "id": "1234567890",
          "display": "User"
        }
      ],
      "groups": [],
      "roles": [
        {
          "id": "OWNER",
          "name": "Owner"
        }
      ]
    },
    "GRANT": {
      "users": [],
      "groups": [],
      "roles": [
        {
          "id": "OWNER",
          "name": "Owner"
        }
      ]
    }
  }
}
Response parameters

Parameter

Description

Data type

acl

Effective permissions.

Object

inheritedFrom

Source of inherited permissions. Omitted when permissions are set directly on the dashboard.

Object

Fields of the acl object

Parameter

Description

Data type

READ

Subjects with read access.

Object

WRITE

Subjects with write access. Also grants READ.

Object

GRANT

Subjects who can manage access.

Object

Fields of the READ, WRITE, and GRANT objects

Parameter

Description

Data type

users

User references. User object fields.

Array of objects

groups

Group references with self, id, and display fields.

Array of objects

roles

System roles with id and name fields.

Array of objects

Fields of elements in the groups array

Parameter

Description

Data type

self

Group API resource URL.

String

id

Group ID.

String

display

Group name.

String

Fields of elements in the roles array

Parameter

Description

Data type

id

System role ID, for example OWNER.

String

name

Role name.

String

If the request is processed incorrectly, the API returns a response with an error code:

400
One or more request parameters have an invalid value.

Invalid request body or If-Match header format, or the dashboard permissions are inherited.

403
You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.

No GRANT permission for the dashboard.

404
The requested object was not found. You may have specified an invalid object ID or key.
412
A conflict occurred while editing the object. The error may be due to an invalid update version.
422
JSON validation error, the request is rejected.

User or group not found.

428
Access to the resource is denied. Make sure all required conditions for the request are specified.

Neither version nor If-Match was provided.

Previous
Get dashboard permissions
Next
Create a widget