All Products
Search

This Product

    Elastic Desktop Service:ModifyEntitlement

    Document Center

    Elastic Desktop Service:ModifyEntitlement

    Last Updated:Aug 28, 2026

    Assigns a cloud computer to specified end users and removes all existing authorized users.

    Operation description

    • The cloud computer must be in the Running state.

    • This operation returns immediately. To check whether the assignment is complete, call the DescribeDesktops operation and check the ManagementFlags response parameter. A value of ASSIGNING indicates that the assignment is in progress. Any other value indicates that the assignment is complete.

    • Check the assignment status every 2 to 5 seconds, for up to 50 seconds. The assignment typically completes within 1 to 5 seconds.

    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
    DesktopId

    string

    Yes

    The ID of the cloud computer.

    ecd-7w78ozhjcwa3u****
    EndUserId

    array

    No

    The end user IDs. The specified users become the authorized users of the cloud computer, replacing all existing authorized users. You can specify 1 to 100 IDs.

    alice

    string

    No

    The username ID of an end user.

    • For a convenience user, specify the username.

    • For an Active Directory (AD) user, specify the sAMAccountName.

    Note

    If you leave this parameter empty, all existing authorized users are removed and the cloud computer becomes unassigned.

    ModifyEntitlement

    Response elements

    Element

    Type

    Description

    Example

    object

    The response structure.

    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.