Use Login REST Service to
log in to
the IBM Security 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, IBM Security Key Lifecycle Manager server listens
to non-secure port 80 (HTTP) and secure port 443 (HTTPS) for communication.
During IBM Security Key Lifecycle Manager installation,
you can modify these default ports. If you are using the default port
for HTTP or HTTPS, the port is an optional part of the URL.
Request Parameters
| Parameter |
Description |
| host |
Specify the IP address or host name of the IBM Security Key Lifecycle Manager server. |
| port |
Specify the port number on which the IBM Security Key Lifecycle Manager server
listens for requests. |
Request headers| Header
name |
Value |
|---|
| Content-Type |
application/json |
| Accept |
application/json |
Request bodyJSON
Object with the following
specification:
| Parameter |
Description |
|---|
| userid |
Specify
the user ID to access the IBM Security 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 bodyJSON
object with
the following specification:
| JSON property name |
Description |
|---|
| userAuthId |
Returns a unique identifier for the authenticated
user. |
Error Response
BodyJSON 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"}
- Error response
Status Code : 401 Unauthorised
{"code" : "CTGKM6001E", "message" : "Authentication Failure :
Incorrect user ID/password combination"}