Get Roles REST Service

Edit online

Use the Get Roles REST Service to retrieve a list of all the user roles in IBM® Guardium® Key Lifecycle Manager.

Operation
GET
URL
https://host:port/GKLM/rest/v1/ckms/usermanagement/roles

By default, IBM Guardium Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM 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 Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM 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 Guardium Key Lifecycle Manager. For example, en or de.

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.
Success Response Body

JSON object with the following specification.

JSON property name Description
code Returns 0 when the request is successful. Otherwise, returns 1.
For every role, the following details are returned:
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.
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

Retrieve a list of all the user roles
GET 
https://host:port/GKLM/rest/v1/ckms/usermanagement/roles
Success response 
[
  {
    "name": "administrator",
    "description": "",
    "isDefault": true
  },
  {
    "name": "operator",
    "description": "",
    "isDefault": true
  },
  {
    "name": "configurator",
    "description": "",
    "isDefault": true
  },
  {
    "name": "monitor",
    "description": "",
    "isDefault": true
  },
  {
    "name": "deployer",
    "description": "",
    "isDefault": true
  },
  {
    "name": "adminsecuritymanager",
    "description": "",
    "isDefault": true
  },
  {
    "name": "nobody",
    "description": "",
    "isDefault": true
  },
  {
    "name": "iscadmins",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmSecurityOfficer",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmBackup",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmConfigure",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmRestore",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmAudit",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmView",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmCreate",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmModify",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmDelete",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmGet",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmAdminDeviceGroup",
    "description": "",
    "isDefault": true
  },
  {
    "name": "LTO",
    "description": "",
    "isDefault": true
  },
  {
    "name": "TS3592",
    "description": "",
    "isDefault": true
  },
  {
    "name": "DS5000",
    "description": "",
    "isDefault": true
  },
  {
    "name": "DS8000",
    "description": "",
    "isDefault": true
  },
  {
    "name": "GENERIC",
    "description": "",
    "isDefault": true
  },
  {
    "name": "BRCD_ENCRYPTOR",
    "description": "",
    "isDefault": true
  },
  {
    "name": "ONESECURE",
    "description": "",
    "isDefault": true
  },
  {
    "name": "suppressmonitor",
    "description": "",
    "isDefault": true
  },
  {
    "name": "ETERNUS_DX",
    "description": "",
    "isDefault": true
  },
  {
    "name": "IBM_SYSTEM_X_SED",
    "description": "",
    "isDefault": true
  },
  {
    "name": "XIV",
    "description": "",
    "isDefault": true
  },
  {
    "name": "GPFS",
    "description": "",
    "isDefault": true
  },
  {
    "name": "PEER_TO_PEER",
    "description": "",
    "isDefault": true
  },
  {
    "name": "DS8000_TCT",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmClientUser",
    "description": "",
    "isDefault": true
  },
  {
    "name": "klmFileTransfer",
    "description": "",
    "isDefault": true
  },
  {
    "name": "LTO_CUSTOM",
    "description": "This is a new role created for the custom LTO endpoint",
    "isDefault": false
  },
  {
    "name": "DS5000_Custom",
    "description": "Role for DS500_custom endpoint",
    "isDefault": false
  }
]
Error response 
{
  "code": "CTGKM6002E",
  "message": "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."
}