All Products
Search
Document Center

Key Management Service:getKeyInfo

Last Updated:Mar 31, 2026

Retrieves the user information (user ID) of a key from HSM, including the key's owner and the Cryptographic User (CU) who has access to the key.

Feature description

The getKeyInfo command retrieves the user information (user ID) of a key from HSM, including the key's owner and the CU who has access to the key.

Important

Before running this command, initiate CMU, log on to HSM, and verify that your user type is permitted by the command's constraints.

User type

The following user type is authorized to run this command. For details, see HSM User Permission Table.

  • Cryptographic User (CU)

Syntax

getKeyInfo -k <key-handle> [<output file>]
Important

Enter parameters in the sequence defined by the syntax.

Example

The following example retrieves key info for key handle 6. The output shows that the key is a Token/Flash Key owned by user 3 and is not shared with any other users.

server0>getKeyInfo -k 6
Key Info on server 0(172.16.0.2):

       	Token/Flash Key,

       	Owned by user 3

Parameters

ParameterDescriptionRequiredValid values
<key handle>The key handle.YesNo Special Requirements
[<output file>]The file name to save the output data.Not supportedNo Special Requirements