Skip to content

Commit 1204a9d

Browse files
update sso doc (#1765)
* add advanced sso doc * add restrictions
1 parent 96a3e30 commit 1204a9d

File tree

8 files changed

+43
-4
lines changed

8 files changed

+43
-4
lines changed

docs/hub/_toctree.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,8 @@
342342
sections:
343343
- local: enterprise-sso
344344
title: Single Sign-On (SSO)
345+
- local: enterprise-hub-advanced-sso
346+
title: Advanced Single Sign-On (SSO)
345347
- local: audit-logs
346348
title: Audit Logs
347349
- local: storage-regions
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Advanced Single Sign-On (SSO)
2+
3+
<Tip warning={true}>
4+
This feature is part of the <a href="https://huggingface.co/contact/sales?from=enterprise" target="_blank">Enterprise Plus</a> plan.
5+
</Tip>
6+
7+
Advanced Single Sign-On (SSO) capabilities extend the standard [SSO features](./security-sso) available in the Enterprise Hub, offering enhanced control and automation for user management and access across the entire Hugging Face platform for your organization members.
8+
9+
## User Provisioning
10+
11+
Advanced SSO introduces automated user provisioning, which simplifies the onboarding and offboarding of users.
12+
13+
* **Just-In-Time (JIT) Provisioning**: When a user from your organization attempts to log in to Hugging Face for the first time via SSO, an account can be automatically created for them if one doesn't already exist. Their profile information and role mappings can be populated based on attributes from your IdP.
14+
* **System for Cross-domain Identity Management (SCIM)**: For more robust user lifecycle management, SCIM allows your IdP to communicate user identity information to Hugging Face. This enables automatic creation, updates (e.g., name changes, role changes), and deactivation of user accounts on Hugging Face as changes occur in your IdP. This ensures that user access is always up-to-date with their status in your organization.
15+
16+
## Global SSO Enforcement
17+
18+
Beyond gating access to specific organizational content, Advanced SSO can be configured to make your IdP the mandatory authentication route for all your organization's members interacting with any part of the Hugging Face platform. Your organization's members will be required to authenticate via your IdP for all Hugging Face services, not just when accessing private or organizational repositories.
19+
20+
This feature is particularly beneficial for organizations requiring a higher degree of control, security, and automation in managing their users on Hugging Face.
21+
22+
## Limitations on Managed User Accounts
23+
24+
<Tip warning={true}>
25+
Important Considerations for Managed Accounts.
26+
</Tip>
27+
28+
To ensure organizational control and data governance, user accounts provisioned and managed via Advanced SSO ("managed user accounts") have specific limitations:
29+
30+
* **No Public Content Creation**: Managed user accounts cannot create public content on the Hugging Face platform. This includes, but is not limited to, public models, datasets, or Spaces. All content created by these accounts is restricted to within your organization or private visibility.
31+
* **No External Collaboration**: Managed user accounts are restricted from collaborating outside of your Hugging Face organization. This means they cannot, for example, join other organizations, contribute to repositories outside their own organization.
32+
33+
These restrictions are in place to maintain the integrity and security boundaries defined by your enterprise. If members of your organization require the ability to create public content or collaborate more broadly on the Hugging Face platform, they will need to do so using a separate, personal Hugging Face account that is not managed by your organization's Advanced SSO.
34+

docs/hub/enterprise-hub.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Enterprise Hub adds advanced capabilities to organizations, enabling safe, compl
1414
In this section we will document the following Enterprise Hub features:
1515

1616
- [Single Sign-On (SSO)](./enterprise-sso)
17+
- [Advanced Single Sign-On (SSO)](./enterprise-hub-advanced-sso)
1718
- [Audit Logs](./audit-logs)
1819
- [Storage Regions](./storage-regions)
1920
- [Dataset viewer for Private datasets](./enterprise-hub-datasets)

docs/hub/enterprise-sso.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ This feature is part of the <a href="https://huggingface.co/enterprise">Enterpri
66

77
Single sign-on (SSO) allows organizations to securely manage user authentication through their own identity provider (IdP). Both SAML 2.0 and OpenID Connect (OIDC) protocols are supported.
88

9+
Please note that this feature is intended to manage access to organization-specific resources such as private models, datasets, and Spaces. However, it does not replace the core authentication mechanism for the Hugging Face platform. For enhanced capabilities like automated user provisioning (JIT/SCIM) and global SSO enforcement, see our [Advanced SSO documentation](./enterprise-hub-advanced-sso).
10+
911
<div class="flex justify-center" style="max-width: 550px">
1012
<img
1113
class="block dark:hidden m-0!"

docs/hub/organizations.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ If an organization needs to track user access to a dataset due to licensing or p
1111
- [Access Control in Organizations](./organizations-security)
1212
- [Enterprise Hub features](./enterprise-hub)
1313
- [SSO](./enterprise-sso)
14+
- [Advanced SSO](./enterprise-hub-advanced-sso)
1415
- [Audit Logs](./audit-logs)
1516
- [Storage Regions](./storage-regions)
1617
- [Dataset viewer for Private datasets](./enterprise-hub-datasets)

docs/hub/security-sso-azure-saml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In this guide, we will use Azure as the SSO provider and with the Security Assertion Markup Language (SAML) protocol as our preferred identity protocol.
44

5-
We currently support SP-initiated and IdP-initiated authentication. User provisioning is not yet supported at this time.
5+
We currently support SP-initiated and IdP-initiated authentication. User provisioning is part of Enterprise Plus's [Advanced SSO](./enterprise-hub-advanced-sso).
66

77
<Tip warning={true}>
88
This feature is part of the <a href="https://huggingface.co/enterprise">Enterprise Hub</a>.

docs/hub/security-sso-okta-saml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In this guide, we will use Okta as the SSO provider and with the Security Assertion Markup Language (SAML) protocol as our preferred identity protocol.
44

5-
We currently support SP-initiated and IdP-initiated authentication. User provisioning is not yet supported at this time.
5+
We currently support SP-initiated and IdP-initiated authentication. User provisioning is part of Enterprise Plus's [Advanced SSO](./enterprise-hub-advanced-sso).
66

77
<Tip warning={true}>
88
This feature is part of the <a href="https://huggingface.co/enterprise">Enterprise Hub</a>.

docs/hub/security-sso.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ The Hugging Face Hub gives you the ability to implement mandatory Single Sign-On
55
We support both SAML 2.0 and OpenID Connect (OIDC) protocols.
66

77
<Tip warning={true}>
8-
This feature is part of the <a href="https://huggingface.co/enterprise">Enterprise Hub</a>.
9-
</Tip>
8+
This feature is part of the <a href="https://huggingface.co/enterprise">Enterprise Hub</a>. For enhanced capabilities like automated user provisioning (JIT/SCIM) and global SSO enforcement, see our <a href="./enterprise-hub-advanced-sso">Advanced SSO documentation</Tip>
109

1110
## How does it work?
1211

0 commit comments

Comments
 (0)