Active Directory Domains ​
Multiple methods are available with the API to query Active Directory Domain entries, or to add, update and delete entries.
You must use the 'Active Directory Domain' API Key for these methods in the API.
| Heading | Data Type | Description |
|---|---|---|
| ADDomainID | Integer | The database ID for the Active Directory Domain entry |
| ADDomainNetBIOS | String | The NetBIOS value for the Active Directory Domain entry |
| ADDomainLDAP | String | The LDAP Query String value for the Active Directory Domain entry e.g. dc=clickstudios,dc=com,dc=au |
| FQDN | String | The FQDN value for the Active Directory Domain entry e.g. clickstudios.com.au |
| DefaultDomain | Boolean | Whether the domain record will be selected as the Default Domain on the authentication screens in Passwordstate |
| PAReadID | Integer | The PAReadID field is the corresponding PrivilegedAccountID value for the Privileged Account Credential entry to be associated with the domain. This Privileged Account Credential is required for looking up/synchronizing Active Directory Security Groups and User Accounts into Passwordstate. Typically this account only requires Read-Only access to your Domain, unless you also use the Privileged Account Credential for other features like Privileged Account Management |
| SiteID | Integer | The SiteID for the Active Directory Domain entry. A value of zero means the entry is associated with the Site 'Internal'. "Sites" in Passwordstate refer to the Remote Site Locations module. If this module is not being used, then the Site of 'Internal' will always be returned |
| SiteLocation | String | The description of the Site the Active Directory Domain entry belongs to |
| UsedForAuthentication | Boolean | True or False - whether the Active Directory Domain record is to be shown on Authentication screens in Passwordstate |
| Protocol | Integer | 0 for LDAP (UDP Port 389), 1 for LDAPS (TCP Port 636), and 2 for Kerberos ((UDP/TCP Port 88 and 464) |
| DomainControllerFQDN | String | This field should only be required if you need to connect to a specific domain controller to improve performance of the Active Directory synchronization process - for synchronization Security Groups and User Accounts. This field is not used for any authentication processes in Passwordstate |