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

delete Active Directories

Description

Deletes an Active Directory record from the database

Request

Request

URL

URL


delete
https://cloud.vmwarehorizon.com/admin/v2/active-directories/{id}
Copy

Path Parameters

Path Parameters

string
id Required

id


Query Parameters

Query Parameters

string
org_id Optional

Organization ID: non-super users can only access their own organization


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns ActiveDirectoryTO of type */*

Successfully deleted 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)


204 No Content Response Body>

Response Body

204 No Content

Returns ActiveDirectoryTO of type */*

No Content

{
    "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

401

Unauthorized


403

Forbidden


404

Not Found


409

Conflict - active directory is in use

Code Samples

Code Samples

cURL Command

curl -X DELETE https://cloud.vmwarehorizon.com/admin/v2/active-directories/{id}


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

Was this page helpful?