Remove Clients from Group REST Service

Use the Remove Clients from Group REST Service to remove clients from a client group.

Operation: PUT
URL: https://host:port/SKLM/rest/v1/clients/groups/{groupName}/removeClients

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.

JSON property name	Description
groupName	Specify the name of the client group from which you want to remove the clients.
clients	Specify names of the clients that you want to remove from the group. Use a comma-separated list for multiple clients. For example, `TestClient1`, `TestClient2`.

Response

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

Remove clients from a client group

PUT https://host:port/SKLM/rest/v1/clients/groups/TEST_CLIENT_GROUP/removeClients
{"clients":"TEST_CLIENT_1"}

Success response

{
  "message": "CTGKM3536I Removed clients [TEST_CLIENT_1], Error processing clients [].",
  "messageId": "CTGKM3536I"
}

Incorrect usage example (where the specified client is not part of the client group)

PUT https://host:port/SKLM/rest/v1/clients/groups/TEST_CLIENT_GROUP/removeClients
{"clients":"client1"}

Error response

{
  "message": "CTGKM3536I Removed these clients: [] Failed to process these clients: [client1] ",
  "messageId": "CTGKM3536I"
}