jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-11 19:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document supervisor's new /auth/list endpoint (#2085)

Browse Source 
Co-authored-by: Stefan Agner <stefan@agner.ch>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Mike Degatano 2024-06-08 05:21:28 -04:00 committed by GitHub
parent 52e2213c0f
commit 9dbcd03e4c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api/supervisor/endpoints.md
View File

@ -750,6 +750,18 @@ Reset internal authentication cache, this is useful if you have changed the pass
</ApiEndpoint> </ApiEndpoint>
<ApiEndpoint path="/auth/list" method="get">
List all users in Home Assistant to help with credentials recovery. Requires an admin level authentication token.
**Payload:**
| key | type | description |
| -------- | ------ | ------------------------------------------------------------------ |
| users | list | List of the Home Assistant [users](api/supervisor/models.md#user). |
</ApiEndpoint>
### Backup ### Backup
<ApiEndpoint path="/backups" method="get"> <ApiEndpoint path="/backups" method="get">

11
docs/api/supervisor/models.md
View File

@ -316,6 +316,17 @@ Response only fields will be in responses but cannot be included in requests.
| status | string | Status of the last boot from slot (good or bad) | | status | string | Status of the last boot from slot (good or bad) |
| version | string | Version of OS installed | | version | string | Version of OS installed |
## User
| key | type | description |
| ---------- | ------- | ------------------------------------------------------------- |
| username | string | Username used to login |
| name | string | Name of the user |
| is_owner | boolean | Is the user the owner |
| is_active | boolean | Is the user active |
| local_only | boolean | Can the user login from the network (e.g. via http) |
| group_ids | list | Role(s) the user has (admin, etc) |
## Drive ## Drive
| key | type | description | | key | type | description |