ДескусДескус · Документация
Все разделыАвторизация

Права ключей и приложений

Право (scope) ограничивает, что может ключ или приложение. Запрос проходит, только если право есть и у ключа, и у сотрудника, от имени которого ключ работает.

Какие бывают права

Право

Что даёт

Право сотрудника в кабинете

tickets:read

Список тикетов, карточка и переписка

Тикеты — просмотр

tickets:write

Ответы клиентам, заметки, статус, приоритет, тема, ответственный

Тикеты — изменение

tickets:write + создание

Новые обращения: POST /tickets

Тикеты — создание

clients:read

Поиск и карточка клиента

Клиенты — просмотр

clients:write

Новые карточки клиентов

Клиенты — создание

kb:read

Опубликованные статьи и поиск

База знаний — просмотр

webhooks

Подписки этого ключа или приложения на события

Интеграции — изменение

Что будет без права

Нет права у ключа — 403 insufficient_scope, в details.required_scope — какое нужно. Право у ключа есть, а у сотрудника отняли — 403 forbidden.

Ответ 403

{
  "error": {
    "code": "insufficient_scope",
    "message": "У ключа нет права clients:read.",
    "details": { "required_scope": "clients:read" },
    "request_id": "req_3f9c2a7d1e6b4a8c0d2e5f71"
  }
}

Права у приложений OAuth

Приложение просит права в параметре scope при входе — через пробел: tickets:read tickets:write webhooks. Клиент видит их списком на экране согласия. Токен получает ровно запрошенные права — не больше. Подробнее — согласие и код.

Права и события

Подписка, созданная ключом или приложением, получает только события, на которые у него есть право чтения: ticket.* и message.created — с tickets:read, client.created — с clients:read. Подробнее — как работают вебхуки.

Давайте ключу минимум прав. Форме сайта хватит tickets:write, виджету статей — kb:read.

Не нашли ответ? Напишите нам
Поддержка ответит в рабочее время.
Вы сотрудник «Дескус»?Изменить статью в Дескусе