Querying SSL Certificate Resource Information

Function

This interface is used to query all the SSL certificates supported.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/SecurityService/HttpsCert

Request header:

X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

None

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/SecurityService/HttpsCert

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#EdgeSystem/SecurityService/HttpsCert/$entity",
    "@odata.id": "/redfish/v1/EdgeSystem/SecurityService/HttpsCert",
    "@odata.type": "#MindXEdgeHttpsCert.v1_0_0.MindXEdgeHttpsCert",
    "Id": "HttpsCert",
    "Name": "Https cert info",
    "X509CertificateInformation": {
        "ServerCert": {
            "Subject": "CN=Server, OU=IT, O=Huawei, L=ShenZhen, S=GuangDong, C=CN",
            "Issuer": "CN=Server, OU=IT, O=Huawei, L=ShenZhen, S=GuangDong, C=CN",
            "ValidNotBefore": "Jul 25 2014 GMT",
            "ValidNotAfter": "Jul 22 2024 GMT",
            "SerialNumber": "07"
            "FingerPrint": "XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:",
            "HttpsCertEable": "",
            "ExpiredDayRemaining": 6933
        }
    },
    "CertificateSigningRequest": null,
    "Actions": {
        "#HttpsCert.ImportServerCertificate": {
            "target": "/redfish/v1/Systems/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate"
        }
    }
}

Response code: 200

Output Description

Table 1 Operation output description

Field

Type

Description

@odata.context

Character string

OData description of an SSL certificate resource model.

@odata.id

Character string

Path to access an SSL certificate resource node.

@odata.type

Character string

Type of an SSL certificate resource.

Id

Character string

ID of an SSL certificate resource.

Name

Character string

Name of an SSL certificate resource.

X509CertificateInformation

Object

SSL certificate information.

ServerCert.Subject

Character string

User of a certificate.

ServerCert.Issuer

Character string

Authority that issues a certificate.

ServerCert.ValidNotBefore

Character string

Date from which a certificate is valid.

ServerCert.ValidNotAfter

Character string

Expiry date of a certificate.

ServerCert.SerialNumber

Character string

Certificate SN.

ServerCert.FingerPrint

Character string

Certificate fingerprint information.

ServerCert.HttpsCertEable

Character string

Whether to enable a certificate.

ServerCert.ExpiredDayRemaining

Number

Certificate validity period.

ServerCert.CertificateSigningRequest

Character string

CSR information.

NOTE:

After the server certificate is imported, the CSR information generated previously is cleared, and null is displayed.

Actions

Object

Operations that can be performed.

Actions.#HttpsCert.ImportServerCertificate

Object

Directory in which a server certificate is to be imported.