Issues a client certificate based on a system-generated Certificate Signing Request (CSR).
Operation description
Before you call this operation, you must call CreateRootCACertificate to create a root certificate authority (CA) certificate and CreateSubCACertificate to create a subordinate CA certificate. Only subordinate CA certificates can issue client certificates.
QPS limits
This operation is limited to 10 queries per second (QPS) per user. If the limit is exceeded, API calls are throttled. This may affect your business. Plan your API calls accordingly.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-cert:CreateClientCertificate |
create |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SanType |
integer |
No |
The type of the Subject Alternative Name (SAN) extension of the client certificate. Valid values:
|
1 |
| SanValue |
string |
No |
The specific extensions for the client certificate. Separate multiple extensions with commas. |
somebody@example.com |
| Organization |
string |
No |
The name of the organization. Default value: Alibaba Inc. |
阿里云 |
| OrganizationUnit |
string |
No |
The name of the department. Default value: Aliyun CDN. |
IT |
| Country |
string |
No |
The country code. Default value: CN. |
CN |
| CommonName |
string |
No |
The name of the certificate user. For a client authentication certificate, the user is typically a person, company, organization, or application. Enter the common name of the user, such as John Doe, Alibaba, Alibaba Cloud Cryptography Platform, or Tmall Genie. |
aliyun |
| State |
string |
No |
The name of the province or state where the organization is located. Chinese and English characters are supported. The default value is the province or state of the organization that is associated with the issuing subordinate CA certificate. |
Zhejiang |
| Locality |
string |
No |
The name of the city where the organization is located. Chinese and English characters are supported. The default value is the city of the organization that is associated with the issuing subordinate CA certificate. |
杭州市 |
| 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. 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 identifier of the subordinate CA certificate. |
273ae6bb538d538c70c01f81jh2**** |
| Years |
integer |
No |
The validity period of the certificate in years. |
5 |
| Months |
integer |
No |
The validity period of the certificate in months. |
1 |
| Days |
integer |
No |
The validity period of the client certificate in days. You cannot leave Days, BeforeTime, and AfterTime all empty. You must specify both BeforeTime and AfterTime or leave them both empty. The following rules apply:
Note
|
365 |
| BeforeTime |
integer |
No |
The issuance time of the client certificate. This value 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 both empty or both specified. |
1634283958 |
| AfterTime |
integer |
No |
The expiration time of the client certificate. This value is a UNIX timestamp. Unit: seconds. Note
The BeforeTime and AfterTime parameters must be both empty or both specified. |
1665819958 |
| Immediately |
integer |
No |
Specifies whether to return the digital certificate immediately.
|
1 |
| EnableCrl |
integer |
No |
Specifies whether to include the Certificate Revocation List (CRL) address. 0: No 1: Yes |
1 |
| Tags |
array<object> |
No |
The list of tags. |
|
|
object |
No |
The list of tags. |
||
| Key |
string |
No |
The tag key. |
account |
| Value |
string |
No |
The tag value. |
1 |
| ResourceGroupId |
string |
No |
The ID of the resource group. |
rg-aek****wia |
| CustomIdentifier |
string |
No |
The custom identifier. This is a unique key. |
****6bb538d538c70c01f81jh2**** |
In addition to the preceding request parameters, you must specify common request parameters when you make an API call.
For the request format, see the request sample in the Examples section of this topic.
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. |
190ae6bb538d538c70c01f81dcf2**** |
| SerialNumber |
string |
The certificate serial number. |
084bde9cd233f0ddae33adc438cfbbbd**** |
| RequestId |
string |
The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues. |
8C467B38-3910-447D-87BC-AC049166F216 |
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": "190ae6bb538d538c70c01f81dcf2****",
"SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
"RequestId": "8C467B38-3910-447D-87BC-AC049166F216"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.