Use the Get Security Configuration Details REST Service to obtain the
values of the security configurations in a containerized IBM Security Guardium Key Lifecycle Manager.
- Operation
GET- URL
- https://host:port/SKLM/rest/v1/ckms/securityConfigurations/{param}
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 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 parameters
JSON object with the following specification:
| Property name |
Description |
| param |
Specify one of the following parameters:
- FIPS
- SUITE_B
- SP800_131A
- securityLevel
- enabledCiphers
- ALL
To obtain the values of all the parameters, specify ALL. |
Response Headers
| Header name |
Value and description |
| Status Code |
- 200 OK
- The request was successful. The response body contains the requested representation.
- 400 Bad Request
- The authentication information was not provided in the correct format.
- 401 Unauthorized
- The authentication credentials were missing or incorrect.
- 404 Not Found Error
- The processing of the request fails.
- 500 Internal Server Error
- The processing of the request fails because of an unexpected condition on the server.
|
| Content-Type |
application/json |
| Content-Language |
Locale for the response message. |
Success response body
JSON object with the following specification:
| JSON property name |
Description |
| parameter |
Returns the value for the requested parameter. |
| code |
Returns the code that is specified by the status
property. |
| status |
Returns the status to indicate whether the node is added to the multi-master
cluster. |
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. |
Example
- Service request to obtain security configuration values
-
GET https://localhost:port/SKLM/rest/v1/ckms/SKLM/rest/v1/ckms/securityConfigurations/ALL
-
- Success response
-
{
"FIPS": "on",
"Suite_B": "128",
"SP800_131A": "on",
"enabledCiphers": "SSL_ECDH_ECDSA_WITH_AES_128_GCM_SHA256,SSL_ECDH_RSA_WITH_AES_128_GCM_SHA256,SSL_DHE_RSA_WITH_AES_128_GCM_SHA256",
"securityLevel": ""
}
- Service request to obtain security configuration values
-
GET https://localhost:port/SKLM/rest/v1/ckms/SKLM/rest/v1/ckms/securityConfigurations/FIPSPlus
-
- Error response
-
{
"code": "CTGKM3546E",
"message": "CTGKM3546E Security Configurations with parameter value ALL, FIPS, Suite_B, SP800_131A, securityLevel and enabledCiphers are only allowed."
}