Get Role Details REST Service
Use the Get Role Details to retrieve details for a user role, such as role description, assigned users, and assigned groups.
- Operation
-
GET
- 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
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. |
Response
Response Headers
Header name | Value and description |
---|---|
Status Code |
|
Content-Type | application/json |
Content-Language | Locale for the response message. |
Path parameter
JSON object with the following specification.
JSON property name | Description |
---|---|
roleName | Specify the user role for which you want to retrieve the details. |
Success Response Body
JSON object with the following specification.
JSON property name | Description |
---|---|
code | Returns 0 when the request is successful. Otherwise, returns 1. |
name | Returns the name of the user role. |
description | Returns the description of the user role. |
isDefault | Indicates whether the user role and its associations are provided by default
during product installation (return value = true) or added later by a
user (return value = false). You cannot modify or delete a default user role. |
groups | Returns details of the associated user groups. |
users | Returns details of the associated users. |
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. |
Examples
-
GET https://host:port/SKLM/rest/v1/ckms/usermanagement/roles/LTO_CUSTOM