Skip to content

Commit 45ce26c

Browse files
charIeszhaocharIeszhao
authored
docs: add sso and idp docs (#668)
* feat: script to pull readme * chore: update content * docs: add sso and idp docs * docs: add entra id oidc sso guide
1 parent fba98c0 commit 45ce26c

File tree

11 files changed

+185
-16
lines changed

11 files changed

+185
-16
lines changed

‎docs/docs/recipes/logto-as-idp/configure-3rd-party-app-in-console.mdx

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
import ClientCredentials from './assets/client-credentials.webp';
2+
import DiscoveryEndpoint from './assets/discovery-endpoint.webp';
3+
import EndpointDetails from './assets/endpoint-details.webp';
4+
import RedirectUri from './assets/redirect-uri.webp';
5+
6+
## Create an third-party OIDC application in Logto
7+
8+
Just like how you create a first-party application in Logto, you can also create an application for third-party services that support OIDC. This application will act as an IdP for your third-party applications.
9+
10+
1. Go to the **Logto Console** and navigate to the **Applications** page.
11+
12+
2. Select "Third-party app -> OIDC" as the application type.
13+
14+
If this is the first time you create an application, click on the **view all** link to see all application types.
15+
![application list](./assets/application-list.webp)
16+
17+
Otherwise, click on the **create application** button on the top right corner of the page and select "Third-party app -> OIDC" as the application type.
18+
![create application](./assets/create-application.webp)
19+
20+
3. Just like creating a Logto first-party application, enter a **name** and **description** for your application and click on the **create** button. A new third-party OIDC application will be created.
21+
22+
![application details](./assets/application-details.webp)
23+
24+
## Setup the OIDC configurations
25+
26+
In order to set up Logto as an IdP for your third-party applications, you need to configure the OIDC settings under the application details page.
27+
28+
1. Provide the **redirect URI** of your third-party application. This is the URL that the third-party application will redirect users to after they are authenticated by Logto. You can usually find this information in the third-party application's IdP connection settings page.
29+
30+
:::note
31+
Logto supports multiple redirect URIs. You can add more redirect URIs by clicking on the **Add another** button.
32+
:::
33+
34+
<img src={RedirectUri} alt="redirect uri" width={500} />
35+
36+
2. Retrieve the **client ID** and **client secret** from Logto application details page and enter them into your service provider's IdP connection settings page.
37+
38+
<img src={ClientCredentials} alt="client credentials" width={500} />
39+
40+
3. Retrieve the **authorization endpoint** and **token endpoint** from Logto application details page and provide them to your service provider.
41+
42+
If your service provider supports OIDC discovery, you can simply copy the **discovery endpoint** from Logto application details page and provide it to your service provider. The service provider will be able to retrieve all the up to date OIDC authentication information from the discovery endpoint automatically.
43+
44+
<img src={DiscoveryEndpoint} alt="discovery endpoint" width={500} />
45+
46+
Otherwise, click on the **show endpoint details** button to view all the OIDC authentication endpoints.
47+
48+
<img src={EndpointDetails} alt="endpoint details" width={500} />
49+
50+
## Manage your third-party applications
51+
52+
All third-party applications will be catalogued on the **Applications** page, specifically under the **Third-party apps** tab. This arrangement distinguishes them from first-party applications for you, ensuring easy management.
53+
54+
![third-party apps](./assets/third-party-apps.webp)

‎docs/docs/recipes/single-sign-on/configure-sso/entra-id-oidc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import endpoints from './assets/entra_id_oidc_endpoints.webp';
1111

1212
# Configure Microsoft Entra ID (Azure AD) OIDC SSO
1313

14+
With minimal configuration efforts, this connector allows integration with Microsoft Entra ID (formerly Azure AD) for enterprise SSO.
15+
1416
## Step 1: Create an Microsoft EntraID OIDC application
1517

1618
1. Go to the [Microsoft Entra admin center](https://entra.microsoft.com/) and sign in as an administrator.

‎docs/integrations/fragments/_sso_guide_tip.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:::tip
2+
3+
- For more information about SSO and how to configure SSO in Logto, please check out the [Enterprise SSO (SAML & OIDC)](/docs/recipes/single-sign-on/) documentation to get started.
4+
5+
:::

‎docs/integrations/sso/entra-id-oidc/README.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
slug: /integrations/entra-id-oidc
3+
sidebar_label: Microsoft Entra ID (OIDC)
4+
sidebar_custom_props:
5+
description: Formerly Azure AD, a comprehensive cloud-based identity management service.
6+
logoFilename: 'entra-id.svg'
7+
---
8+
9+
import Content from '../../../docs/recipes/single-sign-on/configure-sso/entra-id-oidc.md';
10+
import GuideTip from '../../fragments/_sso_guide_tip.mdx';
11+
12+
# Microsoft Entra ID (OIDC)
13+
14+
<GuideTip />
15+
16+
<Content />

‎docs/integrations/sso/entra-id-saml/README.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
slug: /integrations/entra-id-saml
3+
sidebar_label: Microsoft Entra ID (SAML)
4+
sidebar_custom_props:
5+
description: Formerly Azure AD, a comprehensive cloud-based identity management service.
6+
logoFilename: 'entra-id.svg'
7+
---
8+
9+
import Content from '../../../docs/recipes/single-sign-on/configure-sso/azure-ad.md';
10+
import GuideTip from '../../fragments/_sso_guide_tip.mdx';
11+
12+
# Microsoft Entra ID (SAML)
13+
14+
<GuideTip />
15+
16+
<Content />

‎docs/integrations/sso/google-workspace/README.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
slug: /integrations/google-workspace
3+
sidebar_label: Google Workspace
4+
sidebar_custom_props:
5+
description: Unified and secure management of user access within the Google ecosystem.
6+
logoFilename: 'google.svg'
7+
---
8+
9+
import Content from '../../../docs/recipes/single-sign-on/configure-sso/google-workspace.md';
10+
import GuideTip from '../../fragments/_sso_guide_tip.mdx';
11+
12+
# Google Workspace
13+
14+
<GuideTip />
15+
16+
<Content />

‎docs/integrations/sso/oidc/README.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
slug: /integrations/oidc-sso
3+
sidebar_label: OIDC (Enterprise)
4+
sidebar_custom_props:
5+
description: Modern protocol built on OAuth 2.0 for identity verification in web and mobile apps.
6+
logoFilename: 'oidc.svg'
7+
---
8+
9+
import Content from '../../../docs/recipes/single-sign-on/configure-sso/oidc.md';
10+
import GuideTip from '../../fragments/_sso_guide_tip.mdx';
11+
12+
# OIDC enterprise SSO
13+
14+
<GuideTip />
15+
16+
<Content />

‎docs/integrations/sso/okta/README.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
slug: /integrations/okta
3+
sidebar_label: Okta
4+
sidebar_custom_props:
5+
description: Centralizes identity management for customers, employees, and partners.
6+
---
7+
8+
import Content from '../../../docs/recipes/single-sign-on/configure-sso/okta.md';
9+
import GuideTip from '../../fragments/_sso_guide_tip.mdx';
10+
11+
# Okta enterprise SSO
12+
13+
<GuideTip />
14+
15+
<Content />

‎docs/integrations/sso/saml/README.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
slug: /integrations/saml-sso
3+
sidebar_label: SAML (Enterprise)
4+
sidebar_custom_props:
5+
description: XML-based open standard for web single sign-on and identity federation.
6+
logoFilename: 'saml.svg'
7+
---
8+
9+
import Content from '../../../docs/recipes/single-sign-on/configure-sso/saml.md';
10+
import GuideTip from '../../fragments/_sso_guide_tip.mdx';
11+
12+
# SAML Enterprise SSO
13+
14+
<GuideTip />
15+
16+
<Content />

‎docs/integrations/third-party/oidc/README.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
slug: /integrations/third-party-oidc
3+
sidebar_label: OIDC (Third-party app)
4+
sidebar_custom_props:
5+
description: Use Logto as a third-party OIDC identity provider (IdP) for your application.
6+
logoFilename: 'oidc.svg'
7+
---
8+
9+
import Content from '../../../docs/recipes/logto-as-idp/configure-3rd-party-app-in-console.mdx';
10+
11+
# Logto as an Identity Provider (IdP)
12+
13+
<Content />

‎sidebars.js

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -85,22 +85,22 @@ const sidebars = {
8585
className: 'sidebar-section',
8686
},
8787
{ type: 'autogenerated', dirName: 'integrations/sms' },
88-
// {
89-
// type: 'link',
90-
// label: 'Enterprise connectors',
91-
// customProps: { additionalLabel: '(SP-initiated SSO)' },
92-
// href: '#',
93-
// className: 'sidebar-section',
94-
// },
95-
// { type: 'autogenerated', dirName: 'integrations/sso' },
96-
// {
97-
// type: 'link',
98-
// label: 'Third-party apps',
99-
// customProps: { additionalLabel: '(Logto as Idp)' },
100-
// href: '#',
101-
// className: 'sidebar-section',
102-
// },
103-
// { type: 'autogenerated', dirName: 'integrations/third-party' },
88+
{
89+
type: 'link',
90+
label: 'Enterprise connectors',
91+
customProps: { additionalLabel: '(SP-initiated SSO)' },
92+
href: '#',
93+
className: 'sidebar-section',
94+
},
95+
{ type: 'autogenerated', dirName: 'integrations/sso' },
96+
{
97+
type: 'link',
98+
label: 'Third-party apps',
99+
customProps: { additionalLabel: '(Logto as Idp)' },
100+
href: '#',
101+
className: 'sidebar-section',
102+
},
103+
{ type: 'autogenerated', dirName: 'integrations/third-party' },
104104
],
105105

106106
// But you can create a sidebar manually

0 commit comments

Comments
 (0)