PATCH/v1/apps/{app_id}

Изменить OAuth-приложение

update_app

Меняет переданные поля. Сужение scopes сразу сужает уже выданные токены; расширение действует только для новых авторизаций. role и data_profile применяются только к приложению confidential. Тип клиента изменить нельзя. Добавлено в 1.62.0.

Аутентификация

Передайте ключ API в заголовке Authorization: Authorization: Bearer <ключ>.

Параметры пути

app_idstringобязательно
ID приложения (app_…), он же client_id.
length ≤ 36

Параметры заголовков

Idempotency-Keystring
Ключ для безопасного повтора записи: от 1 до 255 печатных символов ASCII; рекомендуется UUID v4 на каждую логическую операцию. Повтор с тем же ключом в течение 24 часов не выполняет операцию заново: он возвращает сохранённый ответ (статус, заголовки и тело) с заголовком Idempotency-Replayed: true. Тот же ключ с другим методом, путём, Content-Type или телом — ответ 409 api.idempotency_mismatch; пока первый запрос ещё выполняется — 409 api.idempotency_in_progress с Retry-After: 1. После ответа 5xx или 429 ключ освобождается, и повтор выполняет операцию заново. Ключ действует в пределах организации и вызывающей стороны (ключ API, пользователь или ключ своего источника).
length ≥ 1, length ≤ 255

Тело запроса

application/json

Объект: OAuthAppUpdate

namestring
Название для экрана согласия.
length ≥ 1, length ≤ 100
descriptionstring
Описание для экрана согласия.
length ≤ 1000
homepage_urlstring | null
Сайт приложения; null или пустая строка удаляют его.
length ≤ 2000
redirect_urisarray of string
Полный новый список адресов возврата.
items ≤ 10
scopesarray of OAuthScope
Полный новый набор областей доступа.
items ≥ 1
rolestring
Роль токенов client credentials (только confidential).
data_profilestring
Профиль доступа токенов client credentials (только confidential).

Ответы

200Успешный ответ

Заголовки ответа

RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.
Idempotency-Replayed
true — ответ воспроизведён из сохранённого для этого Idempotency-Key: операция повторно не выполнялась.

application/json

Объект: OAuthApp

idstringобязательно
ID приложения (app_ и 32 шестнадцатеричных символа), он же client_id.
namestringобязательно
Название, которое сотрудник видит на экране согласия.
descriptionstringобязательно
Описание для экрана согласия (может быть пустым).
homepage_urlstring | nullобязательно
Сайт приложения.
client_typeOAuthClientTypeобязательно
redirect_urisarray of stringобязательно
Разрешённые адреса возврата (точное совпадение строки).
scopesarray of OAuthScopeобязательно
Области доступа, которые приложение может запрашивать.
client_secret_prefixstring | nullобязательно
Первые символы секрета клиента, чтобы его узнать; null для публичного приложения.
rolestring | nullобязательно
Роль токенов client credentials (admin, editor, verifier, viewer); null для публичного приложения.
data_profilestring | nullобязательно
Профиль доступа токенов client credentials; null для публичного приложения.
authorizationsintegerобязательно
Число действующих авторизаций сотрудников.
created_atstring (date-time)обязательно
updated_atstring (date-time)обязательно

400Запрос неверен: значение параметра или состояние объекта не позволяет выполнить действие (`detail` — сообщение).

Заголовки ответа

RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: Error

401Учётные данные не переданы (нет ни cookie сессии, ни ключа API) или ключ не найден.

Заголовки ответа

RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: Error

403Действие запрещено: недостаточно прав роли, нет доступа к коллекции или карточке, запрос выполняется в режиме «Смотреть как» либо организация приостановлена или удалена (`detail` — объект с `code: org_suspended | org_deleted`).

Заголовки ответа

RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: Error

404Объект не существует или вам недоступен. API не подтверждает существование объекта с ограниченным доступом.

Заголовки ответа

RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: Error

409Состояние объекта не позволяет выполнить действие: например, дубль, идёт индексация или задание уже обработано.

Заголовки ответа

RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: Error

422Ошибка проверки: тело или параметры не соответствуют схеме (`detail` — список ошибок проверки) либо значение параметра вне допустимого диапазона (`detail` — сообщение).

Заголовки ответа

RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: Error

429Слишком много запросов (`api.rate_limited`), квота организации на минуту, день или месяц исчерпана (`api.quota_exceeded`; в `error.details` — `quota`, `limit` и `reset_at`), достигнут лимит организации или сервис ответов занят (`answers.engine_busy`). Подождите время, указанное в заголовке `Retry-After`.

Заголовки ответа

Retry-After
Сколько секунд подождать перед повтором запроса.
RateLimit-Policy
Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.
RateLimit
Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).
X-RateLimit-Remaining
Сколько запросов осталось в пределах самого строгого лимита.
X-RateLimit-Reset
Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: Error

Коды ошибок

Коды, которые эта операция может вернуть в error.code, помимо общих кодов любого запроса.

Безопасные повторы

Передавайте заголовок Idempotency-Key (например, UUID) с каждым POST и PATCH. Повтор с тем же ключом в течение 24 часов возвращает сохранённый ответ, а не выполняет запрос снова.

Лимиты частоты

В ответах есть заголовки RateLimit и RateLimit-Policy, а также прежние X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset. В ответе 429 есть Retry-After в секундах: подождите и повторите запрос.

← apps · Справочник API

curl -X PATCH 'https://api.sursa.com/v1/apps/APP_ID' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"support","description":"Customer support articles","homepage_url":"string"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Попробовать

Ключ API

Ключ хранится только в памяти этой вкладки и отправляется только на https://api.sursa.com.

Запросы работают с настоящими данными вашей организации.

app_id path *

Idempotency-Key header

Idempotency-Key

Если поле пустое, для каждого запроса создаётся новый ключ.

Тело запроса (JSON)