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]
[-q | --query-string]
[-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.

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 for users with names matching the expression.

For example, "jdoe, janedoe".

-d
--display-name-search
Optional none Indicates whether the search expression should be used to match display names rather than user names.

Mutually exclusive with the --query-string argument.

-q
--query-string
Optional none Indicates that the search expression should be interpreted as a query string, in accordance with the SCIM query syntax (see section 3.4.2.2 of RFC 7644) rather than as a search expression matching user names.
Mutually exclusive with the --display-name-search and --exclude-disabled arguments. Examples of valid query strings are:
  • 'userName eq "jdoe"'
  • 'userName eq "jdoe" AND enabled eq "false"'
  • 'email co "example.com"'
  • 'userName sw "jd" AND email co "example.com"'
  • ''displayName co "Doe"'
-e value
--exclude-disabled=<true|false>
Optional false Indicates whether disabled users should be excluded.

Mutually exclusive with the --query-string argument.

--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.