Express (Distributed operating systems), v8.0 > Secure applications and their environment > Authenticate users > Select a registry or repository > Manage realms in a federated repository > Virtual member manager > Reference > Supported commands > User and group management commands


searchUsers command

Use this command to search for users.


Purpose

Use the searchUsers command to find users in virtual member manager that match particular criteria. For example, your can use the searchUsers command to find all users with a uid that starts with the letter 'd'.

If successful, the searchUsers command returns a list of unique names of all users that match the search criteria.

If the Use global security settings option is selected for the user realm or the Global federated repositories option is selected as the realm type for the specified domain, this command is executed on the federated repository of the admin domain. However, configuration changes performed on the domain are applied to the security domain-specific configuration.


Syntax

searchUsers { {-cn commonname –sn surname -principalName principalName -uid uid
               -mail mail} [-timeLimit tlimit] [-countLimit countlimit] [-securityDomainName domainName] }
Exactly one of the parameters (cn, sn, principalName, uid, or mail) must be specified. If none or more than one is specified, an exception occurs.


Parameters

-cn commonname

First name or given name of the user. This parameter maps to the cn property in virtual member manager.

-sn surname

Last name or family name of the user. This parameter maps to the sn property in virtual member manager.

-principalName principalName

Principal name of the user used as the logon ID for the user in the system. This parameter maps to the principalName property in virtual member manager.

-uid uid

Unique ID value for the user to search for. This parameter maps to the uid property in virtual member manager.

–timeLimit tlimit

Maximum amount of time in milliseconds that the search can run. The default is no time limit.

–countLimit countlimit

Maximum number of results that you want returned from the search. By default, all users found in the search are returned.

-securityDomainName domainName

Name that uniquely identifies the security domain. If not specified, uses the global federated repository.

If you define multiple login properties, then the first login property is programmatically mapped to the federated repositories principalName property. For example, if you set uid;mail as the login properties, the LDAP attribute uid is mapped to the federated repositories principalName property.


Sample

To search for all users that have a principal name, issue this command:
$AdminTask searchUsers {-principalName *}
To search for all users that have a uid that starts with the letter 'd', issue this command:
$AdminTask searchUsers {-uid d*}

Parent topic: User and group management commands
Command format



+

Search Tips   |   Advanced Search