Use Get Kerberos Configuration REST Service to retrieve details of
the Kerberos configuration on the server.
-
Operation
-
GET
-
URL
-
https://host:port/SKLM/rest/v1/ckms/kerberos/getConfiguration
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. |
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 |
| kdcServerHostame |
Fully-qualified host name of the computer that hosts the Kerberos server. |
| realmName |
Name of the Kerberos realm name. |
| dbServiceName |
Name of the database service that you registered in the Kerberos server. For example:
sklmdb41/gklmserver.example.com@EXAMPLE.COM |
| userId |
Client principal that you registered in the Kerberos server. |
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
- To retrieve Kerberos configuration details
-
https://localhost:9443/SKLM/rest/v1/ckms/kerberos/getConfiguration
-
-
Success response
-
{
"kdcServerHostame": "kserver.example.com",
"realmName": "EXAMPLE.COM",
"dbServiceName": "sklmdb41/gklmserver.example.com@EXAMPLE.COM",
"userId": "sklmdb41"
}
-
Error response
-
{
"CTGKM3565I": "CTGKM3565I Cannot retrieve Kerberos configuration details. The Guardium Security Key Lifecycle Manager server is not configured to use Kerberos authentication with the database."
}