# AD场景支持桌面更换关联用户名 - UpdateDesktopUsername
#### 功能介绍
AD场景支持桌面更换关联用户名。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=UpdateDesktopUsername)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                               | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:desktops:changeUsername | Write | -           | -   | -  | -      |
     
  
 
#### URI
PUT /v2/{project_id}/desktops/change-username
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
#### 请求参数
表2请求Body参数 
| 参数              | 是否必选 | 参数类型    | 描述                                                                                                 |
|:---|:---|:---|:---|
| old_username    | 是    | String  | 桌面关联原用户名，只传用户名，不带域信息。                                                                              |
| old_user_domain | 否    | String  | 桌面关联原用户名的域。                                                                                        |
| new_username    | 是    | String  | 桌面关联新用户名，只传用户名，不带域信息。                                                                              |
| new_user_domain | 否    | String  | 桌面关联新用户名的域。                                                                                        |
| is_reboot       | 否    | Boolean | 桌面关联新用户名后是否重启虚拟机，默认为true，表示需要重启虚拟机。若用户此前已登录过云桌面，建议设置为true，以确保会话资源彻底释放、避免旧会话残留占用，并保障用户名修改后能正常接入新桌面。 |
   
#### 响应参数
**状态码：204**
无
**状态码：400**
表3响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：401**
表4响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：403**
表5响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：500**
表6响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
#### 请求示例
```
{
  "old_username" : "user01",
  "new_username" : "user02",
  "is_reboot" : true
}
```
#### 响应示例
**状态码：204**
```
null
```
#### 状态码
| 状态码 | 描述                     |
|:---|:---|
| 204 | 桌面更换关联用户名响应。           |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。 |
| 401 | 鉴权失败。                  |
| 403 | 没有操作权限。                |
| 500 | 服务器内部错误。               |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。