Skip to main content

GET – Certificate service properties

Use the GET method to retrieve properties in CertificateService resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/CertificateService

Request body​

None

Response body​

Field

Type

Description

Id

String

“CertificateService”

Name

String

“Certificate Service”

Description

String

This resource is used to represent a certificate service for a Redfish implementation.

CertificateLocations

Link

The information about the location of certificates.

Actions

Object

Expanded.

 

#CertificateService.GenerateCSR

Object

This action makes a certificate signing request.

  

KeyUsage@Redfish.AllowableValues

Array

[“DigitalSignature”, “NonRepudiation”, “KeyEncipherment”]

  

KeyCurveId@Redfish.AllowableValues

Array

[“TPM_ECC_NIST_P256”, “TPM_ECC_NIST_P384”]

  

KeyBitLength@Redfish.AllowableValues

String

[“2048”, “3072”, “4096”]

  

KeyPairAlgorithm@Redfish.AllowableValues

Array

[“TPM_ALG_ECDH”, “TPM_ALG_RSA”]

 

#CertificateService.ReplaceCertificate

Array

This action replaces a certificate.

  

CertificateType@Redfish.AllowableValues

Array

[“PEM”]

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "Id": "CertificateService",
    "Name": "Certificate Service",
    "@odata.context": "/redfish/v1/$metadata#CertificateService.CertificateService",
    "@odata.id": "/redfish/v1/CertificateService",
    "@odata.etag": "\"83efd8c1e88e25b7467\"",
    "CertificateLocations": {
        "@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
    },
    "Description": "This resource is used to represent a certificate service for a Redfish implementation.",
    "@odata.type": "#CertificateService.v1_0_4.CertificateService",
    "Actions": {
        "#CertificateService.ReplaceCertificate": {
            "target": "/redfish/v1/CertificateService/Actions/CertificateService.ReplaceCertificate",
            "CertificateType@Redfish.AllowableValues": [
                "PEM"
            ],
            "title": "Replace an existing certificate."
        },
        "#CertificateService.GenerateCSR": {
            "KeyCurveId@Redfish.AllowableValues": [
                "TPM_ECC_NIST_P256",
                "TPM_ECC_NIST_P384"
            ],
            "title": "Generate a CSR file.",
            "KeyBitLength@Redfish.AllowableValues": [
                "2048",
                "3072",
                "4096"
            ],
            "target": "/redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR",
            "KeyUsage@Redfish.AllowableValues": [
                "DigitalSignature",
                "NonRepudiation",
                "KeyEncipherment"
            ],
            "KeyPairAlgorithm@Redfish.AllowableValues": [
                "TPM_ALG_ECDH",
                "TPM_ALG_RSA"
            ]
        }
    }
}