Installation and Configuration

Installation

  1. Ensure you have followed the prerequisites instructions
    • Ensure you have a copy of the Client ID and the Client Secret Value (not the ID)
  2. Optionally you can set up the permissions, alternatively you will be requested to approve permissions when you authenticate to MS 365.
  3. Install this integration:
    • Recommended - see below, or
    • Manually - Copy these files to custom_components/ms365_teams/.
  4. Restart your Home Assistant instance to enable the integration
  5. Add the integration via the Devices & Services dialogue. Follow the instructions in the install process (or see Authentication) to establish the link between this integration and the Entra ID App Registration
    • A persistent token will be created in the hidden directory config/ms365_storage/.MS365-token-cache

Note If your installation does not complete authentication, or the sensors are not created, please go back and ensure you have accurately followed the steps detailed, also look in the logs to see if there are any errors. You can also look at the errors page for some other possibilities.

Note To configure a second account, add the integration again via the Devices & Services dialogue.

HACS

  1. Launch HACS
  2. Navigate to the Integrations section
  3. Add this repository as a Custom Repository (Integration) via the menu at top right.
  4. Search for “Microsoft 365 To Do”
  5. Select “Install this repository”
  6. Restart Home Assistant

Configuration variables

Key Type Required Description
account_name string True Uniquely identifying name for the account. Entity names will be suffixed with this. Do not use email address or spaces.
client_id string True Client ID from your Entra ID App Registration.
client_secret string True Client Secret from your Entra ID App Registration.
alt_auth_method boolean False If False (default), authentication is not dependent on internet access to your HA instance. See Authentication
chat_enable string False Disabled, Read, Update - Enable or disable chat sensor
status_enable string False Disabled, Read, Update - Enable or disable status sensor
alternate_email string False Email address to monitor status for. status_enable must be Read

Options variables

There are no options for the integration.