Get Active Directory Configuration

Product version: 10.11

Last modified: 17 January 2024

Gets multiple ADs 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

getListADDomains

data

null

type

string

rpc

tid

integer

1

filter

Field

Value

Description

start

int

A start ID of the AD domains to be returned

count

int

Number of AD domains to be returned

useUnlimitedCount

boolean

If unlimited count is to be used, then true, false otherwise
sort string

AD domain parameter to be sorted with

sortAsc

boolean

true if the order is ascending

criteria

array

Filter criteria. See the rows below

type

string

Type of criterion

name

string

Name of criterion

type

string

Type of the criterion. EQ means the equality relational operator

value

string

Value of the criterion

values

string

Values of the criterion

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

useLdaps boolean If LDAPs are to be used when connecting to the Active Directory, then true, false otherwise
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
lockReasons boolean Reasons why the item is locked by some task
disabled boolean If the AD Domain is disabled, then true, false otherwise
connected boolean If can connect to the AD Domain, then true, false otherwise
alertErrorCode null  
alertTitle null  
alertDescription null  
totalCount number Number of returned AD domains