Get Authentication Configuration Details REST Service

Use the Get Authentication Configuration Details REST Service to obtain the values of the authentication configurations in a containerized IBM® Security Guardium® Key Lifecycle Manager.

Operation: GET
URL: https://host:port/SKLM/rest/v1/authnConfigProperties

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`.

Response

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 following information for each parameter: Value of the parameter Whether the parameter is editable Whether the parameter is mandatory
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 authentication configuration values

GET https://localhost:port/SKLM/rest/v1/SKLM/rest/v1/authnConfigProperties

Success response

{
  "AUTH_TYPE_LDAP": {
    "value": "false",
    "editable": true,
    "mandatory": true
  },
  "LDAP_GR_OBJ_CLASS": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_PR_OBJ_CLASS": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_RECURSIVE_SEARCH": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_USER_FILTER": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_GROUP_FILTER": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_USER_ID_MAP": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_GROUP_ID_MAP": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_GROUP_MEMBER_ID_MAP": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_TYPE": {
    "value": "",
    "editable": true,
    "mandatory": true
  },
  "LDAP_HOST": {
    "value": "",
    "editable": true,
    "mandatory": true
  },
  "LDAP_PORT": {
    "value": "",
    "editable": true,
    "mandatory": true
  },
  "LDAP_BASE_ENTRY": {
    "value": "",
    "editable": true,
    "mandatory": true
  },
  "LDAP_BIND_DN": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_BIND_PASSWD": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_SSL_ENABLED": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "LDAP_SKLMADMIN_USERNAME": {
    "value": "sklmadmin",
    "editable": true,
    "mandatory": false
  },
  "LDAP_DISPLAY_NAME": {
    "value": "",
    "editable": true,
    "mandatory": false
  },
  "AUTH_TYPE_FILE": {
    "value": "true",
    "editable": true,
    "mandatory": true
  },
  "SKLMADMIN_USERNAME": {
    "value": "sklmadmin",
    "editable": true,
    "mandatory": true
  },
  "SKLMADMIN_PASSWORD": {
    "value": "",
    "editable": true,
    "mandatory": true
  }
}

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.
10 Sept 2021	Initial version.