Skip to content

Commit e39d251

Browse files
authored
IBX-8823: Manage user data from CLI (#2527)
* IBX-8823: Manage user data from CLI
1 parent e728b5a commit e39d251

File tree

3 files changed

+55
-1
lines changed

3 files changed

+55
-1
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
description: Update basic user account data from the console.
3+
---
4+
5+
# Update basic user data from CLI
6+
7+
Multiple user management scenarios may result in having to update basic user account data, such as user status, the password, or email.
8+
Especially, you may need to revoke user access by disabling the account when offboarding an employee, or change the user's forgotten password.
9+
10+
You can do it without accessing the Admin UI, by running a console command.
11+
You reference the user account by passing the user login.
12+
13+
## Disable or enable user account
14+
15+
Disable the user account:
16+
17+
```bash
18+
php bin/console ibexa:user:update-user --disable <login>
19+
```
20+
21+
For example:
22+
23+
```bash
24+
php bin/console ibexa:user:update-user --disable johndoe
25+
```
26+
27+
Enable the user account:
28+
29+
```bash
30+
php bin/console ibexa:user:update-user --enable <login>
31+
```
32+
33+
## Change password
34+
35+
Change the password associated with the user account:
36+
37+
```bash
38+
php bin/console ibexa:user:update-user --password <login>
39+
```
40+
41+
After you run the command, enter the new password when prompted.
42+
The command runs in silent mode and inputs are not echoed.
43+
44+
For more information about changing and revoking passwords, for example, when a security breach occurs, see [Passwords](passwords.md#revoking-passwords).
45+
46+
## Change email address
47+
48+
Change the email address associated with the user account:
49+
50+
```bash
51+
php bin/console ibexa:user:update-user --email=<new_email_address> <login>
52+
```

docs/users/users.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ All such user accounts have the same underlying mechanism and enable you to cont
1515
"users/user_management_guide",
1616
"users/invitations",
1717
"users/user_registration",
18-
], columns=3) =]]
18+
"users/update_basic_user_data"
19+
], columns=4) =]]
1920

2021
## Authenticate users
2122

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,7 @@ nav:
423423
- User setup:
424424
- Invitations: users/invitations.md
425425
- Registration: users/user_registration.md
426+
- Update basic user data: users/update_basic_user_data.md
426427
- User authentication:
427428
- Login methods: users/login_methods.md
428429
- Passwords: users/passwords.md

0 commit comments

Comments
 (0)