Obtener un Agent Enrollment

Consulta el Agent Enrollment creado para un cliente gestionado y relaciónalo con el agente conectado.

GET/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}Versión de la API: v1operationId: getPartnerAgentEnrollmentVer como Markdown

Qué hace este método

Consulta el Agent Enrollment creado para un cliente gestionado y relaciónalo con el agente conectado.

Autenticación

Envía una aserción RS256 de un solo uso de la Developer Application en Authorization: Bearer <application_assertion>. No es un token de acceso de Public API.

Solicitud

URL de producción: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}

Parámetros

Nombre	Ubicación	Tipo	Obligatorio	Descripción	Restricciones
`relationshipId`	path	`string (uuid)`	sí	UUID estable de la relación del partner con el cliente gestionado.	—
`enrollmentId`	path	`string (uuid)`	sí	UUID estable del Agent Enrollment indicado en la ruta.	—
`X-Request-Id`	header	`string`	no	Identificador opcional para rastrear la solicitud; CloudPrint devuelve un valor seguro en la cabecera de respuesta.	maxLength: 128; example: `"order-100045-attempt-1"`

Cuerpo de la solicitud

El método no tiene cuerpo de solicitud.

Ejemplos de solicitud

cURL

bash

curl -sS \
  "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agent-enrollments/$ENROLLMENT_ID" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Respuesta

Estado HTTP: 200 — Solicitud completada.

Campos de respuesta

Nombre	Tipo	Obligatorio	Descripción	Restricciones
`agent_enrollment_id`	`string (uuid)`	sí	Identificador estable del Agent Enrollment.	—
`name`	`string`	sí	Nombre legible del recurso que ven los operadores de la cuenta.	—
`status`	`string`	sí	Estado actual del recurso o flujo; usa los valores enum específicos del método.	enum: `pending`, `claimed`, `expired`, `revoked`
`expires_at`	`string (date-time)`	sí	Marca de tiempo ISO 8601 registrada por CloudPrint.	—
`created_at`	`string (date-time)`	sí	Marca de tiempo ISO 8601 registrada por CloudPrint.	—
`agent_id`	`string \| null (uuid)`	sí	UUID estable del agente CloudPrint conectado.	—
`claimed_at`	`string \| null (date-time)`	sí	Marca de tiempo ISO 8601 registrada por CloudPrint.	—
`revoked_at`	`string \| null (date-time)`	sí	Marca de tiempo ISO 8601 registrada por CloudPrint.	—

Ejemplo de respuesta

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"
}

Errores

Estado HTTP	Descripción
`401`	Falta la autenticación o no es válida.
`403`	El token no tiene permisos suficientes.
`404`	No se encontró el recurso.
`422`	Uno o varios campos no son válidos.
`429`	Se superó el límite de solicitudes; respeta Retry-After.
`500`	Error interno de CloudPrint.

Recomendaciones de integración

Guarda agent_enrollment_id al crear el enlace y consulta exactamente ese recurso.
Continúa mientras el estado sea pending; guarda agent_id en claimed y detente en expired o revoked.

Documentación relacionada

Crear un Agent Enrollment gestionadoGenera un Enrollment idempotente de un solo uso antes o después de incorporar al cliente.Revocar un Agent EnrollmentRevoca un Enrollment aún no utilizado para que su código secreto ya no pueda conectar un agente.Conectar un agente de clienteVincula CloudPrint Agent con la cuenta administrada correcta sin iniciar sesión en el panel del cliente.

Obtener un Agent Enrollment ​

Qué hace este método ​

Autenticación ​

Solicitud ​

Parámetros ​

Cuerpo de la solicitud ​

Ejemplos de solicitud ​

cURL ​

Respuesta ​

Campos de respuesta ​

Ejemplo de respuesta ​

Errores ​

Recomendaciones de integración ​

Documentación relacionada ​