RetrieveUserGroupsRequestType

RetrieveUserGroupsRequestType
RetrieveUserGroupsRequestType

The parameters of RetrieveUserGroups.

JSON Example 
{
    "domain": "string",
    "searchStr": "string",
    "belongsToGroup": "string",
    "belongsToUser": "string",
    "exactMatch": false,
    "findUsers": false,
    "findGroups": false
}
string
domain
Optional

Domain to be searched. If not set, then the method searches the local machine.

string
searchStr
Required

Case insensitive substring used to filter results; the search string is compared to the login and full name for users, and the name and description for groups. Leave this blank to match all users.

string
belongsToGroup
Optional

If present, the returned list contains only users or groups that directly belong to the specified group. Users or groups that have indirect membership will not be included in the list.

string
belongsToUser
Optional

If present, the returned list contains only groups that directly contain the specified user. Groups that indirectly contain the user will not be included in the list.

boolean
exactMatch
Required

Indicates the searchStr passed should match a user or group name exactly.

boolean
findUsers
Required

True, if users should be included in the result.

boolean
findGroups
Required

True, if groups should be included in the result.

Parameter To