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

Conversation

Yasasr1
Copy link
Contributor

@Yasasr1 Yasasr1 commented Dec 9, 2024

Purpose

This pr introduces the following changes

Updated the existing email domain based organization discovery docs to add the email domain based organization discovery for self-registration feature.
Screenshot 2024-12-09 at 3 35 17 PM

Updated the organization discovery configuration management API docs to add the new PUT endpoint
Screenshot 2024-12-09 at 3 34 55 PM

Related issue

Comment on lines 151 to 164
$ref: '#/components/schemas/Properties'
Properties:
required:
- key
- value
type: object
properties:
key:
type: string
example: emailDomain.enable
value:
type: string
example: true

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this was removed? better to keep this consistent with api-server yaml

@@ -27,8 +27,9 @@ 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explain what will happen when toggle is enabled

3. Turn on the toggle to enable email domain based organization discovery.
4. Select the **Email domain discovery for self-registration** checkbox if you want to allow users to discover and self-register in sub-organizations based on their email domain.

![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;"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update Asgrdeo image as well because of title change right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants