This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Account Pending Status
This feature places users in a pending status when the process of self registration, email verification or ask password has been initiated and the confirmation mail has been sent, but the email has not been verified yet. The status claim will be set depending on the flow.
Info
- For more details on self registration, see Self-Registration and Account Confirmation.
- For more details on ask password, see Creating Users Using the Ask Password Option.
To use this feature, apply the 4863 WUM update to WSO2 Identity Server 5.7.0 using the WSO2 Update Manager (WUM).
To deploy a WUM update into production, you need to have a paid subscription. If you do not have a paid subscription, you can use this feature with the next version of WSO2 Identity Server when it is released. For more information on updating WSO2 Identity Server using WUM, see Getting Started with WUM in the WSO2 Administration Guide.
Adding a new claim
In order to keep track of the users’ account status, a new identity claim, http://wso2.org/claims/identity/accountState
is introduced. This claim stores the users’ account states. For more information on how to add claim mappings, see Adding Claim Mapping.
This is a readOnly
claim. It cannot be updated even by the admin user.
If this claim does not exist, the self-registration, ask-password and email verification flows will work according to the previous model where if a user tries to self register and the account has the Account Lock feature enabled the user receives two mails.
- Confirmation mail
- Account Locked mail
However, if this claim exists, only the confirmation mail is sent, and the user is placed in the "pending" state until the user confirms the registration in which case, the status moves to "Unlocked".
Only if the user is in a pending state (PENDING_AP, PENDING_EV, or PENDING_SR
), the confirmation mail will be sent.
This status can have one of the following values. Mentioned below are the values and their corresponding descriptions.
Status | Description |
---|---|
LOCKED | Account is locked but not disabled |
PENDING_AP | Ask password email is sent and the email is not verified |
PENDING_EV | Email Verification email is sent and the email is not verified |
PENDING_SR | Self registration email is sent and the email is not verified |
| Account is disabled |
UNLOCKED | Account is neither disabled nor locked |