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

vcenter activedirectory active directory: status

Returns the Active Directory Domain Join Status of the system the identity server is executing on.

Request:

HTTP request

GET https://{server}/rest/vcenter/system/active-directory
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "domain_name" : "string",
        "state" : "JOINED",
        "organizational_unit" : "string"
    }
}

Response Type:

Name Type Description
bold = required
value status_info StatusInfo.
value.state string State of domain join operation

Defines the current state of domain join. Value is one of:
JOINED: Domain join operation is successful.
NOT_JOINED: Domain join operation is not requested.
FAILED: Domain join operation failed.
value.domain_name string Domain Name to which the appliance is joined

Optional. If appliance is not part of any domain.

value.organizational_unit string Organizational Unit to which the appliance is joined

Optional. If appliance is not part of any organizational unit.

Errors:

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