-
Notifications
You must be signed in to change notification settings - Fork 316
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
Update docs for email domain based organization discovery for self-registration. #4923
Open
Yasasr1
wants to merge
2
commits into
wso2:master
Choose a base branch
from
Yasasr1:org-discovery
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+79
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file modified
BIN
+8.44 KB
(100%)
...cs/assets/img/guides/organization/manage-organizations/assign-email-domains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-29.2 KB
(85%)
...docs/assets/img/guides/organization/manage-organizations/edit-email-domains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+16.2 KB
(120%)
...ation/manage-organizations/enable-email-domain-based-organization-discovery.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
+4.88 KB
(100%)
...cs/assets/img/guides/organization/manage-organizations/assign-email-domains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+26.8 KB
(110%)
...docs/assets/img/guides/organization/manage-organizations/edit-email-domains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+33.1 KB
(140%)
...ation/manage-organizations/enable-email-domain-based-organization-discovery.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,9 +27,33 @@ and user Bob and Ben, with emails `[email protected]` and `[email protected]` should be | |
### Using the Console | ||
|
||
1. Login to the organization (root) from the {{ product_name }} Console. | ||
2. On the {{ product_name }} Console, go to **Login & Registration**, and click **Email Domain Discovery** under **Organization Settings**. | ||
2. On the {{ product_name }} Console, go to **Login & Registration**, and click **Organization Discovery** under **Organization Settings**. | ||
3. Turn on the toggle to enable email domain based organization discovery. | ||
Yasasr1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
!!! note | ||
When this is enabled, following restrctions will apply to child organizations during federated authentication and user onboarding. | ||
|
||
- Users can self-register, and administrators can onboard users to child organizations, only if the users' email domains match the domains mapped to the corresponding child organization. | ||
|
||
{% if (product_name == "WSO2 Identity Server") %} | ||
|
||
- Federated authentication and Just-In-Time (JIT) provisioning for child organizations are restricted to email domains mapped to those child organizations. | ||
|
||
{% endif %} | ||
{% if (product_name == "WSO2 Identity Server") %} | ||
|
||
4. Select the **Email domain discovery for self-registration** checkbox if you want to allow users to discover and self-register in child organizations based on their email domain. | ||
|
||
Yasasr1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
!!! note | ||
To use this capability, self-registration must be enabled in the child organizations. Currently, enabling self-registration for child organizations via the console is not supported. Instead, you need to add the following configuration to the `deployment.toml` file located in the `<IS_HOME>/repository/conf` directory to enable self-registration server-wide. | ||
|
||
``` | ||
[identity_mgt.user_self_registration] | ||
allow_self_registration = true | ||
``` | ||
|
||
{% endif %} | ||
|
||
![Enable email domain based organization discovery]({{base_path}}/assets/img/guides/organization/manage-organizations/enable-email-domain-based-organization-discovery.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
Yasasr1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Using the API | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This API needs to be added to Asgardeo API docs as well right?
May be we can change the sample in Asgardeo API