TIBCO Spotfire® Server and Environment - Installation and Administration

list-users

Lists all users.

list-users 
[-f | --force-synchronization] 
[-l value | --limit=value] 
[-s value | --search-expression=value]
[-d | --display-name-search] 
[-e <true|false> | --exclude-disabled=<true|false>]
[--list-extended-information]
[-b value | --bootstrap-config=value] 
[-t value | --tool-password=value]

Overview

Use this command to list all users in the user directory. It does not work when using the user directory Windows provider.

Options

Option Optional or Required Default Value Description
-f
--force-synchronization
Optional none Indicates that the command should force a user directory synchronization before attempting to list the users. This argument has no effect if the user directory is running in database mode.
-l value
--limit=value
Optional 100 The maximum number of users to list.
-s value
--search-expression=value
Optional none A search expression that can be used to search only for users with names matching the expression.
-d
--display-name-search
Optional none Indicates whether the search expression should be used to match display names rather than user names.
-e value
--exclude-disabled=<true|false>
Optional false Indicates whether disabled users should be excluded.
--list-extended-information
Optional false Indicates whether extended information such as display name, email, and last login time should be displayed for each user.
-b value
--bootstrap-config=value
Optional none The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
-t value
--tool-password=value
Optional none The configuration tool password used to decrypt the database password in the file bootstrap.xml. If the tool password is omitted, the command prompts the user for it in the console. See the Bootstrap.xml file.