Manage Properties and Rooms in Alexa Smart Properties

Your Alexa Smart Properties administrator users perform several important property management tasks, such as managing units within the property, including the property itself and rooms under it. Use the Role API and the Property Hierarchy Management API to develop tools to enable your users to perform these tasks at scale.

Example: How different roles create and manage properties and rooms

The following example shows how the different types of Alexa Smart Properties administrator roles described in About Managing Roles in Alexa Smart Properties work together to create and manage properties and rooms.

In this example, there are two hypothetical administrators, Ana Carolina Silva and John Doe, who work for a property management company.

Step 1: Register and assign roles

Ana registers her organization with Alexa Smart Properties.

  • An Alexa Smart Properties organizational unit is created. Ana is assigned as A4H.OrgAdmin and receives an Alexa Smart Properties organization (amzn1.alexa.unit.did.{id}) identifier to use when calling Alexa Management APIs.
  • Ana can now create child units (Properties) under the Organization unit. She cannot create the child units (Rooms) under the property (L1 unit) until she enables a subscription for the Property.

Step 2: Create a level-one unit (i.e., a property)

Ana creates a unit - Property A - under the organizational unit. This is referred to as a level-one (L1) unit i.e. direct child unit of organization. We refer to this level-one unit as property in the rest of the documentation.

  • As creator of the property A, Ana is asynchronously assigned the A4P.UnitAdmin role for this property within several seconds of unit creation.
  • Ana can create, update, or delete property A, create more units in property A, and manage property A's resources.

Step 3: Create a level-two unit (e.g., a room)

Ana creates a unit under the property created in step above and names it Room 100.

  • As the creator of the unit, Ana is asynchronously assigned the A4P.UnitAdmin role for Room 100 within seconds of unit creation.
  • Ana can manage room 100 and its resources.

Step 4: Assign the unit administrator role

Ana creates property B. Ana lists user roles for property B.

  • Ana assigns John to the A4P.UnitAdmin role for property B.
  • John can manage property B and its resources.
  • John can't manage property A and its resources.

You successfully implemented the tasks that your administrator users must perform to manage units in your organization. Next, see Alexa Smart Properties Device Purchase and Setup to learn how to set up devices and manage them as endpoints.

Was this page helpful?

Last updated: Nov 28, 2023