All Products
Search
Document Center

Elastic Desktop Service:AddUserToDesktopGroup

Last Updated:Jun 10, 2026

Adds authorized users to a desktop group. The service automatically assigns cloud desktops in the group to these users according to rules you configure.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

DesktopGroupId

string

No

The ID of the desktop group to which you want to add authorized users.

dg-2i8qxpv6t1a03****

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000

EndUserIds

array

No

The end users that you want to authorize to use the cloud computers.

string

No

The end user that you want to authorize to use the cloud computer.

alice

DesktopGroupIds

array

No

The desktop group IDs.

string

No

A desktop group ID.

dg-kadkdfaf****

UserOuPath

string

No

UserGroupName

string

No

SimpleUserGroupId

string

No

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.