About Managing Roles in Alexa Smart Properties for Residential

---

An Alexa Smart Properties for residential user's role defines the operations that the user is allowed to perform on organizational units, home communities, and homes. Each user must be assigned a role before they can access any Alexa Smart Properties for residential resources.

Alexa Smart Properties for residential defines the following roles: A4R.OrgAdmin, A4R.HomeCommunityAdmin, and A4R.HomeAdmin.

The following table shows the organizational hierarchy entity and permissions for each role.

User role	Organization hierarchy entity	Permissions
A4R.OrgAdmin	organizational unit	A4R organization hierarchy management APIs for organizational unit Role management APIs for organizational unit
A4R.HomeCommunityAdmin	home community	A4R organization hierarchy management APIs for home community Role management APIs for home community
A4R.HomeAdmin	home	All management APIs for home (including skills and endpoints)

Organization administrator (A4R.OrgAdmin)

The Alexa Smart Properties for residential organizational unit (A4R.Org) represents an Alexa Smart Properties for residential organization under an Alexa organization. An A4R.OrgAdmin user role template is created for the A4R.Org unit type at the time of creation. The A4R.OrgAdmin role can create, get, update, and delete the organization's home communities. It can also manage role assignments.

The organization administrator role owns the Amazon Business account. An organization can have one or more organization administrators.

The organization administrator role has permission to call the following Alexa Smart Properties for residential APIs:

• Create a home community – Create a new home community.
• Get a home community – Get home communities in the organization.
• Update a home community – Update a home community.
• Delete a home community – Delete a home community.
• List Roles for home community – List roles for a unit in the organization.
• Assign roles for home community – Assign roles for a home community.
• List Assignments for a role – List users assigned to a role.

Home community administrator (A4R.HomeCommunityAdmin)

The Alexa Smart Properties for residential home community represents a home community under an Alexa Smart Properties for residential organizational unit. The A4R.HomeCommunityAdmin user role is created for a home community when the home community is created. The A4R.HomeCommunityAdmin role can create, get, update, and delete home communities. It can create homes in the community. It can manage role assignments for the home community.

The home community administrator role has permission to call the following Alexa Smart Properties for residential APIs:

• Get a home community – Get home communities that the user can access.
• Update a home community – Update a home community that the user has access to.
• Delete a home community – Delete a home community that the user has access to.
• List roles for a home community – List roles for the home community.
• Update role assignments for a home community – Update role assignments for users within the home community.
• List assignments for a home community role – List users assigned to a role.
• Create a home – Create homes within the home community.

Home administrator (A4R.HomeAdmin)

The home administrator role has permission to call the following Alexa Smart Properties for residential APIs:

• Create a home – Create homes within the home community.
• Get a home – Get the metadata for a specific home.
• Update a home – Update the metadata for a specific home.
• Delete a home – Delete homes within the home community.
• Manage a home – Manage all settings, states, and experiences in a home.
  • Manage home occupancy – Change a home from vacant to occupied.
  • Manage skills – Enable, link, and disable skills in a home.
  • Manage endpoints – Manage Alexa-connected devices in the home.

Assign a role to a principal

To assign a role to a principal, you must assign it to them for each unit they need to have permission to.

To assign a role to a principal

1. To get the role ID for the administrator role associated with a unit, call the listRoles API.
2. To assign the role for the unit, call the assignRole API.

Now that you understand Alexa Smart Properties for residential administrator roles, see Managing Homes, Communities, and Skills to learn how the roles interact. The topic also explains how to implement the tasks that the roles need to perform so that they can manage homes, home communities, and skills.

Related topics

• About Alexa Smart Properties for Residential
• Get Started with Alexa Smart Properties for Residential APIs
• Managing Homes, Communities, and Skills
• Alexa Smart Properties for Residential Device Purchase and Setup

---

Last updated: Sep 10, 2022