This documentation is for WSO2 Identity Server 5.4.0 . View documentation for the latest release.
||
Skip to end of metadata
Go to start of metadata

The WSO2 Identity Server allows you to set up account suspension to lock accounts that have been idle for a pre-configured amount of time. 

Prior to account suspension, set up the notification system to send a warning notification to the user announcing that the account will be suspended. For instance, if a user has not logged in to his/her account for 90 days, the user can be notified that his account will be suspended within the next 7 days if there continues to be no activity, after which, the account will be suspended. 

Note: Once an account is suspended, only an administrative user can unlock the account. 

Setting up account suspension notifications

The notification module is a scheduled task that runs daily. It fetches users from the user store that are idle and eligible to receive a warning notification based on the last logged-in time. The scheduled task that checks for idle accounts is common to all tenants. 

Before you begin

Ensure that the "IdentityMgtEventListener" with the orderId=50 is set to false and that the "IdentityMgtEventListener" with the orderId=95 is set to true in the <IS_HOME>/repository/conf/identity/identity.xml file. 

<EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.identity.mgt.IdentityMgtEventListener" orderId="50" enable="false"/>
<EventListener type="org.wso2.carbon.user.core.listener.UserOperationEventListener" name="org.wso2.carbon.identity.governance.listener.IdentityMgtEventListener" orderId="95" enable="true" />
  1. Enable notifications for account suspension by setting the following property to true in the <IS_HOME>/repository/conf/identity/identity-event.properties  file.

    suspension.notification.enable=true
  2. To define the start time of the scheduled task, configure the following property in the <IS_HOME>/repository/conf/identity/identity-event.properties  file. The task runs daily at the trigger time that you configure here.

    Tip: Set the value in hh:mm:ss format. If you set it in the wrong format or do not set a value, the default value, which is 20:00:00, applies.

    suspension.notification.trigger.time=20:00:00
  3. Add the following property under all the relevant userstores that you are using in the user-mgt.xml file.

    LDAP Userstore
    <Property name="NotificationReceiversRetrievalClass">org.wso2.carbon.identity.account.suspension.notification.task.ldap.LDAPNotificationReceiversRetrieval</Property>
    JDBC Userstore
    <Property name="NotificationReceiversRetrievalClass">org.wso2.carbon.identity.account.suspension.notification.task.jdbc.JDBCNotificationReceiversRetrieval</Property>
  4. Optionally, you can configure the following email properties to receive email notifications. 
    Open the output-event-adapters.xml file found in the <IS_HOME>/repository/conf directory and configure the relevant property values for the email server under the <adapterConfig type="email"> tag.

    <adapterConfig type="email">
        <!-- Comment mail.smtp.user and mail.smtp.password properties to support connecting SMTP servers which use trust
        based authentication rather username/password authentication -->
       	<property key="mail.smtp.from">abcd@gmail.com</property>
       	<property key="mail.smtp.user">abcd</property>
       	<property key="mail.smtp.password">xxxx</property>
       	<property key="mail.smtp.host">smtp.gmail.com</property>
       	<property key="mail.smtp.port">587</property>
       	<property key="mail.smtp.starttls.enable">true</property>
       	<property key="mail.smtp.auth">true</property>
       	<!-- Thread Pool Related Properties -->
       	<property key="minThread">8</property>
       	<property key="maxThread">100</property>
       	<property key="keepAliveTimeInMillis">20000</property>
       	<property key="jobQueueSize">10000</property>
    </adapterConfig>

    You can customize the emails that are sent to the user by editing the pre-configured email templates.

    • The email template used to send an email when the account has been idle for some time is the idleAccountReminder template.
    • The template used to send an email when the account has been locked is the AccountLock template.

    For more information on how to edit and customize the email templates, see Customizing Automated Emails.

Configuring account suspension settings

  1. Start the WSO2 IS and log into the management console using your tenant credentials. 
  2. Click Resident under Identity Providers found in the Main tab. Expand the Login Policies tab.
  3. Expand the Account Locking tab and select the Account Lock Enabled checkbox. Click Update to save changes. 
  4. Expand the Account Management Policies tab. 

  5. Expand the Lock Idle Accounts tab and select Enable. Fill in the following fields and click Update.

    FieldDescriptionSample Value
    Lock Account AfterThis specifies the total number of days after which the account will be locked. In this case, if the account is idle for 90 days, it will be locked.90
    Alert User inThis specifies the number of days (in a comma separated list) after which the user is sent a warning notification informing him/her that the account is about to be locked. In this case, the user will receive multiple notifications, one notification after 30 days, the next after 45 days etc. Finally if it reaches 90 days with no activity from the user, the account will be locked.30,45,60,75

Troubleshooting Tips

If you want to troubleshoot this feature, add the following property to the log4j.properties file found in the <IS_HOME>/repository/conf/ folder to receive DEBUG logs.

log4j.logger.org.wso2.carbon.identity.account.suspension.notification.task=DEBUG
Related Links

By default, the claim values of the identity claims used in this feature are stored in the JDBC datasource configured in the identity.xml file. See Configuring Claims for more information on how to store the claim values in the user store.

  • No labels