Revoking a Subordinate CA

Function

This API is used to revoke a subordinate CA.

If you do not want to provide the revocation reason, set the request body to {}. Otherwise, an error will be reported.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
pca:ca:revoke	Write	ca *	g:ResourceTag/<tag-key>	-	-
pca:ca:revoke	Write	-	g:EnterpriseProjectId	-	-

URI

POST /v1/private-certificate-authorities/{ca_id}/revoke

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
ca_id	Yes	String	ID of the sub-CA you want to revoke. Minimum: 36 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. For details, see [Obtaining a User Token] (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
reason	No	String	Reason for revocation. The options are as follows: UNSPECIFIED: No revocation reason is specified during revocation. The default value is used. KEY_COMPROMISE: The certificate key material is disclosed. CERTIFICATE_AUTHORITY_COMPROMISE: CA key materials may be disclosed on the issuing path. AFFILIATION_CHANGED: The subject or other information in the certificate has been changed. SUPERSEDED: This certificate has been replaced. CESSATION_OF_OPERATION: The entity in this certificate or issuing path has ceased to operate CERTIFICATE_HOLD: The certificate is invalid at present and may take effect in the future. PRIVILEGE_WITHDRAWN: The certificate no longer has the permission on the attributes it declares. ATTRIBUTE_AUTHORITY_COMPROMISE: The certificate authority that warrants this certificate attribute may have been compromised. NOTE: Note: If you do not want to provide the revocation reason, set the request body to "{}". Otherwise, an error will be reported. UNSPECIFIED is the default value.

Response Parameters

Status code: 204

Request succeeded, but no response body returned.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Example Requests

When you call this API, a token with the permission to use this API is mandatory for the X-Auth-Token field.

POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificate-authorities/6434f74f-2d13-4e6a-89eb-93ee313f1a43/revoke

{
  "reason" : "KEY_COMPROMISE"
}

Example Responses

Status code: 400

Invalid request parameters.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 401

Token required for the requested page.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 403

Authentication failed.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 404

No resources available or found.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 500

Internal service error.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code	Description
204	Request succeeded, but no response body returned.
400	Invalid request parameters.
401	Token required for the requested page.
403	Authentication failed.
404	No resources available or found.
500	Internal service error.