[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Get By ID
DescriptionFetch one Active Directory record
Request
URLURL
https://cloud.vmwarehorizon.com/admin/v1/active-directories/{id}
Path Parameters
Path Parameters
string
id
Required
Active directory ID
Query Parameters
Query Parameters
boolean
expanded
Optional
If true, results will include additional data (e.g. join user name)
string
org_id
Optional
Filter by orgId: non-super users can only query for their own orgIds
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
ActiveDirectoryTO
of type */*
Successfully retrieved active directory record
{
"createdAt": "string",
"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",
"updatedAt": "string",
"version": 0
}
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
Code Samples
Code Samples
cURL Command
curl https://cloud.vmwarehorizon.com/admin/v1/active-directories/{id}
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
On This Page
Admin Operations
post
post
get
get
get
get
patch
patch
delete
delete
