Skip to content

Docs: Add SCIM documentation for Enterprise Hub #1845

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Charlie-Boyer
Copy link
Contributor

@Charlie-Boyer Charlie-Boyer commented Jul 23, 2025

This PR adds documentation for SCIM-based user provisioning with Microsoft Entra ID for Enterprise Hub customers. It includes a new setup guide, an overview of the SCIM feature, and updates to existing documentation to integrate the new content.

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Member

Choose a reason for hiding this comment

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

cool, in the future maybe we can add some "user quotes" ie. testimonials, etc

cc @AdrianLepers for viz

@Charlie-Boyer Charlie-Boyer marked this pull request as draft July 23, 2025 11:19
@Charlie-Boyer Charlie-Boyer force-pushed the scim-doc branch 7 times, most recently from a83f7e3 to 8b9c66a Compare July 25, 2025 13:26
@Charlie-Boyer Charlie-Boyer marked this pull request as ready for review July 25, 2025 13:27
2. Go back to the Provisioning screen and click on **Provision Microsoft Entra ID Groups** to review group mappings.

<Tip>
The default settings should work for most cases. For more information, see the <a href="https://huggingface-openapi.hf.space/#tag/scim" target="_blank">API documentation</a>
Copy link
Member

@Kakulukian Kakulukian Jul 25, 2025

Choose a reason for hiding this comment

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

Obviously, no. We found out during our test ^^"

I think this config should almost always work (minus userName sanitization):

image
customappsso Attribute Microsoft Entra ID Attribute Matching precedence
userName Replace([mailNickname], ".", "", "", "", "", "")  
active Switch([IsSoftDeleted], , "False", "True", "True", "False")  
emails[type eq "work"].value userPrincipalName  
name.givenName givenName  
name.familyName surname  
name.formatted Join(" ", [givenName], [surname])  
externalId objectId 1
customappsso Attribute | Microsoft Entra ID Attribute | Matching precedence 
-- | -- | -- | 
userName | Replace([mailNickname], ".", "", "", "", "", "") |   |
active | Switch([IsSoftDeleted], , "False", "True", "True", "False") |  | Delete
emails[type eq "work"].value | userPrincipalName |   | 
name.givenName | givenName |   | Edit | Delete
name.familyName | surname |   | Edit | Delete
name.formatted | Join(" ", [givenName], [surname]) |   | 
externalId | objectId | 1 | 

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea it was a bit optimistic xD, I'm adding this table for reference

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@Charlie-Boyer Charlie-Boyer force-pushed the scim-doc branch 2 times, most recently from 64e8809 to fdf4ad3 Compare July 25, 2025 15:27
Comment on lines 45 to 53
| `customappsso` Attribute | Microsoft Entra ID Attribute | Matching precedence | Actions |
|---|---|---|---|
| `userName` | `Replace([mailNickname], ".", "", "", "", "", "")` | | |
| `active` | `Switch([IsSoftDeleted], , "False", "True", "True", "False")` | | `Delete` |
| `emails[type eq "work"].value` | `userPrincipalName` | | |
| `name.givenName` | `givenName` | | `Edit`, `Delete` |
| `name.familyName` | `surname` | | `Edit`, `Delete` |
| `name.formatted` | `Join(" ", [givenName], [surname])` | | |
| `externalId` | `objectId` | `1` | |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| `customappsso` Attribute | Microsoft Entra ID Attribute | Matching precedence | Actions |
|---|---|---|---|
| `userName` | `Replace([mailNickname], ".", "", "", "", "", "")` | | |
| `active` | `Switch([IsSoftDeleted], , "False", "True", "True", "False")` | | `Delete` |
| `emails[type eq "work"].value` | `userPrincipalName` | | |
| `name.givenName` | `givenName` | | `Edit`, `Delete` |
| `name.familyName` | `surname` | | `Edit`, `Delete` |
| `name.formatted` | `Join(" ", [givenName], [surname])` | | |
| `externalId` | `objectId` | `1` | |
| `customappsso` Attribute | Microsoft Entra ID Attribute | Matching precedence |
|---|---|---|
| `userName` | `Replace([mailNickname], ".", "", "", "", "", "")` | |
| `active` | `Switch([IsSoftDeleted], , "False", "True", "True", "False")` | |
| `emails[type eq "work"].value` | `userPrincipalName` | |
| `name.givenName` | `givenName` | |
| `name.familyName` | `surname` | |
| `name.formatted` | `Join(" ", [givenName], [surname])` | |
| `externalId` | `objectId` | `1` |

Actions column is useless, bad paste from transcribing the screen to markdown :p

@Kakulukian Kakulukian requested a review from Pierrci July 28, 2025 12:26
Copy link
Member

@pcuenca pcuenca left a comment

Choose a reason for hiding this comment

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

Nice!

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.

5 participants