Use Logout REST Service to
stop the
user session and log out of the IBM® Security Key Lifecycle Manager server.
The server automatically logs out the user after 15 minutes of inactivity.
- Operation
DELETE- URL
- https://<host>:<port>/SKLM/rest/v1/ckms/logout
By default, IBM Security Key Lifecycle Manager server
listens to non-secure port 9080 (HTTP) and secure port 9443 (HTTPS) for communication. During IBM Security Key Lifecycle Manager installation, you can modify these default
ports.
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 body
JSON
Object with the following
specification:
| JSON property name |
Description |
| userAuthId |
Specify the user authentication identifier that
you must use to log out from the IBM Security Key Lifecycle Manager server. |
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 |
| userId |
Returns the user identifier. |
| logout |
Indicates
whether the user is logged out of
the server. Valid values are true or 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. |
Examples
- Service request for user logout
DELETE https://localhost:<port>/SKLM/v1/ckms/logout
Content-Type: application/json
Accept : application/json
{"userAuthId" : "37ea1939-1374-4db7-84cd-14e399be2d20"}
- Success response
Status Code : 200 OK
{"userid" : "admin","logout" : "true”}
- Error response
Status Code : 400 Bad Request
{"code" : ""CTGKM6002E"", "message" : "Invalid Request: Invalid user
authentication ID or invalid request format"}