Find User operation

Filter properties
Result properties
Exceptions

Retrieves information about a user account from User Manager based on search filters that you provide. The search returns the first user that is found that meets the search criteria. The search also returns the total number of users that meet the criteria.

Use the Find Users operation operation to retrieve multiple users 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.

Exact Match

A boolean value that determines whether users are returned only when their properties exactly match the Name and Email filters. A value of true indicates an exact match is returned. A value of false indicates the first user found that partially matches the search criteria is returned.

If you are expressing a literal value, select Exact Match to match the entire user name or email address.

Domain Name

A string value that represents the User Management domain that the user belongs 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 user. This value searches the Unique Identifier property that is configured in the Directory Users properties of the domains that are created in User Management.

You must provide the entire identification, for example 56e04201-1dd211b2-80cafe29-7dd5631b .

Name

A string value that represents the name of the user. This value searches the Full Name property that is configured in the Directory Users properties of the domains that are created in User Management.

You can specify all or part of the name for the user that you want to retrieve.

Email

A string value that represents the email address of the user. This value searches the Primary Email property that is configured in the Directory Users properties of the domains that are created in User Management.

You can specify all or part of the email address for the user that you want to retrieve.

Login Id

A string value that represents the login name that the user logs in with. This value searches the Login ID property that is configured in the Directory Users properties of the domains that are created in User Management.

You can specify all or part of the login name for the user that you want to retrieve.

Result properties

Properties for specifying where to store operation results.

Results

The location to store the returned int value that stores the number of users 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.

User

A User value that represents the first user account that was found that matches the search filters.

Exceptions

The exception event attached to this operation can receive UMException exceptions.