getUser command

Use this command to view information about a user.

Purpose

Use the getUser command to view a list that contains the properties:
  • uniqueName
  • cn
  • sn
  • uid
  • mail
  • principalName
These are the only properties that this command returns; that is, you cannot modify the properties that the command returns.
Note: After login, the first login property is returned as the value of principalName.

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 that are performed on the domain are applied to the security domain-specific configuration.

Syntax

getUser { -uniqueName uniqueName [-clearCache clearCacheMode] [-securityDomainName domainName] }

Parameters

-uniqueNameuniqueName
Specifies the unique name value for the user that you want to view. This parameter maps to the uniqueName property in virtual member manager.
-clearCacheclearCacheMode
Specifies whether the repository adapter cache should be cleared before retrieving the specified user information.
Valid values are:
  • clearEntity: Clears the cache for the specified user, if the user exists in the cache.
  • clearAll: Clears the cached information for all of the entities in the adapter of the repository where the specified user exists.
The values are not case-sensitive. There is no default value for this parameter. If you do not specify a value, or specify a value other than clearEntity or clearAll, an error message appears.
Avoid trouble: Frequent use of this parameter to clear the cache may result in performance degradation. When the cache is cleared, the subsequent operation has to get the details from the repository and update the cache with this newly retrieved data. The impact on performance is more pronounced if you use the clearAll mode, as this invalidates the entire cache, and the subsequent operation takes longer to complete.
-securityDomainNamedomainName
Specifies the name that uniquely identifies the security domain. If you do not specify this parameter, the command uses the global federated repository.

Sample

To retrieve the properties of a user, Dan Meyer, whose uniqueName is uid=dmeyers,cn=users,dc=yourco,dc=com, issue this command:
$AdminTask getUser {-uniqueName uid=dmeyers,cn=users,dc=yourco,dc=com}