-
Notifications
You must be signed in to change notification settings - Fork 41
Feat/sso via portal #542
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
clairekinde11
wants to merge
18
commits into
main
Choose a base branch
from
Feat/SSO-via-portal
base: main
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.
+223
−0
Open
Feat/sso via portal #542
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
cd2d6d5
New topic: Add SSO connection from portal
clairekinde11 2351219
Update sidebarData.ts
clairekinde11 79d18ed
New topic
clairekinde11 8b41f28
Side bar order
clairekinde11 ecba578
New topic draft
clairekinde11 5762f37
typo
clairekinde11 8a37814
Edit
clairekinde11 64f8808
New topic
clairekinde11 4426679
Update manage-self-serve-connections.mdx
clairekinde11 bd907f3
Update sidebarData.ts
clairekinde11 8f2c1e9
Update manage-self-serve-connections.mdx
clairekinde11 bac38fc
Update add-sso-self-serve.mdx
clairekinde11 1314450
Added activating advanced org in procedure
clairekinde11 19a28f1
Update add-sso-self-serve.mdx
clairekinde11 1e3e75a
Update to separate customer and founder settings.
clairekinde11 fc1bbc5
Update add-sso-self-serve.mdx
clairekinde11 a4618ae
Link fix
clairekinde11 775de82
Apply suggestion from @coderabbitai[bot]
clairekinde11 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
102 changes: 102 additions & 0 deletions
102
src/content/docs/authenticate/self-serve-sso/add-sso-self-serve.mdx
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,102 @@ | ||
--- | ||
page_id: ab20745f-0918-403a-8103-fc5749082dba | ||
title: Add SSO connection via self-serve portal | ||
description: Guide for enabling a business customer to set up their own SSO enterprise connection via the self-serve portal. | ||
sidebar: | ||
order: 1 | ||
relatedArticles: | ||
- a2668524-5842-4c68-ab50-30b7e8c3e842 | ||
- f36bce4a-52bb-4785-865b-6b33356f9838 | ||
topics: | ||
- self-serve-portal | ||
- organizations | ||
- billing | ||
sdk: | ||
- react | ||
languages: | ||
- javascript | ||
- jsx | ||
audience: developers | ||
complexity: intermediate | ||
keywords: | ||
- organization portal | ||
- enterprise connection | ||
- SSO | ||
- self-serve portal | ||
updated: 2025-08-25 | ||
featured: false | ||
deprecated: false | ||
ai_summary: Guide for enabling a business customer to set up their own SSO enterprise connection via the self-serve portal. | ||
--- | ||
|
||
<Aside type="upgrade"> | ||
|
||
This feature is only available on the [Kinde Scale plan](https://kinde.com/pricing/) | ||
|
||
</Aside> | ||
|
||
Your business customers who have their own organizations in Kinde can set up and manage their own SSO connections. This can save time going back and forth trying to get app credentials configured. Instead, your customer (who is the Identity Provider for their users) can set up an app and use the credentials to configure a connection. While you manage Kinde settings as the Service Provider. | ||
|
||
## Before an organization can set up an SSO connection | ||
|
||
- Ensure that you have switched on the option in the [self-serve portal settings](/build/self-service-portal/self-serve-portal-for-orgs/) | ||
- Check that the person setting up the connection has the [right role and permissions](/manage-users/roles-and-permissions/user-roles/). They need to be an Admin. | ||
- Add a domain to the verified domains list for the org (see below). Connections can only be set up for verified domains. | ||
|
||
clairekinde11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Add a verified domain to the customer organization in Kinde | ||
|
||
This is like pre-setting the home realm domain for a connection. | ||
|
||
1. Open the organization record in Kinde. | ||
2. If prompted, in the **Activate advanced organization features** box, select **Activate**. | ||
3. Go to **Policies** in the menu. | ||
4. In the **Verified domains** text field, add the customer's domain or domains. Add each on a new line. Make sure you include only the domain, e.g. `mybusiness.com` and not the full domain URL such as `http://www.mybusiness.com`. | ||
5. Select **Save**. | ||
|
||
## Add an SSO connection via the self-serve portal (Instructions for end-users) | ||
|
||
Provide these instructions to the customer in case they need assistance. | ||
|
||
1. Navigate to the self-serve portal and select **SSO**. | ||
2. Select **Add connection**. | ||
3. Select the connection type and then select **Next**. The configuration dialog opens. | ||
4. Add a name for the connection - this name will be shown to end users when they sign in. | ||
5. Complete the other fields with details from your IdP, e.g. **Entity ID**, provisioning options, mapping, certificates, etc. | ||
6. Copy the **ACS URL** - you will need to add this to your IdP application. | ||
7. Select **Save**. | ||
|
||
## Finish setting up the connection for the organization (Instructions for Kinde admin) | ||
|
||
There are some enterprise connection functions that are only configurable by you in Kinde. After the customer has entered their details, you can finish setting up the connection. | ||
|
||
Open the connection in Kinde and adjust any of the following settings (if relevant): | ||
- **Create a user record in Kinde** - Add users if they do not exist when signing in. This is switched on by default. | ||
- **Always show sign-in button** - Show the SSO button on the app home screen. This is switched on by default. | ||
- **Auto-add users** - Allows users to join the organization if their credentials are accepted. Default is switched on. | ||
- **Upstream params** - these have the following default, but more can be added at the customer's request. | ||
```txt | ||
{ | ||
"login_hint": { | ||
"alias": "login_hint" | ||
} | ||
} | ||
``` | ||
|
||
## Make the connection available to end-users | ||
|
||
This is the process for end-users to make the connection live. It can also be enabled in the Kinde admin. | ||
|
||
1. Open the connection configuration dialog via the self-service portal (end users). | ||
2. Select the **Enable for organization** option. | ||
3. Select **Save**. | ||
|
||
## Enable or disable a connection | ||
|
||
1. Navigate to the self-serve portal and select **SSO**. | ||
2. Select the three dots menu on the connection card, and choose **Enable** or **Disable**. | ||
|
||
## Delete a connection | ||
|
||
1. Navigate to the self-serve portal and select **SSO**. | ||
2. Select the three dots menu on the connection card, and choose **Delete**. | ||
3. Confirm that you want to delete the connection. |
72 changes: 72 additions & 0 deletions
72
src/content/docs/authenticate/self-serve-sso/manage-self-serve-connections.mdx
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
page_id: 6bfab126-8887-4030-97aa-f44335fe489d | ||
title: Manage SSO connections added by customers | ||
description: This is a support topic for when a business customer sets up their own SSO enterprise connection via the self-serve portal. | ||
sidebar: | ||
order: 2 | ||
relatedArticles: | ||
- ab20745f-0918-403a-8103-fc5749082dba | ||
- a2668524-5842-4c68-ab50-30b7e8c3e842 | ||
- f36bce4a-52bb-4785-865b-6b33356f9838 | ||
topics: | ||
- self-serve-portal | ||
- organizations | ||
- billing | ||
sdk: | ||
- react | ||
languages: | ||
- javascript | ||
- jsx | ||
audience: developers | ||
complexity: intermediate | ||
keywords: | ||
- organization portal | ||
- enterprise connection | ||
- SSO | ||
- self-serve portal | ||
updated: 2025-08-25 | ||
featured: false | ||
deprecated: false | ||
ai_summary: This is a support topic for when a business customer sets up their own SSO enterprise connection via the self-serve portal. | ||
--- | ||
|
||
If you allow your business customers to set up and manage their own SSO enterprise connections in your app, this topic describes how to help manage and troubleshoot the connections. | ||
|
||
Self-serve portal connections for accessing your site or app are fully under your control. Even though your customer can do the basic configuration, there are some things you'll probably want to manage on your side, such as provisioning behavior and other connection defaults. | ||
|
||
## Troubleshoot self-serve SSO connections | ||
|
||
If a customer can't sign in using the SSO connection they set up, check these things. | ||
|
||
- They have added the ACS URL to the application on their identity provider side | ||
- They have a verified domain (home realm domain) selected in the configuration | ||
- The email they are trying to test belongs to the verified domain | ||
- The credentials and certificates are all valid | ||
- The connection is enabled and is being accessed in the relevant environment | ||
- The org code is being passed when a user goes to sign in | ||
- If there are any issues with upstream params being parsed | ||
- All required fields are included in the configuration, including key attributes (if relevant) | ||
|
||
## How to access and manage enterprise connections created by your customers | ||
|
||
1. Open the organization for the customer. | ||
2. In the left menu, select **Authentication**. The customer's connections are shown. | ||
3. Select the three dots on the connection, and select **Configure**. | ||
4. In the connection configuration window, make the changes you want, and select **Save**. | ||
|
||
## Enable or disable a connection | ||
|
||
You might need to disable a connection if you think it has been compromised or at the customer's request. | ||
|
||
1. Open the organization for the customer. | ||
2. In the left menu, select **Authentication**. The customer's connections are shown. | ||
3. Select the three dots menu on the connection card, and choose **Enable** or **Disable**. | ||
|
||
## Delete a connection | ||
|
||
This completely disables and deletes the connection. This action can't be reversed. | ||
|
||
1. Open the organization for the customer. | ||
2. In the left menu, select **Authentication**. The customer's connections are shown. | ||
3. Select the three dots menu on the connection card, and choose **Delete**. | ||
4. Confirm that you want to delete the connection. |
44 changes: 44 additions & 0 deletions
44
src/content/docs/authenticate/self-serve-sso/self-manage-sso-per-org.mdx
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
page_id: 2a54764d-eb85-4905-8098-9c4e7a5073d7 | ||
title: Switch on SSO self-management per organization | ||
description: Set up access to the self-serve portal SSO function at the org-level | ||
sidebar: | ||
order: 3 | ||
relatedArticles: | ||
- a2668524-5842-4c68-ab50-30b7e8c3e842 | ||
- f36bce4a-52bb-4785-865b-6b33356f9838 | ||
topics: | ||
- self-serve-portal | ||
- organizations | ||
- enterprise SSO | ||
sdk: | ||
- react | ||
languages: | ||
- javascript | ||
- jsx | ||
audience: developers | ||
complexity: intermediate | ||
keywords: | ||
- organization portal | ||
- enterprise connection | ||
- SSO | ||
- self-serve portal | ||
updated: 2025-08-25 | ||
featured: false | ||
deprecated: false | ||
ai_summary: Set up access to the self-serve portal SSO function at the org-level | ||
--- | ||
|
||
<Aside type="upgrade"> | ||
|
||
This feature is only available on the [Kinde Scale plan](https://kinde.com/pricing/) | ||
|
||
</Aside> | ||
|
||
You can give specific permission for an organization to set up and manage SSO connections, without giving it to all organizations in your business. | ||
|
||
1. In Kinde, open the organization you want to give access. | ||
2. In the side menu, select **Self-serve portal**. | ||
3. Switch on the SSO function. | ||
4. Select **Save**. | ||
|
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.