Bånderapp:user:create
Create a new user account. The command runs the same use case as creating a user in the admin panel (POST /api/admin/users in the admin API), so the account starts with a verified email address and the default notification preferences.
Quick start
Run from the installed-instance host shell with the dc function from
Getting started. Password files in these
examples are protected files on that host. Use -T for redirected input.
Create a regular user:
dc exec -T app php bin/console app:user:create alice@baander.app Alice --password < /secure/baander-user-password
Create a super admin, for example to recover from a lockout. Redirected input leaves no terminal to confirm on, so the admin role needs --force:
dc exec -T app php bin/console app:user:create root@baander.app Root --password --role=super-admin --force < /secure/baander-user-password
Print the new user as JSON, for a script:
dc exec -T app php bin/console app:user:create alice@baander.app Alice --password --json < /secure/baander-user-password
Arguments
| Argument | Required | Description |
|---|---|---|
email |
Yes | User's email address |
name |
Yes | Display name |
Options
| Option | Default | Description |
|---|---|---|
--password |
— | Read password from stdin instead of prompting. Use this in scripts and CI. |
--role |
user |
Role to assign: user, admin or super-admin. Repeat the option to assign several, as in --role=user --role=admin |
--force |
— | Grant admin or super-admin without asking. Required for those roles when no terminal is attached |
--json |
— | Print only the new user, as the admin API's data payload, in JSON |
Password input
When you run the command interactively (without --password), it prompts for a hidden password. In scripts or CI, read the password from a protected file through stdin.
Disable Compose's pseudo-terminal for redirected input:
dc exec -T app php bin/console app:user:create user@baander.app "John Doe" --password < /secure/baander-user-password
The password must be between 8 and 255 characters.
Roles
user, admin and super-admin assign ROLE_USER, ROLE_ADMIN and ROLE_SUPER_ADMIN. A super admin has the rights of an admin, and an admin those of a user. A role named twice is assigned once. To change the roles later, use app:user:roles.
The command acts with full authority. The admin panel lets an admin create only regular users, and only while the admin.can_create_users setting is on; shell access is bound by neither.
When the roles include admin or super-admin, the command asks on a terminal before it creates the user:
Create user with the roles ROLE_SUPER_ADMIN? (yes/no) [no]:
Answering no creates nothing and exits with code 1. Without a terminal, for example when the password is piped in, the command creates nothing and exits with code 2 unless --force is given. A user with only the user role is created without asking.
JSON output
With --json the command prints only the new user as the API's data object, the same user resource POST /api/admin/users returns: publicId, name, email, emailVerifiedAt, roles, disabled, createdAt and updatedAt. Questions go to stderr, so stdout carries only the JSON. --json does not stand in for --force.
Exit codes
| Code | Meaning |
|---|---|
| 0 | User created |
| 1 | The address is already in use, the operator declined the confirmation, or another error occurred; the message says why |
| 2 | The email address, a role or the password was rejected, no password was given, or an admin role was asked for without a terminal and without --force; nothing was created |
Tips
- Use
--passwordwhenever you're running from a script or cron job. - After creating a user, they can log in immediately with their email and password.