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 Entra ID SAML SSO docs #8151

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update Entra ID SAML SSO docs #8151

wants to merge 4 commits into from

Conversation

melindafekete
Copy link
Collaborator

@melindafekete melindafekete commented Sep 16, 2024

About the changes

Updates the Azure Entra ID SAML SSO docs to reflect the latest product name changes from Microsoft, update (and remove) some screenshots, and ensure that claims + namespaces are correctly shown.

Docs deeplink-> How to Add SSO with SAML 2.0 and Microsoft Entra ID

@melindafekete melindafekete self-assigned this Sep 16, 2024
Copy link

vercel bot commented Sep 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 4:07pm
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 4:07pm

Copy link

github-actions bot commented Sep 16, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

From @daveleek:

Right now, it seems we do not support namespaces at all in our claims for firstName and lastName. We also show two different sets of claims names, one uses firstName & lastName which without namespaces would be correct. the other one under group sync shows givenname and surname with namespaces which doesn't appear to work with our without namespaces.

I can't user.firstName or user.lastName attributes in the Entra admin UI anymore, I think they removed them. In the new screenshot, I'm only showing user.mail as an attribute. Not sure if we want to explicitly mention, that we don't support any others? 🤷‍♀️

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh wow, that's interesting! Going to have to check the other test setup

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah gone there too, just a dropdown now with valid values.

Copy link
Contributor

Choose a reason for hiding this comment

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

In our test setup we currently have these claims:
image

I'll have a look at them to see which ones are in use, I think we use firstName and lastName claims (transformed in Entra ID from givenname and surname) to set the full name of the user in Unleash

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we use firstName and lastName claims (transformed in Entra ID from givenname and surname) to set the full name of the user in Unleash

Ok checked and we do. Looks like we need 3 claims to set up a user with an email + a name; Unique User Identifier, firstName, and lastName. And groups for group sync. I guess that makes the name parameter in my screenshot above redundant

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks!

So should we specifically state in the instructions to add user.surname and user.givenname claims without namespaces?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah I think we should at least explain that it's how user names get populated in Unleash, it'll work without them but that might look/feel weird as the users get listed with just the email address

Copy link
Contributor

@daveleek daveleek left a comment

Choose a reason for hiding this comment

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

This looks great, love the improved language/details here. Would be good to add in a small explanation around firstName/lastName like we discussed, but apart from that LGTM! :)

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

Successfully merging this pull request may close these issues.

2 participants