Account locking is a security feature in Identity Server that prevents users from logging in to their account and from authenticating themselves using their Identity Server account. For more information about configuring user accounts, see the Configuring User Stores topic. A user account can be locked in one of the following ways:
Account locking by failed login attempts
The Identity Server can be configured to lock a user account when a number of consecutive failed login attempts are exceeded. The following section explains how to configure the Identity Server for account locking.
Configuring Identity Server for account locking
Enable the Identity Listener by setting the
<UserOperationEventListener>property with the name "
IdentityMgtEventListener", to true in the
Configure the following parameters in the
This enables the authentication flow level which checks for the account lock and one time password features. This property must be enabled for the account lock feature to work.
This enables locking the account when authentication fails.
This indicates the number of consecutive attempts that a user can try to log in without the account getting locked. In this case, if the login fails twice, the account is locked.
The time specified here is in minutes. In this case, the account is locked for five minutes and authentication can be attempted once this time has passed.
Unlocking the locked user account
The Identity Server can be configured to automatically unlock a user account after a certain period of time. A user account locked by failed login attempts can be unlocked by setting a lock timeout period. To configure this:
Authentication.Policy.Account.Lock.Timeproperty in the
<IS_HOME>/repository/conf/identity/identity-mgt.propertiesfile. As mentioned in the above table, the value refers to the number of minutes that the account is locked for, after which, authentication can be attempted again.
If the lock time is set to 0, the account has to be unlocked by an admin user. For more information about this, see Account locking by an administrative user.
Account locking by an administrative user
An administrative user can unlock a user account using one of the following methods:
Using the management console
An administrative user can lock a user account by editing the user’s profile in the management console.
- Start the IS server if you have not already and log in to the management console using admin credentials.
- Navigate to Claims>List on the Configure menu and select the http://wso2.org/claims claim dialect. For more information about claims, see Claim Management.
- Select the Account Locked claim and click Edit.
- Select the "Supported by Default" checkbox and click Update. This is done to make the "Account Locked" status appear in the user's profile.
- Navigate to Users and Roles>List>Users on the Main menu and click on User Profile of the user you want to lock.
- If it is the first time this particular account is being locked, a textbox will appear in front of the Account Locked field as seen below. To lock the account, type true in the textbox and click Update.
If it is not the first time you are locking this user account, there will be a checkbox instead of the textbox shown above in front of the Account Locked field.
Select the checkbox to lock the account or unselect it to unlock the account and click Update.
Using the AdminService
An administrative user (with the permission level /permission/admin/configure/security/usermgt/users ) can lock a user account using the
. The admin service provides the
lockUserAccount operation to achieve this. The following request is a sample SOAP request that can be sent to the
to lock a user account.
Unlocking a user account from the admin service
Similarly, you can use the
UserIdentityManagementAdminService to unlock a locked user account. The service provides the
unlockUserAccount operation to achieve this. The following request is a sample SOAP request that can be sent to the
to unlock a user account.
The Identity Server can be configured to send an email notification to the user when a user account is unlocked by an admin user. Follow the steps below to configure this.
Configure the following parameters in the
The time specified here is in minutes. In this case, the notification expires after 7200 minutes.
This enables the internal email sending module. If this property is set to false, the email sending data is available to the application via a Web service. Thus the application can send the email using its own email sender.
This property enables the email sending function when the password account is unlocked.
Navigate to the
<IS_HOME>/repository/conf/axis2/axis2.xmlfile and uncomment the following property. Change the parameter values according to your email (see the second code block below for an example of this).
Make sure the following email template is defined in the
<IS_HOME>/repository/conf/email/email-admin-config.xmlfile. This is the format in which the email is sent to the user when the account is unlocked.
- Restart the server once the configuration changes are made.
Storing claims in the user store
By default, IS stores these claim values in the JDBC datasource configured in the
identity.xml file. If needed, you can configure IS to store the claim values in the userstore as well.
<IS_HOME>/repository/conf/identity/identity-mgt.propertiesfile and change the
Identity.Mgt.User.Data.Storeproperty to the datastore you have configured.
The default value
org.wso2.carbon.identity.mgt.store. JDBCIdentityDataStoreis the Identity datasource. Changing the store to
UserStoreBasedIdentityDataStoreensures that identity claims are stored in the user store.
The identity claims mentioned below should be mapped correctly to the attributes in the underlying user store. For more information on how to do this, see Claim Management.
http://wso2.org/claims/identity/accountLocked - This claim is used to store the status of the user's account, i.e., if it is locked or not.
http://wso2.org/claims/identity/unlockTime - This is used to store the timestamp that the user's account is unlocked.
http://wso2.org/claims/identity/failedLoginAttempts - This is used to track the number of consecutive failed login attempts. It is based on this that the account is locked.