This documentation is for WSO2 Carbon 4.2.0. View documentation for the latest release.
Configuring Users - Carbon 4.2.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

User management functionality is provided by default in all WSO2 Carbon-based products and is configured in the user-mgt.xml file found in the <PRODUCT_HOME>/repository/conf/ directory. The instructions given in this topic explain how you can add and manager users from the management console.

To enable users to log into the management console, you create user accounts and assign them roles, which are sets of permissions. You can add individual users or import users in bulk.

Adding a new user and assigning roles 

Follow the instructions below to add a new user account and configure its role.

Add the GetRoleListOfInternalUserSQL property within the <Realm> section in the <PRODUCT_HOME>/repository/conf/user-mgt.xml file as follows, to avoid case sensitivity issues when creating users.

<Realm>
<Configuration>
<Property name="GetRoleListOfInternalUserSQL">SELECT UM_ROLE_NAME FROM UM_HYBRID_USER_ROLE, UM_HYBRID_ROLE WHERE UPPER(UM_USER_NAME)=UPPER ( ? ) AND UM_HYBRID_USER_ROLE.UM_ROLE_ID=UM_HYBRID_ROLE.UM_ID AND UM_HYBRID_USER_ROLE.UM_TENANT_ID=? AND UM_HYBRID_ROLE.UM_TENANT_ID=? AND UM_HYBRID_USER_ROLE.UM_DOMAIN_ID=(SELECT UM_DOMAIN_ID FROM UM_DOMAIN WHERE UM_TENANT_ID=? AND UM_DOMAIN_NAME=?)</Property>
</Configuration>
</Realm>
  1. Go to the Configure tab in the management console and click Users and Roles.
  2. Click Users. This link is only visible to users with the Admin role. 
  3. Click Add New User. The following screen will open:

  4. Do the following:
    1. In the Domain list, specify the user store where you want to create this user account. This list includes the primary user store and any other secondary user stores that are configured for your product.  For information on configuring user stores, see Configuring User Stores.
    2. Enter a unique user name and the password that the person will use to log in. By default, the password must be at least five characters and should have at least one character with a capital letter, characters, numbers and special characters.
    3. Click Next.
  5. Optionally, select the role(s) you want this user to have. If you have many roles in your system, you can search for them by name.
  6. Click Finish.

A new user account is created with the specified roles and is listed on the Users page.

Importing users

In addition to manually adding individual users, you can import multiple users in bulk if you have exported them to a comma-separated values (.csv) file or Microsoft Excel (.xls) file.

This is only supported if you have configured your user store as a JDBCUserStoreManager. For information on how JDBC user stores are configured, see Configuring User Stores. It is recommended to upload a maximum of 500,000 users at a time. If you need to upload more users, you can upload them in separate batches of 500,000 each. You can also specify the size of the file that you can upload in the <PRODUCT_HOME>/repository/conf/carbon.xml file using the TotalFileSizeLimit element. This value is in MB.

<TotalFileSizeLimit>100</TotalFileSizeLimit>

  1. On the Users screen, click Bulk Import Users.
  2. Browse and select the file that contains the user data. 
  3. Specify a default password to assign to all the users you are importing and click Finish. This password is valid for only 24 hours, so you should inform your users that they must log in and change their password within 24 hours.

Customizing the user's roles and permissions

Each role specifies a set of permissions that the user will have when assigned to that role. After creating a user, you can assign and remove roles for that user by clicking Assign Roles in the Actions column. To see which users a role is already assigned to, click View Users next to the role.

You can also customize which permissions apply to this user by clicking View Roles in the Actions column of the Users screen and then selecting the permissions from each role that you want this user to have. For information on permissions, see Role-based Permissions.

Customizing a user's profile

Each individual user has a profile that can be updated to include various details. To do this, click User Profile on the Users screen. Make the changes required and click Update. You can also add multiple profiles for a user. 

Note: You can only add new profiles if you are connected to a JDBC user store. You also need to have administrator privileges.

Do the following in order to add new profiles. 

  1. On the Configure tab in the Management Console, click Users and Roles.  
  2. Click Users. This link is only visible to users with the Admin role. 
  3. Click the User Profile link.
  4. You can add multiple profiles using the Add New Profile link and create any number of profiles for your user as long as the user is located in a JDBC user store.

Deleting an existing user 

 Follow the instructions below to delete a user.

Deleting a user cannot be undone.

  1. Go to the Configure tab in the management console and click Users and Roles.  
  2. Click Users. This link is only visible to users with User Management level permissions. For information on permissions, see Role-based Permissions.
  3. In the Users list, click Delete next to the user you want to delete, and then click Yes to confirm the operation.
  • No labels