Skip to main content

GET – Certificate properties

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

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/{id}
GET https://<BMC_IPADDR>/redfish/v1/AccountService/LDAP/Certificates/{id}

Request body​

None

Response body​

Field

Type

Description

Id

String

The index of this certificate resource.

Name

String

The name of this certificate resource.

Description

String

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

Actions

Object

Available for /redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/{id}

 

#Certificate.Rekey

Object

This action generates a new key-pair for a certificate and produces a certificate signing request.

  

KeyCurveId@Redfish.AllowableValues

Array

[“TPM_ECC_NIST_P384”].

  

KeyPairAlgorithm@Redfish.AllowableValues

Array

[“TPM_ALG_ECDH”].

 

#Certificate.Renew

Object

This action generates a certificate signing request by using the existing information and key-pair of the certificate.

CertificateString

String

The string for the certificate.

CertificateType

String

The format of the certificate. Only supports “PEM”.

Issuer

Object

The issuer of the certificate.

 

City

String

The city or locality of the organization of the entity.

 

CommonName

String

The fully qualified domain name of the entity.

 

Country

String

The country of the organization of the entity.

 

Email

String

The email address of the contact within the organization of the entity.

 

Organization

String

The name of the organization of the entity.

 

OrganizationalUnit

String

The name of the unit or division of the organization of the entity.

 

State

String

The state, province, or region of the organization of the entity.

ValidNotBefore

String

The date when the certificate becomes valid.

ValidNotAfter

String

The date when the certificate is no longer valid.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "ValidNotAfter": "2029-12-17T01:51:18+00:00",
    "@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1",
    "KeyUsage": [
        "DigitalSignature",
        "NonRepudiation",
        "KeyEncipherment"
    ],
    "Id": "1",
    "Name": "Certificate_HTTPS",
    "CertificateType": "PEM",
    "@odata.etag": "\"eed23a10000d2d28c9cbd\"",
    "Subject": {
        "Organization": "Lenovo",
        "Country": "US",
        "City": "RTP",
        "CommonName": "XCC-7Z60-SN",
        "State": "NC"
    },
    "@odata.type": "#Certificate.v1_1_1.Certificate",
    "ValidNotBefore": "2019-12-20T01:51:18+00:00",
    "Issuer": {
        "Organization": "Lenovo",
        "Country": "US",
        "City": "RTP",
        "CommonName": "XCC-7Z60-SN",
        "State": "NC"
    },
    "CertificateString": "-----BEGIN CERTIFICATE-----\nMIIClTCCAhqgAwIBAgIUfjeBVwa2nDdgtHJxWPn1pn/ZabcwCgYIKoZIzj0EAwIwTzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAk5DMQwwCgYDVQQHDANSVFAxDzANBgNVBAoMBkxlbm92bzEUMBIGA1UEAwwLWENDLTdaNjAtU04wHhcNMTkxMjIwMDE1MTE4WhcNMjkxMjE3MDE1MTE4WjBPMQswCQYDVQQGEwJVUzELMAkGA1UECAwCTkMxDDAKBgNVBAcMA1JUUDEPMA0GA1UECgwGTGVub3ZvMRQwEgYDVQQDDAtYQ0MtN1o2MC1TTjB2MBAGByqGSM49AgEGBSuBBAAiA2IABAoScPNA/aeC9MR9j+8wdKVW9F/+LoaNrXH4OvIB4bN7sWMBdcm8/1oF2yknMR87OTf9rtbdb5Wlbf9h+86N96vAYv0hJ1nUD9LtosCtppp/7ULDnNfSpNRfXoZ1uSnP4aOBtjCBszAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DCBmAYDVR0RBIGQMIGNggtYQ0MtN1o2MC1TTocQ/oAAAAAAAAAKlO///q9On4IpZmU4MC0tYTk0LWVmZmYtZmVhZi00ZTlmLmlwdjYtbGl0ZXJhbC5uZXSHEP6AAAAAAAAACpTv//6vTqCCKWZlODAtLWE5NC1lZmZmLWZlYWYtNGVhMC5pcHY2LWxpdGVyYWwubmV0hwSp/l92MAoGCCqGSM49BAMCA2kAMGYCMQCJI5XXdOr2LvwkEgcpKp/kOlk0Ynq2Bag/E8dVFUF4JwnOHrVUY5pZTqFEUq9rX6ECMQC06e3av/Tw2EWplx5Q+5pJmiLaoP5V8a+WGXHhqAcqY/0MyrB4oAlaoc0QRQGZXdM=\n-----END CERTIFICATE-----",
    "Actions": {
        "#Certificate.Rekey": {
            "title": "Generate a new key pair for an existing certificate and produce a CSR.",
            "KeyCurveId@Redfish.AllowableValues": [
                "TPM_ECC_NIST_P384"
            ],
            "KeyPairAlgorithm@Redfish.AllowableValues": [
                "TPM_ALG_ECDH"
            ],
            "target": "/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1/Actions/Certificate.Rekey"
        },
        "#Certificate.Renew": {
            "title": "Generate a CSR using the existing information and key pair of the certificate.",
            "target": "/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1/Actions/Certificate.Renew"
        }
    },
    "Description": "This resource is used to represent the certificate for a Redfish implementation."
}