home-assistant/core · error · ConfigEntryAuthFailed

coordinator_auth_error

coordinator_auth_error

Error message

Authentication failed for BSB-LAN device

What it means

Raised by the bsblan coordinator when any state fetch in the update raises BSBLANAuthError. It becomes ConfigEntryAuthFailed with translation key `coordinator_auth_error`, which immediately moves the config entry to SETUP_ERROR/re-auth and halts further coordinator updates until credentials are fixed. This is the runtime counterpart of the setup-time auth error.

Source

Thrown at homeassistant/components/bsblan/coordinator.py:135

                try:
                    states[circuit] = await self.client.state(
                        include=STATE_INCLUDE, circuit=circuit
                    )
                except BSBLANAuthError, BSBLANConnectionError:
                    raise
                except BSBLANError as err:
                    raise UpdateFailed(
                        translation_domain=DOMAIN,
                        translation_key="coordinator_state_error",
                        translation_placeholders={
                            "host": host,
                            "circuit": str(circuit),
                        },
                    ) from err
            sensor = await self.client.sensor(include=SENSOR_INCLUDE)

        except BSBLANAuthError as err:
            raise ConfigEntryAuthFailed(
                translation_domain=DOMAIN,
                translation_key="coordinator_auth_error",
            ) from err
        except BSBLANConnectionError as err:
            raise UpdateFailed(
                translation_domain=DOMAIN,
                translation_key="coordinator_connection_error",
                translation_placeholders={"host": host},
            ) from err

        # Fetch DHW state separately - device may not support hot water
        dhw: HotWaterState | None = None
        try:
            dhw = await self.client.hot_water_state(include=DHW_STATE_INCLUDE)
        except BSBLANError:
            # Preserve last known DHW state if available (entity may depend on it)
            if self.data:
                dhw = self.data.dhw

View on GitHub (pinned to 58a3fdb3ea)

Solutions

1. Click re-configure/re-authenticate on the bsblan integration card and enter the new credentials.
2. Confirm the credentials work in a browser against the device's web UI.
3. After re-auth, reload the entry so the coordinator resumes scheduled updates.

When it happens

Trigger: A periodic coordinator refresh after the user changed the BSB-LAN web password, credentials were revoked, or auth settings changed on the device — the first state/sensor call then returns 401/403 and BSBLANAuthError propagates out of the inner try (it is explicitly re-raised by `except BSBLANAuthError, BSBLANConnectionError: raise`).

Common situations: Password rotation on the device without updating HA; token/session invalidation after firmware update; shared credentials changed by another user.

Understand the failure class

• Authentication and authorization failures — expired tokens, bad credentials, and missing scopes.

Related errors

• ConfigEntryAuthFailed
• Unable to deactivate the owner
• Authentication failed, please reauthenticate.
• api_authentication_error
• invalid_api_key

AI-assisted analysis of home-assistant/core@58a3fdb3ea (2026-08-14). Data as JSON: /api/errors/cafdb1813b46637b. Report an issue: GitHub.