Update Db2 Password on Standalone Server REST Service

After the Db2® password is updated at the operating system level, use Update Db2 Password on Standalone Server REST Service to update the password on the standalone IBM® Security Guardium® Key Lifecycle Manager server 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 at the operating system level. For more information about the instructions, see Updating Db2 password on a Windows system, Updating Db2 password on a Linux or AIX system.

Operation
PUT
URL
https://localhost:port/SKLM/rest/v1/ckms/changePassword/db2/standalone
By default, Guardium Key Lifecycle Manager server listens to non-secure port 9080 (HTTP) and secure port 9443 (HTTPS) for communication. During IBM Security Guardium Key Lifecycle Manager installation, you can modify these default ports.
Note: The non-secure port 9080 is not applicable when IBM Security Guardium Key Lifecycle Manager is deployed in a containerized environment.

Request

Request Parameters
Parameter Description
host Specify the IP address or host name 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 body

JSON object with the following specification:

Property name Description
newDb2Password Specify the new Db2 password.

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.
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
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 Guardium Key Lifecycle Manager server standalone server
PUT https://localhost:port/SKLM/rest/v1/ckms/changePassword/db2/standalone
{
"newDb2Password" : "SKLM@db2"
}
Success response
{"code":"0",
"status":"CTGKM3012I DB2 password for Guardium Key Lifecycle Manager instance updated successfully."}
Error response
{"code":"CTGKM0630E",
"status":"CTGKM0630E Validation error: Invalid name for parameter newDb2Password."}