Use the Add Role REST Service to add a user role in IBM® Security Guardium® Key Lifecycle Manager.
- Operation
-
POST
-
URL
-
https://host:port/SKLM/rest/v1/ckms/usermanagement/roles/{roleName}
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. |
Path parameter
JSON object with the following specification.
| JSON property name |
Description |
|
roleName
|
Specify a name for the user role that you want to add. |
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
- Add a user role
-
POST
https://host:port/SKLM/rest/v1/ckms/usermanagement/roles/DS5000_Custom
-
-
Success response
-
{
"code": "0",
"status": "Succeeded"
}
-
Error response
-
{
"code": "CTGKM5004E",
"message": "CTGKM5004E Object with the same name DS5000_Custom already exists."
}