HA OS: add command on listing users from cli (#31932)

* HA OS: add command on listing users from cli

* Reference listing users on locked out page

* Locked out: add related topics

* Update locked out section to use list auth command
This commit is contained in:
c0ffeeca7 2024-03-18 15:56:38 +01:00 committed by GitHub
parent 560864518d
commit 97c61504a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 13 additions and 1 deletions

View File

@ -9,7 +9,7 @@ or need to recover your data.
## Forgot user name
If youve forgotten your username, ask the owner to help you.
If you are the owner and have forgotten your user name, then you need to [prepare the system to start a new onboarding process](/docs/locked_out/#to-prepare-the-system-to-start-a-new-onboarding-process).
If you are using the Home Assistant Operating System and have access to the Home Assistant server, you can connect a terminal and enter the `auth list` command. This command lists all users that are registered on your Home Assistant.
## Forgot password
@ -131,3 +131,9 @@ For Windows or macOS you will need third party software. Below are some options.
- Windows: <https://www.diskinternals.com/linux-reader/> (read-only access to the SD)
- macOS: <https://osxfuse.github.io/>
## Related topics
- [Reset the Green](https://green.home-assistant.io/guides/reset/)
- [Reset the Yellow](https://yellow.home-assistant.io/guides/factory-reset/)
- [Listing all user names via command line](/common-tasks/os/#listing-all-users-from-the-command-line)

View File

@ -115,4 +115,10 @@ The `ha os datadisk wipe` command can only be run from the local terminal. Conne
Note, if you have a Home Assistant Yellow, there is a red hardware button to wipe the data disk. Follow the procedure on [resetting the device](https://yellow.home-assistant.io/guides/factory-reset/).
#### Listing all users from the command line
In Home Assistant Operating System, the `ha auth list` command lists all users that are registered on your Home Assistant.
The `ha auth list` command can only be run from the local terminal. Connect a display and keyboard and use the terminal.
{% endif %}