Exporting a Certificate

Function

This API is used to export a certificate.

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. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v3/scm/certificates/{certificate_id}/export

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
certificate_id	Yes	String	Certificate ID. Minimum: 16 Maximum: 16

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 32 Maximum: 2097152

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
entire_certificate	String	Certificate and certificate chain. Minimum: 1 Maximum: 12288
certificate	String	Certificate content, excluding the certificate chain. Minimum: 1 Maximum: 4096
certificate_chain	String	Certificate chain Minimum: 1 Maximum: 8192
private_key	String	Private key of a certificate Minimum: 1 Maximum: 4096
enc_certificate	String	Encryption certificate content Minimum: 1 Maximum: 4096
enc_private_key	String	Encryption certificate private key. Method of self-generating CSR files: This field is encrypted and needs to be decrypted. Method of Non-self-generated CSR files: This field does not need to be decrypted. The decryption process is as follows: Obtain the symmetric key ciphertext and encrypted private key ciphertext from digital envelope. Use the signature private key to decrypt the symmetric key ciphertext to obtain the symmetric key plaintext. Use the symmetric key to decrypt the encrypted private key ciphertext to obtain the encrypted private key plaintext. Minimum: 1 Maximum: 4096

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code returned for an error request. Minimum: 3 Maximum: 36
error_msg	String	Error information returned for an error request. Minimum: 0 Maximum: 1024

Example Requests

None

Example Responses

Status code: 200

Normal return.

{
  "entire_certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE----------BEGIN CERTIFICATE---******----END CERTIFICATE-----",
  "certificate" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----",
  "certificate_chain" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----",
  "private_key" : "-----BEGIN RSA PRIVATE KEY-----******-----END RSA PRIVATE KEY-----"
}

Status code: 401

Authentication failed.

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

Status code: 403

Access denied.

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

Status code: 500

Failed to complete the request because of an internal server error.

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

Status Codes

Status Code	Description
200	Normal return.
401	Authentication failed.
403	Access denied.
404	Access page not found.
500	Failed to complete the request because of an internal server error.