CharlieBoyer HF Staff commited on
Commit
5b60fa3
Β·
verified Β·
1 Parent(s): 87c5a88

Update index.html

Browse files
Files changed (1) hide show
  1. index.html +33 -32
index.html CHANGED
@@ -23,8 +23,8 @@
23
  <ul>
24
  <li><p>Your organization must be on an <strong>Enterprise</strong> or <strong>Enterprise Plus</strong> plan to enable SAML-based SSO.</p></li>
25
  <li><p>You must have administrator access to both your Okta organization and your Hugging Face Enterprise Hub organization.</p></li>
26
- <li><p>For details about Hugging Face's SSO options, visit the
27
- <a href="https://huggingface.co/docs/hub/enterprise/sso" target="_blank">Hugging Face Enterprise Documentation</a>.</p></li>
28
  </ul>
29
  </div>
30
  </div>
@@ -40,7 +40,7 @@
40
  <a name="features"></a><h2>Supported Features</h2>
41
  <p>The Okta / Hugging Face Enterprise Hub SAML integration supports the following:</p>
42
  <ul>
43
- <li><strong>IdP-initiated SSO:</strong> Users can sign in to Hugging Face from their Okta dashboard via the Hugging Face app tile.</li>
44
  </ul>
45
  <hr>
46
 
@@ -48,65 +48,66 @@
48
 
49
  <h3>Step 1: Add the Hugging Face App from Okta Integration Network (OIN)</h3>
50
  <ol>
51
- <li><p>Sign in to your <strong>Okta Admin Dashboard</strong>.</p></li>
52
- <li><p>Navigate to <strong>Applications</strong> &gt; <strong>Applications</strong>.</p></li>
53
- <li><p>Click <strong>Browse App Catalog</strong>.</p></li>
54
- <li><p>Search for <strong>Hugging Face</strong>.</p></li>
55
- <li><p>Select the <strong>Hugging Face</strong> application.</p></li>
56
- <li><p>Click <strong>Add Integration</strong>.</p></li>
57
  </ol>
58
 
59
  <h3>Step 2: Configure the Hugging Face App in Okta</h3>
60
- <ol start="7">
61
- <li><p>On the <strong>General Settings</strong> page, enter:</p>
62
  <ul>
63
- <li><strong>Application label:</strong> <kbd>Hugging Face</kbd> (or customize as needed)</li>
64
  <li><strong>Organization Name:</strong> Your Hugging Face organization name</li>
65
  <li><strong>Organization ID:</strong> Your Hugging Face organization ID</li>
66
  </ul>
67
- <p><em>Where to find these values:</em> In Hugging Face, go to your organization settings &rarr; <strong>SSO</strong> tab &rarr; <strong>SAML</strong> sub-tab. You will see both your Organization Name and Organization ID.</p>
68
- <p style="border:1px dashed #ccc;padding:8px;margin:10px 0;"><em>Screenshot placeholder β€” insert your screenshot of the Hugging Face SSO &rarr; SAML page here.</em></p>
69
  </li>
70
- <li><p>Click <strong>Next</strong>, review the <strong>Sign-On Options</strong> (username format should be <kbd>Email</kbd>), then click <strong>Done</strong> to create the app.</p></li>
71
- <li><p><strong>Important:</strong> Ensure the administrator performing these steps is <strong>assigned</strong> to the Hugging Face application in Okta (via the <strong>Assignments</strong> tab), otherwise they won't be able to complete the test later.</p></li>
72
  </ol>
73
 
74
  <h3>Step 3: Copy SAML Configuration from Okta</h3>
75
- <ol start="10">
76
- <li><p>From the Hugging Face app in Okta, open the <strong>Sign On</strong> tab.</p></li>
77
- <li><p>Scroll to the <strong>SAML 2.0</strong> section and click <strong>View SAML setup instructions</strong> (or check <strong>Metadata details</strong>).</p></li>
78
- <li><p>Copy the following values:</p>
79
  <ul>
80
  <li><strong>Identity Provider Single Sign-On URL</strong></li>
81
- <li><strong>X.509 Certificate</strong> (full certificate text between <kbd>-----BEGIN CERTIFICATE-----</kbd> and <kbd>-----END CERTIFICATE-----</kbd>)</li>
82
  </ul>
83
  </li>
84
  </ol>
85
 
86
  <h3>Step 4: Configure SAML in Hugging Face</h3>
87
- <ol start="13">
88
- <li><p>Return to your organization's <strong>SSO</strong> settings in Hugging Face and select the <strong>SAML</strong> tab.</p></li>
89
- <li><p>Enter the values from Okta:</p>
90
  <ul>
91
- <li><strong>Sign On URL:</strong> Paste the <strong>Identity Provider Single Sign-On URL</strong> from Okta.</li>
92
- <li><strong>X.509 Certificate:</strong> Paste the full certificate text from Okta.</li>
93
  </ul>
94
  </li>
95
- <li><p>Click <strong>Update and Test SAML Configuration</strong> to validate.</p></li>
96
- <li><p>If the test is successful, toggle <strong>Enable SAML SSO</strong> to enforce SSO for your organization.</p></li>
97
  </ol>
98
 
99
- <p><strong>What happens next?</strong> Once SSO is enabled, users will continue to sign in to the platform with their usual Hugging Face credentials. However, when they attempt to access content that belongs to your organization, they will be prompted to authenticate via SSO through Okta.</p>
100
 
101
  <hr>
102
 
103
  <a name="notes"></a><h2>Notes</h2>
104
  <ul>
105
- <li><p>This guide covers <strong>Standard SSO</strong>. For <strong>Advanced SSO</strong> capabilities, see the official docs: <a href="https://huggingface.co/docs/hub/enterprise/sso" target="_blank">Advanced SSO</a>.</p></li>
106
- <li><p>For automated user lifecycle management via <strong>SCIM provisioning</strong> (Enterprise Plus with Advanced SSO), see: <a href="https://huggingface.co/docs/hub/enterprise/scim" target="_blank">SCIM Provisioning</a>.</p></li>
107
- <li><p>Ensure the <strong>Organization Name</strong> and <strong>Organization ID</strong> entered in Okta exactly match the values shown in your Hugging Face SSO &rarr; SAML settings.</p></li>
 
 
108
  </ul>
109
  </div>
110
  </body>
111
 
 
112
  </html>
 
23
  <ul>
24
  <li><p>Your organization must be on an <strong>Enterprise</strong> or <strong>Enterprise Plus</strong> plan to enable SAML-based SSO.</p></li>
25
  <li><p>You must have administrator access to both your Okta organization and your Hugging Face Enterprise Hub organization.</p></li>
26
+ <li><p>For details about Hugging Face’s SSO options, visit the official documentation:
27
+ <a href="https://huggingface.co/docs/hub/en/enterprise-sso" target="_blank">Hugging Face Enterprise SSO Documentation</a>. :contentReference[oaicite:1]{index=1}</p></li>
28
  </ul>
29
  </div>
30
  </div>
 
40
  <a name="features"></a><h2>Supported Features</h2>
41
  <p>The Okta / Hugging Face Enterprise Hub SAML integration supports the following:</p>
42
  <ul>
43
+ <li><strong>IdP-initiated SSO and SP-initiated SSO:</strong> Users can initiate authentication either from the identity provider (IdP) or from the service provider (Hugging Face). :contentReference[oaicite:2]{index=2}</li>
44
  </ul>
45
  <hr>
46
 
 
48
 
49
  <h3>Step 1: Add the Hugging Face App from Okta Integration Network (OIN)</h3>
50
  <ol>
51
+ <li>Sign in to your Okta Admin Dashboard.</li>
52
+ <li>Go to Applications β†’ Browse App Catalog.</li>
53
+ <li>Search for and select the application named <strong>Hugging Face</strong>.</li>
54
+ <li>Click <strong>Add Integration</strong>.</li>
 
 
55
  </ol>
56
 
57
  <h3>Step 2: Configure the Hugging Face App in Okta</h3>
58
+ <ol start="5">
59
+ <li>On the General Settings page, enter:
60
  <ul>
61
+ <li><strong>Application label:</strong> <kbd>Hugging Face</kbd></li>
62
  <li><strong>Organization Name:</strong> Your Hugging Face organization name</li>
63
  <li><strong>Organization ID:</strong> Your Hugging Face organization ID</li>
64
  </ul>
65
+ <p><em>Where to find these values:</em> In Hugging Face go to <strong>Organisation Settings β†’ SSO β†’ SAML</strong>. You will see both the Organization Name and the Organization ID.</p>
66
+ <p><img src="/static/images/hf-sso-saml-screenshot.png" alt="Hugging Face SSO SAML screenshot" style="max-width:100%;height:auto;"></p>
67
  </li>
68
+ <li>Click <strong>Next</strong>, review the Sign-On Options (make sure username format is <kbd>Email</kbd>), then click <strong>Done</strong>.</li>
69
+ <li><strong>Important:</strong> Make sure the administrator performing these steps is assigned to the Hugging Face application in Okta via the Assignments tab.</li>
70
  </ol>
71
 
72
  <h3>Step 3: Copy SAML Configuration from Okta</h3>
73
+ <ol start="8">
74
+ <li>In the Hugging Face app in Okta, open the <strong>Sign On</strong> tab.</li>
75
+ <li>Locate the SAML 2.0 section and click <strong>View SAML Setup Instructions</strong> (or go to Metadata Details).</li>
76
+ <li>Copy the following values:
77
  <ul>
78
  <li><strong>Identity Provider Single Sign-On URL</strong></li>
79
+ <li><strong>X.509 Certificate</strong> β€” copy the full certificate including <kbd>-----BEGIN CERTIFICATE-----</kbd> and <kbd>-----END CERTIFICATE-----</kbd>.</li>
80
  </ul>
81
  </li>
82
  </ol>
83
 
84
  <h3>Step 4: Configure SAML in Hugging Face</h3>
85
+ <ol start="11">
86
+ <li>Return to your organization's <strong>Organisation Settings β†’ SSO β†’ SAML</strong> tab in Hugging Face.</li>
87
+ <li>Enter the values from Okta:
88
  <ul>
89
+ <li><strong>Sign On URL:</strong> Paste the Identity Provider Single Sign-On URL from Okta.</li>
90
+ <li><strong>X.509 Certificate:</strong> Paste the full certificate text (including the BEGIN/END markers) from Okta.</li>
91
  </ul>
92
  </li>
93
+ <li>Click <strong>Update and Test SAML Configuration</strong> to validate the setup.</li>
94
+ <li>If the test is successful, toggle <strong>Enable SAML SSO</strong> to enforce the SSO for your organization.</li>
95
  </ol>
96
 
97
+ <p><strong>What happens next?</strong> Users will continue signing in with their usual Hugging Face account credentials. But when they access content belonging to your organization, they will be prompted to authenticate via SSO through Okta.</p>
98
 
99
  <hr>
100
 
101
  <a name="notes"></a><h2>Notes</h2>
102
  <ul>
103
+ <li>This guide covers the <strong>Standard SSO</strong> setup. For <strong>Advanced SSO</strong> (with automated user provisioning, SCIM, global enforcement) see:
104
+ <a href="https://huggingface.co/docs/hub/en/enterprise-hub-advanced-sso" target="_blank">Advanced SSO Documentation</a>. :contentReference[oaicite:3]{index=3}</li>
105
+ <li>For automated user lifecycle management via <strong>SCIM provisioning</strong> (Enterprise Plus with Advanced SSO), see:
106
+ <a href="https://huggingface.co/docs/hub/en/enterprise-hub" target="_blank">SCIM & Advanced Features Overview</a>. :contentReference[oaicite:4]{index=4}</li>
107
+ <li>Ensure that the <strong>Organization Name</strong> and <strong>Organization ID</strong> entered in Okta exactly match the values shown in your Hugging Face SSO β†’ SAML settings.</li>
108
  </ul>
109
  </div>
110
  </body>
111
 
112
+
113
  </html>