Для AI-агентов: markdown этой страницы — /docs-content/infra/access/audience-proposals-get.md индекс документации — /llms.txt

Проверить запрос на изменение доступа

GET /v1/infra/servers/:id/audience-proposals/:proposalId

Проверяет состояние собственного запроса на изменение доступа перед повтором исходной операции.

Используйте исходный API-ключ, которым создан запрос. Другой ключ того же владельца не получает доступ к запросу.

Параметры

Параметр В Тип Обяз. Описание
Параметрid Вpath Типstring (UUID) Обяз.да ОписаниеID сервера из исходного действия. Источник — Список серверов
ПараметрproposalId Вpath Типstring (UUID) Обяз.да ОписаниеID запроса из error.details.proposalId ответа 409 AUDIENCE_APPROVAL_REQUIRED на смену политики или создание токена

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/audience-proposals/PROPOSAL_ID" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/audience-proposals/PROPOSAL_ID" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const response = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/audience-proposals/${proposalId}`,
  {
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
    },
  },
)
const { proposal } = await response.json()
console.log(proposal.state)

JavaScript — OAuth-приложение

javascript 
const response = await fetch(
  `https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/audience-proposals/${proposalId}`,
  {
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
)
const { proposal } = await response.json()
console.log(proposal.state)

Поля ответа

Успешный ответ имеет вид { "proposal": ... }, без обёртки success или data. Таблица описывает основные поля. Ответ также содержит проверяемое действие, исходный, предполагаемый и текущий состав доступа, названия участников и различия.

Поле Тип Описание
Полеproposal.id Типstring (UUID) ОписаниеID запроса
Полеproposal.state Типstring ОписаниеPENDING, APPROVED, APPLIED, REJECTED, CANCELLED, EXPIRED или STALE
Полеproposal.baseRevision Типstring ОписаниеВерсия доступа при создании. Десятичная строка
Полеproposal.currentRevision Типstring ОписаниеТекущая версия доступа. Десятичная строка
Полеproposal.expiresAt Типstring ОписаниеСрок запроса в ISO 8601
Полеproposal.canDecide Типboolean ОписаниеДля API-ключа всегда false
Полеproposal.canCancel Типboolean ОписаниеМожно ли отменить запрос сейчас
Полеproposal.resultEntityId Типstring (UUID), optional ОписаниеID созданной записи после применения. Не токен и не секретная ссылка

Пример ответа

Показаны ID, состояние и версии. Остальные поля описаны выше.

JSON 
{
  "proposal": {
    "id": "00000000-0000-4000-8000-000000000001",
    "state": "PENDING",
    "baseRevision": "0",
    "currentRevision": "0"
  }
}

Пример ответа при ошибке

404 — сервер не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Server not found"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодVALIDATION_ERROR ОписаниеНеверный UUID
HTTP401 КодMISSING_API_KEY ОписаниеКлюч не передан
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан
HTTP403 КодPORTAL_COLLABORATOR_NOT_A_MEMBER ОписаниеУ соавтора отозван или истёк ключ либо прекращено членство в портале
HTTP403 КодAUDIENCE_APPROVAL_FORBIDDEN ОписаниеТекущий ключ, его владелец или привязка к порталу больше не допускают действие
HTTP404 КодNOT_FOUND ОписаниеСервер отсутствует, удалён или не привязан к порталу. Сообщение: Server not found
HTTP404 КодNOT_FOUND ОписаниеЗапрос отсутствует на этом сервере и портале или создан другим вызывающим. Сообщение: Proposal not found

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Подтверждение и применение — разные шаги. API-ключ не может подтвердить запрос. После решения человека состояние APPROVED позволяет повторить исходный вызов с тем же ключом, точными параметрами и approvalId.
  • Чтение обнаруживает устаревший запрос. Проверка может вернуть STALE или EXPIRED. Создайте новый запрос исходным действием.
  • Секреты выдаёт исходный вызов. Токены и секретные ссылки получает исходная операция после применения, а не проверка запроса.

Смотрите также