Remove Users from a Client REST Service
Use the Remove Users from a Client REST Service to remove users that are assigned to a client.
- Operation
PUT
- URL
- https://host:port/SKLM/rest/v1/clients/{clientName}/removeUsers
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. |
Path parameters
JSON object with the following specification:
Property name | Description |
---|---|
clientName |
Specify the name of the 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 client. For multiple users, provide an array of the usernames. For example, ["TestUser1", "TestUser2"]. |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
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 client
-
PUT https://localhost:port/SKLM/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" }