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
WasherDryer WasherDryer-Monitor WasherDryer-Control - WasherDryer-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
CleaningRobot CleaningRobot-Monitor CleaningRobot-Control - CleaningRobot-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
  • /api/homeappliances/{haid}
 
*-Monitor Grants access to read resources for the given home appliance type under:
  • /api/homeappliances/{haid}/programs
  • /api/homeappliances/{haid}/status
  • /api/homeappliances/{haid}/events
  • /api/homeappliances/events
 
*-Control Grants access to modify resources for the given home appliance type under:
  • /api/homeappliances/{haid}/programs
  • /api/homeappliances/{haid}/commands

(in case of Oven-Control, FridgeFreezer-Control and Hob-Control)
*-Images Grants access to read resources for the given home appliance type under:
  • /api/homeappliances/{haid}/images
*-Settings Grants access to read and modify resources for the given home appliance type under:
  • /api/homeappliances/{haid}/settings
 
Monitor Grants access to read resources for all home appliance types under:
  • /api/homeappliances/{haid}/programs
  • /api/homeappliances/{haid}/status
  • /api/homeappliances/{haid}/events
  • /api/homeappliances/events
 
Control Grants access to modify resources for all home appliance types under:
  • /api/homeappliances/{haid}/programs
  • /api/homeappliances/{haid}/commands
Images Grants access to read resources for all home appliance types under:
  • /api/homeappliances/{haid}/images
Settings Grants access to read and modify resources for all home appliance types under:
  • /api/homeappliances/{haid}/settings
 
Oven Grants access to read or modify all resources on ovens under:
  • /api/homeappliances/*
Dishwasher Grants access to read or modify all resources on dishwashers under:
  • /api/homeappliances/*
 
Washer Grants access to read or modify all resources on washers under:
  • /api/homeappliances/*
 
Dryer Grants access to read or modify all resources on dryers under:
  • /api/homeappliances/*
 
WasherDryer Grants access to read or modify all resources on washer dryers under:
  • /api/homeappliances/*
 
FridgeFreezer Grants access to read or modify all resources on fridge freezers under:
  • /api/homeappliances/*
CoffeeMaker Grants access to read or modify all resources on coffee machines under:
  • /api/homeappliances/*
 
Hob Grants access to read or modify all resources on cooktops under:
  • /api/homeappliances/*
Hood Grants access to read or modify all resources on hoods under:
  • /api/homeappliances/*
 
CleaningRobot Grants access to read or modify all resources on cleaning robots under:
  • /api/homeappliances/*