Получить один Agent Enrollment
Проверьте конкретное одноразовое подключение управляемого клиента и свяжите его с подключённым Agent.
GET
/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}Версия API: v1operationId: getPartnerAgentEnrollmentОткрыть в MarkdownНазначение метода
Проверьте конкретное одноразовое подключение управляемого клиента и свяжите его с подключённым Agent.
Авторизация
Передавайте одноразовый RS256 assertion Developer Application в Authorization: Bearer <application_assertion>. Это не токен доступа к Public API.
Запрос
Основной адрес API: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}
Параметры
| Имя | Расположение | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|---|
relationshipId | path | string (uuid) | да | Поле контракта API; учитывайте указанные тип и ограничения. | — |
enrollmentId | path | string (uuid) | да | Поле контракта API; учитывайте указанные тип и ограничения. | — |
Тело запроса
У метода нет тела запроса.
Примеры запросов
cURL
bash
curl -sS \
"https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agent-enrollments/$ENROLLMENT_ID" \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Ответ
HTTP-статус: 200 — Запрос выполнен.
Поля ответа
| Имя | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
agent_enrollment_id | string (uuid) | да | Стабильный идентификатор этого ресурса. | — |
name | string | да | Поле контракта API; учитывайте указанные тип и ограничения. | — |
status | string | да | Текущее состояние ресурса или процесса; учитывайте допустимые значения конкретного метода. | enum: pending, claimed, expired, revoked |
expires_at | string (date-time) | да | Временная метка CloudPrint в формате ISO 8601. | — |
created_at | string (date-time) | да | Временная метка CloudPrint в формате ISO 8601. | — |
agent_id | string | null (uuid) | да | Стабильный UUID подключённого агента CloudPrint. | — |
claimed_at | string | null (date-time) | да | Временная метка CloudPrint в формате ISO 8601. | — |
revoked_at | string | null (date-time) | да | Временная метка CloudPrint в формате ISO 8601. | — |
Пример ответа
json
{
"agent_enrollment_id": "11111111-1111-4111-8111-111111111111",
"name": "string",
"status": "pending",
"expires_at": "2026-08-06T12:00:00Z",
"created_at": "2026-08-06T12:00:00Z",
"agent_id": null,
"claimed_at": null,
"revoked_at": null
}Ошибки
| HTTP-статус | Описание |
|---|---|
401 | Авторизация отсутствует или недействительна. |
403 | Для операции недостаточно разрешений. |
404 | Запрошенный ресурс не найден. |
422 | Поля запроса не прошли проверку. |
429 | Превышен лимит запросов; учитывайте Retry-After. |
500 | Внутренняя ошибка CloudPrint. |
Рекомендации по интеграции
- Сохраняйте
enrollment_idпри создании ссылки и проверяйте именно этот ресурс; не определяйте завершение по другому Agent, ранее подключённому к аккаунту. - Статус
readyозначает успешное подключение — сохраните возвращённыйagent_id. Прекратите проверку приexpired,cancelledилиfailed.
Связанная документация
Создать Agent EnrollmentВыпустите идемпотентный одноразовый Enrollment до или после onboarding клиента.Отозвать Agent EnrollmentОтзовите неиспользованный Enrollment, чтобы его secret больше не мог подключить Agent.Подключение агента клиентаПодключите локальный CloudPrint Agent к правильному управляемому аккаунту без входа клиента в кабинет CloudPrint.