How to get the user ID of a key in HSM - Key Management Service

This topic explains the process of retrieving the user ID associated with a key in HSM using the getKeyInfo command.

Feature description

The getKeyInfo command retrieves the user ID information for a key in HSM, which includes both the owner ID of the key and the user ID of the sharer. To list all user IDs in HSM, refer to listUsers. To locate keys owned or shared by a specific user, use the -u parameter with the findKey command.

Important

Ensure you have initiated key_mgmt_tool and logged on to HSM as a CU before executing this command.

Syntax

Follow the syntax provided below. For detailed parameter descriptions, see Parameters.

getKeyInfo -k <key-handle>

Important

Parameters must be entered in the sequence outlined in the syntax.

Example

Below is an example that demonstrates retrieving user information for a key with a handle value of 6. The resulting output indicates that user 3 owns the key, and there are no sharers.

Command:   getKeyInfo -k 6

       	Cfm3GetKey returned: 0x00 : HSM Return: SUCCESS

       	Owned by user: 3

Parameters

Parameter name	Description	Required	Valid values
-k	Specifies the key handle.	Yes	No Special Requirements