Get Active Directory Configuration

Product version: 10.11

Last modified: 31 July 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

curl

Copy

{
  "action": "ADDomainManagement",
  "method": "getListADDomains",
  "data": [
    {
      "filter": {
        "start": 0,
        "count": 20,
        "useUnlimitedCount": false,
        "sort": "name",
        "sortAsc": true,
        "sorts": null,
        "sortsAsc": null,
        "criteria": [
          {
            "type": "OR",
            "name": null,
            "value": null,
            "values": null,
            "criteria": [
              {
                "type": "EQ",
                "name": "STATE",
                "value": "ENABLED",
                "values": null,
                "criteria": null
              },
              {
                "type": "EQ",
                "name": "STATE",
                "value": "DISABLED",
                "values": null,
                "criteria": null
              }
            ]
          }
        ]
      }
    }
  ],
  "type": "rpc",
  "tid": 1
}

Request Fields

Field	Type	Value(s)
`action`	string	`ADDomainManagement`
`method`	string	`getListADDomains`
`data`	null
`filter`	object	Search and paging parameters. See parameters below
`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
`sorts`	array	List form of `sort`: AD domain parameters to be sorted with, in order of priority
`sortsAsc`	array	List form of `sortAsc`: one `true` (ascending) or `false` (descending) value for each element of `sorts`
`criteria`	array	Filter criteria. Each criterion is an object with the fields below
`type`	string	Type of the criterion. A comparison operator, for example, `EQ` (equal), `NEQ` (not equal), `LIKE`, or `IN`, compares the `name` field with `value` or `values`. `AND` and `OR` combine the nested `criteria`; for these types, `name` must be `null`
`name`	string	Name of the field to be compared, for example, `STATE`
`value`	string	Value of the criterion
`values`	array	Values of the criterion, for example, for `IN`
`criteria`	array	Nested criteria for the `AND` and `OR` types. Each nested criterion has the same fields

Response Sample

curl

Copy

{
  "action": "ADDomainManagement",
  "method": "getListADDomains",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "children": [{
      "id": 5,
      "domainName": "adtestvn.local",
      "preferredDc": "10.30.30.1",
      "username": "administrator",
      "password": null,
      "integratedGroups": "users,domain users",
      "refreshInMinutes": 60,
      "useLdaps": false,
      "changeExistingPreferredDc": true,
      "locked": false,
      "lockReasons": [],
      "disabled": false,
      "connected": true,
      "alertErrorCode": null,
      "alertTitle": null,
      "alertDescription": null
    }],
    "totalCount": 2}
}

Data

Field	Value	Description
`children`	array	Active Directory domains. Contains the fields below
`id`	int	Active Directory domain ID
`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