All Products
Search
Document Center

Elastic Desktop Service:ModifyADConnectorOfficeSite

Last Updated:Oct 17, 2024

Modifies the basic properties of an enterprise Active Directory (AD) office network, such as the office network name and domain names of the enterprise AD subdomains.

Operation description

You can modify parameters of domain names and Domain Name System (DNS) for enterprise AD office networks that are in the ERROR or REGISTERED state. The parameters include DomainName, SubDomainName, DnsAddress.N, and SubDomainDnsAddress.N.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
OfficeSiteIdstringYes

The office network ID.

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.

Note Specify 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 office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.

test
SubDomainNamestringNo

The name of the subdomain in the enterprise AD domain.

childexample.com
MfaEnabledbooleanNo

Specifies whether to enable multi-factor authentication (MFA).

Valid values:

  • true

  • 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 subdomain in the enterprise AD domain. You can specify only one DNS address. If you configure SubDomainName and leave this parameter empty, the value is the same as that of the enterprise AD domain.

stringNo

The DNS address of the subdomain in the enterprise AD domain.

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 OUs.

oldad.com/Domain Controllers

Response parameters

ParameterTypeDescriptionExample
object
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
2024-06-26The request parameters of the API has changedView Change Details
2021-08-19The request parameters of the API has changedView Change Details