Skip to content

Add documentation for newly added configs in Login & Registration #5233

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include "../../../../includes/guides/account-configurations/notification-settings.md" %}
26 changes: 26 additions & 0 deletions en/asgardeo/docs/guides/authentication/saml/saml-sso-resident.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Configure SAML Web SSO for your organization

This guide explains how to configure **SAML Web Single Sign-On (SSO)** settings for your organization using the **Login & Registration** section in the Console. These settings apply at the tenant level and control how your organization behaves as a SAML Identity Provider (IdP) during authentication flows.

!!! Note
These settings are applicable when your organization is acting as an IdP and issuing SAML responses to service providers.

## SAML2 configurations

1. To configure SAML2 configurations:

1. In the Console, go to **Login & Registration** from the left navigation menu.
2. Scroll down to **Single Sign-On (SSO) Settings**.
3. Click on **SAML2 Web SSO Configuration** and confgure.

<img src="{{base_path}}/assets/img/guides/authentication/saml2-web-sso-resident.png" width="600" alt="SAML2 Web SSO configurations"/>

The following fields are currently configurable via the Console:

| Field | Description | Sample/Default Value |
|--------------------------|-----------------------------------------------------------------------------|----------------------|
| **Enable Metadata Signing** | This facilitates enabling or disabling metadata signing. | `false` |
| **Metadata Validity Period** | The duration (in minutes) for which the metadata will remain valid before it should be refreshed. | `60` |

!!! Note
You can download the SAML2 metadata by accessing the URL: `https://api.asgardeo.io/t/<org_name>/identity/metadata/saml2`
2 changes: 2 additions & 0 deletions en/asgardeo/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,7 @@ nav:
- Configure SAML flows:
- Configure SAML flows: guides/authentication/saml/index.md
- Discover SAML endpoints and settings: guides/authentication/saml/discover-saml-configs.md
- Configure SAML Web SSO for your organization: guides/authentication/saml/saml-sso-resident.md
- Configure Just-in-Time user provisioning: guides/authentication/jit-user-provisioning.md
- Authorization:
- Authorization: guides/authorization/index.md
Expand Down Expand Up @@ -353,6 +354,7 @@ nav:
- Configure username validation: guides/account-configurations/account-login/username-validation.md
- Configure alternative login identifiers: guides/user-accounts/account-login/configure-login-identifiers.md
- Account disabling: guides/account-configurations/account-disabling.md
- Notification settings: guides/account-configurations/notification-settings.md
- User self-service:
- User self-service: guides/user-self-service/index.md
- Self-service portal:
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
@@ -0,0 +1,26 @@
# Configure SAML Web SSO for your organization

This guide explains how to configure **SAML Web Single Sign-On (SSO)** settings for your organization using the **Login & Registration** section in the Console. These settings apply at the tenant level and control how your organization behaves as a SAML Identity Provider (IdP) during authentication flows.

!!! Note
These settings are applicable when your organization is acting as an IdP and issuing SAML responses to service providers.

## SAML2 configurations

1. To configure SAML2 configurations:

1. In the Console, go to **Login & Registration** from the left navigation menu.
2. Scroll down to **Single Sign-On (SSO) Settings**.
3. Click on **SAML2 Web SSO Configuration** and confgure.

<img src="{{base_path}}/assets/img/guides/authentication/saml2-web-sso-resident.png" width="600" alt="SAML2 Web SSO configurations"/>

The following fields are currently configurable via the Console:

| Field | Description | Sample/Default Value |
|--------------------------|-----------------------------------------------------------------------------|----------------------|
| **Metadata Validity Period** | The duration (in minutes) for which the metadata will remain valid before it should be refreshed. | `60` |
| **Enable Metadata Signing** | This facilitates enabling or disabling metadata signing. | `false` |

!!! Note
You can download the SAML2 metadata by starting the server and downloading the SAML2 metadata by accessing this URL: `https://localhost:9443/identity/metadata/saml2`.
1 change: 1 addition & 0 deletions en/identity-server/next/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -565,6 +565,7 @@ nav:
- Configure SAML flows: guides/authentication/saml/index.md
- Discover SAML endpoints and settings: guides/authentication/saml/discover-saml-configs.md
- Implement SAML federated IdP-initiated SSO: guides/authentication/saml/saml-federated-idp-initiated-sso.md
- Configure SAML Web SSO for your organization: guides/authentication/saml/saml-sso-resident.md
- Authorization:
- Authorization: guides/authorization/index.md
- API authorization:
Expand Down
6 changes: 5 additions & 1 deletion en/includes/guides/account-configurations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,8 @@ Provide users with options to recover their access credentials, ensuring they ca
Enable additional options for managing user accounts.

- [Account disabling]({{base_path}}/guides/account-configurations/account-disabling/)
{% endif %}
{% endif %}

## Notification settings

Learn how to implement advanced notification handling in [Notification settings]({{base_path}}/guides/account-configurations/notification-settings/).