[Index]

Model: data/Role

Role Management

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

Provider administrators can manage the roles that are available for administrators, operators, and users at lower levels in the hierarchy.

Note

You cannot change your own role.

Edit a role

To edit an existing role:

  1. Log in as provider administrator.
  2. Go to the Role Management page.
  3. Locate the role you want to change; then, click on the role to open it.
  4. Update the role settings, as required.
  5. Save your changes.

Note

If hierarchy node types are removed from the Hierarchies Allowed list while users or Site Defaults reference this node type, then the update cannot be saved. The transaction Message shows:

"Cannot update Role. Some User(s) or Site Defaults exist with the hierarchy rules defined in this role."

Add a role

To add a new role:

  1. Log in as provider administrator.

  2. Go to the Role Management.

  3. Click Add.

  4. Fill out details and hierarchy rules for the role:

    Setting Description
    Name Mandatory. The name of the role.
    Description Description of the role.
    Access Profiles Mandatory. Specifies permissions for resources.
    Menu Layout Mandatory. Controls navigation and available actions.
    Dashboard Mandatory. Defines the landing page and widgets shown after login.
    Interface Indicates whether the role applies to the Administration or Self-service interface.
    Theme Controls the visual appearance of the interface.
    Self Service Links Provide useful links to Self-service end users.
    Permitted Hierarchy Types

    Hierarchy rules define the hierarchies where this role can be assigned.

    Where a user is at a specific hierarchy, available roles will then include all roles that include that specific hierarchy in the Hierarchies Allowed list.

    Refer to the Hierarchies Allowed List Impact below.

    When the role is saved, the selected Hierarchy Type is added to the Hierarchies Allowed list if it is not included.

  5. Click Save to add the role.

Hierarchies Allowed List Impact

The following areas in the system are impacted by list entries available in the Hierarchies Allowed List of a role:

Microsoft-only role

Starting with version 21.3-PB1, Automate ships with a Microsoft-only role (MicrosoftOnlyRole) and accompanying role-based access control elements, which are predefined for a Microsoft-only user interface experience. These elements include predefined field display policies, dashboards (MicrosoftOnlyDashboard), and menus (MicrosoftOnlyMenu). Installing these templates provides the baseline for a Microsoft-only version of Automate, and hides non-Microsoft GUI elements, such as the FDPs, menus, and dashboards reflecting functionality used for managing Cisco devices.

To use the MicrosoftOnlyRole in Automate:

  1. Log in to Automate as hscadmin.

  2. Go to the Roles page.

  3. Locate MicrosoftOnlyRole in the list view.

  4. Select the role in the list (or click on the role to open it).

    Note

    This role ships with a standard access profile and a predefined menu layout and dashboard.

  5. Click Export to export the role to a JSON file, and save the file to your local computer.

  6. Edit the JSON file to specify the hierarchy where you want to use the role.

  7. Go to the Import page.

  8. Browse to the location you saved the JSON file, then click Import.

  9. Go to the Role Management list view to verify that the role now exists also at the hierarchy you specified.

  10. At the hierarchy where you wish to assign the role to a user (Provider or Customer), go to the Admins page. Choose a user (or add a user), then on the User Details tab, from the Role field, choose the role (MicrosoftOnlyRole) you imported to this level, and save your change.

A User Role is a combination of Configuration Templates and Field Display Policies that apply to all the Data-, Device- and Domain Models available in the system. When a User Role is created, a Configuration Template and Field Display Policy can be selected as defaults that apply to each available model. The User Role can also be associated with a Menu Layout, Theme and an Access Profile that specifies create, read, update and delete permissions on each model. When a user is created or updated, a User Role can be selected for the user. This means that the user will by default have the menu, relevant permissions, Configuration Template defaults and settings as well as Field Display Policy views applied when using the relevant model. More than one user can have the same User Role assigned. User Roles provide a means to manage users that are logged in on the system.

Model Details: data/Role

Title Description Details
Name * The name that is given to the Role.
  • Field Name: name
  • Type: String
Description A description for the Role.
  • Field Name: description
  • Type: String
Interface * The selected Interface that is associated with the Role. The interface can be an Administration or Self Service.
  • Field Name: interface
  • Type: String
  • Choices: ["Administration", "Self Service", "None"]
Access Profile * The selected Access Profile that is associated with the Role.
  • Field Name: access_profile
  • Type: String
  • Target: data/AccessProfile
  • Target attr: name
  • Format: uri
Menu Layout The selected Menu Layout that is associated with the Role.
  • Field Name: menu_layout
  • Type: String
  • Target: data/MenuLayout
  • Target attr: name
  • Format: uri
Dashboard The selected Dashboard that is associated with the Role.
  • Field Name: dashboard
  • Type: String
  • Target: data/Dashboard
  • Target attr: name
  • Format: uri
Theme The selected Theme that is associated with the Role.
  • Field Name: theme
  • Type: String
  • Target: data/Theme
  • Target attr: name
  • Format: uri
Landing Page Landing page for user
  • Field Name: landing_page
  • Type: String
  • Target: data/LandingPage
  • Target attr: name
  • Format: uri
Self Service Links Provide useful links to Self Service end users
  • Field Name: selfservice_links
  • Type: String
  • Target: data/SelfServiceLinks
  • Target attr: name
  • Format: uri
Self Service Feature Display Policy Self Service Feature Display Policy
  • Field Name: ss_display_policy
  • Type: String
  • Target: data/SelfServiceFeatureDisplayPolicy
  • Target attr: name
  • Format: uri
Rules
  • Field Name: rules
  • Type: Object
Permitted Hierarchy Types Hierarchy Types that this Role can be added under. If no hierarchy types are specified, the role can be added under any non-sys hierarchy type.
  • Field Name: hierarchy_types.[n]
  • Type: Array
  • Cardinality: [1..n]