GET /api/v1/maintenance/certificateSettings
Use this method to return information about the XClarity Orchestrator server certificate settings.
Authentication
Authentication with user name and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/maintenance/certificateSettings
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| 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) To retrieve the country or region codes, use GET /api/v1/service/countryCodes. | ||
| notAfter | 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 | 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 | 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. | ||
| organizationUnit | String | Organizational unit that owns the certificate | ||
| stateLocality | String | Full name of the locality (city) to be associated with the certificate | ||
| stateProvince | String | Full name of the state or province to be associated with the certificate | ||
| _links | Object | Server certificate URI (see Links) | ||
{
"commonName": "Generated by Lenovo Management Ecosystem on IP 10.243.17.108",
"country": "US",
"notAfter": "2030-10-06T14:54:04.000Z",
"notBefore": "2020-10-08T14:54:04.000Z",
"organization": "Lenovo",
"organizationUnit": "DCG",
"stateLocality": "Raleigh",
"stateProvince": "NC",
"_links": {
"rel": "self",
"uri": "/api/v1/maintenance/certificateSettings"
}
}