Get User Group Details REST Service

Use the Get User Group Details REST Service to retrieve details for a user group, such as assigned roles and assigned users.

Operation
GET
URL
https://host:port /GKLM/rest/v1/ckms/usermanagement/groups/{groupName}

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.
name Returns the name of the user group.
description Returns the description of the user group.
isDefault Indicates whether the user group 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 group.
roles Returns details of the roles that are assigned to the user group
users Returns details of the users that are assigned to the user group.
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

Retrieve details of a user group
GET https://host:port/GKLM/rest/v1/ckms/usermanagement/groups/sklmgroup
Success response 
{
  "description": "Custom group",
  "isDefault": false,
  "name": "sklmgroup",
  "roles": [
    {
      "description": "Read or change properties, or act on certificates.",
      "isDefault": false,
      "name": "klmConfigure"
    },
    {
      "description": "View objects.",
      "isDefault": false,
      "name": "klmView"
    },
    {
      "description": "Export a key or certificate.",
      "isDefault": false,
      "name": "klmGet"
    }
  ],
  "users": []
}
Error response 
{
  "code": "CTGKM6002E",
  "message": "CTGKM6002E Bad Request: Invalid user authentication ID or invalid request format."
}