Agent Enrollment abrufen

Rufen Sie das betreffende Agent Enrollment eines verwalteten Kunden ab und ordnen Sie es dem verbundenen Agenten zu.

GET/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}API-Version: v1operationId: getPartnerAgentEnrollmentAls Markdown anzeigen

Funktion dieser Methode

Rufen Sie das betreffende Agent Enrollment eines verwalteten Kunden ab und ordnen Sie es dem verbundenen Agenten zu.

Authentifizierung

Senden Sie eine einmalige RS256-Assertion der Developer Application in Authorization: Bearer <application_assertion>. Sie ist kein Public-API-Zugriffstoken.

Anfrage

Produktions-URL: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}

Parameter

Name	Position	Typ	Erforderlich	Beschreibung	Einschränkungen
`relationshipId`	path	`string (uuid)`	ja	Stabile UUID der Partnerbeziehung zum verwalteten Kunden.	—
`enrollmentId`	path	`string (uuid)`	ja	Stabile UUID des Agent Enrollments im Pfad.	—
`X-Request-Id`	header	`string`	nein	Optionale Kennung zur Anfrageverfolgung; CloudPrint gibt einen sicheren Wert im Antwort-Header zurück.	maxLength: 128; example: `"order-100045-attempt-1"`

Anfrageinhalt

Die Methode hat keinen Anfrageinhalt.

Anfragebeispiele

cURL

bash

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

Antwort

HTTP-Status: 200 — Anfrage erfolgreich.

Antwortfelder

Name	Typ	Erforderlich	Beschreibung	Einschränkungen
`agent_enrollment_id`	`string (uuid)`	ja	Stabile Kennung des Agent Enrollments.	—
`name`	`string`	ja	Anzeigename der Ressource für die Kontobetreiber.	—
`status`	`string`	ja	Aktueller Ressourcen- oder Prozessstatus; verwenden Sie die Enum-Werte der jeweiligen Methode.	enum: `pending`, `claimed`, `expired`, `revoked`
`expires_at`	`string (date-time)`	ja	Von CloudPrint erfasster ISO-8601-Zeitstempel.	—
`created_at`	`string (date-time)`	ja	Von CloudPrint erfasster ISO-8601-Zeitstempel.	—
`agent_id`	`string \| null (uuid)`	ja	Stabile UUID des verbundenen CloudPrint Agenten.	—
`claimed_at`	`string \| null (date-time)`	ja	Von CloudPrint erfasster ISO-8601-Zeitstempel.	—
`revoked_at`	`string \| null (date-time)`	ja	Von CloudPrint erfasster ISO-8601-Zeitstempel.	—

Beispielantwort

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

Fehler

HTTP-Status	Beschreibung
`401`	Authentifizierung fehlt oder ist ungültig.
`403`	Das Token hat nicht die erforderlichen Berechtigungen.
`404`	Ressource nicht gefunden.
`422`	Mindestens ein Feld ist ungültig.
`429`	Anfragelimit überschritten; beachten Sie Retry-After.
`500`	Interner CloudPrint-Fehler.

Hinweise zur Integration

Speichern Sie agent_enrollment_id beim Erstellen des Links und fragen Sie genau diese Ressource ab.
Fragen Sie bei pending weiter ab, speichern Sie bei claimed die agent_id und beenden Sie bei expired oder revoked.

Agent Enrollment abrufen ​

Funktion dieser Methode ​

Authentifizierung ​

Anfrage ​

Parameter ​

Anfrageinhalt ​

Anfragebeispiele ​

cURL ​

Antwort ​

Antwortfelder ​

Beispielantwort ​

Fehler ​

Hinweise zur Integration ​

Verwandte Dokumentation ​