MembershipProvidersServicesQueryAD Method

Queries the Active Directory specified in the Active Directory Membership Provider connection string (local-connection-strings.config). Retrieves the listing of Group and User directory entries.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492

Syntax

C++

Copy

public XHRServiceResponseGeneric<QueryADResult> QueryAD(
	string bindUser,
	string bindPass,
	string searchQuery,
	string groupNameField,
	string groupUsersField,
	string userIdField,
	string userNameField,
	string userEmailField,
	string providerName = ""
)

Public Function QueryAD ( 
	bindUser As String,
	bindPass As String,
	searchQuery As String,
	groupNameField As String,
	groupUsersField As String,
	userIdField As String,
	userNameField As String,
	userEmailField As String,
	Optional providerName As String = ""
) As XHRServiceResponseGeneric(Of QueryADResult)

public:
virtual XHRServiceResponseGeneric<QueryADResult^>^ QueryAD(
	String^ bindUser, 
	String^ bindPass, 
	String^ searchQuery, 
	String^ groupNameField, 
	String^ groupUsersField, 
	String^ userIdField, 
	String^ userNameField, 
	String^ userEmailField, 
	String^ providerName = L""
) sealed

abstract QueryAD : 
        bindUser : string * 
        bindPass : string * 
        searchQuery : string * 
        groupNameField : string * 
        groupUsersField : string * 
        userIdField : string * 
        userNameField : string * 
        userEmailField : string * 
        ?providerName : string 
(* Defaults:
        let _providerName = defaultArg providerName ""
*)
-> XHRServiceResponseGeneric<QueryADResult> 
override QueryAD : 
        bindUser : string * 
        bindPass : string * 
        searchQuery : string * 
        groupNameField : string * 
        groupUsersField : string * 
        userIdField : string * 
        userNameField : string * 
        userEmailField : string * 
        ?providerName : string 
(* Defaults:
        let _providerName = defaultArg providerName ""
*)
-> XHRServiceResponseGeneric<QueryADResult>

Parameters

bindUser String: The user account to connect to Active Directory, need to include domain information
Example
ingeniux\jdoe
bindPass String: The password for the connecting user account
searchQuery String: The query for searching User Groups in Active Directory, default "(&(objectCategory=group))"
groupNameField String: The field for Group Name in Group Account directory entry, default "sAMAccountName"
groupUsersField String: The field for Users in Group Account directory entry, default "member"
userIdField String: The field for User Id in User Account directory entry, default "sAMAccountName" also
userNameField String: The field for User Name in User Account directory entry, default "displayName"
userEmailField String: The field for User Email Address in User Account directory entry, default "mail"
providerName String (Optional): Optional name of the membership provider to query. When empty, the default membership provider is used.

Return Value

XHRServiceResponseGenericQueryADResult

List of Groups that contains Users

Example

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "usersAndGroups": {
            "Domain": "imda",
            "Groups": [{
                "GroupName": "Executives",
                "Users": [{
                    "Email": "Jimmy.Eddie@imda.com",
                    "UserID": "jime",
                    "UserName": "Jimmy Eddie"
                }, {
                    "Email": "Natie.Eggy@imda.com",
                    "UserID": "neggy",
                    "UserName": "Natie Eggy"
                }, {
                    "Email": "Shane.McMahon@imda.com",
                    "UserID": "shanmc",
                    "UserName": "Shane McMahon"
                }]
            }, {
                "GroupName": "Account Operators",
                "Users": []
            }, {
                "GroupName": "AccountManagement",
                "Users": [{
                    "Email": "Jimmy.Eddie@imda.com",
                    "UserID": "jime",
                    "UserName": "Jimmy Eddie"
                }, {
                    "Email": "Rob.Doe@imda.com",
                    "UserID": "robdo",
                    "UserName": "Rob Doe"
                }, {
                    "Email": "Sean.Riddle@imda.com",
                    "UserID": "seanrid",
                    "UserName": "Sean Riddle"
                }, {
                    "Email": "Shane.McMahon@imda.com",
                    "UserID": "shanmc",
                    "UserName": "Shane McMahon"
                }]
            }]
        }
    }
}

Reference

MembershipProvidersServices Class

IngeniuxCMService Namespace