Skip to main content

GET – Certificate

Certificate describes a certificate that proves the identify of a component, account, or service.

Request

GET https://{{ip}}/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Certificates/{CertificateId}
GET https://{{ip}}/redfish/v1/Managers/{ManagerId}/NetworkProtocol/HTTPS/Certificates/{CertificateId}
GET https://{{ip}}/redfish/v1/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}
GET https://{{ip}}/redfish/v1/AccountService/LDAP/Certificates/1
GET https://{{ip}}/redfish/v1/AccountService/LDAP/Certificates/Oem/Ami/ClientCertificates/1
Content-Type: application/json
Note
  1. https://{{ip}}/redfish/v1/AccountService/LDAP/Certificates/1 is the root CA certificate required for LDAP authentication uploaded into BMC

  2. https:// {{ip}}/redfish/v1/AccountService/LDAP/Certificates/Oem/Ami/ClientCertificates/1 is the client certificate required for LDAP authentication uploaded into BMC

  3. Since single certificate is maintained in BMC for root ca, or the client certificate required for LDAP authentication, single certificate instance is maintained from Redfish as well.

Response

The response of the request will be in JSON format. The properties are mentioned in the following table.

Table 1. Certificate Property

Name

Type

Read Only

Description

(OData Attributes)  

Refer to OData Support

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types.

Actions

Object

True

This object will contain the actions for this resource under Oem property if any.

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

Issuer

Object

True

The issuer of the certificate. Please refer to The identifier information about a certificate

KeyUsage

Array

True

The key usage extension, which defines the purpose of the public keys in this certificate.

Enum

Description

CRLSigning

Verifies signatures on certificate revocation lists (CRLs).

ClientAuthentication

TLS WWW client authentication.

CodeSigning

Signs downloadable executable code.

DataEncipherment

Directly enciphers raw user data without an intermediate symmetric cipher.

DecipherOnly

Deciphers data while performing a key agreement.

DigitalSignature

Verifies digital signatures, other than signatures on certificates and CRLs.

EmailProtection

Email protection.

EncipherOnly

Enciphers data while performing a key agreement.

KeyAgreement

Key agreement.

KeyCertSign

Verifies signatures on public key certificates.

KeyEncipherment

Enciphers private or secret keys.

NonRepudiation

Verifies digital signatures, other than signatures on certificates and CRLs, and provides a nonrepudiation service that protects against the signing entity falsely denying some action.

OCSPSigning

Signs OCSP responses.

ServerAuthentication

TLS WWW server authentication.

Timestamping

Binds the hash of an object to a time.

Subject

Object

True

The subject of the certificate. Please refer to The identifier information about a certificate.

ValidNotAfter

String

True

The date when the certificate is no longer valid.

ValidNotBefore

String

True

The date when the certificate becomes valid.

CertificateString

String

True

This parameter shall contain the string of the certificate,and the format shall follow the requirements specified by the CertificateType property value. If the certificate contains any private keys, they shall be removed from the string in responses. If the service does not know the private key for the certificate and it is needed to use the certificate,the client shall provide the private key as part of the string in the POST request.

CertificateType

String

True

The format of the certificate.

Table 2. The identifier information about a certificate

Name

Type

Read only

Description

City

String

True

The city or locality of the organization of the entity.

CommonName

String

True

The fully qualified domain name of the entity.

Country

String

True

The country of the organization of the entity.

Email

String

True

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

Organization

String

True

The name of the organization of the entity.

OrganizationalUnit

String

True

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

State

String

True

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