Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Roles contain permissions for users to manage the server. You can create different roles with various combinations of permissions and assign them to a user or a group of users. Through the management consoleManagement Console, you can also edit and delete an existing user role.

WSO2 supports the  role-based authentication  model where privileges of a user are based on a the role it is attached withto.    By default, WSO2 products come with the following roles:

...

The role is created and is listed on the Roles page. You can now edit the role as needed.    

Info

When adding roles to external user stores, note the following:

  • Some external user stores do not allow you to create empty roles. In that case, selecting users who belong to a role is mandatory.
  • If you connect to an external user store (e.g., LDAP) in read-only mode, you can read existing roles from it, but you can not edit/delete the roles. In this case, you can still create new roles that are editable and can be managed internally.
  • If you connect to an external user store in read/write mode, you can edit the roles in the external user store as well.

Searching for user roles

You can search for an existing user role using the search facility on the  Roles  screen as follows:  

  1. S elect the domain (unique identifier) of the user store where you want to search for the role. By default, there are three options:
    • PRIMARY: Searches within the primary user store
    • ALL-USER-STORE-DOMAINS: Searches within all user stores configured in the system.
    • Internal: Searches in the database where internal/system-reserved user roles such as  Internal/everyone  are stored.
  2. Enter the role name pattern.  For example, if you enter "ab*", it returns all roles that have names starting with "ab". 
  3. Click Search to see the results.

Editing or deleting a role

If you need to make modifications to a role, select the domain (user store) where the role resides, and then use the links in the Actions column on the Roles screen as follows:  

...

If you need to make modifications to the role names, you need to do one of the following:

Table of Contents
maxLevel5
minLevel5

...

Update after the product is used for sometime 

You do not have to do this when updating before the first startup. The following steps guide you through updating the role names:

  1. Make the configuration changes indicated in the above section.
  2. You need to do the following user store level changes for existing users if you have changed the role names as mentioned earlier. 
    • If you are connected to JDBCUserStoreManager you need to update the UM_USER_ROLE table with the existing users after changing the 'admin' and 'everyone' role names. Also if you have changed the permission of 'everyone' role the UM_ROLE_PERMISSION has to be updated with the permissions to the new role.

      Info

      The schema can be located by referring to the data source defined in the user-mgt.xml file. The data source definition can be found under repository/conf/datasources/master-datasources.xml.

    • If you are connected to ReadWriteLdapUserStoreManager you need to populate the members of the previous admin role to the new role under the Groups.
  3. After the changes restart the server.

...