| IDRARestServerGetGroupsRequest Method |
Retrieves a list of groups matching the specified search criteria or returns the requested properties of a specified group.
UriTemplate: /dra/domains/{domainFqdn}/groups/get
Namespace:
NetIQ.DRA.RestServiceLibrary
Assembly:
NetIQ.DRA.RestServiceLibrary (in NetIQ.DRA.RestServiceLibrary.dll) Version: 10.2.2.1
Syntax [OperationContractAttribute]
[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json,
RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
UriTemplate = "/dra/domains/{domainFqdn}/groups/get")]
Stream GetGroupsRequest(
string domainFqdn,
string groupIdentifier,
Group groupAndFilter,
Group groupOrFilter,
PowerFilter[] powerFilters,
SimpleFilterCollection additionalAndFilters,
SimpleFilterCollection additionalOrFilters,
string[] attributes,
GetInfoOptions getInfoOptions,
EnumerationOptions enumerationOptions,
ConnectionParameters connectionParameters
)
<OperationContractAttribute>
<WebInvokeAttribute(Method := "POST", ResponseFormat := WebMessageFormat.Json,
RequestFormat := WebMessageFormat.Json, BodyStyle := WebMessageBodyStyle.Wrapped,
UriTemplate := "/dra/domains/{domainFqdn}/groups/get")>
Function GetGroupsRequest (
domainFqdn As String,
groupIdentifier As String,
groupAndFilter As Group,
groupOrFilter As Group,
powerFilters As PowerFilter(),
additionalAndFilters As SimpleFilterCollection,
additionalOrFilters As SimpleFilterCollection,
attributes As String(),
getInfoOptions As GetInfoOptions,
enumerationOptions As EnumerationOptions,
connectionParameters As ConnectionParameters
) As Stream
Parameters
- domainFqdn
- Type: SystemString
The FQDN of the domain to query - groupIdentifier
- Type: SystemString
A string identifying the group. Used to indicate that the requested attributes of the group should be returned. - groupAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsGroup
An optional group object that defines the attribute match patterns to filter on to use in the 'and' clause - groupOrFilter
- Type: NetIQ.DRA.Common.Rest.DataModelsGroup
An optional group object that defines the attribute match patterns to filter on to use in the 'or' clause - powerFilters
- Type: NetIQ.DRA.Common.Rest.DataModelsPowerFilter
An optional PowerFilter object that limits the returned objects to those which the AA has the specified powers over - additionalAndFilters
- Type: NetIQ.DRA.Common.Rest.DataModelsSimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'and' clauuse - additionalOrFilters
- Type: NetIQ.DRA.Common.Rest.DataModelsSimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'or' clauuse - attributes
- Type: SystemString
An optional array of attributes to retrieve. If not specified a default set will be returned. - getInfoOptions
- Type: NetIQ.DRA.Common.Rest.DataModelsGetInfoOptions
An optional GetInfoOptions structure that controls what data is returned - enumerationOptions
- Type: NetIQ.DRA.Common.Rest.DataModelsEnumerationOptions
An optional EnumerationOptions structure that controls how the enumeration is performed - connectionParameters
- Type: NetIQ.DRA.Common.Rest.DataModelsConnectionParameters
Optional ConnectionParameters to specify a DRA server and Assistant Admin credentials
Return Value
Type:
StreamA
GetGroupPropertiesResponse when attributes of a group are requested or a
GroupListResponse containing the groups that matched the specified search filters.
Remarks
For more information on object filters, see the topic on
ObjectEnum(Computer, Computer, Contact, Contact, Domain, Domain, DomainMember, DomainMember, AzureTenant, AzureTenant, AzureGroup, AzureGroup, AzureUser, AzureUser, AzureContact, AzureContact, Group, Group, OU, OU, User, User, GroupManagedServiceAccount, GroupManagedServiceAccount, EquipmentMailbox, EquipmentMailbox, RoomMailbox, RoomMailbox, SharedMailbox, DynamicDistributionGroup, DynamicDistributionGroup, Container, Container, BuiltinContainer, BuiltinContainer, PowerFilter, SimpleFilterCollection, SimpleFilterCollection, String, EnumerationOptions, ConnectionParameters)See Also