Use the Update Client Group Name REST Service to update the name of
an existing client group.
-
Operation
-
PUT
-
URL
-
https://host:port
/GKLM/rest/v1/clients/groups/updateGroupName
By default, IBM® Guardium® Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM 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 Guardium Key Lifecycle Manager server. |
| port |
Specify the port number on which the IBM 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 Guardium Key Lifecycle Manager. For example, en or
de. |
Request Body
JSON object with the following specification.
| JSON property name |
Description |
|
clientGroupName
|
Specify the name of the client group that you want to update.
|
|
newClientGroupName
|
Specify the new name of the client group.
|
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 to indicate if the operation was successful. |
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 a client group name
-
PUT https://host:port/GKLM/rest/v1/clients/groups/updateGroupName
{"clientGroupName":"TEST_CLIENT_GROUP","newClientGroupName":"TEST_CLIENT_GROUP_2"}
-
-
Success response
-
{
"message": "CTGKM3547I Group name updated successfully.",
"messageId": "CTGKM3547I"
}
- Incorrect usage example (where client group with the same name already exists)
-
PUT https://host:port/GKLM/rest/v1/clients/groups/updateGroupName
{"clientGroupName":"TEST_CLIENT_GROUP","newClientGroupName":"TEST_CLIENT_GROUP_2"}
-
Error response
-
{
"messageId": "CTGKM3542E",
"error": "CTGKM3542E Unable to create group because a group or a client with the same name TEST_CLIENT_GROUP_2 already exists."
}