Suche in diesem Bereich
Table of Contents
Function
The Certificate Object represents all the information in a certificate. It is used for most functions in the SSL Manager API and is the most important core element of the API.
The creation date (created) is always set to the start of the day.
Example: 2017-01-01 13:59:27 is set to 2017-01-01 00:00:00
The expiration date (expire) is always set to the end of the day.
Example: 2017-01-01 13:59:27 is set to 2017-01-01 23:59:59
Structure
| Keyword JSON | Keyword XML | Occurs | Type | Format | Description |
|---|---|---|---|---|---|
| adminContact | admin | 1 | object | SSLContact | The administrative contact |
| authentication | authentication | 0 - 1 | object | CertAuthentication | The authentication of the certificate |
| certificateTransparency | certificate_transparency | 0 - 1 | boolean | Activates the certificate transparency for a certificate. Default is "True". | |
| certificateTransparencyPrivacy | certificate_transparency_privacy | 0 - 1 | enum | CertificateTransparencyPrivacy | The privacy settings for certificate transparency. Default is "Redacted". |
| certificationAuthority | certification_authority | 0 - n | object | CaCertificate | The intermediates for the certificate |
| comment | comment | 1 | string | User defined field. Can only be updated in JSON via PUT /certificate/{id}/_comment. The corresponding ACLs are required for this. | |
| created | created | 0 - 1 | string | date | The date on which the object was created. The creation date is always set to the beginning of the day. Example : 2017-01-01 13:59:27 becomes 2017-01-01 00:00:00 |
| csr | csr | 1 | string | CSR - Key (Certificate Signing Request) | |
| domain | domain | string | The domain, the certificate belongs to | ||
| expire | expire | 0 - 1 | string | date | The date on which the certificate expires |
| extension | extension | 0 - 1 | object | ExtendedValidationAddon | Additional validation data. Only certain Comodo products require this |
| firstname | firstname | 0 - 1 | string | First Name. Only for S/MIME! | |
| hasCsr | has_csr | 0 - 1 | boolean | States if a self created CSR is to be used for S/MIME. Default is false. Only for S/MIME! | |
| histories | histories | 0 - 1 | object | Certificate history (old versions) | |
| id | id | 1 | integer | Int32 | The unique certificate ID |
| lastname | lastname | 0 - 1 | string | Last Name. Only for S/MIME! | |
| lifetime | lifetime | 1 | integer | Int32 | The certificate term in months |
| name | name | 1 | string | The name of the certificate | |
| orderId | order_id | 1 | string | The unique certificate order number | |
| organizationUnitName | organization_unit_name | 0 - 1 | string | Department name. Only for S/MIME! | |
| owner | owner | 0 - 1 | object | User | The owner of the certificate in the system |
| password | password | 0 - 1 | string | The password that is to be used for the certificate download. Only for S/MIME! | |
| product | product | 1 | enum | SSLProduct | Defines the different certificate products. |
| serialNumber | serial_number | 0 - 1 | string | Serial number of the certificate | |
| server | server | 0 - 1 | string | The certificate | |
| signatureHashAlgorithm | sha | 1 | enum | SignatureHashAlgorithm | The signature hash algorithm which was used. |
| software | software | 1 | enum | ServerSoftwareType | The webserver software in use |
| subjectAlternativeName | subject_alternative_name | 0 - n | object | SubjectAlternativeName | Subject Alternative Name ( SAN ) |
| technicalContact | technical | 1 | object | SSLContact | The technical contact |
| updated | updated | 0 - 1 | string | date | The date on which the object was last updated |
| updater | updater | 0 - 1 | object | User | The user who last updated the certificate in the system |
| partnerOrderId | partner_order_id | 1 | string | The order number of the related request | |
| codeSigningType | codeSigningType | 1 | object | CodeSigningType | The type of code signing |
| codeSigningProvisioningMethod | codeSigningProvisioningMethod | 1 | object | CodeSigningProvisioningMethod | The provisioning method for the code signing token |
| codeSigningHardwarePlatform | codeSigningHardwarePlatform | 1 | object | CodeSigningHardwarePlatform | The hardware platform for the code signing token |
| certificateType | certificateType | 1 | object | CertificateType | The type of the certificate |
| signatureHashAlgorithm | sha | 1 | object | SignatureHashAlgorithm | The signature hash algorithm which was used |
| payable | payable | 1 | string | date | The payable date for the certificate. Indicates when a runtime renewal must take place. |
| hsmType | 0 -1 | enum | Describes existing HSM or desired delivery of an HSM (hardware security module) Possible values:
Default value = undefinded Only relevant for Sectigo. | ||
| keyAttestation | 0 -1 | string | base 64 | Proves that a private key has been generated within an HSM (hardware security module). Must only be specified if "LUNA" or "YUBIKEY" was selected for hsmType. Only relevant for Sectigo | |
| globalSignPickupMethod | 0 -1 | enum | Method how the created certificate can be downloaded after the order (and its validation).
|
- english
- sslmanager
- objects
- certificateobject
- certificate
- id
- order_id
- admin
- technical
- name
- lifetime
- software
- product
- comment
- csr
- subject_alternative_name
- server
- serial_number
- sha
- created
- updated
- expire
- owner
- updater
- certificate_authority
- extension
- certificate_transparency
- certificate_transparency_privacy
- fisrname
- lastname
- organization_unit_name
- has_csr
- password
Overview
Content Tools