[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Patch By ID

Description

Patches an existing Active Directory. Supports partial document update by updating only the fields which are non-null.

Request

Request

URL

URL


patch
https://cloud.vmwarehorizon.com/admin/v1/active-directories/{id}
Copy

Path Parameters

Path Parameters

string
id Required

id


Query Parameters

Query Parameters

string
org_id Optional

Filter by orgId: non-super users can only query for their own orgIds


Request Body

Request Body

ActiveDirectoryPatchTO of mimetype application/json Required

patchActiveDirectory

{
    "defaultOU": "OU=Computers",
    "dnsDomainName": "example.com",
    "joinPassword": "secret",
    "joinUsername": "user",
    "primaryDNS": "127.0.0.1",
    "secondaryDNS": "127.0.0.2"
}
string
defaultOU Optional

Default OU (organizational unit) for adding VMs to the domain


string
dnsDomainName Optional

Directory DNS name


string
joinPassword Optional

Password for joining new VMs to the domain


string
joinUsername Optional

Username for joining new VMs to the domain


string
primaryDNS Optional

Primary DNS server


string
secondaryDNS Optional

Secondary DNS server

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ActiveDirectoryTO of type */*

Successfully update existing active directory record

{
    "credentialId": "5fb352ed5b19360006d8fd93",
    "defaultOU": "OU=Computers",
    "dnsDomainName": "example.com",
    "id": "0123456789",
    "joinUsername": "user",
    "location": "US",
    "netBIOSName": "EXAMPLE",
    "orgId": "0123456789",
    "primaryDNS": "127.0.0.1",
    "secondaryDNS": "127.0.0.2"
}
string as date-time
createdAt Optional

Record creation timestamp


string
credentialId Optional

The credential ID to be used with the credential service


string
defaultOU Optional

Default OU (organizational unit) for adding VMs to the domain


string
dnsDomainName Optional

Directory DNS name


string
id Optional

Unique record ID


string
joinUsername Optional

Username for joining new VMs to the domain


string
location Optional

location


string
netBIOSName Optional

Directory NETBIOS name


string
orgId Optional

Org ID that owns this record


string
primaryDNS Optional

Primary DNS server


string
secondaryDNS Optional

Secondary DNS server


string as date-time
updatedAt Optional

Record update timestamp


integer as int64
version Optional

Record version (internal)

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


409

Conflict - concurrent updates

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"defaultOU":"OU=Computers","dnsDomainName":"example.com","joinPassword":"secret","joinUsername":"user","primaryDNS":"127.0.0.1","secondaryDNS":"127.0.0.2"}' https://cloud.vmwarehorizon.com/admin/v1/active-directories/{id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: patchActiveDirectory


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?