Issues a single client certificate based on a custom certificate signing request (CSR).
Operation description
Before you call this operation, you must call CreateRootCACertificate to create a root CA certificate and CreateSubCACertificate to create a subordinate CA certificate. Only subordinate CA certificates can be used to issue client certificates.
QPS limit
This operation is limited to 10 queries per second (QPS) per user. API calls that exceed this limit are throttled. Throttling may affect your business, so we recommend that you call this operation at a reasonable rate.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-cert:CreateClientCertificateWithCsr |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Csr |
string |
No |
The content of the certificate signing request (CSR). Use OpenSSL or Keytool to generate a CSR. For more information, see How to create a CSR file. |
-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST----- |
| SanType |
integer |
No |
The type of the Subject Alternative Name (SAN) extension for the client certificate. Valid values:
|
1 |
| SanValue |
string |
No |
The content of the SAN extension. To enter multiple values, separate them with commas (,). |
somebody@example.com |
| Organization |
string |
No |
The name of the organization. Default: Alibaba Inc. |
阿里云计算有限公司 |
| OrganizationUnit |
string |
No |
The name of the department. Default: Alibaba Cloud CDN. |
Security |
| Country |
string |
No |
The country code, such as CN or US. |
CN |
| CommonName |
string |
No |
The common name of the certificate. Chinese characters and English letters are supported. Note
If you set the Csr parameter, the value of CommonName is based on the information in the Csr parameter. |
aliyundoc.com |
| State |
string |
No |
Specify the province or state where your organization is located. The value can contain letters. The default value is the province or state where the organization of the issuing intermediate CA is located. |
Zhejiang |
| Locality |
string |
No |
The city where the organization is located. Chinese characters and English letters are supported. By default, this is the city of the organization that owns the issuing subordinate CA certificate. |
Hangzhou |
| Algorithm |
string |
No |
The key algorithm of the client certificate. The key algorithm is in the
The encryption algorithm of the client certificate must be the same as the subordinate CA certificate, but the key length can be different. For example, if the key algorithm of the subordinate CA certificate is RSA_2048, the key algorithm of the client certificate must be RSA_1024, RSA_2048, or RSA_4096. Note
Call DescribeCACertificate to query the key algorithm of the subordinate CA certificate. |
RSA_2048 |
| ParentIdentifier |
string |
No |
The unique identifier of the subordinate CA certificate that issues the client certificate. Note
Call DescribeCACertificateList to query the unique identifiers of subordinate CA certificates. |
270ae6bb538d538c70c01f81fg3**** |
| Years |
integer |
No |
The validity period of the certificate in years. |
1 |
| Months |
integer |
No |
The validity period of the certificate in months. |
12 |
| Days |
integer |
No |
The validity period of the client certificate in days. The Days, BeforeTime, and AfterTime parameters cannot all be empty. Also, BeforeTime and AfterTime must be set together or left empty together. The following rules apply:
Note
|
365 |
| BeforeTime |
integer |
No |
The issuance time of the client certificate. This is a UNIX timestamp. The default value is the time when you call this operation. Unit: seconds. Note
The BeforeTime and AfterTime parameters must be set together or left empty together. |
1634283958 |
| AfterTime |
integer |
No |
The expiration time of the client certificate. This is a UNIX timestamp. Unit: seconds. Note
The BeforeTime and AfterTime parameters must be set together or left empty together. |
1665819958 |
| Immediately |
integer |
No |
Specifies whether to immediately return the digital certificate.
|
1 |
| EnableCrl |
integer |
No |
Specifies whether to include the Certificate Revocation List (CRL) address. 0: No 1: Yes |
1 |
| Tags |
array<object> |
No |
A list of tags. |
|
|
object |
No |
A list of tags. |
||
| Key |
string |
No |
The tag key. |
database |
| Value |
string |
No |
The value of the tag. |
1 |
| ResourceGroupId |
string |
No |
The ID of the resource group to which the certificate belongs. |
rg-ae******4wia |
In addition to the parameters in this topic, you must also include the common request parameters for all Alibaba Cloud API calls. For more information about the request format, see the request sample in the Examples section.
For more information, see Common parameters.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
CreateCertificateResponse |
||
| X509Certificate |
string |
The content of the client certificate. |
-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE----- |
| CertificateChain |
string |
The CA certificate chain. |
-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n......\n-----END CERTIFICATE-----\n |
| Identifier |
string |
The unique identifier of the client certificate. |
200ae6bb538d538c70c01f81dcf2**** |
| SerialNumber |
string |
The certificate serial number. |
084bde9cd233f0ddae33adc438cfbbbd**** |
| RequestId |
string |
The ID of the request. Alibaba Cloud generates a unique ID for each request. Use the ID to troubleshoot issues. |
31C66C7B-671A-4297-9187-2C4477247A74 |
| CertSignBufKmc |
string |
The encrypted certificate content. |
MIIDYDCCAwWgAwIBAgIU *** TmTk0CS3WNweqsjMEETyxd2pzU6DA |
| CertKmcRep1 |
string |
The ciphertext of the encrypted certificate. |
userSeal=MHkCIEu94PQAahFWuFk% *** EtFw%2FkMMBjw8i5bFfSkV%2FIUrcOJD |
Examples
Success response
JSON format
{
"X509Certificate": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----",
"CertificateChain": "-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n......\\n-----END CERTIFICATE-----\\n",
"Identifier": "200ae6bb538d538c70c01f81dcf2****",
"SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
"RequestId": "31C66C7B-671A-4297-9187-2C4477247A74",
"CertSignBufKmc": "MIIDYDCCAwWgAwIBAgIU\n***\nTmTk0CS3WNweqsjMEETyxd2pzU6DA",
"CertKmcRep1": "userSeal=MHkCIEu94PQAahFWuFk%\n***\nEtFw%2FkMMBjw8i5bFfSkV%2FIUrcOJD"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.