Use the Login REST Service to log in to the IBM® Security Guardium® Key Lifecycle Manager server with valid user credentials. The REST
service validates the credentials and returns a unique user authentication identifier for all
subsequent service requests.
- Operation
POST
- URL
- https://host:port/SKLM/rest/v1/ckms/login
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 |
Request body
JSON
Object with the following
specification:
Parameter |
Description |
userid |
Specify
the user ID to access the IBM Security Guardium Key Lifecycle Manager server. |
password |
Specify the password that is associated with
the user ID. |
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.
- 500
Internal Server Error
- The processing of the request fails
because of an unexpected condition
on the server.
|
Content-Type |
application/json |
Success response body
JSON
object with
the following specification:
JSON property name |
Description |
userAuthId |
Returns a unique identifier for the authenticated
user. |
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 for user authentication
-
POST https://localhost:port/SKLM/rest/v1/ckms/login
Content-Type: application/json
Accept : application/json
{"userid" : "admin1", "password" : "pswd"}
- Success response
-
Status Code : 200 OK
{"userAuthId" : "37ea1939-1374-4db7-84cd-14e399be2d20"}
- Invalid service request (when the credentials are incorrect)
-
POST https://localhost:port/SKLM/rest/v1/ckms/login
Content-Type: application/json
Accept : application/json
{"userid" : "admin1", "password" : "1234"}
- Error response
-
Status Code : 401 Unauthorized
{
"code": "CTGKM6003E",
"message": "CTGKM6003E Authentication failed. The specified user ID or password is incorrect, or your account is locked out. Specify the correct user ID and password, or wait for some time for the account to be unlocked, and try again."
}