Privileges within the API are managed using Roles represented by the Role class.
The Role class contains a number of predefined roles listed below.
Role |
Description |
Sub Roles |
Administrator |
A role which provides access to all administrative functionality |
User Manager, Portfolio Manager |
User Manager |
A role which provides access to user management |
|
Portfolio Manager |
A role which provides access to portfolio management |
Facility Manager |
Facility Manager |
A role which provides access to facility management |
Meter Manager |
Meter Manager |
A role which provides the ability to manage facility meters |
Writer, Remover, Reader, Modeler |
Modeler |
A role which allows the user to model meter components |
|
Impersonator |
A role which allows the user to impersonate another user at login |
|
WebsiteContentEditor |
A role with allows the user to edit website content |
|
Reader |
A role which allows the user to read existing items |
|
Editor |
A role which allows the user to edit |
|
Creator |
A role which allows the user to create |
|
Writer |
A role which allows the user to create and edit |
Creator, Editor |
Remover |
A role which allows the user to remove |
|
Users may have memberships to any number of Roles. Each membership is represented by the ManagingEnergy.Security.RoleMembership class shown below.
The RoleMembership class specifies the context in which the membership applies as well as the mode. Depending on how the mode set, the RoleMembership can either grant or deny the privileges defined by the associated Role.