List System Certificates REST Service
Use the List System Certificates REST Service to list all the system certificates.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/system/certificates
By default, Guardium® Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager installation, you can modify this default port.
Request
Request Parameters
Parameter | Description |
---|---|
host | Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server. |
port | Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests. |
Request Headers
Header name | Value |
---|---|
Content-Type | application/json |
Accept | application/json |
Authorization | SKLMAuth userAuthId=<authIdValue> |
Accept-Language | Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or de. |
Request body
JSON object with the following specification:
JSON property name | Description |
---|---|
usageSubtype | Specify the certificate type based on the purpose of the certificate. You can
specify multiple values in comma-separated format. For example, SERVERGUI_TLS,
KEYSERVING_TLS. Possible values:
|
offset | Specify the page number from which the records are displayed based on the value that you specify for count. |
count | Specify the number of records to display on the specified page (offset). |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
Success response body
JSON object with the following specification:
JSON property name | Description |
---|---|
code | Returns |
Error Response Body
JSON object with the following specification.
JSON property name | Description |
---|---|
code | Returns the application error code. |
message | Returns a message that describes the error. |
Examples
- Service request to list all certificates
-
PUT https://localhost:port/SKLM/rest/v1/system/certificates
- Service request to list certificates of a particular subtype
-
PUT https://localhost:port/SKLM/rest/v1/system/certificates?usageSubtype=SERVERGUI_TLS
- Invalid service request
-
PUT https://localhost:port/SKLM/rest/v1/system/certificates?usageSubtype=SERVER_TLS
- Error response
-
{ "code": "CTGKM0633E", "message": "CTGKM0633E Validation error: usageSubtype is invalid for parameter SERVER_TLS . Specify one of these valid values: SERVERGUI_TLS, KEYSERVING_TLS, EKMF_TLS, DATABASE_TLS, TLS, EKMF_PUBLIC_CERT, OIDC_PUBLIC_CERT, DB_PUBLIC_CERT, LDAP_PUBLIC_CERT, NOTIFICATION_PUBLIC_CERT, SYSLOG_PUBLIC_CERT, AGENT_PUBLIC_CERT " }