Update index.html
Browse files- index.html +73 -100
index.html
CHANGED
|
@@ -51,112 +51,100 @@
|
|
| 51 |
|
| 52 |
<a name="steps"></a><h2>Configuration Steps</h2>
|
| 53 |
|
| 54 |
-
<h3>Step 1:
|
| 55 |
<ol>
|
| 56 |
-
<li><p>Sign in to
|
| 57 |
-
|
| 58 |
-
<li><p>Navigate to <strong>Applications</strong> > <strong>Applications</strong> in the left sidebar.</p></li>
|
| 59 |
|
| 60 |
-
<li><p>
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
-
<li><p>
|
| 63 |
|
| 64 |
-
<li><p>
|
| 65 |
<ul>
|
| 66 |
-
<li><strong>
|
| 67 |
-
<li><strong>
|
|
|
|
| 68 |
</ul>
|
| 69 |
-
<p>
|
| 70 |
</li>
|
| 71 |
</ol>
|
| 72 |
|
| 73 |
-
<h3>Step 2:
|
| 74 |
-
<ol start="
|
| 75 |
-
<li><p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 76 |
<ul>
|
| 77 |
-
<li><strong>
|
| 78 |
-
|
| 79 |
-
</li>
|
| 80 |
-
<li><strong>Audience URI (SP Entity ID):</strong><br>
|
| 81 |
-
<kbd>https://huggingface.co</kbd>
|
| 82 |
-
</li>
|
| 83 |
-
<li><strong>Default RelayState:</strong> Leave blank</li>
|
| 84 |
-
<li><strong>Name ID format:</strong> <kbd>EmailAddress</kbd></li>
|
| 85 |
-
<li><strong>Application username:</strong> <kbd>Email</kbd></li>
|
| 86 |
</ul>
|
| 87 |
</li>
|
| 88 |
|
| 89 |
-
<li><p>
|
| 90 |
-
<table style="width:100%; border-collapse: collapse; margin: 1rem 0;">
|
| 91 |
-
<thead>
|
| 92 |
-
<tr style="background: #f3f4f6;">
|
| 93 |
-
<th style="padding: 0.75rem; text-align: left; border: 1px solid #d1d5db;">Name</th>
|
| 94 |
-
<th style="padding: 0.75rem; text-align: left; border: 1px solid #d1d5db;">Name Format</th>
|
| 95 |
-
<th style="padding: 0.75rem; text-align: left; border: 1px solid #d1d5db;">Value</th>
|
| 96 |
-
</tr>
|
| 97 |
-
</thead>
|
| 98 |
-
<tbody>
|
| 99 |
-
<tr>
|
| 100 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>email</kbd></td>
|
| 101 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;">Unspecified</td>
|
| 102 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>user.email</kbd></td>
|
| 103 |
-
</tr>
|
| 104 |
-
<tr>
|
| 105 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>firstName</kbd></td>
|
| 106 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;">Unspecified</td>
|
| 107 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>user.firstName</kbd></td>
|
| 108 |
-
</tr>
|
| 109 |
-
<tr>
|
| 110 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>lastName</kbd></td>
|
| 111 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;">Unspecified</td>
|
| 112 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>user.lastName</kbd></td>
|
| 113 |
-
</tr>
|
| 114 |
-
</tbody>
|
| 115 |
-
</table>
|
| 116 |
-
</li>
|
| 117 |
-
|
| 118 |
-
<li><p>Click <strong>Next</strong> to proceed to the Feedback page.</p></li>
|
| 119 |
|
| 120 |
-
<li><p>
|
| 121 |
<ul>
|
| 122 |
-
<li><strong>
|
| 123 |
-
<li><strong>App type:</strong> Select "This is an internal app that we have created"</li>
|
| 124 |
</ul>
|
| 125 |
-
<p>Click <strong>Finish</strong>.</p>
|
| 126 |
</li>
|
| 127 |
-
</ol>
|
| 128 |
|
| 129 |
-
|
| 130 |
-
|
| 131 |
-
<li><p>From your newly created Okta app, go to the <strong>Sign On</strong> tab.</p></li>
|
| 132 |
|
| 133 |
-
|
|
|
|
|
|
|
| 134 |
|
| 135 |
-
<li><p>Scroll down
|
| 136 |
|
| 137 |
-
<li><p>
|
| 138 |
-
<
|
|
|
|
|
|
|
|
|
|
|
|
|
| 139 |
</li>
|
| 140 |
</ol>
|
| 141 |
|
| 142 |
-
<h3>Step
|
| 143 |
-
<ol start="
|
| 144 |
-
<li><p>
|
| 145 |
-
|
| 146 |
-
<li><p>Navigate to your organization's SSO settings page:<br>
|
| 147 |
-
<kbd>https://huggingface.co/organizations/<your_org>/settings/sso</kbd><br>
|
| 148 |
-
<em>(Replace <kbd><your_org></kbd> with your actual organization name)</em>
|
| 149 |
</p></li>
|
| 150 |
|
| 151 |
-
<li><p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 152 |
|
| 153 |
<li><p>Click <strong>Update and Test SAML Configuration</strong>.</p></li>
|
| 154 |
|
| 155 |
<li><p>If the test is successful, toggle the <strong>Enable SAML SSO</strong> switch to enable SSO enforcement for your organization.</p></li>
|
| 156 |
</ol>
|
| 157 |
|
| 158 |
-
<h3>Step
|
| 159 |
-
<ol start="
|
| 160 |
<li><p>Return to your Okta Admin Dashboard.</p></li>
|
| 161 |
|
| 162 |
<li><p>Navigate to the <strong>Assignments</strong> tab of your Hugging Face app integration.</p></li>
|
|
@@ -166,6 +154,8 @@
|
|
| 166 |
<li><p>Click <strong>Done</strong> when finished.</p></li>
|
| 167 |
</ol>
|
| 168 |
|
|
|
|
|
|
|
| 169 |
<hr>
|
| 170 |
|
| 171 |
<a name="sp-initiated"></a><h2>SP-initiated SSO</h2>
|
|
@@ -196,38 +186,20 @@
|
|
| 196 |
<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>
|
| 197 |
|
| 198 |
<h4>Signature Verification Failed</h4>
|
| 199 |
-
<p><strong>Cause:</strong> The
|
| 200 |
-
<p><strong>Solution:</strong> If your Okta certificate has been updated or rotated,
|
| 201 |
|
| 202 |
<h4>Users Cannot Sign In After Enabling SSO</h4>
|
| 203 |
<p><strong>Cause:</strong> Users have not been assigned to the Hugging Face app in Okta.</p>
|
| 204 |
<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>
|
| 205 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 206 |
<h4>Incorrect Email or Name Information</h4>
|
| 207 |
-
<p><strong>Cause:</strong>
|
| 208 |
-
<p><strong>Solution:</strong> Verify that
|
| 209 |
-
<table style="width:100%; border-collapse: collapse; margin: 1rem 0;">
|
| 210 |
-
<thead>
|
| 211 |
-
<tr style="background: #f3f4f6;">
|
| 212 |
-
<th style="padding: 0.75rem; text-align: left; border: 1px solid #d1d5db;">Name</th>
|
| 213 |
-
<th style="padding: 0.75rem; text-align: left; border: 1px solid #d1d5db;">Value</th>
|
| 214 |
-
</tr>
|
| 215 |
-
</thead>
|
| 216 |
-
<tbody>
|
| 217 |
-
<tr>
|
| 218 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>email</kbd></td>
|
| 219 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>user.email</kbd></td>
|
| 220 |
-
</tr>
|
| 221 |
-
<tr>
|
| 222 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>firstName</kbd></td>
|
| 223 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>user.firstName</kbd></td>
|
| 224 |
-
</tr>
|
| 225 |
-
<tr>
|
| 226 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>lastName</kbd></td>
|
| 227 |
-
<td style="padding: 0.75rem; border: 1px solid #d1d5db;"><kbd>user.lastName</kbd></td>
|
| 228 |
-
</tr>
|
| 229 |
-
</tbody>
|
| 230 |
-
</table>
|
| 231 |
|
| 232 |
<h3>Additional Support</h3>
|
| 233 |
<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>
|
|
@@ -238,6 +210,7 @@
|
|
| 238 |
|
| 239 |
<h3>Notes</h3>
|
| 240 |
<ul>
|
|
|
|
| 241 |
<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>
|
| 242 |
<li><p>Hugging Face uses SAML 2.0 with SHA256 encryption for security.</p></li>
|
| 243 |
<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>
|
|
|
|
| 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 2: Add Hugging Face App from Okta Integration Network (OIN)</h3>
|
| 76 |
+
<ol start="5">
|
| 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>Search for <strong>"Hugging Face"</strong> in the search bar.</p></li>
|
| 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 3: Configure the Hugging Face App in Okta</h3>
|
| 91 |
+
<ol start="11">
|
| 92 |
+
<li><p>On the <strong>General Settings</strong> page, enter the following:</p>
|
| 93 |
<ul>
|
| 94 |
+
<li><strong>Application label:</strong> <kbd>Hugging Face Enterprise Hub</kbd> (or customize as needed)</li>
|
| 95 |
+
<li><strong>Organization Name:</strong> Enter your Hugging Face organization name from Step 4 (e.g., <kbd>your-org</kbd>)</li>
|
| 96 |
+
<li><strong>Entity ID:</strong> This should be pre-filled as <kbd>https://huggingface.co</kbd></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 97 |
</ul>
|
| 98 |
</li>
|
| 99 |
|
| 100 |
+
<li><p>Click <strong>Next</strong>.</p></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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 4: Copy SAML Configuration from Okta</h3>
|
| 112 |
+
<ol start="15">
|
| 113 |
+
<li><p>From your Hugging Face app in Okta, go to the <strong>Sign On</strong> tab.</p></li>
|
| 114 |
|
| 115 |
+
<li><p>Scroll down to the <strong>SAML 2.0</strong> section and click <strong>View SAML setup instructions</strong>.</p></li>
|
| 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> (the full certificate text between <kbd>-----BEGIN CERTIFICATE-----</kbd> and <kbd>-----END CERTIFICATE-----</kbd>)</li>
|
| 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 5: Configure SAML in Hugging Face</h3>
|
| 127 |
+
<ol start="18">
|
| 128 |
+
<li><p>Return to the Hugging Face SSO settings page from Step 3:<br>
|
| 129 |
+
<kbd>https://huggingface.co/organizations/<your_org>/settings/sso</kbd>
|
|
|
|
|
|
|
|
|
|
| 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</li>
|
| 137 |
+
<li><strong>X.509 Certificate:</strong> Paste the full certificate text from Okta</li>
|
| 138 |
+
</ul>
|
| 139 |
+
</li>
|
| 140 |
|
| 141 |
<li><p>Click <strong>Update and Test SAML Configuration</strong>.</p></li>
|
| 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 |
+
<h3>Step 6: Assign Users in Okta</h3>
|
| 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>
|
|
|
|
| 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>
|
|
|
|
| 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>
|
|
|
|
| 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>
|