CharlieBoyer HF Staff commited on
Commit
2517343
·
verified ·
1 Parent(s): d2bdcac

Rename yo.html to index.html

Browse files
Files changed (1) hide show
  1. yo.html → index.html +67 -33
yo.html → index.html RENAMED
@@ -21,9 +21,16 @@
21
  <div>
22
  <p><strong>Prerequisites:</strong></p>
23
  <ul>
24
- <li>Your organization must be on an <strong>Enterprise</strong> or <strong>Enterprise Plus</strong> plan to enable SAML-based SSO.</li>
25
- <li>You must have administrator access to both your Okta organization and your Hugging Face Enterprise Hub organization.</li>
26
- <li>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>.
28
  </li>
29
  </ul>
@@ -34,84 +41,111 @@
34
  <ul>
35
  <li><a href="#features">Supported Features</a></li>
36
  <li><a href="#steps">Configuration Steps</a></li>
 
37
  <li><a href="#notes">Notes</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:</p>
 
43
  <ul>
44
- <li><strong>IdP-initiated SSO and SP-initiated SSO:</strong> Users can initiate authentication either from the identity provider (Okta) or from the service provider (Hugging Face).</li>
 
 
 
45
  </ul>
46
  <hr>
47
 
48
- <a name="steps"></a><h2>Configuration Steps</h2>
 
49
 
50
  <h3>Step 1 — Add the Hugging Face App from Okta Integration Network (OIN)</h3>
51
  <ol>
52
- <li>Sign in to your Okta Admin Dashboard.</li>
53
- <li>Go to <strong>Applications → Browse App Catalog</strong>.</li>
54
- <li>Search for and select the application named <strong>Hugging Face</strong>.</li>
55
- <li>Click <strong>Add Integration</strong>.</li>
56
  </ol>
57
 
58
  <h3>Step 2 — Configure the Hugging Face App in Okta</h3>
59
- <ol start="5">
60
- <li>On the <strong>General Settings</strong> page, enter:
61
  <ul>
62
  <li><strong>Application label:</strong> <kbd>Hugging Face</kbd></li>
63
  <li><strong>Organization Name:</strong> Your Hugging Face organization name</li>
64
  <li><strong>Organization ID:</strong> Your Hugging Face organization ID</li>
65
  </ul>
66
- <p><em>Where to find these values:</em> In Hugging Face, go to <strong>Organization Settings → SSO → SAML</strong>. You will see both the Organization Name and Organization ID.</p>
67
  <p><img src="/static/images/hf-sso-saml-screenshot.png" alt="Hugging Face SSO SAML screenshot" style="max-width:100%;height:auto;"></p>
68
  </li>
69
- <li>Click <strong>Next</strong>, review the Sign-On Options (username format should be <kbd>Email</kbd>), then click <strong>Done</strong>.</li>
70
- <li><strong>Important:</strong> Ensure the administrator performing these steps is <strong>assigned</strong> to the Hugging Face app in Okta (via the Assignments tab).</li>
71
  </ol>
72
 
73
  <h3>Step 3 — Copy SAML Configuration from Okta</h3>
74
- <ol start="8">
75
  <li>In the Hugging Face app in Okta, open the <strong>Sign On</strong> tab.</li>
76
- <li>Locate the <strong>SAML 2.0</strong> section and click <strong>View SAML Setup Instructions</strong> (or go to Metadata Details).</li>
77
  <li>Copy the following values:
78
  <ul>
79
  <li><strong>Identity Provider Single Sign-On URL</strong></li>
80
- <li><strong>X.509 Certificate</strong> — copy the full certificate including <kbd>-----BEGIN CERTIFICATE-----</kbd> and <kbd>-----END CERTIFICATE-----</kbd>.</li>
81
  </ul>
82
  </li>
83
  </ol>
84
 
85
  <h3>Step 4 — Configure SAML in Hugging Face</h3>
86
- <ol start="11">
87
- <li>Return to your organization’s <strong>Organization Settings → SSO → SAML</strong> tab in Hugging Face.</li>
88
- <li>Enter the values from Okta:
89
  <ul>
90
- <li><strong>Sign On URL:</strong> Paste the Identity Provider Single Sign-On URL from Okta.</li>
91
- <li><strong>X.509 Certificate:</strong> Paste the full certificate (including BEGIN/END markers) from Okta.</li>
92
  </ul>
93
  </li>
94
- <li>Click <strong>Update and Test SAML Configuration</strong> to validate.</li>
95
- <li>If the test is successful, toggle <strong>Enable SAML SSO</strong> to activate SSO for your organization.</li>
96
  </ol>
97
 
98
- <p><strong>What happens next ?</strong> Users will still sign in to Hugging Face with their usual accounts. When they access content belonging to your organization, they’ll be prompted to authenticate via SSO through Okta.</p>
 
 
 
 
 
 
 
 
 
 
 
99
 
100
  <hr>
101
 
102
- <a name="notes"></a><h2>Notes</h2>
 
103
  <ul>
104
- <li>This guide covers the <strong>Standard SSO</strong> setup. For <strong>Advanced SSO</strong> (with automated user provisioning and SCIM), see
105
  <a href="https://huggingface.co/docs/hub/en/enterprise-hub-advanced-sso" target="_blank">Advanced SSO Documentation</a>.
106
  </li>
107
- <li>For automated user lifecycle management via <strong>SCIM Provisioning</strong> (Enterprise Plus with Advanced SSO), see
108
- <a href="https://huggingface.co/docs/hub/en/enterprise-hub" target="_blank">SCIM and Advanced Features Overview</a>.
109
- </li>
110
- <li>Ensure the <strong>Organization Name</strong> and <strong>Organization ID</strong> entered in Okta exactly match those displayed in your Hugging Face SSO → SAML settings.</li>
 
 
 
 
 
 
 
 
111
  </ul>
112
  </div>
113
  </body>
114
 
115
 
116
 
 
117
  </html>
 
21
  <div>
22
  <p><strong>Prerequisites:</strong></p>
23
  <ul>
24
+ <li>Your organization must be on an <strong>Enterprise</strong> or <strong>Enterprise Plus</strong> plan to enable SAML-based Single Sign-On (SSO).</li>
25
+ <li>You must have <strong>administrator privileges</strong> in both your Okta organization and your Hugging Face Enterprise Hub organization.</li>
26
+ <li>Ensure your Hugging Face organization has a unique <strong>Organization Name</strong> and <strong>Organization ID</strong>. You will find these under <em>Organization Settings → SSO → SAML</em>.</li>
27
+ <li>Have your <strong>Okta Identity Provider (IdP) metadata</strong> available, including:
28
+ <ul>
29
+ <li>Identity Provider Single Sign-On URL</li>
30
+ <li>X.509 Certificate (full text including BEGIN/END markers)</li>
31
+ </ul>
32
+ </li>
33
+ <li>For more information about Hugging Face’s Enterprise SSO, see:
34
  <a href="https://huggingface.co/docs/hub/en/enterprise-sso" target="_blank">Hugging Face Enterprise SSO Documentation</a>.
35
  </li>
36
  </ul>
 
41
  <ul>
42
  <li><a href="#features">Supported Features</a></li>
43
  <li><a href="#steps">Configuration Steps</a></li>
44
+ <li><a href="#sp-initiated">SP-initiated SSO</a></li>
45
  <li><a href="#notes">Notes</a></li>
46
+ <li><a href="#support">Customer Support Contact</a></li>
47
  </ul>
48
  <hr>
49
 
50
+ <a name="features"></a>
51
+ <h2>Supported Features</h2>
52
+ <p>The Okta / Hugging Face Enterprise Hub SAML integration supports the following features:</p>
53
  <ul>
54
+ <li><strong>IdP-initiated SSO:</strong> Users can sign in to Hugging Face directly from the Okta dashboard.</li>
55
+ <li><strong>SP-initiated SSO:</strong> Users accessing Hugging Face content are redirected to Okta for authentication.</li>
56
+ <li><strong>JIT (Just-In-Time) provisioning:</strong> Supported for users authenticating via SAML (accounts are created upon first successful SSO login).</li>
57
+ <li><strong>Single Logout (SLO):</strong> Not currently supported.</li>
58
  </ul>
59
  <hr>
60
 
61
+ <a name="steps"></a>
62
+ <h2>Configuration Steps</h2>
63
 
64
  <h3>Step 1 — Add the Hugging Face App from Okta Integration Network (OIN)</h3>
65
  <ol>
66
+ <li>Sign in to your Okta Admin Console.</li>
67
+ <li>Navigate to <strong>Applications → Browse App Catalog</strong>.</li>
68
+ <li>Search for <strong>Hugging Face</strong> and click <strong>Add Integration</strong>.</li>
 
69
  </ol>
70
 
71
  <h3>Step 2 — Configure the Hugging Face App in Okta</h3>
72
+ <ol start="4">
73
+ <li>On the <strong>General Settings</strong> page, specify:
74
  <ul>
75
  <li><strong>Application label:</strong> <kbd>Hugging Face</kbd></li>
76
  <li><strong>Organization Name:</strong> Your Hugging Face organization name</li>
77
  <li><strong>Organization ID:</strong> Your Hugging Face organization ID</li>
78
  </ul>
79
+ <p><em>Where to find these values:</em> In Hugging Face, go to <strong>Organization Settings → SSO → SAML</strong>.</p>
80
  <p><img src="/static/images/hf-sso-saml-screenshot.png" alt="Hugging Face SSO SAML screenshot" style="max-width:100%;height:auto;"></p>
81
  </li>
82
+ <li>Click <strong>Next</strong>, review the sign-on options (the username format should be <kbd>Email</kbd>), and then click <strong>Done</strong>.</li>
83
+ <li><strong>Important:</strong> Ensure the administrator performing these steps is <strong>assigned</strong> to the Hugging Face app in Okta under the <strong>Assignments</strong> tab.</li>
84
  </ol>
85
 
86
  <h3>Step 3 — Copy SAML Configuration from Okta</h3>
87
+ <ol start="7">
88
  <li>In the Hugging Face app in Okta, open the <strong>Sign On</strong> tab.</li>
89
+ <li>Locate the <strong>SAML 2.0</strong> section and click <strong>View SAML Setup Instructions</strong>.</li>
90
  <li>Copy the following values:
91
  <ul>
92
  <li><strong>Identity Provider Single Sign-On URL</strong></li>
93
+ <li><strong>X.509 Certificate</strong> — copy the full text including <kbd>-----BEGIN CERTIFICATE-----</kbd> and <kbd>-----END CERTIFICATE-----</kbd>.</li>
94
  </ul>
95
  </li>
96
  </ol>
97
 
98
  <h3>Step 4 — Configure SAML in Hugging Face</h3>
99
+ <ol start="10">
100
+ <li>In Hugging Face, navigate to <strong>Organization Settings → SSO → SAML</strong>.</li>
101
+ <li>Enter the values obtained from Okta:
102
  <ul>
103
+ <li><strong>Sign On URL:</strong> Paste the Identity Provider Single Sign-On URL.</li>
104
+ <li><strong>X.509 Certificate:</strong> Paste the certificate including BEGIN/END markers.</li>
105
  </ul>
106
  </li>
107
+ <li>Click <strong>Update and Test SAML Configuration</strong>.</li>
108
+ <li>If the test succeeds, toggle <strong>Enable SAML SSO</strong> to activate SSO for your organization.</li>
109
  </ol>
110
 
111
+ <hr>
112
+
113
+ <a name="sp-initiated"></a>
114
+ <h2>SP-Initiated SSO</h2>
115
+ <p>Hugging Face also supports SP-initiated Single Sign-On. To initiate login directly from Hugging Face:</p>
116
+ <ol>
117
+ <li>Navigate to <a href="https://huggingface.co/login" target="_blank">https://huggingface.co/login</a>.</li>
118
+ <li>Select <strong>Sign in with your Enterprise SSO</strong>.</li>
119
+ <li>Enter your Hugging Face <strong>organization name</strong> and click <strong>Continue</strong>.</li>
120
+ <li>You’ll be redirected to Okta to authenticate, and then returned to your Hugging Face organization workspace.</li>
121
+ </ol>
122
+ <p>This flow can also occur automatically when accessing restricted organization content — users will be prompted with a “Login with SSO” banner that redirects to Okta.</p>
123
 
124
  <hr>
125
 
126
+ <a name="notes"></a>
127
+ <h2>Notes</h2>
128
  <ul>
129
+ <li>This setup describes <strong>Standard SSO</strong>. For <strong>Advanced SSO</strong> (with SCIM user provisioning and additional network security controls), see
130
  <a href="https://huggingface.co/docs/hub/en/enterprise-hub-advanced-sso" target="_blank">Advanced SSO Documentation</a>.
131
  </li>
132
+ <li>Ensure that the <strong>Organization Name</strong> and <strong>Organization ID</strong> used in Okta exactly match those in Hugging Face SSO settings.</li>
133
+ <li>After enabling SAML, access to organization resources will require authentication through Okta.</li>
134
+ </ul>
135
+
136
+ <hr>
137
+
138
+ <a name="support"></a>
139
+ <h2>Customer Support Contact</h2>
140
+ <p>For assistance with SSO setup or troubleshooting, please contact the Hugging Face Enterprise Support team:</p>
141
+ <ul>
142
+ <li><strong>Email:</strong> <a href="mailto:enterprise-support@huggingface.co">enterprise-support@huggingface.co</a></li>
143
+ <li><strong>Documentation:</strong> <a href="https://huggingface.co/docs/hub/en/enterprise-sso" target="_blank">https://huggingface.co/docs/hub/en/enterprise-sso</a></li>
144
  </ul>
145
  </div>
146
  </body>
147
 
148
 
149
 
150
+
151
  </html>