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

Update docs for email domain based organization discovery for self-registration. #4923

Open
wants to merge 2 commits 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.
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,55 @@ paths:
]
}'
x-codegen-request-body-name: body
put:
tags:
- Discovery
summary: Update organization discovery configuration.
description: |
This API provides the capability to update discovery configuration of the primary organization. <br>

<b>Scope(Permission) required:</b> `internal_organization_config_update`
Comment on lines +94 to +101
Copy link
Contributor

@AnuradhaSK AnuradhaSK Dec 17, 2024

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

operationId: updateDiscoveryConfig
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/ServerError'
x-codeSamples:
- lang: Curl
source: |
curl --location --request PUT 'https://localhost:9443/api/server/v1/organization-configs/discovery' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic YWRtaW46YWRtaW4=' \
-d '{
"properties": [
{
"key": "emailDomain.enable",
"value": true
},
{
"key": "emailDomainBasedSelfSignup.enable",
"value": false
}
]
}'
x-codegen-request-body-name: body
delete:
tags:
- Discovery
Expand Down Expand Up @@ -149,6 +198,11 @@ components:
type: array
items:
$ref: '#/components/schemas/Properties'
example:
- key: emailDomain.enable
value: true
- key: emailDomainBasedSelfSignup.enable
value: false
Properties:
required:
- key
Expand All @@ -161,7 +215,6 @@ components:
value:
type: string
example: true

responses:
BadRequest:
description: Invalid input in the request.
Expand Down
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
Expand Up @@ -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
Expand Down