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

Create

Description

Creates a new Active Directory record in the admin service, belonging to the specified org. This does not create anything in AD itself.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/admin/v2/active-directories
Copy

Request Body

Request Body

ActiveDirectoryCreateTO of mimetype application/json Required

createTO

{
    "defaultOU": "OU=Computers",
    "description": "This is a test AD",
    "dnsDomainName": "example.com",
    "name": "TestAD",
    "orgId": "0123456789"
}
bindAccounts Optional

string
defaultOU Optional

OU (Organizational Unit) used by default for adding pool VMs to the domain unless specified on the pool


string
description Optional

Description for the AD


string
dnsDomainName Optional

Directory Domain Name


enrollmentServiceAccounts Optional

joinAccounts Optional

string
name Optional

Name that helps the customer identify the record


string
orgId Optional

Org ID that owns this record

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns ActiveDirectoryTO of type */*

Successfully created active directory record

{
    "credentialId": "5fb352ed5b19360006d8fd93",
    "defaultOU": "OU=Computers",
    "description": "This is a test AD",
    "dnsDomainName": "example.com",
    "id": "0123456789",
    "location": "US",
    "name": "TestAD",
    "orgId": "0123456789"
}
bindAccounts Optional

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
description Optional

Description for the AD


string
dnsDomainName Optional

Directory DNS name


enrollmentServicesAccounts Optional

string
id Optional

Unique record ID


joinAccounts Optional

string
location Optional

location


string
name Optional

Name that helps the customer identify the record


string
orgId Optional

Org ID that owns this record


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

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"defaultOU":"OU=Computers","description":"This is a test AD","dnsDomainName":"example.com","name":"TestAD","orgId":"0123456789"}' https://cloud.vmwarehorizon.com/admin/v2/active-directories
Vendor Extensions

Vendor Extensions

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


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

Was this page helpful?