Add basic user info API

homeassistant/components/api/__init__.py

@@ -35,6 +35,7 @@
     URL_API_STATES,
     URL_API_STREAM,
     URL_API_TEMPLATE,
+    URL_API_USER,
 )
 import homeassistant.core as ha
 from homeassistant.core import Event, EventStateChangedData, HomeAssistant
@@ -74,6 +75,7 @@
 async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
     """Register the API with the HTTP interface."""
     hass.http.register_view(APIStatusView)
+    hass.http.register_view(APIUserView)
     hass.http.register_view(APICoreStateView)
     hass.http.register_view(APIEventStream)
     hass.http.register_view(APIConfigView)
@@ -104,6 +106,26 @@ def get(self, request: web.Request) -> web.Response:
         return self.json_message("API running.")
 
 
+class APIUserView(HomeAssistantView):
+    """View to handle User requests."""
+
+    url = URL_API_USER
+    name = "api:user"
+
+    @ha.callback
+    def get(self, request: web.Request) -> web.Response:
+        """Retrieve user's info."""
+        user: User = request[KEY_HASS_USER]
+        return self.json(
+            {
+                "id": user.id,
+                "username": user.credentials[0].data["username"],
+                "name": user.name,
+                "is_admin": user.is_admin,
+            }
+        )
+
+
 class APICoreStateView(HomeAssistantView):
     """View to handle core state requests."""
 

homeassistant/const.py

@@ -1552,6 +1552,7 @@ class UnitOfDataRate(StrEnum):
 
 URL_ROOT: Final = "/"
 URL_API: Final = "/api/"
+URL_API_USER: Final = "/api/user"
 URL_API_STREAM: Final = "/api/stream"
 URL_API_CORE_STATE: Final = "/api/core/state"
 URL_API_CONFIG: Final = "/api/config"

tests/components/api/test_init.py

@@ -635,6 +635,19 @@ async def test_event_stream_requires_admin(
     assert resp.status == HTTPStatus.UNAUTHORIZED
 
 
+async def test_api_user(
+    hass: HomeAssistant, mock_api_client: TestClient, hass_admin_user: MockUser
+) -> None:
+    """Test getting user information."""
+    resp = await mock_api_client.get("/api/user")
+    assert resp.status == HTTPStatus.OK
+    json = await resp.json()
+    assert json["id"] == hass_admin_user.id
+    assert json["username"] == hass_admin_user.credentials[0].data["username"]
+    assert json["name"] == hass_admin_user.name
+    assert json["is_admin"]
+
+
 async def test_states(
     hass: HomeAssistant, mock_api_client: TestClient, hass_admin_user: MockUser
 ) -> None: