Verwaltetes Agent Enrollment erstellen

Stellen Sie vor oder nach dem Kunden-Onboarding ein idempotentes, einmaliges Enrollment aus.

POST/partner-api/v1/accounts/{relationshipId}/agent-enrollmentsAPI-Version: v1operationId: createPartnerAgentEnrollmentAls Markdown anzeigen

Funktion dieser Methode

Stellen Sie vor oder nach dem Kunden-Onboarding ein idempotentes, einmaliges Enrollment aus.

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

Parameter

Name	Position	Typ	Erforderlich	Beschreibung	Einschränkungen
`relationshipId`	path	`string (uuid)`	ja	Stabile UUID der Partnerbeziehung zum verwalteten Kunden.	—
`Idempotency-Key`	header	`string`	ja	Stabiler, vom Client erzeugter Schlüssel, damit Wiederholungen das ursprüngliche Ergebnis liefern und kein Duplikat erstellen.	minLength: 1; maxLength: 200
`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

Inhaltstyp: application/json

Name	Typ	Erforderlich	Beschreibung	Einschränkungen
`name`	`string`	nein	Anzeigename der Ressource für die Kontobetreiber.	minLength: 1; maxLength: 255; example: `"Warehouse workstation 2"`
`agent_onboarding`	`object`	ja	Einmalige Verbindungsdaten für den Agenten des verwalteten Kunden.	—
`replaces_enrollment_id`	`string \| null (uuid)`	nein	UUID des vorherigen Agent Enrollments, das durch dieses Enrollment ersetzt wird.	—

Anfragebeispiele

cURL

bash

curl -sS -X POST "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agent-enrollments" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION" \
  -H 'Idempotency-Key: customer-42-agent-2-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Warehouse workstation 2",
    "agent_onboarding": {
      "return_uri": "https://app.integrator.example/cloudprint/callback",
      "state": "new-single-use-random-state"
    }
  }'

Antwort

HTTP-Status: 201 — Ressource erstellt.

Antwortfelder

Name	Typ	Erforderlich	Beschreibung	Einschränkungen
`agent_enrollment_id`	`string (uuid)`	ja	Stabile Kennung des Agent Enrollments.	—
`expires_at`	`string (date-time)`	ja	Von CloudPrint erfasster ISO-8601-Zeitstempel.	—
`agent_onboarding_url`	`string (uri)`	ja	Kanonischer Einmal-Link zum Verbinden eines Agenten. Öffnen Sie ihn vollständig und unverändert und schreiben Sie ihn nicht in Protokolldateien.	example: `"https://connect.cloudprint.me/setup#token=cpat_example"`
`status`	`string`	ja	Aktueller Ressourcen- oder Prozessstatus; verwenden Sie die Enum-Werte der jeweiligen Methode.	enum: `pending`

Beispielantwort

json

{
  "agent_enrollment_id": "11111111-1111-4111-8111-111111111111",
  "expires_at": "2026-08-06T12:00:00Z",
  "agent_onboarding_url": "https://connect.cloudprint.me/setup#token=cpat_example",
  "status": "pending"
}

Fehler

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

Verwaltetes Agent Enrollment erstellen ​

Funktion dieser Methode ​

Authentifizierung ​

Anfrage ​

Parameter ​

Anfrageinhalt ​

Anfragebeispiele ​

cURL ​

Antwort ​

Antwortfelder ​

Beispielantwort ​

Fehler ​

Verwandte Dokumentation ​