Use the Get Status of Authentication Mechanisms REST Service to know
which of the supported authentication mechanism are configured in IBM Guardium Key Lifecycle Manager container.
- Operation
GET- URL
- https://host:port/GKLM/rest/v1/authnConfigProperties/configuredRepositories
By default, IBM® Guardium Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM 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 Guardium Key Lifecycle Manager server. |
| port |
Specify the port number on which the IBM 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 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 |
| code |
Returns the success code. |
| AUTH_TYPE_FILE |
Returns true if file-based user authentication is
configured. Otherwise, returns false. |
| AUTH_TYPE_OIDC |
Returns true if OIDC-based user authentication is
configured. Otherwise, returns false. |
| AUTH_TYPE_LDAP |
Returns true if LDAP-based user authentication is
configured. Otherwise, returns false. |
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
- Get user authentication mechanism status
-
GET https://localhost:port/GKLM/rest/v1/authnConfigProperties/configuredRepositories
- Success response
-
{
"AUTH_TYPE_FILE": "true",
"AUTH_TYPE_OIDC": "true",
"AUTH_TYPE_LDAP": "false"
}
- Error response
-
Status Code : 400 Bad Request
Content-Language: en
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}
Table 1. Topic change
log
| Date |
Change description |
| 20 Oct 2021 |
Corrected the example. |
| 30 Sept 2021 |
Removed ckms from the REST endpoint (device group). |
| 10 Sept 2021 |
Initial version. |