Issue a new Certificate Authority
Issue a new Certificate Authority
|
name
string
required |
Certificate Authority enrollment request
|
ca
string
required |
||||||||||||||||||
|
csr
string
required |
||||||||||||||||||
|
template
object (CertificateAuthorityTemplate)
required
|
||||||||||||||||||
|
||||||||||||||||||
-
200 Certificate Authority successfully issued
application/jsontypestring requiredThe type of Certificate Authority
Valuemanagedenrollboolean requiredIf true, this Certificate Authority can emit certificates
enforceKeyUnicityboolean requiredIf true, each enrollment request must have a unique key
namestring requiredThe name of the Certificate Authority
trustedForClientAuthenticationboolean requiredIf true, certificates emitted by this Certificate Authority can be used for client authentication on Stream
trustedForServerAuthenticationboolean requiredIf true, certificates emitted by this Certificate Authority can be used for server authentication by Stream
privateKeyobject (Signer Private Key) requiredThis signer's private key
keystorestring requiredThe Keystore in which the key is stored
namestring requiredThe name of the key in the keystore
hashAlgorithmstring (Hash Algorithm)The Hash Algorithm to use when signing with this key
EnumSHA1SHA224SHA256SHA384SHA512SHA3_224SHA3_256SHA3_384SHA3_512usePSSbooleanFor RSA Keys in PKCS11 Keystores only: use the PSS signature algorithm
dnstringThis Certificate Authority's Distinguished Name
queuestringThe queue to apply on this Certificate Authority's operations
crldpsarray of stringThe urls of this Certificate Authority's CRL Distribution Points
aiaobject (Authority Information Access)AIAs to add to the certificate
certificatearray of stringList of URIs on which the Certificate Authority certificate can be found
ocsparray of stringList of URIs on which the OCSP Responder of the Certificate Authority can be accessed
policyarray of objects (Certificate Policy)This Certificate Authority's Certificate Policies
Array [
oidstring requiredObject Identifier of the Policy
cpsPointerstringURI to a Certification Practice Statement document
organizationstringOrganization of the user notice. Introduced in 2.0.12
noticeNumbersarray of integerNotice numbers of the policy. Introduced in 2.0.12
explicitTextstringThe text of the user notice. Introduced in 2.0.12
]
qcStatementobject (Qualified Certificate Statements)The Qualified Certificate Statements to add to the emitted certificates
eTSIQCComplianceboolean requiredIf true, the certificate is a Qualified Certificate
eTSIQCSSCDboolean requiredIf true, the private key of the certificate resides in a Secure Signature Creation Device
eTSIRetentionPeriodinteger requiredThis indicates the duration of the retention period of material information in years
eTSIQCTypeobject requiredThis indicates which type of document can be signed by the certificate. One of eseal, esign, web or none
eTSIPDSobjectThe PKI Disclosure Statements URI for a specified language
property name*stringadditional propertyeTSITransactionLimitobject (Transaction Limit Statement)This indicates the limits of the transactions the certificate is qualified for. The maximum amount is calculated by: valueLimit * 10^(valueLimitExp)
valueLimitinteger requiredThe maximum amount this certificate is qualified for simplified to the lowest power of 10
valueLimitExpinteger requiredThe exponent of the power of 10 to multiply with valueLimit to get the maximum amount
currencyCodestring requiredThe ISO-4217 currency code for this limit
eTSILegislationarray of stringThe alpha-2 ISO-3166 country codes where the certificate is qualified
overridePermissionsobject (Override Permissions)This indicates which properties can be overriden in the enrollment request
kubooleanIf true, the Key Usages can be redefined in the enrollment request
ekubooleanIf true, the Extended Key Usages can be redefined in the enrollment request
emptyExtensionsbooleanIf true, the Empty Extensions can be redefined in the enrollment request
crldpsbooleanIf true, the CRL Distribution Points can be redefined in the enrollment request
aiabooleanIf true, the Authority Information Access can be redefined in the enrollment request
policybooleanIf true, the Certificate Policy can be redefined in the enrollment request
pathlenbooleanIf true, the length of the certification path can be redefined in the enrollment request
lifetimebooleanIf true, the certificate's lifetime can be redefined in the enrollment request
backdatebooleanIf true, the certificate's backdate can be redefined in the enrollment request
checkPoPbooleanIf true, the need to check the proof of possession can be redefined in the enrollment request
crlPolicyobject (CRL Generation Policy)Define how to generate the CRL fot his Certificate Authority
validitystring requiredThe duration of the CRL's validity
eidasboolean requiredIf true, the CRL will be EIDAS compliant
hardGenerationstringThe CRL will be generated at each period
lazyGenerationstringThe CRL will be checked at each period and generated if a new entry was added
triggersobject (TriggersManagedCertificateAuthority)Triggers that apply on events on this CA
onCRLGenerationarray of stringName of the triggers to execute when this CA's CRL are generated (manually or via cron)
onCRLGenerationErrorarray of stringName of the triggers to execute when an error occurs when this CA's CRL are generated (manually or via cron)
onCRLGenerationRecoverarray of stringName of the triggers to execute when this CA's CRL are successfully generated when the last status was error
onCRLSyncarray of stringName of the triggers to execute when this CA's CRL are synced
onCRLSyncErrorarray of stringName of the triggers to execute when this CA's CRL fail
onCRLExpirationarray of stringName of the triggers to execute when this CA's CRL expire
onCAExpirationarray of stringName of the triggers to execute when this CA expires
descriptionstringrevokedbooleanIf true, the Certificate Authority is revoked
revocationDatestringThe revocation date of this Certificate Authority
revocationReasonstring (Revocation Reason)The revocation reason of this Certificate Authority
enableOCSPbooleanEnable OCSP on this CA
ocspSignerstringName of the OCSP signer associated with this CA
compromisedbooleanDefine this CA as compromised for OCSP responses
archiveCutoffobject (Archive Cutoff)OCSP Archive Cutoff configuration
modestring requiredArchive cutoff mode. issuer uses the CA's expiration date and retention uses the retentionPeriod defined below
EnumissuerretentionretentionPeriodstringretention mode: The time during which the certificate will be kept in retention after expiration
ocspResponseMinimalDurationstringaltPrivateKeyobject (Signer Private Key)This signer's private key
keystorestring requiredThe Keystore in which the key is stored
namestring requiredThe name of the key in the keystore
hashAlgorithmstring (Hash Algorithm)The Hash Algorithm to use when signing with this key
EnumSHA1SHA224SHA256SHA384SHA512SHA3_224SHA3_256SHA3_384SHA3_512usePSSbooleanFor RSA Keys in PKCS11 Keystores only: use the PSS signature algorithm
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCA-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Certificate Authority enrollment requesttitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Certificate Authority enrollment requestdetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValueAuthentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueAuthentication expireddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-010messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCA-008messagestring requiredA short, human-readable summary of the problem type
ValueCertificate Authority enrollment errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate Authority enrollment errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueCA-009messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Certificate Authority typetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Certificate Authority typedetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueCA-014messagestring requiredA short, human-readable summary of the problem type
ValueCertificate Authority is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate Authority is expireddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueCA-015messagestring requiredA short, human-readable summary of the problem type
ValueCertificate Authority is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate Authority is revokeddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueCA-016messagestring requiredA short, human-readable summary of the problem type
ValueCertificate Authority is not readytitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate Authority is not readydetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid LicensedetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired LicensedetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCA-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate Authority not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate Authority not founddetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCA-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueCA-008messagestring requiredA short, human-readable summary of the problem type
ValueCertificate Authority enrollment errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate Authority enrollment errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807