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

Updated on 2024-01-10 GMT+08:00

View PDF

Querying User Details

Function

Query 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.

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

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

**Table 4** 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. The default value is USER_ACTIVATE. USER_ACTIVATE: activated by the user ADMIN_ACTIVATE: activated by the administrator
object_sid	String	SID of a user.
sam_account_name	String	Login name (earlier Windows versions).
user_principal_name	String	User login name.
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	Character corresponding to the millisecond in UTC time. The format is yyyy-MM-ddTHH:mm:ss.SSSZ.
account_expires	Long	UTC time corresponding to the last day of the account validity period, in milliseconds.
is_pre_user	Boolean	Indicates whether the user is a pre-created user. true indicates that the user is a pre-created user, and false indicates that the user is not a pre-created user.
user_expired	Boolean	Indicates whether the account has expired. true indicates that the account has expired, and false indicates that the account has not expired.
locked	Boolean	Indicates whether the account is locked. true indicates that the account is locked, and false indicates that the account is not locked.
enabled_change_password	Boolean	Indicates whether the password can be changed. true indicates that the password can be changed, and false indicates that the password cannot be changed.
password_never_expired	Boolean	Indicates whether the password never expires. true indicates that the password never expires, and false indicates that the password will expire.
next_login_change_password	Boolean	Indicates whether the password needs to be reset upon the next login. true indicates that the password needs to be reset, and false indicates that the password does not need to be reset.
disabled	Boolean	Indicates whether the account is disabled. true indicates that the account is disabled, and false indicates that the account is not disabled.
group_names	Array of strings	Groups that a user joins.
total_desktops	Integer	Total number of cloud desktops bound to a user.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001

null

Example Responses

Status code: 200

Response to the request for querying desktop user details.

{
  "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,
    "enabled_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 desktop user details.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource 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	The service is unavailable.