Retrieves a list of users matching the specified search criteria or returns the requested attributes of a specified user.
UriTemplate: /dra/domains/{domainFqdn}/users/get

Namespace: NetIQ.DRA.RestServiceLibrary
Assembly: NetIQ.DRA.RestServiceLibrary (in NetIQ.DRA.RestServiceLibrary.dll) Version: 10.2.2.1

Syntax

Copy

[OperationContractAttribute]
[WebInvokeAttribute(Method = "POST", ResponseFormat = WebMessageFormat.Json, 
	RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped, 
	UriTemplate = "/dra/domains/{domainFqdn}/users/get")]
Stream GetUsersRequest(
	string domainFqdn,
	string userIdentifier,
	User userAndFilter,
	User userOrFilter,
	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}/users/get")>
Function GetUsersRequest ( 
	domainFqdn As String,
	userIdentifier As String,
	userAndFilter As User,
	userOrFilter As User,
	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
userIdentifier: Type: SystemString
A string identifying the user. Used to indicate the reqeusted attributes of the user should be returned.
userAndFilter: Type: NetIQ.DRA.Common.Rest.DataModelsUser
An optional user object that defines the attribute match patterns to filter on to use in the 'and' clause
userOrFilter: Type: NetIQ.DRA.Common.Rest.DataModelsUser
An optional user 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 list of properties to retrieve from the server
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: Stream
A GetUserPropertiesResponse when attributes of a user are requested or a UserListResponse containing the users that matched the specified search filters.

Remarks

For more information on object filtcoers, 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)

Reference

IDRARestServer Interface

NetIQ.DRA.RestServiceLibrary Namespace

IDRARestServerAddLanguageSpecificTextSet("LSTB8D8D203_0?cpp=::|nu=.");GetUsersRequest Method

Parameters

Return Value

Reference

IDRARestServerGetUsersRequest Method