Update Client REST Service
Use the Update Client REST Service to update the name and application usage of a client.
- Operation
PUT
- URL
- https://host:port/SKLM/rest/v1/clients/updateClientName
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
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 body
JSON object with the following specification:
Property name | Description |
---|---|
clientName |
Specify the name of the client that you want to update. |
newClientName | Specify the new name of the client. |
applicationUsage | Specify the application usage of the client. You can specify the following
possible values: You can specify any of the following values:
|
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
Success response body
JSON object with the following specification:
JSON property name | Description |
---|---|
messageId | Returns the message identifier. |
message | Returns the message to indicate the operation is successful. |
Error response body
JSON object with the following specification.
JSON property name | Description |
---|---|
messageId | Returns the message identifier. |
error | Returns a message that describes the error. |
Example
- Update the name and application usage of a client
-
PUT https://localhost:port/SKLM/rest/v1/clients/updateClient { "clientName": "abc_new", "newClientName": "client1", "applicationUsage": "Mongo Db" }
- Success response
-
{ "message": "CTGKM3420I Client details updated successfully.", "messageId": "CTGKM3420I" }
- Invalid service request (where the application usage is incorrect)
-
PUT https://localhost:port/SKLM/rest/v1/clients/updateClient { "clientName": "abc_new", "newClientName": "client1", "applicationUsage": "mongo db" }
- Error response
-
{ "error": "CTGKM6260E Invalid application name. Specify a valid value for the parameter and retry the operation.", "messageId": "CTGKM6260E" }