Use the Remove Users from a Generic KMIP Client REST Service to remove
users that are assigned to a generic KMIP client.
- Operation
PUT- URL
- https://host:port/GKLM/rest/v1/clients/{clientName}/removeUsers
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. |
Path parameters
JSON object with the following specification:
| Property name |
Description |
| clientName |
Specify the name of the generic KMIP client from which you want to remove
the users.
|
Request body
JSON object with the following specification:
| Property name |
Description |
| users |
Specify names of the users that you want to remove from the generic KMIP
client. For multiple users, provide an array of the usernames. For example, ["TestUser1",
"TestUser2"].
|
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. |
Table 1. Success and Error response body
| JSON property name |
Description |
| messageId |
Returns the message identifier. |
| message |
Returns the message to indicate the success and error part of the
operation. |
Example
- Remove users from a generic KMIP client
-
PUT https://localhost:port/GKLM/rest/v1/clients/client_rest/removeUsers
{"users" : ["KLMUserRole_Member_2","KLMUserRole_Member_3"]}
- Success and Error response
-
{
"message": "CTGKM3446I Removed users [KLMUserRole_Member_2], Error processing users [KLMUserRole_Member_3].",
"messageId": "CTGKM3446I"
}