Retrieve a certificate
/users/{user_id}/certificates/{certificate_id}Revoked certificates remain retrievable, with status set to revoked. Template previews are not certificates and cannot be retrieved through this operation.
The response includes an ETag representing the current revision. Send this value in the If-Match header when revoking the certificate to avoid acting on an outdated version.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
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.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/users/string/certificates/string"{ "data": { "code": "string", "deleted": true, "fields": {}, "id": "string", "issued_at": "2019-08-24T14:15:22Z", "number": { "instance": 0, "product": 0 }, "object": "certificate", "pdf_url": "string", "product_id": "string", "reissue": true, "revision": "string", "revoked": { "at": "2019-08-24T14:15:22Z", "by": { "id": "string", "kind": "admin" }, "reason": "string" }, "status": "valid", "superseded_by_certificate_id": "string", "supersedes_certificate_id": "string", "user_id": "string", "validation_url": "string" }}Issue a certificate POST
Issues a certificate to the user for the specified product. If the user already holds a valid certificate for the product, the existing certificate is returned instead of a new one being issued. To reissue a certificate, set `supersedes_certificate_id` to the certificate being replaced. Reissuing requires the `certificates.reissue` permission in addition to `certificates.create`, and the certificate identified in `supersedes_certificate_id` is revoked with the reason `reissued`. That certificate must belong to the same user and product; otherwise, the request is rejected with a validation error on `supersedes_certificate_id`. A certificate that is already revoked cannot be superseded.
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.