List All Objects REST Service

Use List All Objects of Type REST Service to retrieve details of all the cryptographic objects that are associated with a client. You can further filter the results to retrieve details of the cryptographic objects that are of a specific type.

Operation
GET
URL
https://host:port/SKLM/rest/v1/objects?clientName=clientName&objectType=objectType

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.
Pagination headers

JSON object with the following specification:

Property name Description
Range Optional. Specify the number of items (in the range 0 to 9) to be displayed on a page. Provide the value in the following format:
items=0-9
where, 0 is the start and 9 is the end of the range. If this property is not specified, all items are listed.
Query parameters

JSON object with the following specification:

Property name Description
clientName Specify the name of the client. Details of all the cryptographic objects that are associated with the client are retrieved.
objectType Specify the type of objects that you want to retrieve. You can provide one of the following values:
  • PUBLIC_KEY
  • PRIVATE_KEY
  • SYMMETRIC_KEY
  • CERTIFICATE
  • OPAQUE_OBJECT
  • SECRET_DATA

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
managedObject Returns details of all the cryptographic objects based on the query parameters that you specified.
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

Example 1: Retrieve details of all objects that are associated with a client
GET https://localhost:port/SKLM/rest/v1/objects?clientName=test1
Success response
{
    "managedObject": [
        {
            "uuid": "KEY-d374678-8413ee49-f3eb-4851-92b9-8be9b8d118c0",
            "Cryptographic Usage Mask": "ENCRYPT ",
            "Name": "[[INDEX 0] [TYPE TEXT] [VALUE tre00d374678000000002]]",
            "Digest": "[[INDEX 0] [HASH SHA256] [VALUE x8f,xb6,x05,x8b,x6b,x42,xab,x57,xe8,x77,x39,x86,x85,x7e,x06,xbf,xaa,xfb,x11,x47,x44,x83,xe4,x60,x0b,xc1,x0e,x03,xdf,xbb,x91,xb4] [DIGESTED_KEY_FORMAT RAW]]",
            "Custom Attributes": "[[NAME y-Fresh] [[INDEX 0] [TYPE JAVA_STRING] [VALUE true]]][[NAME y-RNGSimulation] [[INDEX 0] [TYPE JAVA_STRING] [VALUE QgDZAQAAABBCANoFAAAABAAAAAEAAAAA]]]",
            "Last Changed Date": "6/12/19, 4:01:49 AM Eastern Daylight Time",
            "alias": "[tre00d374678000000002]",
            "key algorithm": "AES",
            "key length (in bits)": "256",
            "key type": "SYMMETRIC_KEY",
            "key state": "PRE_ACTIVE",
            "activation date": "null",
            "archive date": "null",
            "compromise date": "null",
            "creation date": "6/12/19, 8:01:49 AM Eastern Daylight Time",
            "expiration date": "null",
            "destroy date": "null",
            "hash value": "0000: 35 31 30 66 64 39 34 66  2d 35 66 62 64 2d 34 36  510fd94f.5fbd.46\n0010: 31 66 2d 61 64 65 32 2d  35 36 31 32 66 35 32 63  1f.ade2.5612f52c\n0020: 33 34 38 39 "
        },
        {
            "uuid": "K_SEC_DATA-d374678-4c61660a-863a-4c8a-9af6-7bf92da8a368",
            "Cryptographic Usage Mask": "VERIFY ",
            "Name": "[[INDEX 0] [TYPE TEXT] [VALUE ddr00d374678000000000]]",
            "Digest": "[[INDEX 0] [HASH SHA256] [VALUE x56,x2e,x5f,xf6,x81,x0c,xac,x78,x7d,xde,x87,x72,xc4,x89,xa6,x39,x46,x24,xdf,xc8,x06,x72,x82,x60,x1a,xb3,x5a,x61,x6f,x5c,x90,xec] [DIGESTED_KEY_FORMAT OPAQUE]]",
            "Custom Attributes": "[[NAME y-Fresh] [[INDEX 0] [TYPE JAVA_STRING] [VALUE true]]][[NAME y-RNGSimulation] [[INDEX 0] [TYPE JAVA_STRING] [VALUE QgDZAQAAABBCANoFAAAABAAAAAEAAAAA]]]",
            "Last Changed Date": "6/12/19, 4:01:59 AM Eastern Daylight Time",
            "Cryptographic Length": "60",
            "Type": "PASSWORD",
            "Initial Date": "6/12/19, 8:01:59 AM Eastern Daylight Time",
            "State": "PRE_ACTIVE"
        },
        {
            "uuid": "K_OPQ_OBJ-d374678-a99f1f86-27ed-4916-a2dd-cfa688666fa4",
            "Name": "[[INDEX 0] [TYPE TEXT] [VALUE yjg00d374678000000000]]",
            "Last Changed Date": "6/12/19, 4:02:10 AM Eastern Daylight Time",
            "Initial Date": "6/12/19, 8:02:10 AM Eastern Daylight Time",
            "Type": "1",
            "State": "PRE_ACTIVE"
        },
        {
            "uuid": "KEY-d374678-2315b700-6a28-4206-b47d-2148096a8688",
            "Cryptographic Usage Mask": "SIGN ",
            "Name": "[[INDEX 0] [TYPE TEXT] [VALUE fds00d374678000000000]]",
            "Link": "[[TYPE PUBLIC_KEY] [LINKED_OBJECT_ID KEY-d374678-ad5b91ae-f474-49b7-8f8a-13ea1abde9be] ]",
            "Digest": "[[INDEX 0] [HASH SHA256] [VALUE x1d,xc2,x93,x34,x60,xaf,x5c,x80,x73,x58,x67,x28,xd1,xc3,xa8,xaa,x2a,x9a,x5b,x20,xee,x95,x6b,xce,x8e,xd5,xfa,x92,x5c,x64,x21,x79] [DIGESTED_KEY_FORMAT PKCS8]]",
            "Custom Attributes": "[[NAME y-Fresh] [[INDEX 0] [TYPE JAVA_STRING] [VALUE true]]][[NAME y-RNGSimulation] [[INDEX 0] [TYPE JAVA_STRING] [VALUE QgDZAQAAABBCANoFAAAABAAAAAEAAAAA]]]",
            "Last Changed Date": "6/12/19, 4:03:05 AM Eastern Daylight Time",
            "alias": "[fds00d374678000000000]",
            "key algorithm": "RSA",
            "key length (in bits)": "2048",
            "key type": "PRIVATE_KEY",
            "key state": "PRE_ACTIVE",
            "activation date": "null",
            "archive date": "null",
            "compromise date": "null",
            "creation date": "6/12/19, 8:03:05 AM Eastern Daylight Time",
            "expiration date": "null",
            "destroy date": "null",
            "hash value": "0000: 65 64 61 65 30 36 30 33  2d 39 35 32 64 2d 34 30  edae0603.952d.40\n0010: 64 38 2d 39 65 32 39 2d  36 65 65 30 35 65 34 37  d8.9e29.6ee05e47\n0020: 32 35 30 38 "
        },
        {
            "uuid": "KEY-d374678-ad5b91ae-f474-49b7-8f8a-13ea1abde9be",
            "Cryptographic Usage Mask": "SIGN ",
            "Name": "[[INDEX 0] [TYPE TEXT] [VALUE fds00d374678000000001]]",
            "Link": "[[TYPE PRIVATE_KEY] [LINKED_OBJECT_ID KEY-d374678-2315b700-6a28-4206-b47d-2148096a8688] ], [[TYPE CERTIFICATE] [LINKED_OBJECT_ID CERTIFICATE-d374678-f728a7cf-dca9-495f-b8b1-a5ff6b0e77f9] ]",
            "Digest": "[[INDEX 0] [HASH SHA256] [VALUE xef,xdf,xf9,x3b,x78,x23,xe2,x79,xd3,xf3,xcf,x47,x85,x10,xa5,x22,x13,x41,xfa,xb2,xc7,x6d,xc7,x73,xf1,x7e,xd4,xd9,x3b,x13,x6f,x64] [DIGESTED_KEY_FORMAT X509]]",
            "Custom Attributes": "[[NAME y-Fresh] [[INDEX 0] [TYPE JAVA_STRING] [VALUE false]]][[NAME y-RNGSimulation] [[INDEX 0] [TYPE JAVA_STRING] [VALUE QgDZAQAAABBCANoFAAAABAAAAAEAAAAA]]]",
            "Last Changed Date": "6/12/19, 4:03:05 AM Eastern Daylight Time",
            "alias": "[fds00d374678000000001]",
            "key algorithm": "RSA",
            "key length (in bits)": "2048",
            "key type": "PUBLIC_KEY",
            "key state": "PRE_ACTIVE",
            "activation date": "null",
            "archive date": "null",
            "compromise date": "null",
            "creation date": "6/12/19, 8:03:05 AM Eastern Daylight Time",
            "expiration date": "null",
            "destroy date": "null",
            "hash value": "0000: 35 61 66 30 61 63 64 61  2d 36 66 31 34 2d 34 36  5af0acda.6f14.46\n0010: 64 62 2d 62 36 36 34 2d  62 39 65 39 62 65 33 66  db.b664.b9e9be3f\n0020: 30 66 33 61 "
        },
        {
            "uuid": "CERTIFICATE-d374678-f728a7cf-dca9-495f-b8b1-a5ff6b0e77f9",
            "Cryptographic Usage Mask": "VERIFY ",
            "Name": "[[INDEX 0] [TYPE TEXT] [VALUE fds00d374678000000002]]",
            "Link": "[[TYPE PUBLIC_KEY] [LINKED_OBJECT_ID KEY-d374678-ad5b91ae-f474-49b7-8f8a-13ea1abde9be] ]",
            "Digest": "[[INDEX 0] [HASH SHA256] [VALUE x19,xf5,x02,x08,x36,x5c,x03,x23,x41,x4e,x08,xc5,xfa,xdc,x24,x48,x68,x04,x49,x1b,xbd,x52,x5a,x14,x98,x72,x56,xc1,xbe,xbb,xf2,xa2] [DIGESTED_KEY_FORMAT RAW]]",
            "Custom Attributes": "[[NAME y-Fresh] [[INDEX 0] [TYPE JAVA_STRING] [VALUE true]]]",
            "Last Changed Date": "6/12/19, 8:03:06 AM Eastern Daylight Time",
            "alias": "[fds00d374678000000002]",
            "key algorithm": "RSA",
            "key length (in bits)": "739",
            "key type": "X509",
            "key state": "PRE_ACTIVE",
            "activation date": "null",
            "archive date": "null",
            "compromise date": "null",
            "creation date": "6/12/19, 8:03:06 AM Eastern Daylight Time",
            "expiration date": "null",
            "destroy date": "null",
            "hash value": "0000: 30 63 33 62 39 32 33 34  2d 64 33 35 31 2d 34 61  0c3b9234.d351.4a\n0010: 36 36 2d 61 62 37 34 2d  39 64 30 36 63 62 38 66  66.ab74.9d06cb8f\n0020: 61 30 31 63 "
        },
Error response
{
    "messageId": "CTGKM3408E",
    "error": "CTGKM3408E Client with test1 name not found."
}
Example 2: Retrieve details of all objects that are associated with a client and are of a specific type
GET https://localhost:port/SKLM/rest/v1/objects/?clientName=test1&objectType=SECRET_DATA
Success response
{
    "managedObject": [
        {
            "uuid": "K_SEC_DATA-d374678-4c61660a-863a-4c8a-9af6-7bf92da8a368",
            "Cryptographic Usage Mask": "VERIFY ",
            "Name": "[[INDEX 0] [TYPE TEXT] [VALUE ddr00d374678000000000]]",
            "Digest": "[[INDEX 0] [HASH SHA256] [VALUE x56,x2e,x5f,xf6,x81,x0c,xac,x78,x7d,xde,x87,x72,xc4,x89,xa6,x39,x46,x24,xdf,xc8,x06,x72,x82,x60,x1a,xb3,x5a,x61,x6f,x5c,x90,xec] [DIGESTED_KEY_FORMAT OPAQUE]]",
            "Custom Attributes": "[[NAME y-Fresh] [[INDEX 0] [TYPE JAVA_STRING] [VALUE true]]][[NAME y-RNGSimulation] [[INDEX 0] [TYPE JAVA_STRING] [VALUE QgDZAQAAABBCANoFAAAABAAAAAEAAAAA]]]",
            "Last Changed Date": "6/12/19, 4:01:59 AM Eastern Daylight Time",
            "Cryptographic Length": "60",
            "Type": "PASSWORD",
            "Initial Date": "6/12/19, 8:01:59 AM Eastern Daylight Time",
            "State": "PRE_ACTIVE"
        }
    ]
}
Error response
{
    "messageId": "CTGKM3408E",
    "error": "CTGKM3408E Client with client_test name not found."
}