Skip to main content

External-User Commands

External-user commands are used for managing the external users recognized by Key Manager.

count-external-users​

Syntax:

ssh-mgr-client count-external-users [options] [-F <filter>] [-vvv] [-U <url>]

Return a count of external users.

The default command returns the total number of external users in the Key Manager system:

$ ssh-mgr-client count-external-users

You can specify filters (-F) to only return the number of external users that match your filter criteria. The available filter criteria are the same as with the list-external-users command (described in list-external-users).

For example:

$ ssh-mgr-client count-external-users -F email="*@example.com"

list-external-users​

Syntax:

ssh-mgr-client list-external-users [options] [-F <filter>] [-vvv] [-U <url>] \
[-o <format>] [-C <columns>] [-H] [-O <sort-order>] [-S <start-from>] \
[-M <max-results>] [-E <delim>] [-B]

List the external users recognized by Key Manager.

The default command displays the email addresses of all the external users:

$ ssh-mgr-client list-external-users

external01@example.com
external02@example.com
external03.example.com
...

The following columns can be used for filtering (-F) and output formatting (-C):

cn​

Common name of the user

dn​

Distinguished name of the user

email​

Email contact of the user

id​

Internal PrivX Key Manager id for provider

Example for listing the ID and the email address of all the external users:

$ ssh-mgr-client list-external-users -C id,email

show-external-user​

Syntax:

ssh-mgr-client show-external-user -i <id> [options] [-vvv] \
[-U <url>] [-o <format>] [-C <columns>]

Display information about a specified external user. Specify the external user using their ID (-i).

You may also specify the column(s) that are displayed (-C). The available column-output attributes are the same as those available for the list-external-users command (described in list-external-users).

Example:

$ ssh-mgr-client show-external-user -i 99