Saltar al contenido

Listar Agent Enrollments gestionados

Consulta Agent Enrollments pendientes, utilizados, caducados y revocados sin exponer sus códigos secretos.

GET/partner-api/v1/accounts/{relationshipId}/agent-enrollmentsVersión de la API: v1operationId: listPartnerAgentEnrollmentsVer como Markdown

Qué hace este método

Consulta Agent Enrollments pendientes, utilizados, caducados y revocados sin exponer sus códigos secretos.

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

Parámetros

NombreUbicaciónTipoObligatorioDescripciónRestricciones
relationshipIdpathstring (uuid)UUID estable de la relación del partner con el cliente gestionado.
limitqueryintegernoNúmero máximo de recursos que se devuelven en una página.min: 1; max: 100; default: 50
cursorquerystringnoCursor opaco de la página solicitada; envíalo de nuevo sin modificarlo.
X-Request-IdheaderstringnoIdentificador 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" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Respuesta

Estado HTTP: 200 — Solicitud completada.

Campos de respuesta

NombreTipoObligatorioDescripciónRestricciones
dataarrayRecursos devueltos en la página actual de resultados.
next_cursorstring | nullCursor opaco de la página siguiente; envíalo de nuevo sin modificarlo.

Ejemplo de respuesta

json
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "string"
}

Errores

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

Documentación relacionada

Guías para integrar CloudPrint, conectar el agente local y operar flujos de impresión.