Skip to content

Commit

Permalink
IBX-8823: Manage user data from CLI (#2527)
Browse files Browse the repository at this point in the history
* IBX-8823: Manage user data from CLI
  • Loading branch information
dabrt authored Nov 7, 2024
1 parent e728b5a commit e39d251
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 1 deletion.
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 @@
---
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

0 comments on commit e39d251

Please sign in to comment.