Получить Agent Enrollment

Проверьте конкретное одноразовое подключение клиента и получите идентификатор подключённого агента.

GET/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}Версия API: v1operationId: getPartnerAgentEnrollmentОткрыть в Markdown

Назначение метода

Проверьте конкретное одноразовое подключение клиента и получите идентификатор подключённого агента.

Авторизация

Передавайте одноразовое JWT-подтверждение Developer Application, подписанное RS256, в Authorization: Bearer <application_assertion>. Это не токен доступа к Public API.

Запрос

Основной адрес API: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}

Параметры

Имя	Расположение	Тип	Обязательно	Описание	Ограничения
`relationshipId`	path	`string (uuid)`	да	Стабильный UUID связи партнёра с управляемым клиентом.	—
`enrollmentId`	path	`string (uuid)`	да	Стабильный UUID Agent Enrollment, указанного в пути.	—
`X-Request-Id`	header	`string`	нет	Необязательный идентификатор для трассировки запроса; CloudPrint вернёт безопасное значение в заголовке ответа.	maxLength: 128; example: `"order-100045-attempt-1"`

Тело запроса

У метода нет тела запроса.

Примеры запросов

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)`	да	Стабильный идентификатор Agent Enrollment.	—
`name`	`string`	да	Отображаемое имя ресурса для операторов аккаунта.	—
`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": "11111111-1111-4111-8111-111111111111",
  "claimed_at": "2026-08-06T12:00:00Z",
  "revoked_at": "2026-08-06T12:00:00Z"
}

Ошибки

HTTP-статус	Описание
`401`	Авторизация отсутствует или недействительна.
`403`	Для операции недостаточно разрешений.
`404`	Запрошенный ресурс не найден.
`422`	Поля запроса не прошли проверку.
`429`	Превышен лимит запросов; учитывайте Retry-After.
`500`	Внутренняя ошибка CloudPrint.

Связанная документация

Создать Agent EnrollmentСоздайте одноразовое подключение агента, которое можно безопасно повторить до или после первоначального подключения клиента.Отозвать Agent EnrollmentОтзовите неиспользованный Enrollment, чтобы его секретный код больше нельзя было применить для подключения агента.Настройка агента для управляемого аккаунтаСоздайте одноразовую ссылку и подключите CloudPrint Agent к нужному аккаунту клиента без входа в кабинет.

Получить Agent Enrollment ​

Назначение метода ​

Авторизация ​

Запрос ​

Параметры ​

Тело запроса ​

Примеры запросов ​

cURL ​

Ответ ​

Поля ответа ​

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

Ошибки ​

Рекомендации по интеграции ​

Связанная документация ​