Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Querying User Details

Updated on 2026-02-10 GMT+08:00

View PDF

Querying User Details

Function

Queries details about a specified desktop user.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:users:get	Read	user *	-	-	-

URI

GET /v2/{project_id}/users/{user_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
user_id	Yes	String	User ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
user_detail	UserDetail object	User details.

**Table 3** UserDetail
Parameter	Type	Description
description	String	User description.
id	String	User ID.
user_name	String	Desktop username.
user_email	String	User mailbox.
user_phone	String	Mobile number.
active_type	String	Activation type, which defaults to activation by users. USER_ACTIVATE: activated by users ADMIN_ACTIVATE: activated by the administrator
object_sid	String	User SID.
sam_account_name	String	Login name (earlier Windows versions).
user_principal_name	String	Username used for login.
full_name	String	Full name.
distinguished_name	String	Unique location of a user in the domain tree.
account_type	Integer	Account type (0: user; 1: user group).
when_created	String	UTC time, in millisecond. The format is yyyy-MM-ddTHH:mm:ss.SSSZ.
account_expires	Long	UTC time (in millisecond) corresponding to the last day of the account validity period.
is_pre_user	Boolean	Whether the user is pre-created. The options are true (yes) and false (no).
user_expired	Boolean	Whether the account has expired. The options are true (yes) and false (no).
locked	Boolean	Whether the account is locked. The options are true (yes) and false (no).
enable_change_password	Boolean	Whether the password can be changed. The options are true (yes) and false (no).
password_never_expired	Boolean	Whether the password never expires. The options are true (never expires) and false (will expire).
next_login_change_password	Boolean	Whether the password needs to be reset upon the next login. The options are true (yes) and false (no).
disabled	Boolean	Whether the account is disabled. The options are true (yes) and false (no).
group_names	Array of strings	Groups that users join.
share_space_subscription	Boolean	Whether the user has subscribed to collaboration. The options are true (yes) and false (no).
share_space_desktops	Integer	Number of collaborative desktops bound to the user.
total_desktops	Integer	Total number of cloud desktops bound to a user.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001

null

Example Responses

Status code: 200

Response to the request for querying details about a specified desktop user.

{
  "user_detail" : {
    "description" : "API test user.",
    "id" : "8a2c3f9579d240820179d51e6caf0001",
    "user_name" : "api-test",
    "user_email" : "test@huawei.com",
    "object_sid" : "8a2c3f9579d240820179d51e6caf0001",
    "sam_account_name" : "api-test",
    "full_name" : "api-test",
    "distinguished_name" : "api-test",
    "account_type" : 0,
    "when_created" : "2021-06-03T19:43:31.000Z",
    "account_expires" : 0,
    "user_expired" : false,
    "locked" : false,
    "enable_change_password" : true,
    "password_never_expired" : false,
    "next_login_change_password" : true,
    "disabled" : false,
    "group_names" : [ "DomainUsers" ],
    "total_desktops" : 0
  }
}

Status Codes

Status Code	Description
200	Response to the request for querying details about a specified desktop user.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	Service unavailable.