From 9dbcd03e4cecfa64a2c6afb6fac7bab69e29c326 Mon Sep 17 00:00:00 2001 From: Mike Degatano Date: Sat, 8 Jun 2024 05:21:28 -0400 Subject: [PATCH] Document supervisor's new /auth/list endpoint (#2085) Co-authored-by: Stefan Agner Co-authored-by: Franck Nijhof --- docs/api/supervisor/endpoints.md | 12 ++++++++++++ docs/api/supervisor/models.md | 11 +++++++++++ 2 files changed, 23 insertions(+) diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index 6d79db52..64efc590 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -750,6 +750,18 @@ Reset internal authentication cache, this is useful if you have changed the pass + + +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). | + + + ### Backup diff --git a/docs/api/supervisor/models.md b/docs/api/supervisor/models.md index 3f919079..97c46c2a 100644 --- a/docs/api/supervisor/models.md +++ b/docs/api/supervisor/models.md @@ -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 |