After you update the Db2® password on
the operating system of each master server, use Update Database Password in Multi-Master
Cluster REST Service to update the password in the Multi-Master cluster so that Db2 continues to be connected to the Guardium® Key Lifecycle Manager server agent.
Before you begin
Before you use this REST service, ensure that you update the Db2 database password on the operating system of each
master server.
- Operation
PUT
- URL
- https://localhost:port/SKLM/rest/v1/ckms/changePassword/db2/multimaster
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. |
Query parameters
Parameter name |
Description |
System-Token |
Specify the system token to recover the server. |
Request bodyJSON object with the following
specification:
Property name |
Description |
newDb2Password
|
Specify the new Db2 password. |
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 bodyJSON object with the following
specification:
JSON property name |
Description |
code |
Returns the code that is specified by the status
property. |
status |
Returns the status of the operation. |
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
- Update database password on Multi-Master cluster
-
PUT https://localhost:port/SKLM/rest/v1/ckms/changePassword/db2/multimaster
{
"newDb2Password" : "SKLM@db2"
}
- Success response
-
{
"code": "CTGKM3448I",
"status": "CTGKM3448I Db2 password changed successfully.
Services on the Guardium Key Lifecycle Manager servers will resume shortly."
}
- Error response
-
{"code":"CTGKM0630E",
"status":"CTGKM0630E Validation error: Invalid name for parameter newDb2Password."}