PUT /api/v1/maintenance/certificateSettings
Use this method to modify the Lenovo XClarity Orchestrator server certificate settings.
Authentication
Authentication with username and password is required.
Resource URI
PUT https://{orchestrator_server_IP}/api/v1/maintenance/certificateSettings
Query parameters
None
Request body
This PUT request updates the entire resource. To clear a value, set the attribute to null (if applicable). If an array is specified, the entire array is replaced (unless stated otherwise). If an optional attribute is not specified, that attribute is not changed. If an immutable (unchangeable) attribute is specified, it is ignored.
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| commonName | Optional | 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). The length of this value cannot exceed 63 characters. | ||
| country | Optional | 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) To retrieve the country or region codes, use GET /api/v1/service/countryCodes. | ||
| notAfter | Optional | String | Timestamp before which the created certificate is not valid This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | ||
| notBefore | Optional | String | Timestamp after which the created certificate is not valid This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage. | ||
| organization | Optional | String | Organization (company) that owns the certificate. Typically, this is the legal incorporate name of a company. It should include any suffixes, such as Ltd., Inc., or Corp. The length of this value cannot exceed 60 characters. | ||
| organizationUnit | Optional | String | Organizational unit that owns the certificate The length of this value cannot exceed 60 characters. | ||
| stateLocality | Optional | String | Full name of the locality (city) to be associated with the certificate The length of this value cannot exceed 50 characters. | ||
| stateProvince | Optional | String | Full name of the state or province to be associated with the certificate | ||
{
"commonName": "Generated by Lenovo System Management Software",
"country": "US",
"notAfter": "2069-12-31T23:59:59Z",
"notBefore": "1970-01-01T00:00:00Z",
"organization": "Lenovo",
"organizationUnit": "EBG",
"stateLocality": "Raleigh",
"stateProvince": "North Carolina"
}
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. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| {message_attributes} | varies | Status messages (see Status messages) | ||