Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed account configurations documentation #4890

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../../../includes/guides/account-configurations/account-recovery/password-recovery.md" %}
1 change: 1 addition & 0 deletions en/asgardeo/docs/guides/account-configurations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../../includes/guides/account-configurations/index.md" %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../../../includes/guides/account-configurations/login-security/login-attempts.md" %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../../../includes/guides/account-configurations/login-security/password-validation.md" %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../../../includes/guides/account-configurations/user-onboarding/self-registration.md" %}
2 changes: 0 additions & 2 deletions en/asgardeo/docs/guides/user-accounts/password-recovery.md

This file was deleted.

28 changes: 17 additions & 11 deletions en/asgardeo/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,15 @@ plugins:
'apis/organization-apis/org-group-mgt.md': 'apis/organization-apis/scim2/scim2-org-group-mgt.md'
'apis/organization-apis/scim-bulk.md': 'apis/organization-apis/scim2/scim2-org-bulk.md'
'guides/api-authorization.md' : 'guides/authorization/api-authorization/api-authorization.md'
'guides/account-configurations.md': 'guides/user-accounts/index.md'
'guides/user-accounts/index.md': 'guides/account-configurations/index.md'
'references/application-logs.md' : 'guides/asgardeo-logs.md'
'apis/oauth-dcr.md' : 'apis/dynamic-client-registration-rest-api.md'
'/guides/authorization/impersonation/user-impersonation/' : '/guides/authorization/user-impersonation/'
'guides/branding/localization-in-asgardeo.md': 'guides/branding/localization.md'
'guides/user-accounts/password-recovery.md': 'guides/account-configurations/account-recovery/password-recovery.md'
'guides/user-accounts/account-security/login-attempts-security.md': 'guides/account-configurations/account-security/login-attempts.md'
'guides/user-accounts/account-security/password-validation.md': 'guides/account-configurations/login-security/password-validation.md'
'guides/user-accounts/configure-self-registration.md': 'guides/account-configurations/user-onboarding/self-registration.md'

exclude_docs: |
/get-started/hello-world.md
Expand Down Expand Up @@ -302,16 +306,18 @@ nav:
- Connect a remote user store: guides/users/user-stores/configure-a-user-store.md
- Configure high availability: guides/users/user-stores/configure-high-availability.md
- Manage remote user stores: guides/users/user-stores/update-user-stores.md
- Account management:
- Account management: guides/user-accounts/index.md
- Configure password recovery: guides/user-accounts/password-recovery.md
- Configure self-registration: guides/user-accounts/configure-self-registration.md
- Manage account security:
- Configure login-attempts security: guides/user-accounts/account-security/login-attempts-security.md
- Configure bot detection: guides/account-configurations/login-security/bot-detection.md
- Configure password validation: guides/user-accounts/account-security/password-validation.md
- Manage account login:
- Configure username validation: guides/user-accounts/account-login/username-validation.md
- Account configurations:
- Account configurations: guides/account-configurations/index.md
- Login security:
- Login attempts: guides/account-configurations/login-security/login-attempts.md
- Bot detection: guides/account-configurations/login-security/bot-detection.md
- Password validation: guides/account-configurations/login-security/password-validation.md
- Account recovery:
- Password recovery: guides/account-configurations/account-recovery/password-recovery.md
- User onboarding:
- Self-registration: guides/account-configurations/user-onboarding/self-registration.md
- Manage login identifiers:
- Configure username validation: guides/account-configurations/account-login/username-validation.md
- Configure alternative login identifiers: guides/user-accounts/account-login/configure-login-identifiers.md
- User self-service:
- User self-service: guides/user-self-service/index.md
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,13 +1 @@
# Admin initiated password reset

Provide administrators with the ability to initiate a password reset process for users in {{product_name}}.

Follow the steps below to set up admin initiated password reset:

1. On the {{product_name}} Console, go to **Login & Registration** > **Account Recovery** > **Admin Initiated Password Reset**.

2. Select **Enable Password Reset via Recovery Email** checkbox. Once an administrator forces a password reset, users may reset their passwords through a recovery link sent via email.

3. Click **Update** to save the changes.

![Admin Initiated Password Reset Configuration]({{base_path}}/assets/img/guides/account-configurations/admin-initiated-password-reset.png){: width="800" style="display: block; margin: 0;"}
{% include "../../../../../../includes/guides/account-configurations/account-recovery/admin-initiated-password-reset.md" %}
Original file line number Diff line number Diff line change
@@ -1,24 +1 @@
# Password recovery

Provide self-service password recovery right from the login page of {{product_name}} for users to securely reset a forgotten password.

Follow the steps below to configure password recovery:

1. On the {{product_name}} Console, go to **Login & Registration** > **Account Recovery** > **Password Recovery**.
2. Toggle the switch to enable passwords recovery.
3. Configure the following options:

<table>
<tr>
<td><b>Notify on Successful Recovery</b></td>
<td>When checked, the user will be notified via email after a successful password recovery.</td>
</tr>
<tr>
<td><b>Recovery Link Expiry Time</b></td>
<td>Time in minutes until the password recovery link expires.</td>
</tr>
</table>

4. Click **Update** to save the changes.

![Password Recovery Configuration]({{base_path}}/assets/img/guides/account-configurations/password-recovery.png){: width="800" style="display: block; margin: 0;"}
{% include "../../../../../../includes/guides/account-configurations/account-recovery/password-recovery.md" %}
Original file line number Diff line number Diff line change
@@ -1,12 +1 @@
# Username recovery

Allow users to retrieve their usernames through a self-service process on the login page in {{product_name}}.

Follow the steps below to enable username recovery:

1. On the {{product_name}} Console, go to **Login & Registration** > **Account Recovery** > **Username Recovery**.
2. Toggle the switch to enable username recovery option to allow users to recover their usernames.
3. Click **Update** to save the changes.

![Username Recovery Configuration]({{base_path}}/assets/img/guides/account-configurations/username-recovery.png){: width="900" style="display: block; margin: 0;"}

{% include "../../../../../../includes/guides/account-configurations/account-recovery/username-recovery.md" %}
Original file line number Diff line number Diff line change
@@ -1,61 +1 @@
# Login attempts

Secure user accounts from unauthorized access by configuring the login attempts policy in {{product_name}}.

## Configuration instructions

To manage login attempts settings, do the following:

1. In the {{product_name}} Console, go to **Login & Registration** > **Login Security** > **Login Attempts**.
2. Adjust the settings according to your security requirements.
3. Click **Update** to save the changes.

![Login Attempts Configuration]({{base_path}}/assets/img/guides/account-configurations/login-attempts.png){: width="900" style="display: block; margin: 0;"}

## Parameters

<table>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td><code>Number of Consecutive Failed Login Attempts</code></td>
<td>The count of consecutive incorrect login attempts before locking the account.</td>
</tr>
<tr>
<td><code>Account Lock Duration</code></td>
<td>The time in minutes an account stays locked after reaching the failed attempt limit.</td>
</tr>
<tr>
<td><code>Account Lock Duration Increment Factor</code></td>
<td>The rate at which the lock duration increases after successive lockouts.</td>
</tr>
</table>

!!! Info
- In the {{product_name}} login pages, a generic error message is displayed by default to end-users in the event of login failures. To show more specific error messages on the login page, the following properties can be configured in the `deployment.toml` file, which is located in the `<IS_HOME>/repository/conf` directory.

Basic authenticator configurations:

```toml
[authentication.authenticator.basic.parameters]
showAuthFailureReason = true
showAuthFailureReasonOnLoginPage = true
```

Email OTP authenticator configurations:

```toml
[authentication.authenticator.email_otp.parameters]
showAuthFailureReason = true
showAuthFailureReasonOnLoginPage = true
```

TOTP authenticator configurations:

```toml
[authentication.authenticator.totp.parameters]
showAuthFailureReason = true
showAuthFailureReasonOnLoginPage = true
```
{% include "../../../../../../includes/guides/account-configurations/login-security/login-attempts.md" %}
Original file line number Diff line number Diff line change
@@ -1,37 +1 @@
# Password validation

Customize password validation rules to enhance the security of user accounts in {{product_name}}.

## Configuration instructions

To configure password validation rules, follow the steps below:

1. On the {{product_name}} Console, go to **Login & Registration** > **Login Security** > **Password Validation**.
2. Adjust the settings according to your security requirements.

![Password Validation Configuration]({{base_path}}/assets/img/guides/account-configurations/password-validation.png){: width="600" style="display: block; margin: 0;"}

<table>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td><code>Password Expiration</code></td>
<td>Defines the number of days after which a password must be changed.</td>
</tr>
<tr>
<td><code>Password History Count</code></td>
<td>Specifies the number of unique new passwords a user must use before an old password can be reused.</td>
</tr>
<tr>
<td><code>Password Input Validation</code></td>
<td>Sets requirements for password complexity, including length and character types.</td>
</tr>
</table>

3. Click **Update** to save the changes.

!!! note "Validation for whitespace in passwords"

{{product_name}} automatically trims leading and trailing whitespace from passwords when creating, updating, or when entering passwords to login.
{% include "../../../../../../includes/guides/account-configurations/login-security/password-validation.md" %}
Original file line number Diff line number Diff line change
@@ -1,30 +1 @@
# Session management

Customize session timeout and remember me settings to maintain optimal security and user experience in {{product_name}}.

## Configuration instructions

To adjust session management settings, follow these steps:

1. On the {{product_name}} Console, go to **Login & Registration** > **Login Security** > **Session Management**.
2. Configure the **Idle Session Timeout** and **Remember Me Period** to suit your security policies.
3. Click **Update** to save the changes.

![Session Management Configuration]({{base_path}}/assets/img/guides/account-configurations/session-management.png){: width="800" style="display: block; margin: 0;"}

## Parameters

<table>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td><code>Idle Session Timeout</code></td>
<td>Time in minutes before an inactive user session is automatically ended.</td>
</tr>
<tr>
<td><code>Remember Me Period</code></td>
<td>Duration in minutes that the system will remember a user's session.</td>
</tr>
</table>
{% include "../../../../../../includes/guides/account-configurations/login-security/session-management.md" %}
Original file line number Diff line number Diff line change
@@ -1,45 +1 @@
# Invite user to set password

Allow administrator to invite users to set their own passwords during the onboarding process in {{product_name}}.

## Configuration instructions

For inviting users to set their password, follow these instructions:

1. On the {{product_name}} Console, go to **Login & Registration** > **User Onboarding** > **Invite User to Set Password**.
2. Check the **Enable email invitations for user password setup** to send an email to the user to set the password after user creation.
3. Select the **Enable account lock on creation** to lock the user account during user creation.
4. If you want to send an account activation confirmation email, enable the **Send account activation email**.
5. Set the **Password setup invitation code expiration time** in minutes to define how long the password setup invitation e-mail would be valid. For infinite validity period, set -1. Setting 0 will cause immediate expiry of the invitation.
6. Click **Update** to save the changes.

![Invite User to Set Password Configuration]({{base_path}}/assets/img/guides/account-configurations/invite-user-to-set-password.png){: width="700" style="display: block; margin: 0;"}

## Parameters

<table>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td><code>Enable user email verification</code></td>
<td>Triggers a verification notification during user creation if enabled.</td>
</tr>
<tr>
<td><code>Enable account lock on creation</code></td>
<td>Locks the user account during creation to prevent unauthorized access.</td>
</tr>
<tr>
<td><code>Send account activation email</code></td>
<td>Sends an email to users for account activation if enabled.</td>
</tr>
<tr>
<td><code>Email verification code expiry time</code></td>
<td>The duration in minutes for which the email verification code remains valid.</td>
</tr>
<tr>
<td><code>Password Setup Invitation Code Expiration Time</code></td>
<td>Defines the validity period in minutes for the password setup code sent to users. For infinite validity period, set -1.</td>
</tr>
</table>
{% include "../../../../../../includes/guides/account-configurations/user-onboarding/invite-user-to-set-password.md" %}
Original file line number Diff line number Diff line change
@@ -1,43 +1 @@
# Self registration

Enable users to self-register and create their own accounts within the organization on {{product_name}}.

## Configuration instructions

To set up self-registration, follow these steps:

1. On the {{product_name}} Console, go to **Login & Registration** > **User Onboarding** > **Self Registration**.
2. Toggle the switch to enable self-registration.
3. Configure the additional settings such as account verification, auto-login, and notification emails as needed.
4. Click **Update** to save the changes.

![Self Registration Configuration]({{base_path}}/assets/img/guides/account-configurations/self-registration.png){: width="900" style="display: block; margin: 0;"}

## Parameters

<table>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td><code>Account Verification</code></td>
<td>When enabled, requires users to verify their accounts as part of registration.</td>
</tr>
<tr>
<td><code>Account verification link expiry time</code></td>
<td>Time in minutes until the account verification link expires.</td>
</tr>
<tr>
<td><code>Activate account immediately</code></td>
<td>If selected, the new account is activated immediately after registration without waiting for account confirmation.</td>
</tr>
<tr>
<td><code>Enable auto login</code></td>
<td>If selected, the user will be automatically logged in after registration.</td>
</tr>
<tr>
<td><code>Send sign up confirmation email</code></td>
<td>A confirmation email is sent upon successful self-registration if this option is enabled.</td>
</tr>
</table>
{% include "../../../../../../includes/guides/account-configurations/user-onboarding/self-registration.md" %}
Loading