Assign Users to a Client REST Service
Use the Assign Users to a Client REST Service to assign users to a client who can access the cryptographic objects of the client.
- Operation
PUT
- URL
- https://host:port/SKLM/rest/v1/clients/{clientName}/assignUsers
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 to which you want to assign the users. |
Request body
JSON object with the following specification:
Property name | Description |
---|---|
users |
Specify names of the users that you want to assign to the client. For multiple users, provide an array of the user names. For example, ["user1", "user2", "user3"]. |
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
- Assign users to a client
-
PUT https://localhost:port/SKLM/rest/v1/client_rest/assignUsers {"users" : "KLMUserRole_Member_2"}
- Success and Error response
-
{ "message": "CTGKM3445I Assigned users [KLMUserRole_Member_2], Error processing users [].", "messageId": "CTGKM3445I" }