Изменить настройки доступа сущности

Запрос позволяет выдать или отозвать доступ к сущности — цели, проекту или портфелю проектов. Подробнее о настройках доступа читайте в разделе Как настроить права доступа в проектах, портфелях и целях.

https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/extendedPermissions

PATCH https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/permissions

Формат запроса

Перед выполнением запроса получите доступ к API.

Чтобы изменить сущность, используйте HTTP-запрос с методом PATCH. В теле запроса укажите параметры в формате JSON.

PATCH /v3/entities/<тип_сущности>/<id_сущности>/extendedPermissions
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "permissionSources": [],
    "acl": {
        "grant": {
            "READ": {
                "users": ["username1", "username2"],
                "groups": [],
                "roles": []
            },
            "WRITE": {
                "users": [],
                "groups": [1, 2],
                "roles": []
            },
            "GRANT": {
                "users": [],
                "groups": [],
                "roles": []
            }
        },
        "revoke": {
            "READ": {
                "users": {"uid": 123********},
                "groups": 3,
                "roles": []
            },
            "WRITE": {
                "users": [],
                "groups": [],
                "roles": "FOLLOWER"
            },
            "GRANT": {
                "users": [],
                "groups": [],
                "roles": []
            }
        }
    }
}

Пример 1: Включить наследование прав доступа к проекту от основного портфеля

PATCH /v3/entities/project/655f8cc52*****/extendedPermissions
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "permissionSources": "67ffd7e3********"
}

Пример 2: Отключить наследование прав доступа к проекту от основного портфеля и выдать права для редактирования проекта группе с идентификатором 2.

PATCH /v3/entities/project/655f8cc52*****/extendedPermissions
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "permissionSources": [],
   "acl": {
       "grant": {
           "WRITE": {
               "users": [],
               "groups": 2,
               "roles": []
           }
       }
   }
}

Пример 3: Выдать доступ для просмотра проекта пользователю с логином username1. Наследование прав доступа от основного портфеля должно быть предварительно отключено.

PATCH /v3/entities/project/655f8cc52*****/extendedPermissions
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "acl": {
      "grant": {
          "READ": {
              "users": {"login": "username1"}
          }
      }
  }
}

Пример 4: Отозвать права на управление доступом к проекту у пользователя с логином username2с помощью метода https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>/permissions. Наследование прав доступа от основного портфеля должно быть предварительно отключено.

PATCH /v3/entities/project/655f8cc52*****/permissions
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
  "revoke": {
      "GRANT": {
          "users": "username2"
      }
    }
}

Формат ответа

{
    "acl": {
        "READ": {
            "users": [
                {
                    "self": "https://api.tracker.yandex.net/v3/users/11********",
                    "id": "11********",
                    "display": "Имя Фамилия",
                    "passportUid": 11********
                }
            ],
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/1",
                    "id": "1",
                    "display": "Группа 1"
                }
            ],
            "roles": []
        },
        "GRANT": {
            "users": [],
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/2",
                    "id": "2",
                    "display": "Группа 2"
                }
            ],
            "roles": [
                "AUTHOR",
                "OWNER"
            ]
        },
        "WRITE": {
            "users": [],
            "groups": [
                {
                    "self": "https://api.tracker.yandex.net/v3/groups/3",
                    "id": "3",
                    "display": "Группа 3"
                }
            ],
            "roles": [
                "CLIENT",
                "AUTHOR",
                "FOLLOWER",
                "OWNER",
                "MEMBER"
            ]
        }
    },
    "permissionSources": [
        {
            "self": "https://api.tracker.yandex.net/v3/entities/portfolio/67ffd7e3********",
            "id": "67ffd7e3********",
            "display": "My portfolio"
        }
    ],
    "parentEntities": {
        "primary": {
            "self": "https://api.tracker.yandex.net/v3/entities/portfolio/67ffd7e3********",
            "id": "67ffd7e3********",
            "display": "My portfolio"
        },
        "secondary": []
    }
}