Assign Clients to a Client Group REST Service

Use the Assign Clients to a Client Group REST Service to assign clients to a client group that can access the cryptographic objects of the clients in the group.

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

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
groupName	Specify the name of the client group to which you want to assign the clients.

Request body

JSON object with the following specification:

Property name	Description
clients	Specify the name of the clients that you want to assign to the group. To assign multiple clients, provide the names in a comma-separated list.

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.

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

Assign clients to a client group

PUT https://localhost:port/SKLM/rest/v1/clients/groups/TEST_CLIENT_GROUP/assignClients
{"clients":"TEST_CLIENT_1, TEST_CLIENT_2"}

Success response

{
  "message": "CTGKM3534I Assigned clients [TEST_CLIENT_1, TEST_CLIENT_2], Error processing clients [].",
  "messageId": "CTGKM3534I"
}

Invalid service request example (where the specified client does not exist)

PUT https://localhost:port/SKLM/rest/v1/clients/groups/TEST_CLIENT_GROUP/assignClients
{"clients": "client1"}

Error response

{
  "message": "CTGKM3534I Assigned clients: [], Failed to process these clients: [client1] ",
  "messageId": "CTGKM3534I"
}