Microsoft OneDrive
This integration allows you to use Microsoft OneDrive
Backups will be created in a folder called Home Assistant\backups_<id> in the App Folder of your OneDrive.
id is part of your Home Assistant instance’s unique id to allow backups from multiple instances to the same OneDrive account.
The integration only has access to an application specific Home Assistant folder in the App Folder and cannot access any other parts of your OneDrive.
Because of an issue in Microsoft’s APIs, the application-specific folder is often called Graph instead of Home Assistant. More on that below.
Configuration
To add the Microsoft OneDrive service to your Home Assistant instance, use this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the bottom right corner, select the
Add Integration button. -
From the list, select Microsoft OneDrive.
-
Follow the instructions on screen to complete the setup.
Requested permissions by the integration
The integration will request the following permissions on your OneDrive for the integration to work:
-
Files.ReadWrite.AppFolder: Grants the application permission to read and write in its own, app-specific folder inside your OneDrive -
offline_access: Grants the application permission to refresh its authentication token without requiring your manual intervention -
openid: Grants the application permission to read basic information, e.g. if you have a OneDrive
Getting application credentials
This integration comes with a predefined set of application credentials through Home Assistant account linking.
Nobody will ever have access to your data except you, as the app does not have permission to do anything on its own. It only works with a signed-in user (it only has delegated not application permissions).
However, if you want to use your own credentials, follow this guide
You will need an Azure tenant with an active Azure subscription to create your own client credentials.
Make sure to configure the following settings on the app registration:
- Supported account types: Personal Microsoft accounts only
-
Redirect URI: Type:
Web, URL:https://my.home-assistant.io/redirect/oauth
If you set the integration up with the default credentials and switch to custom credentials later, your backup folder will change inside your OneDrive, and you will have to manually copy existing backups from the old folder to the new one.
Backup folder is called Graph
This integration uses Microsoft’s Graph API to communicate with your OneDrive. Because of an issueHome Assistant), but Graph instead.
There is no risk of different applications mixing in that Graph folder, if you already have such a Graph folder from a different application, the next folders will just be called Graph 1, Graph 2 and so on.
You should be able to manually rename the folder to something else, without the integration breaking.
Known limitations
- Only personal OneDrives are supported at the moment.
Removing the integration
This integration follows standard integration removal. No extra steps are required.
To remove an integration instance from Home Assistant
- Go to Settings > Devices & services and select the integration card.
- From the list of devices, select the integration instance you want to remove.
- Next to the entry, select the three-dot
menu. Then, select Delete.
Troubleshooting
Unknown error while adding the integration
Make sure that your OneDrive is not frozen. This can happen if you haven’t used it for a longer period of time, or went over your data quota.