How to get HSM user information - Key Management Service

Lists all users in the Hardware Security Module (HSM), including their types, names, and security status.

Prerequisites

Before you begin, ensure that you have:

Started key_mgmt_tool
Logged in to the HSM as a Crypto User (CU)

Syntax

listUsers

No parameters.

Example

The following example lists all users in the HSM. Pass the User ID values returned to other commands, such as findAllKeys and changePswd.

Command:

listUsers

Output:

       Number of users found: 4

       Index      User ID    User Type    User Name          MofnPubKey    LoginFailureCnt    2FA
       1                1    PCO          admin              NO                          0     NO
       2                2    AU           app_user           NO                          0     NO
       3                3    CU           crypto_user        NO                          0     NO
       4                4    CU           crypto_user1       NO                          0     NO

       Cfm3ListUsers returned: 0x00 : HSM Return: SUCCESS

Output fields

Field	Description
User ID	The unique identifier for the user. Use this value as the identity parameter in commands such as `findAllKeys` and `changePswd`.
User Type	The user's role in the HSM, which determines what operations the user can perform. Valid values: `PCO`, `CU` (Crypto User), and `AU`.
User Name	The name assigned to the user.
MofnPubKey	Whether the user has a registered key pair for arbitration authentication. `YES` means the key pair is registered; `NO` means it is not.
LoginFailureCnt	The number of failed login attempts.
2FA	Whether multi-factor authentication is enabled for the user.