Use the Assign Roles to User Group REST Service to assign multiple
user roles to a user group.
- Operation
-
POST
- URL
-
https://host:port/SKLM/rest/v1/ckms/usermanagement/groups/{groupName}/roles
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 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. |
Query Parameter
JSON object with the following specification.
JSON property name |
Description |
groupName
|
Required. Specify the name of the user group to which you want to assign the
roles. |
Request Body
JSON object with the following specification.
JSON property name |
Description |
roleNames
|
Required. Specify a JSON array of role names that you want to assign to the
user. |
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
- Assign roles to a user group
-
POST
https://host:port/SKLM/rest/v1/ckms/usermanagement/groups/DS5000_CUSTOM_GROUP/roles
{"roleNames":"DS5000_Custom","DS8000_Custom"}
-
- Success response
-
{
"code": "0",
"status": "Succeeded"
}
- Error response
-
{
"code": "CTGKM6002E",
"message": "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."
}
Table 1. Topic
change log
Date |
Change description |
01 Oct 2021 |
Corrected the request URL in the example. |
10 Sept 2021 |
Initial version. |