Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion en/identity-server/5.11.0/docs/learn/user-account-suspension.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
!!! note
Once an account is suspended, only an administrative user can
unlock the account.

Check failure on line 16 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:16:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
## Setting up account suspension notifications

The notification module is a scheduled task that runs daily. It fetches
Expand All @@ -22,7 +22,7 @@
task that checks for idle accounts is common to all tenants.

!!! tip "Before you begin"

Check failure on line 25 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:25:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
Ensure that the identity listener with the
` priority=50 ` is set to **false** and that the "
identity listener with the
Expand All @@ -38,7 +38,7 @@
enable = true
```

1. Enable notifications for account suspension by setting the following

Check failure on line 41 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:41:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
property to true in the `<IS_HOME>/repository/conf/deployment.toml` file.

``` toml
Expand All @@ -46,12 +46,12 @@
inactive_account_suspention.enable_account_suspension = true
```

2. To define the start time of the scheduled task, configure the

Check failure on line 49 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:49:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
following property in the `<IS_HOME>/repository/conf/deployment.toml`
file. The task runs daily at the trigger time that you configure
here.

!!! Tip

Check failure on line 54 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:54:12 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
Set the value in hh:<zero-width-space>mm:<zero-width-space>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.
Expand All @@ -61,7 +61,7 @@
inactive_account_suspension.trigger_notifications_at = "20:00:00"
```

3. Add the following property under all the relevant userstores that

Check failure on line 64 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:64:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
you are using in the deployment.toml file.

**LDAP Userstore**
Expand All @@ -78,7 +78,7 @@
notification_receivers_retrieval_class = "org.wso2.carbon.identity.account.suspension.notification.task.jdbc.JDBCNotificationReceiversRetrieval"
```

4. Optionally, you can configure the following email properties to

Check failure on line 81 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:81:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
receive email notifications in `<IS_HOME>/repository/conf/deployment.toml`

``` toml
Expand All @@ -93,7 +93,7 @@
```

!!! tip

Check failure on line 96 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:96:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
You can customize the emails that are sent to the user by editing
the pre-configured email templates.

Expand All @@ -105,11 +105,32 @@
For more information on how to edit and customize the email
templates, see [Customizing Automated
Emails](../../learn/customizing-automated-emails).


5. Optionally, configure the date format used to render the

Check failure on line 109 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:109:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
`{{suspension-date}}` placeholder in the **idleAccountReminder** email
template. By default, the suspension date is rendered using the
`dd-MM-yyyy` pattern (e.g. `04-05-2026`). To use a different pattern
(e.g. US-locale `MM-dd-yyyy`), add the following property in
`<IS_HOME>/repository/conf/deployment.toml`.

``` toml
[identity_mgt.inactive_account_suspension]
date_format = "MM-dd-yyyy"
```

The value accepts any pattern supported by
[`java.text.SimpleDateFormat`](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html).
If the property is unset, blank, or contains an invalid pattern, the
server falls back to `dd-MM-yyyy` and logs a warning.

!!! info
This capability is available as an update in WSO2 IS 5.11.0 from
update level **5.11.0.<TBD>** onwards (Updates 2.0 model). See the

Check warning on line 128 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / Vale style check

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'onwards'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'onwards'?", "location": {"path": "en/identity-server/5.11.0/docs/learn/user-account-suspension.md", "range": {"start": {"line": 128, "column": 39}}}, "severity": "WARNING"}
instructions on [updating WSO2 products](https://updates.docs.wso2.com/en/latest/).

## Configuring account suspension settings

1. Start the WSO2 IS and log into the management console using your

Check failure on line 133 in en/identity-server/5.11.0/docs/learn/user-account-suspension.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

en/identity-server/5.11.0/docs/learn/user-account-suspension.md:133:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
tenant credentials.
2. Click **Resident** under **Identity Providers** found in the
**Main** tab. Expand the **Login Attempts Security** tab.
Expand Down
8 changes: 8 additions & 0 deletions en/identity-server/7.3.0/docs/apis/governance-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,14 @@ This is the RESTful API for managing identity governance configurations in WSO2
| Suspend idle user accounts | suspension.notification.enable | Lock user account after a given idle period. |
| Allowed idle time span in days | suspension.notification.account.disable.delay | Time period in days before locking the user account. |
| Alert sending time periods in days | suspension.notification.delays | Send warning alerts to users before locking the account after each period. Comma-separated multiple values accepted. |
| Alert date format | suspension.notification.date.format | Date format of the suspension date in the idle account reminder email. Examples: dd-MM-yyyy, MM-dd-yyyy, yyyy/MM/dd. |

{% if is_version == "7.3.0" %}
!!! info
The `suspension.notification.date.format` property is available
in WSO2 Identity Server 7.3.0 from update level **7.3.0.<TBD>**
onwards. See the instructions on [updating WSO2 products](https://updates.docs.wso2.com/en/latest/).
{% endif %}

**Account Disable**

Expand Down
8 changes: 8 additions & 0 deletions en/identity-server/next/docs/apis/governance-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,14 @@ This is the RESTful API for managing identity governance configurations in WSO2
| Suspend idle user accounts | suspension.notification.enable | Lock user account after a given idle period. |
| Allowed idle time span in days | suspension.notification.account.disable.delay | Time period in days before locking the user account. |
| Alert sending time periods in days | suspension.notification.delays | Send warning alerts to users before locking the account after each period. Comma-separated multiple values accepted. |
| Alert date format | suspension.notification.date.format | Date format of the suspension date in the idle account reminder email. Examples: dd-MM-yyyy, MM-dd-yyyy, yyyy/MM/dd. |

{% if is_version == "7.3.0" %}
!!! info
The `suspension.notification.date.format` property is available
in WSO2 Identity Server 7.3.0 from update level **7.3.0.<TBD>**
onwards. See the instructions on [updating WSO2 products](https://updates.docs.wso2.com/en/latest/).
{% endif %}

**Account Disable**

Expand Down
Loading