POST – Generate CSR
Use the POST method to generate a certificate signing request.
Request URL
POST https://<BMC_IPADDR>/redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR
Request body
Field | Type | Description | |
---|---|---|---|
title | String | Generate a CSR file. | |
target | Link | The link of this action. | |
CertificateCollection | Object | Required. The link to the certificate collection where the certificate is installed after the certificate authority (CA) signs the certificate. | |
@odata.id | Link | Required. Allowable value: “/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates” | |
Country | String | Required. The two-letter country code of the organization making the request. | |
City | String | Required. The city or locality of the organization making the request. | |
CommonName | String | Required. The fully qualified domain name of the component to secure. | |
State | String | Required. The state, province, or region of the organization making the request. | |
Organization | String | Required. The name of the organization making the request. | |
AlternativeNames | Array | Optional. The additional host names of the component to secure. | |
AlternativeNames[N] | String | The additional host names of the component to secure. | |
ChallengePassword | String | Optional. The challenge password to apply to the certificate for revocation requests. | |
ContactPerson | String | Optional. The name of the user making the request. | |
String | Optional. The email address of the contact within the organization making the request. | ||
GivenName | String | Optional. The given name of the user making the request. | |
Initials | String | Optional. The initials of the user making the request. | |
OrganizationalUnit | String | Optional. The name of the unit or division of the organization making the request. | |
Surname | String | Optional. The surname of the user making the request. | |
KeyCurveId | String | Optional. The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. | |
KeyPairAlgorithm | String | Optional. The type of key-pair for use with signing algorithms. | |
KeyBitLength | String | Optional. The key bit length. | |
UnstructuredName | String | Optional. The unstructured name of the subject. | |
CSRString | String | PEM format string. | |
CertificateCollection | Link | Indicates what the CSR is generated for which certificate collection. |
Response body
Field | Type | Description |
---|---|---|
CSRString | String | The string for the certificate signing request. |
CertificateCollection | Link | The link to the certificate collection where the certificate is installed. |
Status code
HTTP Status Code | Error Message ID |
---|---|
400 | BadRequest, ActionParamMissing , ActionParamTypeError , ActionParamFormatError |
500 | InternalError |