Skip to content

stratumctl users

Manage IAM users

Terminal window
stratumctl users [flags]

Aliases: user

Create a new user

Terminal window
stratumctl users create [flags]
Terminal window
stratumctl users create --email alice@example.com --display-name "Alice Liddell"
stratumctl users create --email bob@example.com --display-name "Bob" --password "$INITIAL_PASSWORD"
Flag Type Default Description
--display-name string Display name (required)
--email string Email (required)
--password string Initial password (server generates one if empty)

Soft-delete a user

Terminal window
stratumctl users delete <user-id> [flags]
Terminal window
stratumctl users delete u-alice

Get a single user

Terminal window
stratumctl users get <id> [flags]
Terminal window
stratumctl users get u-alice
stratumctl users get u-alice --output json

List users

Terminal window
stratumctl users list [flags]
Terminal window
stratumctl users list
stratumctl users list --output json

Rotate a user’s password

Terminal window
stratumctl users set-password <user-id> [flags]

Rotate the named user’s password.

The new password is read from –password, the STRATUM_NEW_PASSWORD env var, or (for tty stdin) prompted without echo. Same conventions as stratumctl login.

Terminal window
stratumctl users set-password u-alice
stratumctl users set-password u-alice --password "$NEW_PASSWORD"
Flag Type Default Description
--password string New password (or set STRATUM_NEW_PASSWORD; or prompt)

Update a user’s display name, state or email

Terminal window
stratumctl users update <user-id> [flags]

Apply a sparse PATCH to a user.

Suspending a user (–state suspended) immediately revokes the user’s active sessions + PATs server-side. Reactivating them (–state active) restores login but does NOT restore the revoked tokens — the user must log in again.

Changing the email (–email, install admins only) keeps the user’s sessions and PATs; the next login uses the new address.

Terminal window
stratumctl users update u-alice --display-name "Alice L."
stratumctl users update u-alice --state suspended
stratumctl users update u-alice --email alice@new.example.com
Flag Type Default Description
--display-name string New display name (omit to leave unchanged)
--email string New sign-in email (install admins only; omit to leave unchanged)
--state string New state: active|suspended (omit to leave unchanged)

Show the currently-authenticated user

Terminal window
stratumctl users whoami [flags]
Terminal window
stratumctl whoami
stratumctl whoami --output json