ha-options-flow

Home Assistant — Options Flow and Reauth

OptionsFlow Template

Options flow lets users adjust integration settings after initial setup (scan interval, feature toggles, etc.).

from typing import Any

from homeassistant.config_entries import ConfigEntry, ConfigFlowResult, OptionsFlow
import voluptuous as vol


class {Name}OptionsFlow(OptionsFlow):
    """Handle options."""

    # NOTE: Do NOT use __init__ to store config_entry - deprecated since 2024.12,
    # removed in 2025.12. Access via self.config_entry (automatically set by HA)

    async def async_step_init(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        if user_input is not None:
            return self.async_create_entry(title="", data=user_input)

        return self.async_show_form(
            step_id="init",
            data_schema=vol.Schema({
                vol.Optional(
                    "scan_interval",
                    default=self.config_entry.options.get("scan_interval", 30),
                ): vol.All(vol.Coerce(int), vol.Range(min=10, max=300)),
            }),
        )

Wire it to the config flow class with async_get_options_flow:

from homeassistant.core import callback

class {Name}ConfigFlow(ConfigFlow, domain=DOMAIN):
    ...
    @staticmethod
    @callback
    def async_get_options_flow(config_entry: ConfigEntry) -> OptionsFlow:
        return {Name}OptionsFlow()

strings.json — Options Section

{
	"options": {
		"step": {
			"init": {
				"title": "Settings",
				"data": { "scan_interval": "Update interval (seconds)" },
				"data_description": {
					"scan_interval": "How often to poll the device (10-300 seconds)"
				}
			}
		}
	}
}

Reauth Flow

Reauth handles expired credentials without removing the integration. Add to the ConfigFlow class (not OptionsFlow):

Assumes _async_validate_input, CannotConnect, and InvalidAuth from ha-config-flow are defined on the same ConfigFlow class.