Get Active Directory Configuration

Gets AD configuration.

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

Request Fields

Field

Type

Value(s)

action

string

ADDomainManagement

method

string

getADConfiguration

data

null

type

string

rpc

tid

integer

1

Response Sample

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

refreshInMinutes

number

number in minutes in which system will fetch data from AD

changeExistingPreferredDc boolean

Allows deleting old data from old existing configuration.

It is relevant only if you change value of 'preferred DC' but keep value in 'domain name'.

locked boolean Checks if the item is locked by some task