Revoke an Agent Enrollment
Revoke one unclaimed Enrollment so its secret can no longer connect an Agent.
DELETE
/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}API version: v1operationId: revokePartnerAgentEnrollmentView as MarkdownWhat this endpoint does
Revoke one unclaimed Enrollment so its secret can no longer connect an Agent.
Authentication
Send a one-time RS256 Developer Application assertion in Authorization: Bearer <application_assertion>. This assertion is not a Public API access token.
Request
Production base URL: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}
Parameters
| Name | Location | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
relationshipId | path | string (uuid) | yes | Stable UUID of the partner's relationship with the managed customer. | — |
enrollmentId | path | string (uuid) | yes | Stable UUID of the Agent Enrollment addressed by the path. | — |
X-Request-Id | header | string | no | Optional request identifier for tracing; CloudPrint returns a safe value in the response header. | maxLength: 128; example: "order-100045-attempt-1" |
Request body
This endpoint has no request body.
Example requests
cURL
bash
curl -sS -X DELETE \
"https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agent-enrollments/$ENROLLMENT_ID" \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Response
HTTP status: 204 — Agent Enrollment revoked
Errors
| HTTP status | Description |
|---|---|
401 | Application assertion is invalid |
403 | Developer Account production access is not active |
404 | Managed Account or Agent Enrollment was not found |
422 | Relationship ID or Agent Enrollment ID is invalid |
429 | Rate limit exceeded |
500 | Unexpected error |
Related documentation
List managed Agent EnrollmentsList pending, claimed, expired and revoked Agent Enrollments without exposing their secret codes.Create a managed Agent EnrollmentIssue an idempotent one-time Enrollment before or after customer onboarding.Set up an Agent for a managed accountCreate a one-time setup link and connect CloudPrint Agent to the correct customer account without a portal login.