Search Active Directory Domains

GET /api/activedirectory

Searching for Active Directory Domains can be achieved via multiple criteria, as outlined by the fields below. You can search using just one field, or multiple to further narrow down the search results. You must specify the Active Directory Domain API Key which can be found on the screen Administration -> Passwordstate Administration -> System Settings -> API tab.

• ADDomainID
• ADDomainNetBIOS
• ADDomainLDAP
• FQDN
• SiteID
• SiteLocation

# Search by ADDomainID
$PasswordstateURL = $PasswordstateBaseURL + '/api/activedirectory/?ADDomainID=<value>'
                        
# Search by ADDomainNetBIOS
$PasswordstateURL = $PasswordstateBaseURL + '/api/activedirectory/?ADDomainNetBIOS=<value>'

# Search by ADDomainLDAP
$PasswordstateURL = $PasswordstateBaseURL + '/api/activedirectory/?ADDomainLDAP=<value>'

# Search by FQDN
$PasswordstateURL = $PasswordstateBaseURL + '/api/activedirectory/?FQDN=<value>'

# Searching by SiteID
$PasswordstateURL = $PasswordstateBaseURL + '/api/activedirectory/?SiteID=<value>'

# Searching by SiteLocation
$PasswordstateURL = $PasswordstateBaseURL + '/api/activedirectory/?SiteLocation=<value>'

# Search by FQDN and SiteLocation
$PasswordstateURL = $PasswordstateBaseURL + '/api/activedirectory/?FQDN=<value>&SiteLocation=<value>'

Invoke-Restmethod -Method GET -Uri $PasswordstateURL -Header @{ "APIKey" = "$APIKey" }

# Response
HTTP/1.1 200          
[
    {
        "ADDomainID":"1",
        "ADDomainNetBIOS":"clickstudios",
        "ADDomainLDAP":"dc=clickstudios,dc=com,dc=au",
        "FQDN":"clickstudios.com.au",
        "DefaultDomain":"False",
        "PAReadID","1",
        "SiteID":"0",
        "SiteLocation":"Internal",
        "UsedForAuthentication":"True",
        "Protocol":"2",
        "DomainControllerFQDN":"",
    }
]