All Products
Search
Document Center

:ModifyADConnectorOfficeSite

Last Updated:Apr 18, 2023

Modifies a workspace of an enterprise Active Directory (AD) account.

Operation Description

This operation modifies the domain name and DNS parameters of workspaces that are of enterprise AD account type and in the Error or Registering state. DNS parameters include DomainName, SubDomainName, DnsAddress.N, and SubDomainDnsAddress.N.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
OfficeSiteIdstringYes

The ID of the workspace.

cn-hangzhou+dir-363353****
DomainNamestringNo

The domain name of the enterprise AD system. You can register each domain name only once.

example.com
DomainUserNamestringNo

The username of the domain administrator. The username can be up to 64 characters in length.

NoteSpecify the value of the sAMAccountName parameter instead of the value of the userPrincipalName parameter as the username.
Administrator
DomainPasswordstringNo

The password of the domain administrator. The username can be up to 64 characters in length.

testPassword
OfficeSiteNamestringNo

The name of the workspace. The name must be 2 to 255 characters in length. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

test
SubDomainNamestringNo

The domain name of the enterprise AD subdomain.

childexample.com
MfaEnabledbooleanNo

Specifies whether to enable multi-factor authentication (MFA).
Default value: false.

false
DnsAddressarrayNo

Details of the IP addresses of the Domain Name System (DNS) servers that correspond to the enterprise AD system. You can specify only one IP address.

stringNo

Details of the IP addresses of the DNS servers that correspond to the enterprise AD system.

127.0.*.*
SubDomainDnsAddressarrayNo

The DNS address of the enterprise AD subdomain. You can specify only one IP address. If you specify a value for the SubDomainName parameter but you do not specify a value for this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.

stringNo

The DNS address of the enterprise AD subdomain.

127.0.*.*
AdHostnamestringNo

The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows.

beijing-ad01
OUNamestringNo

The name of the organizational unit (OU) in the AD domain. You can call the ListUserAdOrganizationUnits operation to obtain the name of the OU.

oldad.com/Domain Controllers

Response parameters

ParameterTypeDescriptionExample
object

The information that is returned.

RequestIdstring

The ID of the request.

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

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 timeSummary of changesOperation
2021-08-19The input parameters of the API operation change.
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: AdHostname
    Added Input Parameters: OUName