GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/object/objects/{objectid}

Gets the information associated with a specific partition object.

User Privileges

Users with the following role privileges can perform this command:

admin
operator
monitor

Note:

Accessing objects that are not publicly visible requires authentication. Requests made without proper authentication will result in an empty response.

Parameters

hsmid

The serial number of the HSM of interest.

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1
   maximum: 9999999999

partitionid

The identifier of the partition of interest

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1000000
   maximum: 99999999999999999

objectid

The identifier of the partition object of interest

Use: Required

JSON Schema:

   Object
   type: string
    minLength: 1
    maxLength: 32
    pattern: ^[a-zA-Z0-9_.-]*$

Responses

Note:

The attributes that are not applicable to a specific key object will be represented as 'n/a', while those that are empty (i.e., "") indicate attributes that can be set but have not been assigned a value till now.

200

Object details.

JSON Schema: Partition Object Description

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

401

FRAMEWORK_SESSION_NOT_PRIVATE

Session was not created.

404

HSMPLUGIN_INVALID_OBJECT

Object requested does not exist.

HSMPLUGIN_INVALID_PARTITION

The partition specified does not exist.

HSMPLUGIN_HSM_DOES_NOT_EXIST

The hsm specified does not exist.

500

HSMPLUGIN_FAILED_TO_GET_OBJECT_INFO

Failure while fetching the object information.

Example Request

   GET
   https://1.2.3.4:8443/api/lunasa/hsms/154704/partitions/273087011784/object/objects/19

Example Result

{
  "id": "0b46e45afaddddfaedc3221f9313a03d",
  "objectHandle":"43"
  "alwaysSensitive": "true",
  "application": "ThisIssigneddataobject",
  "assigned": "true",
  "certificateType": "X.509",
  "decrypt": "false",
  "derive": "false",
  "encrypt": "false",
  "endDate": "20240812",
  "extracable": "false",
  "fingerprint": "339a7445515a2f864fb1935d5b8a50b6a65f983a",
  "issuer": " | CN:test_cmu_cert | org:SafeNet | orgUnit:PD | locality:Ottawa | state:ON | country:CA | ",
  "keyStatus": {
    "failedKeyAuthorizationLimit": "3",
    "flags": "0x00"
  },
  "keyType": "RSA",
  "label": "test_cmu_cert",
  "local": "false",
  "modifiable": "false",
  "modulus": "bb1a9bdb96b4e673cbd7ffff254b8fb72496a3d57f7463181de673d985ec4ede1907dcfd829cf7ad23b428997ad7cd1de272daa736b24d9823d50b76e82efa95d36e6b60d5f512c6347a08c08b33b17c4696541d475527d9385a5d547b50824c82ca500c803d31fbfbc34b18eddbfecabff9cfa46fa04b4632287a9706485c3e9815153231ff6b020bd170dafc4ca2e4a6a16fa512beed49b09c12736a6f8677426cafbf651974a66344f324bcc9fc24b471e66a645396fce8cbd2d7727069b5046fec826eda9bd05b3538186d9368b8bd23c9df3b993503caa838904ce592646658ef1bca4ce637e10a6b236054f5562ecc0b86f47e892df94a707cb7431e4b",
  "modulusBits": "2048",
  "neverExtracable": "false",
  "private": "false",
  "publicExponent": "03",
  "sensitive": "false",
  "serialNumber": "2fd5",
  "sign": "false",
  "startDate": "20240812",
  "subject": " | CN:test_cmu_cert | org:SafeNet | orgUnit:PD | locality:Ottawa | state:ON | country:CA | ",
  "token": "false",
  "type": "Certificate",
  "uid": "360000004800000b371e0800",
  "unwrap": "false",
  "value": "3082035030820238a00302010202022fd5300d06092a864886f70d01010b05003062310b3009060355040613024341310b3009060355040813024f4e310f300d060355040713064f74746177613110300e060355040a1307536166654e6574310b3009060355040b13025044311630140603550403160d746573745f636d755f63657274301e170d3234303831303030303030305a170d3332303932303030303030305a3062310b3009060355040613024341310b3009060355040813024f4e310f300d060355040713064f74746177613110300e060355040a1307536166654e6574310b3009060355040b13025044311630140603550403160d746573745f636d755f6365727430820120300d06092a864886f70d01010105000382010d00308201080282010100bb1a9bdb96b4e673cbd7ffff254b8fb72496a3d57f7463181de673d985ec4ede1907dcfd829cf7ad23b428997ad7cd1de272daa736b24d9823d50b76e82efa95d36e6b60d5f512c6347a08c08b33b17c4696541d475527d9385a5d547b50824c82ca500c803d31fbfbc34b18eddbfecabff9cfa46fa04b4632287a9706485c3e9815153231ff6b020bd170dafc4ca2e4a6a16fa512beed49b09c12736a6f8677426cafbf651974a66344f324bcc9fc24b471e66a645396fce8cbd2d7727069b5046fec826eda9bd05b3538186d9368b8bd23c9df3b993503caa838904ce592646658ef1bca4ce637e10a6b236054f5562ecc0b86f47e892df94a707cb7431e4b020103a3123010300e0603551d0f010100040403020204300d06092a864886f70d01010b05000382010100292d88ddc049d5f1410f8af861d5d955194e20317fb6e77986f887d9cc441c5caf6d69d403a4c5cf11b0509f4808daa4183e369e88589c241900801a185bcf32e3fc245a04acfa40d774c102c264971b617330a663a35499a503cb64af0c2cbde9508e3aee8424cea00ea49690ca0dfefd723a96576ac64fe8a2086fc5fd75624e6408a09618312165e99baf846d58f85dfdb9173eab23e481fb49a53767a2a84e013fb71dd2d53154962b2313cfb8e0a8937c941be718045a9f5008aa73e6dded6b07853a69979218149af5a7c21b3f20f08c2d7884c9035b6733815de41cc1c65bd87850023308a7c2ff944c0e5d519ea64cce6609e5357d818c652297343b",
  "verify": "false",
  "valueLength": "32",
  "wrap": "false",
  "decapsulate": "true",
  "encapsulate": "true",
  "failedKeyAuthCount": "5",
  "hssKeysRemaining": "4294967295",
  "hssLevels": "2",
  "hssLmotsType": "LMOTS_SHA256_N32_W8",
  "hssLmotsTypes": "LMOTS_SHA256_N32_W8,LMOTS_SHA256_N24_W8,LMOTS_SHA256_N24_W4",
  "hssLmsType": "LMS_SHA256_M32_H10",
  "hssLmsTypes": "LMS_SHA256_M32_H10,LMS_SHA256_M24_H15,LMS_SHA256_M24_H10",
  "parameterSet": "2",
  "publicKey": "000000030000000600000004587161f73790ee1fb5194df660caf4ca325809f8817b8e40acf91336ac00c1168257559f5abe957b1a06ec2799802182",
  "publicKeyInfo": "30820336300b060960864801650304040103820325000382032100ce3a7077434fb03aaadd9ba50961c1dd591be9a453e61c5e0825af076b4ae7ec61397ac65270ac99801382423f42083d0e173a141851020b2a3f4376a6e13a18e1a44dd01505730596a28aa92c3807a882ab2c187e7341a8955e35f91d425044f05a77330401912a76b1604e05e421f8f0486b9a1f6ce4ccc841bd06f20be19376f0088a82d433f63702319cafc149bd638b443720c3be675db6b2830fac79025682349986e9e171dd0a1bd03111bea9bfccc9b4b05a287a597193c129fa96216f109266469b7fbb2c14762d944b1e288a68d6e03e12ec081375389e680e152c213ac5b62e22ae6e5125283a0b63bca92b611a97510501db480e24a895806bb2a43486b67928da01090595d3902f0149620481ba7c65baaad21c51483b49f18059b51a6c2135ae4c3e7ff19be55b37e55cae5068412b066b0dfc9be54599afb96c6d5c4e42a00c1002a0e1cb054669be0eb4caacba90b30514310916ce08ce6169c5644a08af6866fe3b67c67513403672e2b17bac404b7c747c5f2a68fdc4bbc12779263357bbd6cb45664b79688c9b82b279dc1b80f02d8b798b8789749d5b89f340070ca19d406cbd51a06df7fb2e411a5d91649eb090ad701917a4f40597631edaec836a9a0d60d656cec5584165291c09578e97334c4c5430abb47696b4012ca73299764375c6429598669c385aec1074e78992363904e9c522a561699b5747970989cc5c0ca5551ce09b957378c676ba823b6c5bc551150602c79661ddc15ea050605ed90058aac49a68b0b46299a1a662fc76a05c478625dca5b732ce4fc6aa2cdc3f934a2df589925a026b69a059fe543d10e7cf5b492edf960c869039f49139dea746a00985c2a2c84145b6fc56c7e45bb28d09b85cfc07f176475fc799ec674f38e430c04a898b718f722a69b6c572bfbbcef99559d64b6f87dabcfab4b01c4aacc60703f712c6f805258d9ba15fe578dfc7bb4045554736564d907017e031bfb4505a868b628b058ff12289fc41765439e0dbb22afc35a076385011ba958479c748001e7c9a56d832041bba481c60a7535bae2a2a32c80006fb6a069ce9e81dabbd3dbfef5edcc8ea0c2a66c240d99201bdcf8cb8f07a1437cd"
}

Note:

If the response is too large, a task may be returned. User can filter these large responses using 'limit' and 'offset' options.
Tasks can be manually deleted using 'DELETE:https://LUNAIPADDRESS:PORT/tasks/{taskid}'.
'id' and 'objectHandle' are two different attributes where 'id' is the big-endian hexadecimal integer value while 'objectHandle' is the partition object reference.