feat: Dev Portal SSO one pager #7633

cloudjumpercat · 2024-07-11T19:53:56Z

Description

Dev Portal SSO info for the supported IdPs is scattered or missing. This PR attempts to bring all the content together on one page with tabs for the IdPs.
Adding in Auth0 SSO information from feat(portal): add guide for configuring Auth0 SSO for dev portal #7612
Azure SSO info already exists, so converting that page to the SSO one pager
pulling Okta information from the org SSO page

Testing instructions

Preview link: https://deploy-preview-7633--kongdocs.netlify.app/konnect/dev-portal/access-and-approval/sso/

Checklist

Review label added
Conditional version tags added, if applicable.

…d Auth0 SSO content, start outlining Okta content Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

netlify · 2024-07-11T19:54:15Z

✅ Deploy Preview for kongdocs ready!

Name	Link
🔨 Latest commit	`06ec83c`
🔍 Latest deploy log	https://app.netlify.com/sites/kongdocs/deploys/66bd1c4df112c70008760393
😎 Deploy Preview	https://deploy-preview-7633--kongdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	9 paths audited Performance: 92 (🟢 up 3 from production) Accessibility: 92 (no change from production) Best Practices: 98 (🟢 up 8 from production) SEO: 91 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

…ommendations, reformat some content, add Auth0 values to the SSO table Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Mierenga

This is a very nice format update, thank you!

Mierenga · 2024-07-11T21:21:12Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+You can configure single sign-on (SSO) for {{site.konnect_short_name}} Dev Portal with OIDC. This allows developers to log in to Dev Portals by using their SSO credentials. 
+
+<!--Do developers get auto approved in Dev Portal then?-->


Developers do get auto-approved by Konnect when using SSO. This is because we outsource the approval process to the IDP instance when using SSO. Meaning it is possible to restrict who can sign up via the IDP rather than through Konnect.

Mierenga · 2024-07-11T21:23:55Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+<!--Do developers get auto approved in Dev Portal then?-->
+
+<!-- would we recommend SSO instead of adding developers and teams from IdPs if we don't want to map team? Or would we maybe recommend both (one to create/map devs and the other to let them log in to Dev Portal)-->


SSO and IDP team mappings must come from the same IDP instance

Mierenga · 2024-07-11T21:24:34Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+<!-- would we recommend SSO instead of adding developers and teams from IdPs if we don't want to map team? Or would we maybe recommend both (one to create/map devs and the other to let them log in to Dev Portal)-->
+
+<!-- should we add a note that this SSO is different than the one for Konnect? As in, if they want to use SSO for logging in to Konnect, they still need to configure that separately?-->


👍 That could be a good note with a link to the configuring in Konnect. Also could be good to note that each Dev Portal has a separate SSO configuration. They can use the same IDP for multiple portals or different IDPs per portal.

Mierenga · 2024-07-11T21:28:25Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+## Prerequisites
+
+* Ensure that any users that need to use the Dev Portal SSO have been added to the **User Management > Users** section of your Auth0 tenant


Suggested change

* Ensure that any users that need to use the Dev Portal SSO have been added to the **User Management > Users** section of your Auth0 tenant

* Ensure that any user emails that need to use the Dev Portal SSO have been added as users in your IDP instance

Mierenga · 2024-07-11T21:29:18Z

app/konnect/dev-portal/access-and-approval/sso.md

+## Prerequisites
+
+* Ensure that any users that need to use the Dev Portal SSO have been added to the **User Management > Users** section of your Auth0 tenant
+* An application for {{site.konnect_short_name}} configured in your IdP:


Note that other IDPs are able to be used if they follow the OIDC standard for SSO. Those listed are the most common

Mierenga · 2024-07-11T21:30:35Z

app/konnect/dev-portal/access-and-approval/sso.md

+## Configure Login Action in Auth0
+
+   {:.note}
+   > **Important:** This section is required due to the Auth0 API implementation not being inline with the OIDC standard for the value of the `updated_at` token claim.


Looks like this notice got combined with the next list item since there is no newline between

Suggested change

> **Important:** This section is required due to the Auth0 API implementation not being inline with the OIDC standard for the value of the `updated_at` token claim.

> **Important:** This section is required due to the Auth0 API implementation not being inline with the OIDC standard for the value of the `updated_at` token claim.

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

cloudjumpercat · 2024-07-18T20:53:56Z

@Mierenga Thanks for the feedback! I made a bunch of changes and cleaned up some of the text, could you review again for technical accuracy? Thanks!

cloudjumpercat · 2024-07-18T21:09:57Z

@c3pko Hi! If you have time, could you look over the revised Dev Portal SSO one pager and let me know what you think? Thanks!

Guaris

The Azure instructions threw me off because I feel like the Azure documentation is not as clear as the other providers and the links made me confused. Specifically the transition between a clear action-oriented step in the Kong docs, to a wall of text in the Azure docs.

Guaris · 2024-08-02T18:21:51Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+1. In [Azure](https://portal.azure.com/), [create an application](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) for {{site.konnect_short_name}}. 
+
+1. Enter the Dev Portal [Redirect URI](/konnect/dev-portal/access/) for the **Redirect URI**. 


Redirect URI here just links to: https://deploy-preview-7633--kongdocs.netlify.app/konnect/dev-portal/

app/konnect/dev-portal/access-and-approval/sso.md

Guaris · 2024-08-02T18:25:45Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+1. Enter the Dev Portal [Redirect URI](/konnect/dev-portal/access/) for the **Redirect URI**. 
+
+1. [Create a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=client-secret) and save the secret value to configure {{site.konnect_short_name}}.


Suggested change

1. [Create a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=client-secret) and save the secret value to configure {{site.konnect_short_name}}.

1. [Create a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=client-secret) and save the secret value to configure {{site.konnect_short_name}}.

This doesn't link me to the create a client secret tab, and so instead it just opens the same link from the first step. That feels confusing to me.

Guaris · 2024-08-02T18:32:46Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+## Configure an application and group claims in your IdP
+{% navtabs %}
+{% navtab Azure %}


The firs three steps of the Azure instructions feel confusing because of the links.
If you want to take this approach, i think it might be better to combine the first three steps into one.

Like you did with the Okta tab.

Guaris · 2024-08-02T18:37:12Z

app/konnect/dev-portal/access-and-approval/sso.md

+1. [Configure an optional claim](https://learn.microsoft.com/en-us/entra/identity-platform/optional-claims?tabs=appui#configure-optional-claims-in-your-application) with **ID** as the token type and **email** as the claim.
+
+{% endnavtab %}
+{% navtab Okta %}


This section works a lot better, I think the microsoft docs just are too messy.

Guaris · 2024-08-02T18:37:36Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+1. [Add users to the application](https://help.okta.com/en-us/content/topics/users-groups-profiles/usgp-assign-apps.htm).
+
+1. [Test ID token claims](https://developer.okta.com/docs/guides/customize-authz-server/main/#create-claims) and find groups for mapping. Configure the following claims settings:


Is this the right link?

app/konnect/dev-portal/access-and-approval/sso.md

Guaris · 2024-08-02T18:42:48Z

app/konnect/dev-portal/access-and-approval/sso.md

+   {:.note}
+   > **Important:** This section is required because the Auth0 API implementation isn't inline with the OIDC standard for the `updated_at` token claim value.
+
+1. Deploy the action by dragging it from the Start to Complete step in the [Login Flow](https://auth0.com/docs/customize/actions/flows-and-triggers/login-flow).


Should it be this link?
https://auth0.com/docs/customize/actions/write-your-first-action#deploy-the-action

Co-authored-by: Angel <Guaris@users.noreply.github.com>

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Guaris · 2024-08-14T21:01:23Z

app/konnect/dev-portal/access-and-approval/sso.md

+
+## Configure SSO in {{site.konnect_short_name}}
+
+From the [{{site.konnect_short_name}} portal identity page](https://cloud.konghq.com/portal/portal-settings#identity), click **Configure provider** for **OIDC**, and enter the values from your IdP application.


This link takes me to the portal settings page, then I have to click identity.

app/konnect/dev-portal/access-and-approval/sso.md

Rename current Azure SSO page to a general SSO page, add redirect, ad…

1d90f12

…d Auth0 SSO content, start outlining Okta content Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

cloudjumpercat added the review:sme Request for SME review, external to the docs team. label Jul 11, 2024

cloudjumpercat mentioned this pull request Jul 11, 2024

feat(portal): add guide for configuring Auth0 SSO for dev portal #7612

Closed

2 tasks

Rework Azure instructions to be in line with our third party docs rec…

70e97a7

…ommendations, reformat some content, add Auth0 values to the SSO table Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Mierenga reviewed Jul 11, 2024

View reviewed changes

cloudjumpercat added 4 commits July 17, 2024 16:12

Apply some feedback, revise Okta section, start revising Auth0

adfd888

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Finish revising the Auth0 instructions

71992a6

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Appease Vale

8b82a8d

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Adjust intro paragraph

24d5ce1

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

cloudjumpercat requested a review from Mierenga July 18, 2024 20:53

cloudjumpercat marked this pull request as ready for review July 18, 2024 21:09

cloudjumpercat requested a review from a team as a code owner July 18, 2024 21:09

cloudjumpercat added the review:copyedit Request for writer review. label Jul 18, 2024

Guaris requested changes Aug 2, 2024

View reviewed changes

cloudjumpercat and others added 3 commits August 14, 2024 14:23

Apply suggestions from code review

78edacc

Co-authored-by: Angel <Guaris@users.noreply.github.com>

apply additional feedback

ce8cd17

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Merge branch 'main' into feat/dev-portal-sso

0d81dde

Guaris requested changes Aug 14, 2024

View reviewed changes

cloudjumpercat commented Aug 14, 2024

View reviewed changes

app/konnect/dev-portal/access-and-approval/sso.md Outdated Show resolved Hide resolved

Fix identity tab link

06ec83c

Guaris self-requested a review August 14, 2024 23:43

Guaris approved these changes Aug 14, 2024

View reviewed changes

Guaris merged commit acccc91 into main Aug 14, 2024
15 checks passed

Guaris deleted the feat/dev-portal-sso branch August 14, 2024 23:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Dev Portal SSO one pager #7633

feat: Dev Portal SSO one pager #7633

cloudjumpercat commented Jul 11, 2024 •

edited

Loading

netlify bot commented Jul 11, 2024 •

edited

Loading

Mierenga left a comment

Mierenga Jul 11, 2024

Mierenga Jul 11, 2024

Mierenga Jul 11, 2024 •

edited

Loading

Mierenga Jul 11, 2024 •

edited

Loading

Mierenga Jul 11, 2024

Mierenga Jul 11, 2024

cloudjumpercat commented Jul 18, 2024

cloudjumpercat commented Jul 18, 2024

Guaris left a comment

Guaris Aug 2, 2024

Guaris Aug 2, 2024

Guaris Aug 2, 2024

Guaris Aug 2, 2024

Guaris Aug 2, 2024

Guaris Aug 2, 2024

Guaris Aug 2, 2024

Guaris Aug 14, 2024


		You can configure single sign-on (SSO) for {{site.konnect_short_name}} Dev Portal with OIDC. This allows developers to log in to Dev Portals by using their SSO credentials.

		<!--Do developers get auto approved in Dev Portal then?-->


		<!--Do developers get auto approved in Dev Portal then?-->

		<!-- would we recommend SSO instead of adding developers and teams from IdPs if we don't want to map team? Or would we maybe recommend both (one to create/map devs and the other to let them log in to Dev Portal)-->


		<!-- would we recommend SSO instead of adding developers and teams from IdPs if we don't want to map team? Or would we maybe recommend both (one to create/map devs and the other to let them log in to Dev Portal)-->

		<!-- should we add a note that this SSO is different than the one for Konnect? As in, if they want to use SSO for logging in to Konnect, they still need to configure that separately?-->


		## Prerequisites

		* Ensure that any users that need to use the Dev Portal SSO have been added to the User Management > Users section of your Auth0 tenant

	* Ensure that any users that need to use the Dev Portal SSO have been added to the User Management > Users section of your Auth0 tenant
	* Ensure that any user emails that need to use the Dev Portal SSO have been added as users in your IDP instance

	> Important: This section is required due to the Auth0 API implementation not being inline with the OIDC standard for the value of the `updated_at` token claim.
	> Important: This section is required due to the Auth0 API implementation not being inline with the OIDC standard for the value of the `updated_at` token claim.


		1. In [Azure](https://portal.azure.com/), [create an application](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=certificate) for {{site.konnect_short_name}}.

		1. Enter the Dev Portal [Redirect URI](/konnect/dev-portal/access/) for the Redirect URI.


		1. Enter the Dev Portal [Redirect URI](/konnect/dev-portal/access/) for the Redirect URI.

		1. [Create a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=client-secret) and save the secret value to configure {{site.konnect_short_name}}.


		1. [Add users to the application](https://help.okta.com/en-us/content/topics/users-groups-profiles/usgp-assign-apps.htm).

		1. [Test ID token claims](https://developer.okta.com/docs/guides/customize-authz-server/main/#create-claims) and find groups for mapping. Configure the following claims settings:


		## Configure SSO in {{site.konnect_short_name}}

		From the [{{site.konnect_short_name}} portal identity page](https://cloud.konghq.com/portal/portal-settings#identity), click Configure provider for OIDC, and enter the values from your IdP application.

feat: Dev Portal SSO one pager #7633

feat: Dev Portal SSO one pager #7633

Conversation

cloudjumpercat commented Jul 11, 2024 • edited Loading

Description

Testing instructions

Checklist

netlify bot commented Jul 11, 2024 • edited Loading

✅ Deploy Preview for kongdocs ready!

Mierenga left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mierenga Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Mierenga Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cloudjumpercat commented Jul 18, 2024

cloudjumpercat commented Jul 18, 2024

Guaris left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cloudjumpercat commented Jul 11, 2024 •

edited

Loading

netlify bot commented Jul 11, 2024 •

edited

Loading

Mierenga Jul 11, 2024 •

edited

Loading

Mierenga Jul 11, 2024 •

edited

Loading