Get Object REST Service
Use Get Object REST Service to retrieve details about a specific managed object.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/objects/{objectId}
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. |
Path parameters
JSON object with the following specification:
Property name | Description |
---|---|
objectId | Required. Specify the unique identifier of the managed object. For example, CERTIFICATE-d374678-9273bd2c-861f-4f5a-834a-7b1085d3a0dd. |
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 |
---|---|
managedObject | Returns details of the managed object. |
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. |
Example
- Retrieve details of a specific managed object
-
GET https://localhost:port/SKLM/rest/v1/objects/CERTIFICATE-d374678-9273bd2c-861f-4f5a-834a-7b1085d3a0dd
- Success response
-
{ "managedObject": { "uuid": "CERTIFICATE-d374678-9273bd2c-861f-4f5a-834a-7b1085d3a0dd", "Cryptographic Usage Mask": "ENCRYPT ", "Link": "[[TYPE PUBLIC_KEY] [LINKED_OBJECT_ID KEY-d374678-56ec9bfb-8709-46eb-8b42-b8f6bfa69ff4] ]", "Digest": "[[INDEX 0] [HASH SHA256] [VALUE x00,x7b,xd4,x7e,x4c,x86,xe9,x8b,x10,xe8,xd0,x79,x92,x2a,xa4,x3d,x3a,x0d,x24,x1b,x41,x88,x3c,xd4,x8e,x60,xf0,x77,x28,x9f,x96,xe0] [DIGESTED_KEY_FORMAT RAW]]", "Custom Attributes": "[[NAME y-Fresh] [[INDEX 0] [TYPE JAVA_STRING] [VALUE true]]]", "Last Changed Date": "6/12/19, 8:15:39 AM Eastern Daylight Time", "alias": "[fff00d374678000000001]", "key algorithm": "RSA", "key length (in bits)": "790", "key type": "X509", "key state": "PRE_ACTIVE", "activation date": "null", "archive date": "null", "compromise date": "null", "creation date": "6/12/19, 8:15:39 AM Eastern Daylight Time", "expiration date": "null", "destroy date": "null", "hash value": "0000: 62 36 39 38 32 38 66 65 2d 64 33 37 62 2d 34 34 b69828fe.d37b.44\n0010: 37 32 2d 39 37 38 31 2d 65 38 34 35 33 34 37 66 72.9781.e845347f\n0020: 33 34 35 39 ", "CERT_MATERIAL": "30820312308201FAA003020102020101300D06092A864886F70D0101050500303B310B3009060355040613025553310D300B060355040A130454455354310E300C060355040B13054F41534953310D300B060355040313044B4D4950301E170D3130313130313233353935395A170D3230313130313233353935395A303B310B3009060355040613025553310D300B060355040A130454455354310E300C060355040B13054F41534953310D300B060355040313044B4D495030820122300D06092A864886F70D01010105000382010F003082010A0282010100AB7F161C0042496CCD6C6D4DADB919973435357776003ACF54B7AF1E440AFB80B64A8755F8002CFEBA6B184540A2D66086D74648346D75B8D71812B205387C0F6583BC4D7DC7EC114F3B176B7957C422E7D03FC6267FA2A6F89B9BEE9E60A1D7C2D833E5A5F4BB0B1434F4E795A41100F8AA214900DF8B65089F98135B1C67B701675ABDBC7D5721AAC9D14A7F081FCEC80B64E8A0ECC8295353C795328ABF70E1B42E7BB8B7F4E8AC8C810CDB66E3D21126EBA8DA7D0CA34142CB76F91F013DA809E9C1B7AE64C54130FBC21D80E9C2CB06C5C8D7CCE8946A9AC99B1C2815C3612A29A82D73A1F99374FE30E54951662A6EDA29C6FC411335D5DC7426B0F6050203010001A321301F301D0603551D0E0416041404E57BD2C431B2E816E180A19823FAC858273F6B300D06092A864886F70D01010505000382010100A876ADBC6C8E0FF017216E195FEA76BFF61A567C9A13DC50D13FEC12A4273C441547CFABCB5D61D991E966319DF72C0D41BA826A45112FF26089A2344F4D71CF7C921B4BDFAEF1600D1BAAA15336057E014B8B496D4FAE9E8A6C1DA9AEB6CBC960CBF2FAE77F587EC4BB282045338845B88DD9AEEA53E482A36E734E4F5F03B9D0DFC4CAFC6BB34EA9053E52BD609EE01E86D9B09FB51120C19834A997B09CE08D79E81311762F974BB1C8C09186C4D78933E0DB38E905084877E147C78AF52FAE07192FF166D19FA94A11CC11B27ED050F7A27FAE13B205A574C4EE00AA8BD65D0D7057C985C839EF336A441ED53A53C6B6B696F1BDEB5F7EA811EBB25A7F86" } }
- Error response
-
{ "messageId": "CTGKM3405E", "error": "CTGKM3405E Object with CERTIFICATE-d374678-9273bd2c-861f-4f5a-834a-7b1085d3a0dd unique identifier not found." }