Skip to end of metadata
Go to start of metadata

About this Resource

Defines the Certificates resource containing the certificate configuration settings on the SBC Edge system.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
CertFileNameYesNostringnone80 - Max Length Indicates the name of the file to be uploaded with allowable file type extension such as pem, der, cer, ber and p7b.
CertFileOperationYesNoEnum0Possible values:
  • 0 - certOperationUnknown
  • 1 - certOperationCopyAndPaste
  • 2 - certOperationFileUpload
Specifies the mode to be used for uploading the certificate file.
  • Copy and Paste - Indicates copy and paste of the base64 encoded content from the signed server certificate file.
  • File Upload - Indicates the name of the file to be uploaded with allowable file type extension such as pem, der, cer, ber and p7b.
CertFileContentYesNostringnone15000 - Max Length Indicates copy and paste of the entire data to be copied from a base64 encoded signed server certificate file.
CertSerialNumberYesNostringnone200 - Max Length Identifies the certificate with a unique text string.
CertCommonNameYesNostringnone64 - Max Length Displays the Common Name of the certificate
CertIssuerNameYesNostringnone1000 - Max Length Displays all the relevant issuer name fields of the certificate.
CertSubjectNameYesNostringnone1000 - Max Length Displays all the relevant subject name fields of the certificate.
CertStartDateEpochYesNolong0 Indicates the date and time from which this certificate is considered valid in Epoch Seconds, with a January 1, 1970 baseline.
CertEndDateEpochYesNolong0 Indicates the certificate expiration date and time in Epoch Seconds, with a January 1, 1970 baseline.
CertKeyLengthYesNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
Displays the key size to use when generating the Certificate Signing Request public and private key pair.
CertSignatureAlgoYesNostringnone64 - Max Length Displays the security algorithm used to create the certificate signature.
CertExtendedKeyUsageYesNostringnone300 - Max Length Displays the enhanced key usage for defining the purposes for which the subject's public key may be used. TLS Web Server Authentication usage purpose is required in order to be compatible with some browsers.
CertKeyUsageStrYesNostringnone300 - Max Length Displays the key usage for defining the purposes of the key contained in the certificate. Non Repudiation service purpose is disallowed in order to be compatible with some browsers.
CertExtendedSubjectAltNameNoNostringnone256 - Max Length Displays the alternative fully-qualified domain name.
CertVerifyStatusYesNostringnone32 - Max Length Displays the status of the certificate validation and verification against the trusted CA.
EncryptedPasswordYesYesstringnone255 - Max Length Specifies password to use for validation when allowing PKCS12 file import on the system.
IsFromCCEYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether this certificate is imported from CCE.