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.RestServiceLibraryUriTemplate: /dra/domains/{domainFqdn}/users/get
Assembly: NetIQ.DRA.RestServiceLibrary (in NetIQ.DRA.RestServiceLibrary.dll) Version: 1.1.0.318 (1.1.0.318)
Syntax
[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 )
Parameters
- domainFqdn
- Type: System String
The FQDN of the domain to query
- userIdentifier
- Type: System String
A string identifying the user. Used to indicate the reqeusted attributes of the user should be returned.
- userAndFilter
- Type: NetIQ.DRA.Common.Rest.DataModels User
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.DataModels User
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.DataModels PowerFilter
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.DataModels SimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'and' clauuse
- additionalOrFilters
- Type: NetIQ.DRA.Common.Rest.DataModels SimpleFilterCollection
An optional SimpleFilterCollection object that contains an additional set of simple filters to use in the 'or' clauuse
- attributes
- Type: System String
An optional list of properties to retrieve from the server
- getInfoOptions
- Type: NetIQ.DRA.Common.Rest.DataModels GetInfoOptions
An optional GetInfoOptions structure that controls what data is returned
- enumerationOptions
- Type: NetIQ.DRA.Common.Rest.DataModels EnumerationOptions
An optional EnumerationOptions structure that controls how the enumeration is performed
- connectionParameters
- Type: NetIQ.DRA.Common.Rest.DataModels ConnectionParameters
Optional ConnectionParameters to specify a DRA server and Assistant Admin credentials
Return Value
Type: StreamA GetUserPropertiesResponse when attributes of a user are requested or a UserListResponse containing the users that matched the specified search filters.
Remarks
See Also