Use the Update User Group REST Service to modify an existing user
group. You can modify the name and description of a user group.
-
Operation
-
PUT
-
URL
-
https://host:port/SKLM/rest/v1/ckms/usermanagement/groups/{oldGroupName}
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. |
Path parameter
JSON object with the following specification.
JSON property name |
Description |
oldGroupName
|
Specify the name of the user group that you want to modify. |
Request Body
JSON object with the following specification.
JSON property name
|
Description
|
newGroupName
|
Specify the new name for the user group. |
description
|
Specify a description for the user group that you want to
modify. |
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. |
Example
- Modify a user group
-
PUT https://host:port/SKLM/rest/v1/ckms/usermanagement/groups/LTO_CUSTOM_GROUP
{"newGroupName":"LTO_NEW","description":"changing group name"}
-
-
Success response
-
{
"code": "0",
"status": "Succeeded"
}
-
Error response
-
{
"code": "CTGKM5004E",
"message": "CTGKM5004E Object with the same name DS5000_Custom already exists."
}