Get an Active Directory by id.

get

https://cluster.ip.address/v2/active-directories/{id}

Privileges: AD_LDAP_VIEW

Get an Active Directory by id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies id of an Active Directory.

Query Params

includeCentrifyZones

boolean

Specifies whether to include Centrify Zones of the Active Directory in response.

includeDomainControllers

boolean

Specifies whether to include Domain Controllers of the Active Directory in response.

includeSecurityPrincipals

boolean

Specifies whether to include Security Principals of the Active Directory in response.

prefix

string

Specifies a prefix, only security principals with name or sAMAccountName having this prefix (ignoring cases) will be returned. This field is appliciable and mandatory if 'includeSecurityPrincipals' is set to true.

objectClass

array of strings

Specifies a list of object classes, only security principals with object class in this list will be returned. This field is appliciable if 'includeSecurityPrincipals' is set to true.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError