REST API - leave
  1. Operations
  2. vcenter
  3. activedirectory
  4. active directory

vcenter activedirectory active directory: leave

Leave the registered domain, if registered to any.

Request:

HTTP request

PATCH https://{server}/rest/vcenter/system/active-directory

Request Body Structure:

{
    "user_spec" : {
        "password" : "secret string",
        "username" : "string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
user_spec user_spec User information i.e username and password for domain controller access.
user_spec.username string Username of user authorized to join the appliance to the domain. Username can be either in UPN (ex: [email protected]) or netbios (ex: domain\name) format.
user_spec.password secret Password of user authorized to join the appliance to the domain

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
400 already_in_desired_state
401 unauthenticated if user is unauthenticated to use the API.
403 unauthorized if user is unauthorized to use the API.
500 error