Passwordstate Documentation

Search Active Directory Domains ​

GET /winapi/activedirectory

Searching for Active Directory Domain 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. The account executing this call must have the 'Active Directory Domains' Security Administrator's role in Passwordstate.

  • ADDomainID
  • ADDomainNetBIOS
  • ADDomainLDAP
  • FQDN
  • SiteID
  • SiteLocation
Powershell
# Search by ADDomainID
$PasswordstateUrl = 'https://passwordstate/winapi/activedirectory/?ADDomainID=<value>'
                           
# Search by ADDomainNetBIOS
$PasswordstateUrl = 'https://passwordstate/winapi/activedirectory/?ADDomainNetBIOS=<value>'

# Search by ADDomainLDAP
$PasswordstateUrl = 'https://passwordstate/winapi/activedirectory/?ADDomainLDAP=<value>'

# Search by FQDN
$PasswordstateUrl = 'https://passwordstate/winapi/activedirectory/?FQDN=<value>'

# Searching by SiteID
$PasswordstateUrl = 'https://passwordstate/winapi/activedirectory/?SiteID=<value>'

# Searching by SiteLocation
$PasswordstateUrl = 'https://passwordstate/winapi/activedirectory/?SiteLocation=<value>'

# Search by FQDN and SiteLocation
$PasswordstateUrl = 'https://passwordstate/winapi/activedirectory/?FQDN=<value>&SiteLocation=<value>'

Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -UseDefaultCredentials
Json
# 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":"",
    }
]