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

Update index.html

Browse files
Files changed (1) hide show
  1. index.html +29 -25
index.html CHANGED
@@ -21,10 +21,11 @@
21
  <div>
22
  <p><strong>Prerequisites:</strong></p>
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,39 +41,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 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
 
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>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>
@@ -81,33 +82,36 @@
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>
 
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>
30
  </div>
31
  </div>
 
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>
 
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>