Working with roles
Use these consolecli commands for to manipulate roles.
- ListRoles
- List all roles.
- AddRole --username dash_admin_username --password dash_admin_password --roleName role_name
- Add the specified role. Console users are granted access to resources
based on the role to which they have been assigned. All roles that
are created have a resource type of Custom.Note: Arguments to the role_name parameter should not include spaces.
- UpdateRole --username dash_admin_username --password dash_admin_password --roleName role_name --newRoleName new_role_name
- Change the name of a specified role to the supplied new role name.Note: Arguments to the role_name and newRoleName parameters should not include spaces.
- DelRole --username dash_admin_username --password dash_admin_password --roleName role_name
- Delete the specified role.Note: Arguments to the role_name parameter should not include spaces.
- ListRolesFromGroup --username dash_admin_username --password dash_admin_password --groupID group_ID
- List all roles associated with a specified user group.
- MapRolesToGroup --username dash_admin_username --password dash_admin_password --groupID group_ID --rolesList role_name1, role__name2
- Associate a comma separated list of roles with a particular user group.
- RemoveRolesFromGroup --username dash_admin_username --password dash_admin_password --groupID group_ID --rolesList role_name1, role__name2
- Disassociate a comma separated list of roles from a particular user group.
- ListRolesForPage --pageUniqueName page_unique_name
- List all roles associated with a specified page.
- MapRolesToPage --username dash_admin_username --password dash_admin_password --pageUniqueName page_unique_name --rolesList role_name1, role__name2 --accessLevelList level1, level2
- Associate a comma separated list of roles with a particular page and set the access level to the page for each role.
- RemoveRolesFromPage --username dash_admin_username --password dash_admin_password --pageUniqueName page_unique_name --rolesList role_name1, role__name2
- Disassociate a comma separated list of roles from a particular page.
- ListRolesForPortletEntity --portletEntityUniqueName portlet_entity_unique_name
- List all roles associated with a specified portlet.
- MapRolesToPortletEntity --username dash_admin_username --password dash_admin_password --portletEntityUniqueName portlet_entity_unique_name --rolesList role_name1, role__name2 --accessLevelList level1, level2
- Associate a comma separated list of roles with a particular portlet and set the access level to the portlet for each role.
- RemoveRolesFromPortletEntity --username dash_admin_username --password dash_admin_password --portletEntityUniqueName portlet_entity_unique_name --rolesList role_name1, role__name2
- Disassociate a comma separated list of roles from a particular portlet.
- ListRolesFromUser --username dash_admin_username --password dash_admin_password --userID user_ID
- List all roles associated with a specified user ID.
- MapRolesToUser --username dash_admin_username --password dash_admin_password --userID user_ID --rolesList role_name1, role__name2
- Associate a comma separated list of roles with a particular user ID.
- RemoveRolesFromUser --username dash_admin_username --password dash_admin_password --userID user_ID --rolesList role_name1, role__name2
- Disassociate a comma separated list of roles from a particular user ID.
- ListRolesForView --viewUniqueName view_name
- List all roles associated with a specified view.
- MapRolesToView --username dash_admin_username --password dash_admin_password --viewUniqueName view_name --rolesList role_name1, role__name2 --accessLevelList level1, level2
- Associate a comma separated list of roles with a particular view and set the access level for the view for each role.
- RemoveRolesFromView --username dash_admin_username --password dash_admin_password --viewUniqueName view_name --rolesList role_name1, role__name2
- Disassociate a comma separated list of roles from a particular view.
- ListOrphanedRoleMappings --username dash_admin_username --password dash_admin_password
- Use the ListOrphanedRoleMappings command option to list orphaned role mappings.
- RemoveOrphanedRoleMappings --username dash_admin_username --password dash_admin_password --maxUsersAndGroups num_of_roles_returned_by_ListOrphanedRoleMappings
- Use the RemoveOrphanedRoleMappings command option to remove orphaned role
mappings.Tip: Before you run this command option, run the ListOrphanedRoleMappings command option to list roles that can be removed. It is good practice to set the --maxUsersAndGroups parameter in the RemoveOrphanedRoleMappings command option to the number of orphaned roles that are returned by the ListOrphanedRoleMappings command option.Important: Before you run the RemoveOrphanedRoleMappings command option, make a backup copy of the following directory:
- JazzSM_HOME/profile/config/cells/JazzSMNode01Cell