Skip to main content

PUT /certificatePolicy

Use this method to modify the certificate policy type for the management server. This policy applies to all parts of the certificate, including the root CA certificate, server certificate, and CSR for externally signed certificates.

Note
This REST API requires Lenovo XClarity Administrator v4.0.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/certificatePolicy

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
specNameRequiredStringCertificate policy. This can be one of the following values.
  • DEFAULT. (default) The certificate key length is 2048 bits, and the signing algorithm is SHA256RSA (SHA256/2048).
  • CNSA. The certificate key length must be 3072 bits, and the signing algorithm is SHA384RSA (SHA384/3072).
The following example sets the certificate policy to CNSA (SHA384/3072).
{
   "specName": "CNSA"
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "explanation": ""
   }]
}