diff --git a/docs/users/update_basic_user_data.md b/docs/users/update_basic_user_data.md new file mode 100644 index 0000000000..e4deeef6f0 --- /dev/null +++ b/docs/users/update_basic_user_data.md @@ -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 +``` + +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 +``` + +## Change password + +Change the password associated with the user account: + +```bash +php bin/console ibexa:user:update-user --password +``` + +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= +``` \ No newline at end of file diff --git a/docs/users/users.md b/docs/users/users.md index 9c244383df..fcf48893bf 100644 --- a/docs/users/users.md +++ b/docs/users/users.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index a4396ef833..8ee302a083 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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