Get the list of user and group principals from the Active Directory that match the specified filter criteria.

get

https://cluster.ip.address/v2/active-directory-principals

Privileges: PRINCIPAL_VIEW, AD_LDAP_VIEW

Get the list of user and group principals from the Active Directory that match the specified filter criteria.

Query Params

domainName

string

Specifies the domain name of the principals to search. If specified the principals in that domain are searched. Domain could be an Active Directory domain joined by the Cluster or any one of the trusted domains of the Active Directory domain or the LOCAL domain. If not specified, all the domains are searched.

sids

array of strings

Optionally filter by a list of security identifiers (SIDs) found in the specified domain. Only principals matching the specified SIDs are returned. If specified, a 'searchTerm' parameter should not be specified. Note: Duplicate SIDs will be ignored.

sids

searchTerm

string

Optionally filter by matching a substring. Only principals with a name or sAMAccountName that matches part or all of the specified substring are returned. If specified, a 'sids' parameter should not be specified

includeComputers

boolean

Specifies if Computer/GMSA accounts need to be included in this search.

includeServiceAccounts

boolean

Specifies if service accounts should be included in the search result.

objectClass

string

enum

Specifies the type of principal, a user or a group.

Allowed:

Responses

Language

Credentials

Header

Response

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

application/json

200Success

defaultError