Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel4
minLevel4
Anchor
addU
addU

Adding a user role 

Follow the instructions below to add a user role.

  1. On the Main tab in the management console, click Add under Users and Roles.
  2. Click Roles. This link is only visible to users with Security level permissions role. By default, the admin user has this permission enabled. See more information about permissions in the related topics.
  3. Click Add New Role. The following screen will open:
     
  4. Do the following:
    1. In the Domain list, specify the user store where you want to create this role. This list includes the primary user store and any other secondary user stores that are configured for your product. See the related topics for information on configuring user stores
    2. Enter a unique name for this role.
    3. Click Next.
  5. Select the permissions that you want users with this role to have. See more information about permissions in the related topics .
    Note that when you assign this role to a user, you can override the role's permissions and customize them for the user. 
  6. Select the existing users to whom this role should be assigned. You can also assign this role to users later, but if you are creating this role in an external user store that does not allow empty roles, you must assign it to at least one user. You can search for a user by name, or view all users by entering * in the search field.
  7. Click Finish.

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

Editing or deleting a role

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

...

Info

If the role is in an external user store to which you are connected in read-only mode, you will be able to view the existing roles but not edit or delete them. However, you can still create new editable roles.

Updating role names

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

Table of Contents
maxLevel5
minLevel5

Anchor
UpdateRole1
UpdateRole1
Update before the first startup (recommended)

The default role names (admin and everyone) can be changed before starting the WSO2 product by editing <PRODUCT_HOME>/repository/conf/user-mgt.xml. See more information about configuring the system administrator.

Code Block
languagehtml/xml
<Configuration> 
	<AdminRole>admin</AdminRole> 
	<AdminUser> 
		<UserName>admin</UserName> 
		<Password>admin</Password> 
	</AdminUser> 
	<EveryOneRoleName>everyone</EveryOneRoleName> <!-- By default users in this role sees the registry root --> 
	<Property name="dataSource">jdbc/WSO2CarbonDB</Property> 
	<Property name="MultiTenantRealmConfigBuilder">org.wso2.carbon.user.core.config.multitenancy.SimpleRealmConfigBuilder</Property> 
</Configuration>

...

  • Change <AdminRole>admin</AdminRole> to <AdminRole>administrator</AdminRole>.
  • Change <EveryOneRoleName>everyone</EveryOneRoleName> to <EveryOneRoleName>Your role</EveryOneRoleName>.
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. Do 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 <PRODUCT_HOME>/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.
    See more information about setting up user stores.
  3. After the changes, restart the server.

Related Topics

Excerpt
hiddentrue

Note to writers: Add the following with links to the relevant documentation:

  • Role-Based Permissions: This section describes all the permissions that can be enabled for a role using the management console.
  • Configuring the System Administrator: This section describes how the system administrator user and role is set up and configured.
  • Configuring User Stores: This section explains how user stores (which are repositories storing information about Users and Roles) are set up and configured.