.. _user_roles:

User Roles
-----------

.. _21.3|VOSS-1072|EKB-12791:
.. _21.3-PB3|EKB-13696:


VOSS Automate ships with a powerful role-based access framework that ties a user role to
menu layouts, access profiles, landing pages, and themes. 

.. note:: 
   
   The system comes with a default set of roles, menu layouts, access profiles, landing pages, and themes.

Default roles:  

* HCS Admin
* Provider
* Reseller
* Customer
* Site
* User
* MicrosoftOnlyRole (for a Microsoft-only scenario)
* MvsEnhancedCustomerAdministrator and MvsEnhancedProviderAdministrator (for multi-vendor scenarios)
  

A user role in the system combines the look and feel of the system interface
with a number of default permissions and values. 

Each user role is a combination of:

.. tabularcolumns:: |p{5cm}|p{10cm}|

+----------------+--------------------------------------------------------------------------------------+
| Component      | Description                                                                          |
+================+======================================================================================+
| Landing page   | The content of the first page you see when logging in, including links on the page.  |
+----------------+--------------------------------------------------------------------------------------+
| Menu layout    | The menu layout associated with a user role defines the available menu, and where    |
|                | relevant, may also include the configuration templates and the field display         |
|                | policies (FDP) that apply to the resources that the menu links to.                   |
+----------------+--------------------------------------------------------------------------------------+
| Theme          | The appearance of the user interface can be associated with a role.                  |
+----------------+--------------------------------------------------------------------------------------+
| Access profile | Permissions for resources are defined in Access Profiles. An Access Profile can      |
|                | be associated with a user role.                                                      |
+----------------+--------------------------------------------------------------------------------------+
| Interface      | Defines the application interface the role definition applies to. Roles support      |
|                | the Administration interface and the Self Service interface.                         | 
+----------------+--------------------------------------------------------------------------------------+


When creating or updating a user, you can select their role. The user will then have a 
landing page, menu, theme, and interface defined for their user role. For example, 
the Configuration Template defaults and settings as well as Field Display Policy views of the menu
associated with the role apply.

A user role may be assigned to more than one users. The user hierarchy and role
serve as components of role-based access control in the system.

A number of default user roles are provided. Each user role has a predefined landing page, 
menu layout and access profile. Each of these elements, including theme, can be customized. 

.. note::
   Users cannot modify their own user role or the associated Access Profile, Menu
   Layout, Landing Page or any of the Configuration Templates or Field Display 
   Policies associated with the role.

A role may be associated with a specific hierarchy. For example, the Site Admin role can only be assigned to a 
user at the Site hierarchy level. 


.. rubric:: Related Topics 


* 
    .. raw:: latex
  
       Add and Edit Roles in the Core Feature Guide
  
    .. raw:: html
    
       <a href="role-management.html">Add and Edit Roles</a>

* 
    .. raw:: latex
  
       Role-based Access in the Core Feature Guide
  
    .. raw:: html
    
       <a href="concepts-role-based-access.html">Role-based Access</a>
  

* :ref:`concepts-role-based-access-for-multi-vendor-subscriber` and :ref:`multi-vendor-subscribers`


.. |VOSS Automate| replace:: VOSS Automate
.. |Unified CM| replace:: Unified CM