Configuring Users

To enable users to log into the IS 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. The following sections list out the various ways to configure your users.

Adding a new user and assigning roles 

<Property name="SCIMEnabled">true</Property>

curl -v -k --user admin:admin --data "{"schemas":[],"name":{"familyName":"familyName","givenName":"givenName"},"userName":"username","password":"password","emails":[{"primary":true,"value":"wso2_home.com","type":"home"},{"value":"wso2_work.com","type":"work"}]}" --header "Content-Type:application/json" https://localhost:9443/wso2/scim/Users

{"id":"0d2714d0-6a33-4ddd-b4e0-612584c4a8c8","schemas":["urn:scim:schemas:core:1.0"],"name":{"familyName":"familyName","givenName":"givenName"},"userName":"username","emails":[{"value":"wso2_home.com","type":"home"},{"value":"wso2_work.com","type":"work"}],"meta":{"lastModified":"2016-01-25T11:44:14","location":"https://localhost:9443/wso2/scim/Users/0d2714d0-6a33-4ddd-b4e0-612584c4a8c8","created":"2016-01-25T11:44:14"}} 

curl -v -k --user {IS_USERNAME}:{IS_PASSWORD}  -X PATCH -d '{"schemas":[],"name":{"familyName":"{LAST_NAME}","givenName":"{FIRST_NAME"},"userName":"{USERNAME","emails": "{EMAIL"}' --header "Content-Type:application/json" https://{IS_IP}:{IS_PORT}/wso2/scim/Users/{SCIM_USER_ID}

curl -v -k --user admin:admin -X PATCH -d '{"schemas":[],"name":{"familyName":"gunasinghe","givenName":"hasinitg"},"userName":"hasinitg","emails":[{"value":"hasini@wso2.com","type":"work"},{"value":"hasi7786@gmail.com","type":"home"}]}' --header "Content-Type:application/json" https://localhost:9443/wso2/scim/Users/0032fd29-55a9-4fb9-be82-b1c97c073f02

Importing users

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

Creating a file with users

You must first create a CSV file or an Excel file with the user information. It is possible to import the username and password directly from the CSV/Excel to the product. Other user attributes can be imported if claim URls are defined for such attributes. Shown below are the claim URls that are defined be default in WSO2 IS. These will allow you to import the user's email address, country, given name etc. in addition to the username and password.

• http://wso2.org/claims/country
• http://wso2.org/claims/emailaddress
• http://wso2.org/claims/givenname
• http://wso2.org/claims/im
• http://wso2.org/claims/lastname
• http://wso2.org/claims/mobile
• http://wso2.org/claims/organization
• http://wso2.org/claims/role
• http://wso2.org/claims/streetaddress
• http://wso2.org/claims/telephone
• http://wso2.org/claims/url

The username, password and other attributes (claim URls) that you import should be given in a CSV file as shown below. Note that the first line of the file will not be imported considering that it is not a username.

UserName,Password,Claims
name1,Password1,http://wso2.org/claims/emailaddress=name1@gmail.com,http://wso2.org/claims/country=France
name2,Password2,http://wso2.org/claims/emailaddress=name2@gmail.com,http://wso2.org/claims/country=France
name3,Password3,http://wso2.org/claims/emailaddress=name3@gmail.com,http://wso2.org/claims/country=France

UserName,Password,Claims
name1,Password1,http://wso2.org/claims/emailaddress=name1@gmail.com,http://wso2.org/claims/country=France
name2,Password2,http://wso2.org/claims/emailaddress=name2@gmail.com,http://wso2.org/claims/country=France
name3,,http://wso2.org/claims/emailaddress=name3@gmail.com,http://wso2.org/claims/country=France

Importing users from the CSV/Excel file

To import users in bulk:

1. Log in to the management console.
2. Click Add under Users and Roles in the Main menu.
3. In the Add Users and Roles screen, click Bulk Import Users.
4. The user stores configured for your product will be listed in the Domain field. Select the user store to which you want to import the users from the list.
5. Click Choose File to give the path to the CSV/Excel file that contains the users that you want to import.
6. Click Finish to start importing.

Searching for users

Search users using management console

Once you have added a user in the Identity Server, you can search for the user by doing the following.

1. On the Main tab in the Management Console, click List under Users and Roles.
   
2. Click Users. This link is only visible to users with the Admin role. The following screen appears.
   You can search for users by doing one of the following.
   
   • Search by Domain
     
     1. Select the user store that the user resides in using the Select Domain dropdown.
     2. Enter the user name of the user and click Search Users . For users to be listed, you must use the exact name of the user, or use a username pattern by including *. For example, if you have a user named Don, you can either search for this user by searching for "Don", or you could search for "D*" to list out all the users with names beginning with D.
     3. The user is displayed in the list.
        
        
   • Search by Claim
     1. Select the relevant claim URI from the Select Claim Uri dropdown and enter the claim value in the user name field. 
     2. Click on Search Users. 

Search users using SCIM

In SCIM, searching for a user can be done by filtering users after listing them.

curl -v -k --user {IS_USERNAME}:{IS_PASSWORD} https://{IS_IP}:{IS_PORT}/wso2/scim/Users?filter={VALUE_TO_BE_CHECKED}+Eq+%22{VALUE_TO_BE_EQUAL}%22

curl -v -k --user admin:admin https://localhost:9443/wso2/scim/Users?filter=userName+Eq+%22hasinitg%22

You receive a response similar to the one below from which you can extract the SCIM ID to perform the rest of the operations.

{"schemas":["urn:scim:schemas:core:1.0"],"totalResults":1,"Resources":[{"id":"0032fd29-55a9-4fb9-be82-b1c97c073f02","userName":"hasinitg","meta":{"lastModified":"2016-01-26T18:26:04","created":"2016-01-26T16:46:53","location":"https://localhost:9443/wso2/scim/Users/0032fd29-55a9-4fb9-be82-b1c97c073f02"}}]}

Search users using SOAP

The user also can search user Ids by calling the RemoteUserStoreManager service. If you are new to admin services, see Calling Admin Services.

The following SOAP method like getUserId() will give you the user ID of the relevant username. There are many more such methods you can use according to your requirement.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://service.ws.um.carbon.wso2.org">
   <soap:Header/>
   <soap:Body>
      <ser:getUserId>
         <!--Optional:-->
         <ser:username>user123</ser:username>
      </ser:getUserId>
   </soap:Body>
</soap:Envelope>

Customizing the user's roles and permissions

Each role specifies a set of permissions that the user will have when assigned that role. After creating a user, you can assign roles for that user by clicking Assign Roles in the Actions column. To see or remove roles of a user, 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. 

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.

Add multiple profiles for a user

You can also add multiple profiles for a user. Claim Management can be used to update the details that are shown in the User Profile page. 

Do the following in order to add new profiles.

1. On the Main tab in the Management Console, click List under 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.

Changing a user's password

You can change your password or reset another user's password (if you have administrative privileges) using the management console. 

1. On the Main tab in the management console, click List under Users and Roles.
   
2. To change your own password, click  Change My Password, enter your current password and new password, and click Change.
3. If you are an admin user and need to  change another user's password (such as if they have forgotten their current password and need you to reset it), do the following:
   1. Click Users.
   2. Find the user's account on the Users screen and click Change Password in the Actions column.
   3. Enter a new temporary password and click Change. 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.
   4. Inform the user of their new temporary password and instruct them to log in and change it as soon as possible.

Deleting an existing user 

 Follow the instructions below to delete a user.

Delete user using management console

1. On the Main tab in the Management Console, click List under Users and Roles.  
   
2. Click Users. This link is only visible to users with the Admin role. 
   
3. In the Users list, click Delete next to the user you want to delete, and then click Yes to confirm the operation.

Delete user using SCIM

curl -v -k --user {IS_USERNAME}:{IS_PASSWORD} -X DELETE https://{IS_IP}:{IS_PORT}/wso2/scim/Users/{SCIM_USER_ID} -H "Accept: application/json"

curl -v -k --user admin:admin -X DELETE https://localhost:9443/wso2/scim/Users/b228b59d-db19-4064-b637-d33c31209fae -H "Accept: application/json"

You receive a response with status 200 OK and the user will be deleted from the user store. Similarly, you can manage groups by performing CRUD operations on the group resource endpoint.

Delete user using SOAP

The user also can delete user by calling the RemoteUserStoreManager service. If you are new to admin services, see Calling Admin Services.

The following SOAP method like deleteUser() will give you the user ID of the relevant username. There are many more such methods you can use according to your requirement.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://service.ws.um.carbon.wso2.org">
   <soap:Header/>
   <soap:Body>
      <ser:deleteUser>
         <!--Optional:-->
         <ser:userName>user123</ser:userName>
      </ser:deleteUser>
   </soap:Body>
</soap:Envelope>

Tracking user deletion on deleting a user

WSO2 Identity Server (WSO2 IS) allows you to track details related to user deletion by writing the following information to a log file each time a user is deleted:

• Username: The username of the deleted user.

• Domain name: The user store domain name of the deleted user.

• Tenant ID: The tenact ID of the deleted user.
• Timestamp: The timestamp that the user was deleted.

You can use this log file as an input to the Identity Anonymization tool that is packaged with WSO2 Identity Server, to ensure that you remove references to all deleted user identities.

Follow the steps below to configure WSO2 Identity Server to log details related to user deletion each time you delete a user:

1. Edit the <IS_HOME>/repository/conf/identity/identity.xml file, and set enable to true in the following event listener:

   <EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener"
                         name="org.wso2.carbon.user.mgt.listeners.UserDeletionEventListener"
                         orderId="98" enable="false"/>
   </EventListeners>

2. Edit the <IS_HOME>/repository/conf/identity/identity.xml file, and set enable to true in the following event recorder:

   <UserDeleteEventRecorders>
          <UserDeleteEventRecorder name="org.wso2.carbon.user.mgt.recorder.DefaultUserDeletionEventRecorder" enable="false">
          </UserDeleteEventRecorder>
   </UserDeleteEventRecorders>

   This writes details related to user deletion in the CSV format to the <IS_HOME>/repository/logs/delete-event.log file. 

   Note

   If necessary you can write user delete event details to a custom CSV file that you specify. To do this, add the following property within the <UserDeleteEventRecorder> element in the <IS_HOME>/repository/conf/identity/identity.xml file, and be sure to specify the custom CSV file path.

   <Property name="path">${carbon.home}/repository/logs/delete-records.csv</Property>