GET /certificateSettings

Use this method to return the saved certificate values from the most recent certificate creation.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/certificateSettings

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A 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.
404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
response Array Information about certificate settings
  CommonName String Name of the certificate owner. Typically, this is the fully-qualified domain name (FQDN) or IP address of the server that is using the certificate (for example, www.domainname.com or 10.15.23.99).
  Country String Two-letter ISO 3166 code for the country or region of origin associated with the certificate organization (for example, US for the United States)
  notBefore String UTC date and time before which the created certificate is not valid

The date and time is specified in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ (for example, 2017-01-25T18:00:00Z).

  notAfter String UTC date and time after which the created certificate is not valid

The date and time is specified in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ (for example, 2017-01-25T18:00:00Z).

  Organization String Organization (company) that will own the certificate. Typically, this is the legal incorporate name of a company. It should include any suffixes, such as Ltd., Inc., or Corp (for example, ACME International Ltd.).
  OrganizationUnit String Organizational unit that will own the certificate (for example, ABC Division)
  StateLocality String Full name of the locality (city) to be associated with the certificate (for example, San Jose)
  StateProvince String Full name of the state or province to be associated with the certificate (for example, California or New Brunswick)
  subjectAlternativeNames Object Information about the Subject Alternative Names (SANs) to be included in Certificate Signing Requests
    generalNames Array of objects List of Subject Alternative Names to be included in Certificate Signing Requests
      name String Subject Alternative Name
      type String RFC 5280 GeneralName type of this Subject Alternative Name
    possibleGeneralNameTypes Array of strings List of supported RFC 5280 GeneralName type strings
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failure. The request failed, a descriptive error message was returned.
messages Array Information about one or more messages
  id String The message identifier of a returned message
  explanation String Additional information to clarify the reason for the message
  recovery Array Recovery information
      text String User actions that can be taken to recover from the event
      URL String Link to the help system for more information, if available
  text String Message text associated with the message identifier
The following example is returned if the request is successful.
{
   "response": {
      "CommonName": "Generated by Lenovo System Management Software",
      "Country": "US",
      "notBefore": "2017-06-01T12:30:00Z",
      "notAfter": "2018-06-01T12:30:00Z",
      "Organization": "Lenovo",
      "OrganizationUnit": "DCG",
      "StateLocality": "Raleigh",
      "StateProvince": "North Carolina",
      "subjectAlternativeNames": {
         "generalNames": [{
            "name": "LXCA-1",
            "type": "dNSName"
         },
         {
            "name": "192.0.2.0",
            "type": "iPAddress"
         }],
         "possibleGeneralNameTypes": ["dNSName", "iPAddress", "rfc822Name", "directoryName",
                                      "uniformResourceIdentifier", "registeredID"]
      }
   },
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "explanation": "",
      "recovery": {
         "text": "Information only; no action is required.",
         "URL": ""
      },
      "text": "The request completed successfully."
   }]
}