|
Retrieves information about a user group from User Manager
based on search filters that you provide. The search returns the
first group that is found that meets the search criteria. The search
also returns the total number of groups that meet the criteria.
Use the
Find Groups operation
to retrieve multiple groups that meet the same search criteria.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Filter properties
Properties for specifying search criteria. You must specify
at least one filter. You can specify more than one filter to narrow
the search results.
Domain Name
A
string
value that represents
the User Management domain that the groups belong to. To specify
a literal value, select a domain from the list.
For information
about domains, see
Setting up and managing domains
in
LiveCycle ES2 Administration Help
.
Universal ID
A
string
value that represents
the unique identification of the group. This value searches the
Unique Identifier property that is configured in the Directory Groups
properties of the domains that are created in User Management.
You
must provide the entire identification, for example
fb5f4c02-1dd111b2-8093fe29-7dd5631b
.
Name
A
string
value that represents
the name of the group. This value searches the Full Name property
that is configured in the Directory Groups properties of the domains
that are created in User Management.
You can specify all or
part of the name for the group that you want to retrieve.
Result properties
Properties for specifying where to store operation results.
Results
An
int
value that stores the
number of groups that were found that matched the search filters.
The maximum value that Result can be is
10
. After
ten matches are found, the search is stopped to conserve server
resources.
Group
A
Group
value that represents
the first group that was found that matches the search filters.
Exceptions
The exception event attached to this operation can receive
UMException
exceptions.
|
|
|
