About Managing Roles in Alexa for Residential

An Alexa 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 for Residential resources.

Alexa 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 for Residential organizational unit (A4R.Org) represents an Alexa 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 A4R.Org unit's child units (home communities), list, assign roles, and list assignments for roles.

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 for Residential APIs:

Home community administrator (A4R.HomeCommunityAdmin)

The Alexa for Residential home community unit (HomeCommunity) represents a home community under an Alexa for Residential organizational unit (A4R.Org) unit. The A4R.HomeCommunityAdmin user role is created for a HomeCommunity when the HomeCommunity is created. The A4R.HomeCommunityAdmin role can create, get, update, and delete HomeCommunity units, create, as well as role management for that home community, and create, list, and assign roles for the home community.

The home community administrator role has permission to call the following Alexa for Residential APIs:

Home administrator (A4R.HomeAdmin)

The home community administrator role has permission to call the following Alexa for Residential APIs:

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 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.