mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-10 02:46:29 +00:00
Document supervisor's new /auth/list endpoint (#2085)
Co-authored-by: Stefan Agner <stefan@agner.ch> Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
parent
52e2213c0f
commit
9dbcd03e4c
@ -750,6 +750,18 @@ Reset internal authentication cache, this is useful if you have changed the pass
|
||||
|
||||
</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
|
||||
|
||||
<ApiEndpoint path="/backups" method="get">
|
||||
|
@ -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) |
|
||||
| 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
|
||||
|
||||
| key | type | description |
|
||||
|
Loading…
x
Reference in New Issue
Block a user