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>]
| Argument | Required | Description |
|---|---|---|
<username> | yes | Username |
--realm | no | Realm (defaults to context realm) |
Returns id, username, firstname, lastname, email, and enabled.
user create
Create a user.
ferris-ctl user create <username> [flags]
| Argument | Default | Description |
|---|---|---|
<username> | Username (required) | |
--realm | context realm | Realm |
--email | User email | |
--firstname | First name | |
--lastname | Last 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]
| Argument | Required | Description |
|---|---|---|
<username> | yes | Username |
--realm | no | Realm (defaults to context realm) |
--force / -f | no | Skip the confirmation prompt (required in non-interactive shells) |