All Products
Search
Document Center

Key Management Service:getKeyInfo

Last Updated:Mar 31, 2026

Retrieves the owner ID and sharer user ID of a key stored in the Hardware Security Module (HSM).

Prerequisites

Before you begin, ensure that you have:

Syntax

getKeyInfo -k <key-handle>
Important

Enter parameters in the order shown in the syntax.

Parameters

ParameterDescriptionRequiredValid values
-kThe key handle.YesNo special requirements

Example

The following example retrieves user information for the key with handle 6. The output shows 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

What's next

  • To list all user IDs in HSM, use listUsers.

  • To find keys owned or shared by a specific user, use findKey with the -u parameter.