Sign in

v1

latestOpenAPI 3.0.12026-07-1719674.9 KB
fabric-ca-server

Perform revocation of one of the following:

  • a specific certificate identified by a serial number and AKI (Authority Key Identitifer), or
  • all certificates associated with the identity and prevent any future enrollments for this identity.
    The caller must have the hf.Revoker attribute.
post/api/v1/revoke

Query parameters

castring

The name of the CA to direct this request to within the server, or the default CA if not specified

Headers

Authorizationstring required

An enrollment token consisting of two base 64 encoded parts separated by a period:

  • an enrollment certificate;
  • a signature over the HTTP method, URL path, request body, and the certificate.

Request body

idstring

The enrollment ID of the identity whose certificates are to be revoked, including both enrollment certificates and transaction certificates. All future enrollment attempts for this identity will be rejected.
If this field is specified, the serial and aki fields are ignored.

akistring

The Authority Key Identifier of the certificate which is to be revoked.
The serial field must also be specified.

serialstring

The serial number of the certificate which is to be revoked.
The aki (Authority Key Identifier) field must also be specified.

reasonstring

The reason for revocation.
See https://godoc.org/golang.org/x/crypto/ocsp for valid values.
The default value is 0 (ocsp.Unspecified).

canamestring

Name of the CA to direct traffic to within server.

gencrlboolean

When this request results in revoking one or more certificates, this boolean indicates whether to generate a CRL and return it in the response

Response

Successfully completed the revocation

{"stackTrail":"components:schemas:responseBase:properties:result","oasType":"schema","type":"unknown"}
successboolean required

Boolean indicating if the request was successful.