• Workspace

workspace
  1. Help Center
  2. Workspace
  3. API Reference
  4. Desktop Users
  5. Querying the Desktop User List

Querying the Desktop User List

Function

This interface is used to query the list of users with allocated desktops.

URI

  • URI format

    GET /v1.0/{project_id}/desktop-users

  • URI parameter description

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Specifies the user ID.

The following table lists the optional parameters for querying the desktop user list.

Name

Mandatory

Type

Description

user_name

No

string

Specifies the desktop username.

user_email

No

string

Specifies the desktop user email.

marker

No

string

Starts from the next record of the desktop username specified by marker during query by page.

limit

No

integer

Specifies the limits on the number of users who will be returned during query by page. If the parameter is not specified, all users who meet the search criteria are returned.

  • Request example
GET /v1.0/92c84e5bce3d48d7ab5714a44901eb08/desktop-users?user_name=wjj&user_email=Join@test.com&marker=wjj0001a&limit=10

Response

  • Description

    Name

    Type

    Description

    users

    List data structure [1]

    Specifies the user list.

[1] users field data structure description

Name

Type

Description

user_name

string

Specifies the desktop username.

user_email

string

Specifies the desktop user email.

ad_domains

Dictionary data structure [2]

Specifies the user domain information.

[2] ad_domains field data structure description

Name

Type

Description

domain_name

string

Specifies the user domain, for example, vdesktop.test.com.

domain_type

string

Specifies the domain type. Possible values are:

  • LITE_AD: indicates the lightweight AD that is deployed on the cloud.
  • LOCAL_AD: indicates the local AD, namely, the user's existing AD.
  • Response example
    {
      "users": [
        {
          "user_name": "a01",
          "user_email": "user01@test.com",
          "ad_domains": {
            "domain_name": "abc.com",
            "domain_type": "LITE_AD"
          }
        },
        {
          "user_name": "a02",
          "user_email": "user02@test.com",
          "ad_domains": {
            "domain_name": "abc.com",
            "domain_type": "LITE_AD"
          }
        }
      ]
    }

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The request syntax is incorrect and cannot be understood by the server.

    401 Unauthorized

    Authentication fails.

    403 Forbidden

    You are not authorized to perform the operation.

    404 Not Found

    The requested resource is not found.

    405 Method Not Allowed

    The method specified in the request is not allowed.

    500 Internal Server Error

    Internal service error. For details about error codes, see Error Code Description.

    503 Service Unavailable

    The service is unavailable.