Find Users operation

Filter properties
Result properties
Exceptions

Retrieves information about one or more user accounts from User Manager based on search filters that you provide. The search returns all users that are found that meet the search criteria.

Note: The maximum number of users that is returned is 1000.

To retrieve only one user that meets the search criteria, use the Find User operation operation.

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 that only exact matches are returned. A value of false indicates that user accounts that partially match the search criteria are 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 users 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 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 users. 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 users that you want to retrieve.

Email

A string value that represents the email address of the users. 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 users that you want to retrieve.

Login ID

A string value that represents the 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 names for the users that you want to retrieve.

Result properties

Properties for specifying where to store operation results.

List of Users

The location to store the returned list value that contains User values. Each User value represents a user account that matches the search filters.

For information about retrieving values from a list, see Accessing data in data collections.

Output XML Document

The location in the process data model to store a returned document value that represents an XML document that contains the search results. The XML represents a list of User values. For example, the following XML is the result of a search that returns the default Administrator user:

<?xml version="1.0" encoding="UTF-8"?> 
<users> 
    <user> 
        <principalOid>BA79A041-5DC7-102C-8ED7-00000A24CA8A</principalOid> 
        <userID>administrator</userID> 
        <domainName>DefaultDom</domainName> 
        <familyName>Administrator</familyName> 
        <givenName>Super</givenName> 
        <initials/> 
        <commonName>Super Administrator</commonName> 
        <canonicalName>SuperAdmin</canonicalName> 
        <telephoneNumber/> 
        <postalAddress/> 
        <email/> 
        <org/> 
    </user> 
</users>

Exceptions

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