Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document revocation parameter formats #1112

Merged
merged 1 commit into from Oct 15, 2020
Merged

Document revocation parameter formats #1112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/api/endpoint_revoke.txt
View file
Open in desktop
Expand Up @@ -5,10 +5,10 @@ Method: POST

Required parameters:

* serial: a string specifying the serial number of a certificate
* serial: a string specifying the serial number of a certificate in decimal format
* authority_key_id: a string specifying the authority key identifier
of the certificate to be revoked; this is used to distinguish
which private key was used to sign the certificate.
which private key was used to sign the certificate. Should be formatted without colons and all lowercase.
* reason: a string identifying why the certificate was revoked; see,
for example, ReasonStringToCode in the ocsp package or section
4.2.1.13 of RFC 5280. The "reasons" used here are the ReasonFlag
Expand All @@ -21,6 +21,6 @@ Result:
Example:

$ curl -d '{"serial": "7961067322630364137", \
"authority_key_id": "00:01:02:03:04:05:07", \
"authority_key_id": "a0b1c2d3e4f5", \
"reason": "superseded"}' \
${CFSSL_HOST}/api/v1/cfssl/revoke