Authorization Scopes

For all requests on the Home Connect API at least the scope IdentifyAppliance is required.

Furthermore, you can select a set of rows, columns or cells from the following matrix. If you choose a row all cells of this row are included. If you choose, for instance, Dishwasher, then you also get Dishwasher-Monitor, Dishwasher-Control and Dishwasher-Settings. The same inclusion applies to columns.

Note that you should always choose the minimum required set of scopes which is required by your application. This increases the acceptance by your customers.

  Monitor Control Images Settings
Oven Oven-Monitor Oven-Control - Oven-Settings
Dishwasher Dishwasher-Monitor Dishwasher-Control - Dishwasher-Settings
Washer Washer-Monitor Washer-Control - Washer-Settings
Dryer Dryer-Monitor Dryer-Control - Dryer-Settings
FridgeFreezer FridgeFreezer-Monitor FridgeFreezer-Control FridgeFreezer-Images FridgeFreezer-Settings
CoffeeMaker CoffeeMaker-Monitor CoffeeMaker-Control - CoffeeMaker-Settings
Hob Hob-Monitor Hob-Control - Hob-Settings
Hood Hood-Monitor Hood-Control - Hood-Settings

 

All available scopes are listed in the following:

Name Description Additional Partner
Agreement required
IdentifyAppliance Grants right to identify a home appliance under /api/homeappliances  
*-Monitor Grants access to read resources under /api/homeappliances except images and settings for the given home appliance type  
*-Control Grants access to modify resources under under /api/homeappliances except images and settings for the given home appliance type
(in case of Oven-Control, FridgeFreezer-Control and Hob-Control)
*-Images Grants access to read resources under /api/homeappliances/{haid}/images for the given home appliance type
*-Settings Grants access to read and modify resources under /api/homeappliances/{haid}/settings for the given home appliance type  
Monitor Grants access to read resources under /api/homeappliances except images and settings  
Control Grants access to modify resources under under /api/homeappliances except images and settings
Images Grants access to read resources under /api/homeappliances/{haid}/images
Settings Grants access to read and modify resources under /api/homeappliances/{haid}/settings  
Oven Grants access to read or modify all resources under /api/homeappliances on ovens
Dishwasher Grants access to read or modify all resources under /api/homeappliances on dishwashers  
Washer Grants access to read or modify all resources under /api/homeappliances on washers  
Dryer Grants access to read or modify all resources under /api/homeappliances on dryers  
FridgeFreezer Grants access to read or modify all resources under /api/homeappliances on fridge freezers
CoffeeMaker Grants access to read or modify all resources under /api/homeappliances on coffee machines  
Hob Grants access to read or modify all resources under /api/homeappliances on cooktops
Hood Grants access to read or modify all resources under /api/homeappliances on hoods