Cloud API Scopes

Bosch smart home API has a scope based access control concept. As a partner you can request one or more of the following API scopes. Being granted a certain list of scopes means that you have the rights to perform the corresponding operations using the smart home API. For more information on how to request scopes, see partner onboarding process.

System Solution

Scope Name	Technical ID	Description
Monitor room climate	cc_monitor	Permission to query the status of the room climate
Control room climate	cc_control	Permission to control the room climate
Monitor door/window contact	contactsensor_monitor	Permission to query the status of door/window contacts
Monitor alarm system	intrusiondetectionsystem_monitor	Permission to query the status of the alarm system
Control alarm system	intrusiondetectionsystem_control	Permission to control the alarm system
Arm alarm system	intrusiondetectionsystem_arm	Permission to switch on the alarm system
Monitor intrusion alarm	intrusionalarm_monitor	Permission to query the status of alarm sirens
Monitor light switch	lightswitch_monitor	Permission to query the status of light controls
Control light switch	lightswitch_control	Permission to control light controls
Monitor motion detector	motiondetector_monitor	Permission to query the status of the motion detectors
Control radiator thermostat	radiatorthermostat_control	Permission to control radiator thermostats
Monitor radiator thermostat	radiatorthermostat_monitor	Permission to retrieve information regarding radiator thermostats
Monitor dimmer	dimmer_monitor	Permission to query the status of dimmer
Control dimmer	dimmer_control	Permission to control dimmer
Monitor relay	relay_monitor	Permission to query the status of relay
Control relay	relay_control	Permission to control relays
Monitor room	room_monitor	Permission to retrieve information regarding rooms
Monitor room thermostat	roomthermostat_monitor	Permission to retrieve information regarding room thermostats
Monitor scenario	scenario_monitor	Permission to retrieve information regarding scenarios
Control scenario	scenario_control	Permission to control scenarios
Monitor smart home controller	shc_monitor	Permission to query data of the Smart Home Controller
Monitor shutter	shutter_monitor	Permission to query the status of the shutter controls
Control shutter	shutter_control	Permission to control shutter controls
Monitor smart plug	smartplug_monitor	Permission to query the status of plugs
Control smart plug	smartplug_control	Permission to control plugs
Monitor smoke detection system	smokedetectionsystem_monitor	Permission to query the status of the smoke alarm
Control smoke detection system	smokedetectionsystem_control	Permission to control the smoke alarm
Monitor water leakage detection system	waterleakagedetectionsystem_monitor	Permission to query the status of the water alarm
Control water leakage detection system	waterleakagedetectionsystem_control	Permission to control the water alarm

Camera Solution

Scope Name	Technical ID	Description
Monitor camera	camera_monitor	Permission to query data and clips of the Smart Home cameras
Control camera	camera_control	Permission to switch on and configure Smart Home cameras
Switch on camera privacy mode	camera_privacy_on	Permission to activate the privacy mode
Monitor camera stream	camera_stream_monitor	Permission to access the live streams of cameras
Control camera events	camera_events_control	Permission to manage the saved events
Control camera lights	camera_lights_control	Permission to control the lamps of the Smart Home cameras

Combined

Scope Name	Technical ID	Description
Monitor system solution	system_monitor	Permission to query the status of your Bosch Smart Home System
Control system solution	system_control	Permission to control your Bosch Smart Home System
Monitor full camera state	camera_monitor_full	Permission to access the streams, events and data of the cameras
Control full camera state	camera_control_full	Permission to control Smart Home cameras
Domain comfort	domain_comfort	Permission to query data and to control devices and services of the domain Comfort
Monitor bosch smart home	sh_monitor	Permission to query the status of your Bosch Smart Home System and cameras
Control bosch smart home	sh_control	Permission to control your Bosch Smart Home System and your cameras