Update index.html
Browse files- index.html +39 -148
index.html
CHANGED
|
@@ -23,7 +23,7 @@
|
|
| 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
|
| 27 |
<a href="https://huggingface.co/docs/hub/enterprise/sso" target="_blank">Hugging Face Enterprise Documentation</a>.</p></li>
|
| 28 |
</ul>
|
| 29 |
</div>
|
|
@@ -33,189 +33,80 @@
|
|
| 33 |
<ul>
|
| 34 |
<li><a href="#features">Supported Features</a></li>
|
| 35 |
<li><a href="#steps">Configuration Steps</a></li>
|
| 36 |
-
<li><a href="#
|
| 37 |
-
<li><a href="#troubleshoot">Troubleshoot</a></li>
|
| 38 |
</ul>
|
| 39 |
<hr>
|
| 40 |
|
| 41 |
<a name="features"></a><h2>Supported Features</h2>
|
| 42 |
-
<p>The Okta / Hugging Face Enterprise Hub SAML integration supports the following
|
| 43 |
<ul>
|
| 44 |
-
<li><strong>IdP-initiated SSO:</strong> Users can sign in to Hugging Face
|
| 45 |
-
<li><strong>SP-initiated SSO:</strong> Users can initiate sign-in from the Hugging Face login page, which redirects them to Okta for authentication.</li>
|
| 46 |
-
<li><strong>Just-In-Time (JIT) provisioning:</strong> User accounts are automatically created in Hugging Face when they first sign in via SAML.</li>
|
| 47 |
-
<li><strong>Optional SCIM user deprovisioning:</strong> Available for Enterprise Plus customers using Advanced SSO to automatically manage user lifecycle.</li>
|
| 48 |
</ul>
|
| 49 |
-
<p>For more information on the listed features, visit the <a href="https://help.okta.com/okta_help.htm?type=oie&id=ext_glossary" target="_blank">Okta Glossary</a>.</p>
|
| 50 |
<hr>
|
| 51 |
|
| 52 |
<a name="steps"></a><h2>Configuration Steps</h2>
|
| 53 |
-
|
| 54 |
-
<h3>Step 1: Get Your Organization Name and Entity ID from Hugging Face</h3>
|
| 55 |
-
<ol>
|
| 56 |
-
<li><p>Sign in to <strong>Hugging Face</strong> with your administrator account.</p></li>
|
| 57 |
-
|
| 58 |
-
<li><p>Navigate to your organization's settings page and click on <strong>SSO</strong>:<br>
|
| 59 |
-
<kbd>https://huggingface.co/organizations/<your_org>/settings/sso</kbd><br>
|
| 60 |
-
<em>(Replace <kbd><your_org></kbd> with your actual organization name)</em>
|
| 61 |
-
</p></li>
|
| 62 |
-
|
| 63 |
-
<li><p>Click on the <strong>SAML</strong> tab.</p></li>
|
| 64 |
-
|
| 65 |
-
<li><p>Note the following values - you will need them in the next steps:</p>
|
| 66 |
-
<ul>
|
| 67 |
-
<li><strong>Organization Name:</strong> Your Hugging Face organization name (e.g., <kbd>your-org</kbd>)</li>
|
| 68 |
-
<li><strong>Entity ID:</strong> <kbd>https://huggingface.co</kbd></li>
|
| 69 |
-
<li><strong>ACS URL:</strong> <kbd>https://huggingface.co/login/sso/saml</kbd></li>
|
| 70 |
-
</ul>
|
| 71 |
-
<p><em>Keep this page open - you'll return to it later.</em></p>
|
| 72 |
-
</li>
|
| 73 |
-
</ol>
|
| 74 |
|
| 75 |
-
<h3>Step
|
| 76 |
-
<ol
|
| 77 |
<li><p>Sign in to your <strong>Okta Admin Dashboard</strong>.</p></li>
|
| 78 |
-
|
| 79 |
-
<li><p>Navigate to <strong>Applications</strong> > <strong>Applications</strong> in the left sidebar.</p></li>
|
| 80 |
-
|
| 81 |
<li><p>Click <strong>Browse App Catalog</strong>.</p></li>
|
| 82 |
-
|
| 83 |
-
<li><p>
|
| 84 |
-
|
| 85 |
-
<li><p>Select the <strong>Hugging Face Enterprise Hub</strong> application from the results.</p></li>
|
| 86 |
-
|
| 87 |
<li><p>Click <strong>Add Integration</strong>.</p></li>
|
| 88 |
</ol>
|
| 89 |
|
| 90 |
-
<h3>Step
|
| 91 |
-
<ol start="
|
| 92 |
-
<li><p>On the <strong>General Settings</strong> page, enter
|
| 93 |
<ul>
|
| 94 |
-
<li><strong>Application label:</strong> <kbd>Hugging Face
|
| 95 |
-
<li><strong>Organization Name:</strong>
|
| 96 |
-
<li><strong>
|
| 97 |
</ul>
|
|
|
|
|
|
|
| 98 |
</li>
|
| 99 |
-
|
| 100 |
-
<li><p>
|
| 101 |
-
|
| 102 |
-
<li><p>On the <strong>Sign-On Options</strong> page, review the default settings.</p>
|
| 103 |
-
<ul>
|
| 104 |
-
<li><strong>Application username format:</strong> Should be set to <kbd>Email</kbd></li>
|
| 105 |
-
</ul>
|
| 106 |
-
</li>
|
| 107 |
-
|
| 108 |
-
<li><p>Click <strong>Done</strong>.</p></li>
|
| 109 |
</ol>
|
| 110 |
|
| 111 |
-
<h3>Step
|
| 112 |
-
<ol start="
|
| 113 |
-
<li><p>From
|
| 114 |
-
|
| 115 |
-
<li><p>
|
| 116 |
-
|
| 117 |
-
<li><p>From the setup instructions page, copy the following values:</p>
|
| 118 |
<ul>
|
| 119 |
<li><strong>Identity Provider Single Sign-On URL</strong></li>
|
| 120 |
-
<li><strong>X.509 Certificate</strong> (
|
| 121 |
</ul>
|
| 122 |
-
<p><em>Alternatively, you can find these values in the Sign On tab under "Metadata details".</em></p>
|
| 123 |
</li>
|
| 124 |
</ol>
|
| 125 |
|
| 126 |
-
<h3>Step
|
| 127 |
-
<ol start="
|
| 128 |
-
<li><p>Return to
|
| 129 |
-
|
| 130 |
-
</p></li>
|
| 131 |
-
|
| 132 |
-
<li><p>Make sure you're on the <strong>SAML</strong> tab.</p></li>
|
| 133 |
-
|
| 134 |
-
<li><p>Enter the following values from Step 17:</p>
|
| 135 |
<ul>
|
| 136 |
-
<li><strong>Sign On URL:</strong> Paste the <strong>Identity Provider Single Sign-On URL</strong> from Okta
|
| 137 |
-
<li><strong>X.509 Certificate:</strong> Paste the full certificate text from Okta
|
| 138 |
</ul>
|
| 139 |
</li>
|
| 140 |
-
|
| 141 |
-
<li><p>
|
| 142 |
-
|
| 143 |
-
<li><p>If the test is successful, toggle the <strong>Enable SAML SSO</strong> switch to enable SSO enforcement for your organization.</p></li>
|
| 144 |
</ol>
|
| 145 |
|
| 146 |
-
<
|
| 147 |
-
<ol start="23">
|
| 148 |
-
<li><p>Return to your Okta Admin Dashboard.</p></li>
|
| 149 |
-
|
| 150 |
-
<li><p>Navigate to the <strong>Assignments</strong> tab of your Hugging Face app integration.</p></li>
|
| 151 |
-
|
| 152 |
-
<li><p>Click <strong>Assign</strong> and select either <strong>Assign to People</strong> or <strong>Assign to Groups</strong> to grant access to users.</p></li>
|
| 153 |
-
|
| 154 |
-
<li><p>Click <strong>Done</strong> when finished.</p></li>
|
| 155 |
-
</ol>
|
| 156 |
-
|
| 157 |
-
<p><strong>Your SAML configuration is now complete!</strong> Users can now sign in to Hugging Face through Okta.</p>
|
| 158 |
-
|
| 159 |
-
<hr>
|
| 160 |
-
|
| 161 |
-
<a name="sp-initiated"></a><h2>SP-initiated SSO</h2>
|
| 162 |
-
<p>Users can initiate sign-in from Hugging Face and be redirected to Okta for authentication.</p>
|
| 163 |
-
|
| 164 |
-
<h3>How to Sign In via SP-initiated SSO</h3>
|
| 165 |
-
<ol>
|
| 166 |
-
<li><p>Navigate to the following URL in your browser:<br>
|
| 167 |
-
<kbd>https://huggingface.co/login/sso/saml/<your_org></kbd><br>
|
| 168 |
-
<em>(Replace <kbd><your_org></kbd> with your organization name)</em>
|
| 169 |
-
</p></li>
|
| 170 |
-
|
| 171 |
-
<li><p>You will be automatically redirected to Okta to authenticate.</p></li>
|
| 172 |
-
|
| 173 |
-
<li><p>Enter your Okta credentials and click <strong>Sign In</strong>.</p></li>
|
| 174 |
-
|
| 175 |
-
<li><p>If your credentials are valid, you will be redirected back to Hugging Face and automatically signed in.</p></li>
|
| 176 |
-
</ol>
|
| 177 |
|
| 178 |
<hr>
|
| 179 |
|
| 180 |
-
<a name="
|
| 181 |
-
|
| 182 |
-
<h3>Common Issues and Solutions</h3>
|
| 183 |
-
|
| 184 |
-
<h4>"400 SSO not enabled" Error</h4>
|
| 185 |
-
<p><strong>Cause:</strong> SAML SSO has not been enabled in Hugging Face settings.</p>
|
| 186 |
-
<p><strong>Solution:</strong> Ensure the <strong>Enable SAML SSO</strong> toggle is turned on in your Hugging Face organization's SSO settings page.</p>
|
| 187 |
-
|
| 188 |
-
<h4>Signature Verification Failed</h4>
|
| 189 |
-
<p><strong>Cause:</strong> The certificate in Hugging Face doesn't match the certificate in Okta.</p>
|
| 190 |
-
<p><strong>Solution:</strong> If your Okta certificate has been updated or rotated, copy the new X.509 certificate from Okta and paste it into Hugging Face settings, then click "Update and Test SAML Configuration".</p>
|
| 191 |
-
|
| 192 |
-
<h4>Users Cannot Sign In After Enabling SSO</h4>
|
| 193 |
-
<p><strong>Cause:</strong> Users have not been assigned to the Hugging Face app in Okta.</p>
|
| 194 |
-
<p><strong>Solution:</strong> In Okta Admin Dashboard, go to the Hugging Face app's <strong>Assignments</strong> tab and assign the appropriate users or groups.</p>
|
| 195 |
-
|
| 196 |
-
<h4>Incorrect Organization Name Error</h4>
|
| 197 |
-
<p><strong>Cause:</strong> The organization name entered in Okta doesn't match your Hugging Face organization name.</p>
|
| 198 |
-
<p><strong>Solution:</strong> In Okta, go to the Hugging Face app's <strong>General</strong> tab, click <strong>Edit</strong>, and verify the Organization Name matches exactly with your Hugging Face organization name (case-sensitive).</p>
|
| 199 |
-
|
| 200 |
-
<h4>Incorrect Email or Name Information</h4>
|
| 201 |
-
<p><strong>Cause:</strong> User profile attributes in Okta are not populated correctly.</p>
|
| 202 |
-
<p><strong>Solution:</strong> Verify that users in Okta have their email, first name, and last name fields populated. Hugging Face automatically receives these attributes through SAML.</p>
|
| 203 |
-
|
| 204 |
-
<h3>Additional Support</h3>
|
| 205 |
-
<p>If you continue to experience issues or need assistance with advanced configuration options such as SCIM provisioning (available for Enterprise Plus customers), please contact Hugging Face Enterprise support:</p>
|
| 206 |
<ul>
|
| 207 |
-
<li>
|
| 208 |
-
<li>
|
| 209 |
-
|
| 210 |
-
|
| 211 |
-
<h3>Notes</h3>
|
| 212 |
-
<ul>
|
| 213 |
-
<li><p>Ensure you enter the correct Organization Name in Okta (Step 11). An incorrect organization name will prevent authentication.</p></li>
|
| 214 |
-
<li><p>SCIM provisioning is available for Enterprise Plus customers using Advanced SSO. This allows automatic user provisioning, deprovisioning, and attribute syncing between Okta and Hugging Face.</p></li>
|
| 215 |
-
<li><p>Hugging Face uses SAML 2.0 with SHA256 encryption for security.</p></li>
|
| 216 |
-
<li><p>Just-In-Time (JIT) provisioning automatically creates user accounts in Hugging Face when users first sign in via SAML, so you don't need to manually create accounts beforehand.</p></li>
|
| 217 |
-
<li><p>If you disable SAML SSO in Hugging Face after it has been enabled, users will need to use their regular Hugging Face credentials to sign in.</p></li>
|
| 218 |
</ul>
|
| 219 |
</div>
|
| 220 |
</body>
|
|
|
|
| 221 |
</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
|
| 27 |
<a href="https://huggingface.co/docs/hub/enterprise/sso" target="_blank">Hugging Face Enterprise Documentation</a>.</p></li>
|
| 28 |
</ul>
|
| 29 |
</div>
|
|
|
|
| 33 |
<ul>
|
| 34 |
<li><a href="#features">Supported Features</a></li>
|
| 35 |
<li><a href="#steps">Configuration Steps</a></li>
|
| 36 |
+
<li><a href="#notes">Notes</a></li>
|
|
|
|
| 37 |
</ul>
|
| 38 |
<hr>
|
| 39 |
|
| 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 |
|
| 47 |
<a name="steps"></a><h2>Configuration Steps</h2>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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> > <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 → <strong>SSO</strong> tab → <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 → 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 → SAML settings.</p></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 108 |
</ul>
|
| 109 |
</div>
|
| 110 |
</body>
|
| 111 |
+
|
| 112 |
</html>
|