Authentication Providers


When you log in, an auth provider checks your credentials to make sure you are an authorized user.

The authentication system has been changed recently. Previously there was a single “API password” to log in, but you can now choose from several auth providers.

To make the transition from API passwords easier, we’ve added a Legacy API Password auth provider. This is enabled by default if you have an API password configured so you will still be able to log in. However, this feature is deprecated and will be removed in a future release so you should set up one of the newer authentication techniques.

Configuring auth providers

Home Assistant automatically configures the standard auth providers so you don’t need to specify auth_providers in your configuration.yaml file unless you are configuring more than one. Specifying auth_providers will disable all auth providers that are not listed, so you could reduce your security or create difficulties logging in if it is not configured correctly.

Authentication providers are configured in your configuration.yaml under the homeassistant: block. You can supply more than one, for example:

homeassistant:
  auth_providers:
    - type: homeassistant
    - type: legacy_api_password

Available auth providers

Home Assistant auth provider

This is the default auth provider. The first user created is designated as the owner and can create other users.

User details are stored in the [your config]/.storage directory. All passwords are stored hashed and with a salt, making it almost impossible for an attacker to figure out the password even if they have access to the file.

Users can be managed in Home Assistant by the owner. Go to the configuration panel and click on Users.

This is the entry in configuration.yaml for Home Assistant auth:

homeassistant:
  auth_providers:
    - type: homeassistant

If you don’t specify any auth_providers section in the configuration.yaml file then this provider will be set up automatically.

Trusted Networks

The Trusted Networks auth provider defines a range of IP addresses for which no authentication will be required (also known as “whitelisting”). For example, you can whitelist your local network so you won’t be prompted for a password if you access Home Assistant from inside your home.

When you log in from one of these networks, you will be asked which user account to use and won’t need to enter a password.

The multi-factor authentication module will not participate in the login process if you are using this auth provider.

Here is an example in configuration.yaml to set up Trusted Networks:

homeassistant:
  auth_providers:
    - type: trusted_networks
      trusted_networks:
        - 192.168.0.0/24
        - fd00::/8

Configuration Variables

trusted_networks

(list of string)(Required)A list of IP address or IP network you want to whitelisted. It accepts both IPv4 and IPv6 IP address or network

trusted_users

(dictionary | string as key | list of string as value)(Optional)You can also assign which users are available to select when user access login page from certain IP address or network.

allow_bypass_login

(boolean)(Optional)You can bypass login page if you have only one user available for selection.

Default value: false

Trusted Users Examples

homeassistant:
  auth_providers:
    - type: trusted_networks
      trusted_networks:
        - 192.168.0.0/24
        - 192.168.10.0/24
        - fd00::/8
      trusted_users:
        192.168.0.1: user1_id
        192.168.0.0/24:
          - user1_id
          - user2_id
        "fd00::/8":
          - user1_id
          - group: system-users

First note, trusted_users configuration need you use user id, you can find it through Configuration -> Users -> View User Detail. The trusted_users configuration will not validate the existing of the user, so please make sure you have put in correct user id by yourself.

Second note, a trusted user with an IPv6 address must put the IPv6 address in quotes as shown.

In above example, if user try to access Home Assistant from 192.168.0.1, they will have only one user available to choose. They will have two users available if access from 192.168.0.38 (from 192.168.0.0/24 network). If they access from 192.168.10.0/24 network, they can choose from all available users (non-system and active users).

Specially, you can use group: GROUP_ID to assign all users in certain user group to be available to choose. Group and users can be mix and match.

Skip Login Page Examples

This is a feature to allow you bring back some of the experience before the user system be implemented. You can directly jump to main page if you are accessing from trusted networks, the allow_bypass_login is on, and you have ONLY ONE available user to choose in the login form.

# assuming you have only one non-system user
homeassistant:
  auth_providers:
    - type: trusted_networks
      trusted_networks:
        - 192.168.0.0/24
        - 127.0.0.1
        - ::1
      allow_bypass_login: true
    - type: homeassistant

Assuming you have only the owner created though onboarding process, no other users ever created. The above example configuration will allow you directly access Home Assistant main page if you access from your internal network (192.168.0.0/24) or from localhost (127.0.0.1). You will get a login abort error, then you can change to use HomeAsssitant Authentication Provider to login, if you access your Home Assistant instance from outside network.

Command Line

The Command Line auth provider executes a configurable shell command to perform user authentication. Two environment variables, username and password, are passed to the command. Access is granted when the command exits successfully (with exit code 0).

This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is this one, for instance.

Here is a configuration example:

homeassistant:
  auth_providers:
    - type: command_line
      command: /absolute/path/to/command
      # Optionally, define a list of arguments to pass to the command.
      #args: ["--first", "--second"]
      # Uncomment to enable parsing of meta variables (see below).
      #meta: true

When meta: true is set in the auth provider’s configuration, your command can write some variables to standard output to populate the user account created in Home Assistant with additional data. These variables have to be printed in the form:

name = John Doe

Leading and trailing whitespace, as well as lines starting with # are ignored. The following variables are supported. More may be added in the future.

  • name: The real name of the user to be displayed in their profile.

Stderr is not read at all and just passed through to that of the Home Assistant process, hence you can use it for status messages or suchlike.

Any leading and trailing whitespace is stripped from usernames before they’re passed to the configured command. For instance, “ hello “ will be rewritten to just “hello”.

For now, meta variables are only respected the first time a particular user is authenticated. Upon subsequent authentications of the same user, the previously created user object with the old values is reused.

Legacy API password

This is a legacy feature for backwards compatibility and will be dropped in a future release. You should move to one of the other auth providers.

Activating this auth provider will allow you to authenticate with the API password set in the HTTP component.

homeassistant:
  auth_providers:
   - type: legacy_api_password
     api_password: !secret http_password

api_password is required option since 0.90 release.

Activating this auth provider will also allow you to provide the API password using an authentication header to make requests against the Home Assistant API. This feature will be dropped in the future in favor of long-lived access tokens.

If you don’t specify any auth_providers section in the configuration.yaml file then this provider will be set up automatically if api_password was configured under http section.

Issue 16441: the legacy API password auth provider, won’t be automatically configured if your API password is located in a package. This is because Home Assistant processes the auth_provider during the core section loading, which is earlier than the packages processing.