Modifies the basic properties of an office network, including the name and local administrator permission settings.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:ModifyOfficeSiteAttribute | update | *All Resources * |
| none |
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 |
| OfficeSiteId | string | Yes | The office network ID. | cn-hangzhou+dir-882398**** |
| DesktopAccessType | string | No | The method to connect to cloud computers from Alibaba Cloud Workspace clients. Note
VPC connection relies on the Alibaba Cloud PrivateLink service. You can use PrivateLink for free. When you set this parameter to VPC or Any, the system automatically activates PrivateLink.
Valid values:
| INTERNET |
| OfficeSiteName | string | No | The office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). It must start with a letter and cannot start with | test |
| NeedVerifyLoginRisk | boolean | No | Specifies whether to enable two-factor verification when an end user logs on to an Alibaba Cloud Workspace client. This parameter is required only for convenience office networks. If two-factor verification is enabled, the system checks whether security risks exist within the logon account when the end user uses a convenience user to log on to the client. If risks are detected, the system sends a verification code to the email address that is associated with the account of the convenience user. Then, the end user can log on to the client only when the verification code is correct. | false |
| NeedVerifyZeroDevice | boolean | No | Specifies whether to enable device verification. This parameter is required only for convenience office networks. This parameter is left empty for enterprise Active Directory (AD) office networks. | false |
| EnableAdminAccess | boolean | No | Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-10-24 | API Description Update. The request parameters of the API has changed | View Change Details |
| 2023-11-15 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-03-07 | The request parameters of the API has changed | View Change Details |