Truststore Certificate List REST Service
Use Truststore Certificate List REST Service to list certificates that are present in the IBM® Security Guardium® Key Lifecycle Manager internal truststore.
- Operation
GET
- URL
- https://<host>:<port>/SKLM/rest/v1/trustStoreCertificates
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. |
Query parameter
JSON object with the following specification:
JSON property name | Description |
---|---|
alias | Optional. Specify a unique name for the certificate. To list all certificates, do not specify an alias. |
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 array that contains JSON objects with the following specification:
JSON property name | Description |
---|---|
alias | Returns the alias name of the truststore certificate. |
key state | Returns the state of the certificate, such as ACTIVE . |
issuer name | Returns the name of the issuer of the certificate. |
subject name | Returns the subject name of the certificate. |
activation date | Returns the activation date of the certificate. |
creation date | Returns the certificate creation date. |
expiration date | Returns the certificate expiration date. |
trusted | Indicates whether the certificate is trusted
by returning the following values:
|
serial number | Returns the certificate serial number. |
hash value | Returns the digest value for the managed object, that is, certificate. |
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 obtain truststore certificate list
GET https://localhost:<port>/SKLM/rest/v1/trustStoreCertificates? alias=ibmdiskds5000 Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m