List All Clients REST Service
Use the List All Clients REST Service to retrieve the list of clients from the database.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/clients
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. |
Success response body
JSON object with the following specification:
JSON property name | Description |
---|---|
client | Returns an array of clients. |
Error response body
JSON object with the following specification.
JSON property name | Description |
---|---|
messageId | Returns the message identifier. |
error | Returns a message that describes the error. |
Examples
- List all clients
-
GET https://localhost:port/SKLM/rest/v1/clients
- Success response
-
{ "client": [ { "clientName": "TEST", "userCount": 2, "users": "KLMUserRole_Member_2, KLMUserRole_Member_3", "clientCert": "", "managedObjectCount": 13, "object": "Symmetric Key (10)\tPublic Key (1)\tPrivate Key (1)\tCertificate (1)\t" }, { "clientName": "CLIENT_TEST", "userCount": 0, "users": "", "clientCert": "", "managedObjectCount": 0, "object": "" }, { "clientName": "CLIENT_REST", "userCount": 0, "users": "", "clientCert": "", "managedObjectCount": 0, "object": "" } ]