How to get HSM user information - Key Management Service

This topic explains the use of the listUsers command to retrieve user information from HSM, including user types, IDs, and properties.

Feature description

The listUsers command retrieves user information from HSM, such as user type, ID, and properties. This information serves as an identity for executing other commands, including findAllKeys and changePswd.

Important

No login is required to execute this command.

User types

The following user roles are authorized to use this command. For detailed user role descriptions, see HSM user permission table.

Administrator (CO)
Crypto Officer (CU)
Audit Officer (AU)

Syntax

listUsers

Example

cloudmgmt>listUsers
Users on server 0(172.16.0.2):
Number of users found:3

    User Id    		User Type      	User Name      			   MofnPubKey  	 LoginFailureCnt       	 2FA
         1     		CO     		admin                                  	 NO               0    	       	  NO
         2     		AU     		app_user                               	 NO               0    	       	  NO
         3     		CU     		crypto_user                            	 NO               0    	       	  NO

Note

The output includes the following properties for each user:

User Id: The unique identifier of the user.
User type: Defines the user's permissions and accessible operations within HSM.
User Name: The user-defined name for identification.
MofnPubKey: Indicates if the user has a registered key pair for arbitration authentication.
LoginFailureCnt: The count of unsuccessful login attempts.
2FA: Specifies whether two-factor authentication is enabled for the user.