---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
  - property: og:type
    content: article
  - property: article:section
    content: Справочник API
  - property: og:title
    content: Получить права доступа к сущности
  - property: article:tag
    content: Техническая инструкция
alternate:
  - https://yandex.ru/support/tracker/en/api/entities/get-permissions.md
  - https://yandex.ru/support/tracker/ru/api/entities/get-permissions.md
  - href: https://yandex.ru/support/tracker/ru/api/entities/get-permissions.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/support/tracker/ru/llms.txt?revision=r22105730
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/ru/llms.txt?revision=r22105730


# Получить права доступа к сущности

Запрос возвращает прямые права доступа к [цели](*goal), [проекту](*project) или [портфелю проектов](*portfolio).

<div class="request_example yfm-code-floating-container method_get">
    <p>GET</p>
    <pre><code>https://api.tracker.yandex.net/v3/entities/{тип_сущности}/{id_сущности}/permissions</code></pre>
    <button class="yfm-clipboard-button"><svg width="16" height="16" viewBox="0 0 24 24" class="yfm-clipboard-icon" data-animation="15">
    <path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path>
    <path stroke="currentColor" fill="transparent" strokewidth="1.5" d="M9.5 13l3 3l5 -5" visibility="hidden">
        <animate id="visibileAnimation-15" attributeName="visibility" from="hidden" to="visible" dur="0.2s" fill="freeze" begin=""></animate>
        <animate id="hideAnimation-15" attributeName="visibility" from="visible" to="hidden" dur="1s" begin="visibileAnimation-15.end+1" fill="freeze"></animate>
    </path>
</svg>
</button>
</div>

<!-- source: ru/api/_assets/style/methods.md -->

<!-- endsource: ru/api/_assets/style/methods.md -->

## Формат запроса {#query}

Перед выполнением запроса [получите доступ к API](https://yandex.ru/support/tracker/ru/api/access.md).

```
GET /v3/entities/{тип_сущности}/{id_сущности}/permissions
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID или X-Cloud-Org-ID: ИДЕНТИФИКАТОР_ОРГАНИЗАЦИИ
```

<!-- source: ru/api/_includes/headings-no-body.md -->
{% cut "Заголовки" %}

* `Host`: адрес узла, предоставляющего API.

* <!-- source: ru/api/_includes/authorization.md -->
  `Authorization`: токен для авторизации в одном из форматов:

    - `OAuth OAUTH_TOKEN` при авторизации по протоколу OAuth 2.0. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#about_OAuth)

    - `Bearer IAM_TOKEN` при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Identity Hub. [Читать подробнее](https://yandex.ru/support/tracker/ru/api/access.md#iam-token)
  <!-- endsource: ru/api/_includes/authorization.md -->


* <!-- source: ru/api/_includes/org-id.md -->
  `X-Org-ID` или `X-Cloud-Org-ID`: идентификатор организации.

  - если к Трекеру привязана организация Яндекс 360 для бизнеса, используйте заголовок `X-Org-ID`,

  - если к Трекеру привязана организация Yandex Identity Hub, используйте заголовок `X-Cloud-Org-ID`.
  <!-- endsource: ru/api/_includes/org-id.md -->

  <!-- source: ru/api/_includes/org-id.md -->
  Чтобы узнать идентификатор организации, перейдите на страницу **Администрирование** → [**Организации**](https://tracker.yandex.ru/admin/orgs) и скопируйте значение поля **идентификатор**.
  <!-- endsource: ru/api/_includes/org-id.md -->


{% endcut %}
<!-- endsource: ru/api/_includes/headings-no-body.md -->

<!-- source: ru/api/_includes/resource-entity.md -->
{% cut "Ресурс" %}

Параметр | Описание | Тип данных
-------- | -------- | ----------
`тип_сущности` | Тип сущности:<ul><li>project — проект;</li><li>portfolio — портфель;</li><li>goal — цель</li></ul>| Строка
`id_сущности` | Идентификатор сущности. Чтобы получить идентификатор, посмотрите [список сущностей](search-entities.md). В качестве идентификатора можно использовать параметр `id` или `shortId`.| Строка

{% endcut %}
<!-- endsource: ru/api/_includes/resource-entity.md -->

В параметре `{id_сущности}` можно использовать значение `id` или `shortId`.

## Формат ответа {#answer}

{% list tabs %}

- Запрос выполнен успешно

   <!-- source: ru/api/_includes/answer-200.md -->
   В случае успешного выполнения запроса API возвращает ответ с кодом `200 OK`.
   <!-- endsource: ru/api/_includes/answer-200.md -->

   API возвращает объект с правами доступа. Свойства `READ`, `GRANT` и `WRITE` находятся в корне ответа. В ответ не входят `acl`, `permissionSources` и `parentEntities`.

   <!-- source: ru/api/_includes/entity-permissions.md -->
   ```json translate=no
   {
       "READ": {
           "users": [],
           "groups": [],
           "roles": []
       },
       "GRANT": {
           "users": [],
           "groups": [],
           "roles": ["AUTHOR", "OWNER"]
       },
       "WRITE": {
           "users": [],
           "groups": [],
           "roles": ["CLIENT", "AUTHOR", "FOLLOWER", "OWNER", "MEMBER"]
       }
   }
   ```
   <!-- endsource: ru/api/_includes/entity-permissions.md -->

   {% cut "Параметры ответа" %}

   <!-- source: ru/api/_includes/entity-permissions.md -->
   Параметр | Описание | Тип данных
   -------- | -------- | ----------
   [READ](#read-grant-write) | Объект с пользователями, группами и ролями, которые могут просматривать сущность | Объект
   [GRANT](#read-grant-write) | Объект с пользователями, группами и ролями, которые могут изменять настройки доступа к сущности | Объект
   [WRITE](#read-grant-write) | Объект с пользователями, группами и ролями, которые могут редактировать сущность | Объект
   <!-- endsource: ru/api/_includes/entity-permissions.md -->

   **Поля объектов** `READ`, `GRANT` и `WRITE` {#read-grant-write}

   <!-- source: ru/api/_includes/entity-permissions.md -->
   #|
   || Параметр | Описание | Тип данных ||
   || users | Список пользователей с этим типом доступа | Массив объектов ||
   || groups | Список групп с этим типом доступа | Массив объектов ||
   || roles | Список ролей сущности с этим типом доступа:<ul><li>`AUTHOR` — Автор;</li><li>`OWNER` — Ответственный;</li><li>`CLIENT` — Заказчики;</li><li>`FOLLOWER` — Наблюдатели;</li><li>`MEMBER` — Участники</li></ul> | Массив строк ||
   |#
   <!-- endsource: ru/api/_includes/entity-permissions.md -->

   **Поля объектов в массиве** `users` {#users}

   <!-- source: ru/api/_includes/user.md -->
   Параметр | Описание | Тип данных
   ----- | ----- | -----
   self | Адрес ресурса API, который содержит информацию о пользователе. | Строка
   id | Идентификатор пользователя. | Строка
   display | Отображаемое имя пользователя. | Строка
   passportUid | Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. | Число
   cloudUid | Уникальный идентификатор пользователя в Yandex Identity Hub. | Строка
   <!-- endsource: ru/api/_includes/user.md -->

   **Поля объектов в массиве** `groups` {#groups}

   <!-- source: ru/api/_includes/group-short.md -->
   Параметр | Описание | Тип данных
   ----- | ----- | -----
   self | Адрес ресурса API, который содержит информацию о группе пользователей | Строка
   id | Идентификатор группы | Строка
   display | Отображаемое имя группы | Строка
   <!-- endsource: ru/api/_includes/group-short.md -->

   {% endcut %}

- Запрос выполнен с ошибкой

   Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

   <!-- source: ru/api/_includes/answer-error-401.md -->
   401
   :   Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе [Доступ к API](https://yandex.ru/support/tracker/ru/api/access.md).
   <!-- endsource: ru/api/_includes/answer-error-401.md -->

   <!-- source: ru/api/_includes/answer-error-403.md -->
   403
   :   У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
   <!-- endsource: ru/api/_includes/answer-error-403.md -->

   <!-- source: ru/api/_includes/answer-error-404.md -->
   404
   :   Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
   <!-- endsource: ru/api/_includes/answer-error-404.md -->

{% endlist %}

{% note info "" %}

Чтобы получить расширенные настройки доступа, включая наследование прав, используйте запрос [Получить расширенные настройки доступа сущности](https://yandex.ru/support/tracker/ru/api/entities/get-access.md).

{% endnote %}

[*portfolio]: Портфель — это инструмент для объединения проектов и других портфелей по продукту, отделу или другому признаку.

Когда у вас несколько параллельных проектов, портфель позволяет взглянуть на них с высоты: как распределены ресурсы, где сроки подходят к концу.

[*project]: Проект — это набор задач из разных очередей, в которых работают над общим результатом. Это может быть запуск мобильного приложения или редизайн главной страницы сайта.

Проект помогает отслеживать: сколько задач сделано, сколько осталось, укладывается ли команда в сроки.

[*goal]: Цель — это стратегия развития или желаемый итог работы команды. Прогресс цели оценивают в количественных показателях. К цели можно привязать проекты, портфели и задачи, чтобы видеть, какая работа ведется для ее достижения.