Use the Get Access Token REST Service to get the access token for
accessing IBM® Security Guardium® Key Lifecycle Manager when OIDC is configured as
the authentication method.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/ckms/accessToken
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 |
Authorization |
SKLMAuth userAuthId=<authIdValue> |
Accept-Language |
Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or
de. |
Request bodyJSON Object with the following
specification:
Parameter |
Description |
userid |
The user ID to access the IBM Security Guardium Key Lifecycle Manager server. |
password |
The password that is associated with the user ID. |
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 |
UserAuthId |
Returns the access token value. |
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 get an access token
-
GET https://host:port/SKLM/rest/v1/ckms/accessToken
-
- Success response
-
{
"UserAuthId": "bbe27e7a-779f-4c87-90e3-1433c34be916"
}
- Invalid service request example (where either the username or password is incorrect)
-
GET https://host:port/SKLM/rest/v1/ckms/accessToken
- Error response
-
{
"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."
}