InCommon Request Objects
InCommon caConnectorInfo
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
certificateAuthority
|
Yes | Name of the certificateAuthority that will issue the
certificate. |
String | Value should be InCommon. |
isAutoRenewal
|
No | If enabled, renewal will be triggered before expiry based on
renewBefore days. |
Boolean
|
Should be disabled if autoRegenerateEnabled is
true. |
renewBefore
|
No | Specifies the no of days prior to expiry for triggering the renewal request. |
Integer
|
Value must be provided if isAutoRenewal is
true. |
autoRegenerateEnabled
|
No | If enabled, renewal will be triggered before expiry based on
renewBefore days. |
Boolean | Should be disabled if isAutoRenewal is
true. |
regenerateBeforeInDays
|
No | Specifies the no of days prior to expiry for triggering the regenerate request. |
Integer
|
Value must be provided if autoRegenerateEnabled is
true. |
caSettingName
|
Yes | Name of the CASetting that has been created in
AppViewX for the chosen Certificate Authority. |
String
|
NA |
certificateType
|
No | Name of the certificate product offered by the Certificate Authority. |
String
|
Must be provided for request with InCommon. |
description
|
No | Note about the certificate. |
String
|
NA |
csrParameters
|
Yes | Parameters that are necessary for generating the CSR. |
InCommon csrParameters
|
NA |
genericFields
|
No | Custom fields configured for the CA/Customer. |
genericFields
|
NA |
vendorSpecificDetails
|
No | Data specific to the Sectigo vendor |
InCommon
vendorSpecificDetails
|
NA |
validityInDays
|
Yes | Specifies the validity in days. |
Integer
|
NA |
InCommon
vendorSpecificDetails
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
| serverType | Yes | Server category for which certificate is requested. For example, AOL. |
String
|
NA |
InCommon
csrParameters
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
commonName
|
Yes | Fully qualified domain name (FQDN) of the server for which certificate is requested. |
String
|
Must be compliant with the common name specified in the policy, if the policy is set as ‘Strict’. |
hashFunction
|
No |
Hash function to be used in the Certificate. For example, SHA160. Should be chosen from the possible values configured in the Certificate Policy. |
String
|
Default value - the first value will be chosen from the policy. |
keyType
|
No | Algorithm to be used for Key generation. For example, RSA, DSA, EC. Should be chosen from the possible values configured in the Certificate Policy. |
String
|
Default value - the first value will be chosen from the policy. |
bitLength
|
No | Bit length for the key is dependent on the key type chosen. Should be chosen from the possible values configured in the Certificate Policy. |
String
|
Default value - the first value will be chosen from the policy. |
certificateCategories
|
Yes | Purpose for which the generated certificate will be used. |
Array
|
Possible values - Server, Client, Code Signing, Email. |
ellipticCurve
|
No | If the keyType chosen is EC, then the
ellipticCurve must be specified depending on the bitlength
selected. Should be chosen from the possible values configured in the Certificate
Policy. |
String
|
Default value - the first value will be chosen from the policy. |
enhancedSANTypes
|
No | Subject alternative names for the certificate. |
InCommon enhancedSANTypes
|
NA |
InCommon enhancedSANTypes
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
dNSNames
|
No | List of Subject Alternative names for the Certificate. | Array of String |
NA |