Connect to Active Directory Domain

Product version: 10.11

Last modified: 31 July 2024

Connects to the AD domain.

Note

In case NAKIVO Backup & Replication was installed in Multi-tenant mode, the use of API is possible only for the Master tenant.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:

https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl

Copy

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
        "action": "ADDomainManagement",
        "method": "connectAD",
        "data": [{
            "domainName": "adtestvn.local",
            "preferredDc": "10.30.30.1",
            "username": "administrator",
            "password": "password",
            "integratedGroups": "users,domain users" }],
        "type": "rpc",
        "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`ADDomainManagement`
`method`	string	`connectAD`
`data`	null
`type`	string	`rpc`
`tid`	integer	`1`

Data

Field	Value	Description
`domainName`	string	AD domain
`preferredDc`	string	Preferred DC/Host (optional)
`username`	string	Username
`password`	string	Password
`integratedGroups`	string	List of integrated groups

Response Sample

curl

Copy

{
    "action": "ADDomainManagement",
    "method": "connectAD",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": true

}

Response Fields

Field	Type	Value(s)
`action`	string	`ADDomainManagement`
`method`	string	`connectAD`
`tid`	integer	`1`
`type`	string	`rpc`
`message`	null
`where`	null
`cause`	null
`data`	boolean	`true`