Patch By ID
DescriptionPatches an existing Active Directory. Supports partial document update by updating only the fields which are non-null.
Request
URLURL
Path Parameters
Path Parameters
id
Query Parameters
Query Parameters
Organization ID: non-super users can only access their own organization
Request Body
{
"defaultOU": "OU=Computers",
"description": "This is a test AD",
"name": "TestAD"
}
Default OU (organizational unit) for adding VMs to the domain
Description for the AD
Name that helps the customer identify the record
Authentication
Response
Response BodyResponse Body
200 OK
Successfully updated existing 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"
}
Record creation timestamp
The credential ID to be used with the credential service
Default OU (organizational unit) for adding VMs to the domain
Description for the AD
Directory DNS name
Unique record ID
location
Name that helps the customer identify the record
Org ID that owns this record
Record update timestamp
Record version (internal)
204 No Content
No Content
Errors
Bad Request
Unauthorized
Forbidden
Not Found
Conflict - concurrent updates
Internal Server Error
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: patchActiveDirectory
