Zum Inhalt springen

Status eines verwalteten Kunden ändern

Sperren, reaktivieren oder schließen Sie eine Kundenbeziehung der Partneranwendung dauerhaft.

POST/partner-api/v1/accounts/{relationshipId}/{action}API-Version: v1operationId: changePartnerManagedAccountStateAls Markdown anzeigen

Funktion dieser Methode

Sperren, reaktivieren oder schließen Sie eine Kundenbeziehung der Partneranwendung dauerhaft.

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}/{action}

Parameter

NamePositionTypErforderlichBeschreibungEinschränkungen
relationshipIdpathstring (uuid)jaStabile UUID der Partnerbeziehung zum verwalteten Kunden.
actionpathstringjaGewünschte Änderung des verwalteten Kontos: sperren, reaktivieren oder dauerhaft schließen.enum: suspend, resume, close
X-Request-IdheaderstringneinOptionale 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 -X POST "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/suspend" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Antwort

HTTP-Status: 200 — Anfrage erfolgreich.

Antwortfelder

NameTypErforderlichBeschreibungEinschränkungen
relationship_idstring (uuid)jaStabile UUID der Beziehung zwischen Partner und verwaltetem Kunden.
developer_account_idstring (uuid)jaStabile UUID des Entwicklerkontos, dem die Kundenbeziehung gehört.
cloudprint_account_idstring (uuid)jaStabile UUID des CloudPrint-Kontos für den verwalteten Kunden.
external_customer_idstringjaStabile Kennung, die der Integrator dem Kunden im eigenen System zuordnet.maxLength: 160
namestringjaAnzeigename der Ressource für die Kontobetreiber.maxLength: 120
application_idstring (uuid)jaStabile Kennung der Developer Application, die mit der Ressource verknüpft ist.
installation_idstring | null (uuid)jaStabile UUID der App Installation, die mit der Ressource verknüpft ist.
agent_enrollment_idstring | null (uuid)jaStabile Kennung des Agent Enrollments.
agent_onboarding_expires_atstring | null (date-time)jaVon CloudPrint erfasster ISO-8601-Zeitstempel.
agent_onboarding_urlstring | null (uri)jaKanonischer 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"
onboarding_statusstringjaAktueller Bereitschaftsstatus der CloudPrint-Einrichtung des verwalteten Kunden.enum: provisioning, waiting_for_agent, ready, failed
statusstringjaAktueller Ressourcen- oder Prozessstatus; verwenden Sie die Enum-Werte der jeweiligen Methode.enum: provisioning, active, suspended, closed
created_atstring (date-time)jaVon CloudPrint erfasster ISO-8601-Zeitstempel.
updated_atstring (date-time)jaVon CloudPrint erfasster ISO-8601-Zeitstempel.

Beispielantwort

json
{
  "relationship_id": "11111111-1111-4111-8111-111111111111",
  "developer_account_id": "11111111-1111-4111-8111-111111111111",
  "cloudprint_account_id": "11111111-1111-4111-8111-111111111111",
  "external_customer_id": "string",
  "name": "string",
  "application_id": "11111111-1111-4111-8111-111111111111",
  "installation_id": "11111111-1111-4111-8111-111111111111",
  "agent_enrollment_id": "11111111-1111-4111-8111-111111111111",
  "agent_onboarding_expires_at": "2026-08-06T12:00:00Z",
  "agent_onboarding_url": "https://connect.cloudprint.me/setup#token=cpat_example",
  "onboarding_status": "provisioning",
  "status": "provisioning",
  "created_at": "2026-08-06T12:00:00Z",
  "updated_at": "2026-08-06T12:00:00Z"
}

Fehler

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

Verwandte Dokumentation

Anleitungen zur CloudPrint-Integration, zur Verbindung des lokalen Agenten und zum zuverlässigen Betrieb von Druckabläufen.