How to get HSM user information - Key Management Service

This topic explains the use of the listUsers command to retrieve HSM user information.

Feature description

The listUsers command retrieves information from HSM, including user types and properties.

Important

Ensure you have started the key_mgmt_tool and logged on to HSM with a CU identity before executing this command.

Syntax

listUsers

Example

In this example, the listUsers command is used to obtain all user information. The User ID can then serve as an identity to execute additional commands, such as findAllKeys and changePswd.

Command:  listUsers

       	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

Note

The output includes the following properties for each user:

User Id: The unique identifier for the user.
User Type: Defines the user's permissions within HSM.
User Name: The name assigned to the user.
MofnPubKey: Status of the user's registered key pair for arbitration authentication.
LoginFailureCnt: The count of unsuccessful login attempts.
2FA: Status of multi-factor authentication for the user.