Device Type and Clients List REST Service
Use the Device Type and Clients List REST Service to obtain a list of device groups and clients with the objects that are associated with them.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/deviceTypes/deviceclientgroups
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 |
---|---|
devices | The devices created under a device family. |
deviceFamily | The name of the device family. For example, 3592 . |
deviceGroupName | The name of the device group. |
objectTypesOwned | The objects associated with a device group. |
objectType | The type of the cryptographic object. |
count | The number of objects that are associated with the device or client. |
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
- Service request to get a device group list
-
GET https://localhost:port/SKLM/rest/v1/deviceTypes/deviceclientgroups Content-Type: application/json Accept : application/json Authorization: SKLMAuth userAuthId=139aeh34567m Accept-Language : en
- Success response
-
Status Code : 200 OK Content-Language: en [ [ { "devices": [ "123467839122" ], "deviceFamily": "3592", "deviceGroupName": "3592", "objectTypesOwned": [ { "objectType": "CERTIFICATE", "count": 3 }, { "objectType": "PRIVATE_KEY", "count": 1 }, { "objectType": "PUBLIC_KEY", "count": 3 } ] }, { "devices": [], "deviceFamily": "DS5000", "deviceGroupName": "DS5000", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "DS5000", "deviceGroupName": "XIV", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "LTO", "deviceGroupName": "LTO", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "LTO", "deviceGroupName": "BRCD_ENCRYPTOR", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "DS5000", "deviceGroupName": "ETERNUS_DX", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "GPFS", "deviceGroupName": "GPFS", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "PEER_TO_PEER", "deviceGroupName": "PEER_TO_PEER", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "DS8000", "deviceGroupName": "DS8000", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "DS5000", "deviceGroupName": "ONESECURE", "objectTypesOwned": [] }, { "devices": [], "deviceFamily": "DS5000", "deviceGroupName": "IBM_SYSTEM_X_SED", "objectTypesOwned": [] } ]