Developers
Certificates8

Delete a certificate

DELETE/users/{user_id}/certificates/{certificate_id}

Moves the certificate to the trash. A reason is required and is recorded with the deletion.

Deleted certificates no longer appear in the user's certificate list and can no longer be verified through public validation. If the user is still eligible, they can obtain a new certificate on demand. To invalidate a certificate while keeping it on record, revoke it through the update operation instead.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string

Public ID of the user, prefixed with usr_.

certificate_id*string

Public ID of the certificate, prefixed with cer_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/users/string/certificates/string" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
Empty

Revoke a certificate PATCH

Revokes a certificate. Revocation is the only supported change: set `status` to `revoked` and provide a `reason`. Any other field is rejected. A revoked certificate remains on record and retrievable, and public validation reports it as revoked. Revocation does not affect the user's access, progress, or points. To remove a certificate, use the delete operation instead. Send the certificate's current `ETag` in the `If-Match` header to avoid acting on an outdated version.

Gateways2

Next Page