Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/users/update_basic_user_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---

Check warning on line 1 in docs/users/update_basic_user_data.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/users/update_basic_user_data.md#L1

[Ibexa.ReadingLevel] The grade level is 9.45. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 9.45. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/users/update_basic_user_data.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Update basic user account data from the console.
---

# Update basic user data from CLI

Multiple user management scenarios may result in having to update basic user account data, such as user status, the password, or email.
Especially, you may need to revoke user access by disabling the account when offboarding an employee, or change the user's forgotten password.

You can do it without accessing the Admin UI, by running a console command.
You reference the user account by passing the user login.

## Disable or enable user account

Disable the user account:

```bash
php bin/console ibexa:user:update-user --disable <login>
```

For example:

```bash
php bin/console ibexa:user:update-user --disable johndoe
```

Enable the user account:

```bash
php bin/console ibexa:user:update-user --enable <login>
```

## Change password

Change the password associated with the user account:

```bash
php bin/console ibexa:user:update-user --password <login>
```

After you run the command, enter the new password when prompted.
The command runs in silent mode and inputs are not echoed.

For more information about changing and revoking passwords, for example, when a security breach occurs, see [Passwords](passwords.md#revoking-passwords).

## Change email address

Change the email address associated with the user account:

```bash
php bin/console ibexa:user:update-user --email=<new_email_address> <login>
```
3 changes: 2 additions & 1 deletion docs/users/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ All such user accounts have the same underlying mechanism and enable you to cont
"users/user_management_guide",
"users/invitations",
"users/user_registration",
], columns=3) =]]
"users/update_basic_user_data"
], columns=4) =]]

## Authenticate users

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,7 @@ nav:
- User setup:
- Invitations: users/invitations.md
- Registration: users/user_registration.md
- Update basic user data: users/update_basic_user_data.md
- User authentication:
- Login methods: users/login_methods.md
- Passwords: users/passwords.md
Expand Down
Loading