Skip to content

Users

Users are human principals who can log in to Chronicle using a username and password. They are distinct from applications, which authenticate with client credentials. Manage users when you need to grant or revoke interactive access to the Chronicle server.

Lists all users registered on the Chronicle server.

Terminal window
cratis chronicle users list

List all users:

Terminal window
cratis chronicle users list

List in plain format:

Terminal window
cratis chronicle users list --output plain

Creates a new user account with the specified username, email address, and password.

Terminal window
cratis chronicle users add <USERNAME> <EMAIL> <PASSWORD>
ArgumentDescription
USERNAMEThe login name for the new user.
EMAILThe email address for the new user.
PASSWORDThe initial password for the new user.

Add a new user:

Terminal window
cratis chronicle users add alice alice@example.com initialpassword

Avoid passing passwords as shell arguments in environments where command history is logged. Use a variable to supply the password:

Terminal window
cratis chronicle users add alice alice@example.com "$INITIAL_PASSWORD"

Removes a user account from Chronicle. This operation is irreversible. The user immediately loses all access to the server.

Terminal window
cratis chronicle users remove <USER_ID>

The command prompts for confirmation before proceeding. Pass --yes to skip the prompt in automated workflows.

ArgumentDescription
USER_IDThe GUID of the user to remove. Use users list to retrieve user IDs.
FlagDescription
-y, --yesSkip confirmation prompt.

Remove a user interactively:

Terminal window
cratis chronicle users remove a1b2c3d4-e5f6-7890-abcd-ef1234567890

Remove without confirmation:

Terminal window
cratis chronicle users remove a1b2c3d4-e5f6-7890-abcd-ef1234567890 --yes