user

Manage users within a realm.

ferris-ctl user <subcommand>

Every subcommand accepts --realm <name> to target a specific realm; otherwise the context default is used.

user list

List users in a realm.

ferris-ctl user list [--realm <realm>]

Table columns: USERNAME, EMAIL, ID, ENABLED.

user get

Show a user’s details.

ferris-ctl user get <username> [--realm <realm>]
ArgumentRequiredDescription
<username>yesUsername
--realmnoRealm (defaults to context realm)

Returns id, username, firstname, lastname, email, and enabled.

user create

Create a user.

ferris-ctl user create <username> [flags]
ArgumentDefaultDescription
<username>Username (required)
--realmcontext realmRealm
--emailUser email
--firstnameFirst name
--lastnameLast name
ferris-ctl user create alice \
  --email alice@example.com \
  --firstname Alice \
  --lastname Doe

Setting a password

user create does not set credentials. Set the user’s password from the FerrisKey admin console, or have the user complete a recovery flow.

user delete

Delete a user. Prompts for confirmation unless --force is passed.

ferris-ctl user delete <username> [--realm <realm>] [--force]
ArgumentRequiredDescription
<username>yesUsername
--realmnoRealm (defaults to context realm)
--force / -fnoSkip the confirmation prompt (required in non-interactive shells)