Applying for a Certificate

X-Auth-Token

Yes

String

User token. For details, see Obtaining a User Token.

issuer_id

Yes

String

ID of the parent CA.

Minimum: 36

Maximum: 36

key_algorithm

Yes

String

Key algorithm. The options are as follows:

• RSA2048: RSA algorithm with the key length of 2048 bits

• RSA4096: RSA algorithm with the key length of 4096 bits

• EC256: Elliptic Curve Digital Signature Algorithm (ECDSA) with the key length of 256 bits

• EC384: Elliptic Curve Digital Signature Algorithm (ECDSA) with the key length of 384 bits

signature_algorithm

Yes

String

Signature hash algorithm. The options are as follows:

• SHA256

• SHA384

• SHA512

distinguished_name

Yes

CertDistinguishedName object

Certificate name. For details, see data structure for the CertDistinguishedName field.

validity

Yes

Validity object

Certificate validity. For details, see data structure for the Validity field.

key_usages

No

Array of strings

Key usage. For details, see 4.2.1.3 in RFC 5280.

• digitalSignature: The key is used as a digital signature.

• nonRepudiation: The key can be used for non-repudiation.

• keyEncipherment: The key can be used for key encryption.

• dataEncipherment: The key can be used for data encryption.

• keyAgreement: The key can be used for key negotiation.

• keyCertSign: The key can issue a certificate.

• cRLSign: The key can issue a certificate revocation list (CRL).

• encipherOnly: The key is used only for encryption.

• decipherOnly: The key is used only for decryption.

subject_alternative_names

No

Array of SubjectAlternativeName objects

Alternative name for the subject. For details, see data structure for the SubjectAlternativeName field.

• Array size: [0, 20]

extended_key_usage

No

ExtendedKeyUsage object

Extended Key Usage. For details, see data structure for the ExtendedKeyUsage field.

customized_extension

No

CustomizedExtension object

Customized extension information. For details, see data structure for the CustomizedExtension field.

common_name

Yes

String

Common certificate name (CN).

Minimum: 1

Maximum: 64

country

No

String

Country code, which must comply with the regular expression "[A-Za-z]{2}".If not passed in, the value corresponding to the parent CA is inherited by default.

Minimum: 2

Maximum: 2

state

No

String

State or city name.If not passed in, the value corresponding to the parent CA is inherited by default.

Minimum: 1

Maximum: 128

locality

No

String

Country/Region.If not passed in, the value corresponding to the parent CA is inherited by default.

Minimum: 1

Maximum: 128

organization

No

String

Organization name.If not passed in, the value corresponding to the parent CA is inherited by default.

Minimum: 1

Maximum: 64

organizational_unit

No

String

Organization Unit (OU).If not passed in, the value corresponding to the parent CA is inherited by default.

Minimum: 1

Maximum: 64

type

Yes

String

Validity period type, which is mandatory. The options are as follows:

• YEAR: Year (12 months)

• MONTH: Month (31 days)

• DAY: Day

• HOUR: Hour

value

Yes

Integer

The certificate validity period. The value of this parameter varies depending on the value of type:

• Root CA certificates: no longer than 30 years

• Subordinate CA or private certificates: no longer than 20 years

start_from

No

Integer

Start time. The options are as follows:

• The value is a timestamp in milliseconds. For example, 1645146939688 indicates 2022-02-18 09:15:39.

• The value of start_from cannot be earlier than the result of the value of current_time minus 5 minutes.

type

Yes

String

Type of the alternative name. Currently, only DNS, IP, DNS, and URI are allowed.

• DNS

• IP

• EMAIL

• URI

value

Yes

String

Value of the corresponding alternative name type.

• DNS type. Length range: 0 to 253 characters

• IP address type. Length range: 0 to 39 characters

• EMAIL type. Length range: 0 to 256 characters

• URI address type. Length range: 0 to 253 characters

server_auth

No

Boolean

Server authentication. The OID is 1.3.6.1.5.5.7.3.1.

• true

• false

NOTE:

Enable this enhanced key usage for the server certificate. The default value is false.

Default: false

client_auth

No

Boolean

Client authentication. The OID is 1.3.6.1.5.5.7.3.2

• true

• false

NOTE:

Enable this enhanced key usage for the client certificate. The default value is false.

Default: false

code_signing

No

Boolean

Signing of downloadable executable code client authentication. The OID is 1.3.6.1.5.5.7.3.3.

• true

• false

NOTE:

The default value is false.

Default: false

email_protection

No

Boolean

Email protection. The OID is 1.3.6.1.5.5.7.3.4.

• true

• false

NOTE:

The default value is false.

Default: false

time_stamping

No

Boolean

Binding the hash of an object to a time. The OID is 1.3.6.1.5.5.7.3.8

• true

• false

NOTE:

The default value is false.

Default: false

object_identifier

No

String

Object identifier

NOTE:

The value of this parameter must be a dot-decimal notation string that complies with the ASN1 specifications, for example, 1.3.6.1.4.1.2011.4.99.

Minimum: 1

Maximum: 64

value

No

String

Custom attribute content

Minimum: 1

Maximum: 64

certificate_id

String

ID of the certificate being issued.

Minimum: 36

Maximum: 36

error_code

String

Error code

Minimum: 3

Maximum: 36

error_msg

String

Error message

Minimum: 0

Maximum: 1024

error_code

String

Error code

Minimum: 3

Maximum: 36

error_msg

String

Error message

Minimum: 0

Maximum: 1024

error_code

String

Error code

Minimum: 3

Maximum: 36

error_msg

String

Error message

Minimum: 0

Maximum: 1024

error_code

String

Error code

Minimum: 3

Maximum: 36

error_msg

String

Error message

Minimum: 0

Maximum: 1024

error_code

String

Error code

Minimum: 3

Maximum: 36

error_msg

String

Error message

Minimum: 0

Maximum: 1024

200

Request succeeded.

400

Invalid request parameters.

401

Token required for the requested page.

403

Authentication failed.

404

No resources available or found.

500

Internal service error.