Skip to content

Commit ef78124

Browse files
add okta configuration steps for scim (#1854)
* add okta configuration steps for scim * fix note slightly * address comments * add dark picture * add more detailed steps for HF apps * use bold instead of quotes * add username rules to entra
1 parent 1d47615 commit ef78124

File tree

4 files changed

+88
-2
lines changed

4 files changed

+88
-2
lines changed

docs/hub/_toctree.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -396,6 +396,8 @@
396396
title: How to configure OIDC with Azure in the Hub
397397
- local: security-sso-entra-id-scim
398398
title: How to configure SCIM with Microsoft Entra ID (Azure AD)
399+
- local: security-sso-okta-scim
400+
title: How to configure SCIM with Okta
399401
- local: security-resource-groups
400402
title: Advanced Access Control (Resource Groups)
401403
- local: security-malware

docs/hub/enterprise-hub-scim.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,5 @@ Once SCIM is enabled in your IdP, users and groups provisioned will appear in th
3030
## Supported Identity Providers
3131

3232
We support SCIM with any IdP that implements the SCIM 2.0 protocol. We have specific guides for some of the most popular providers:
33-
- [How to configure SCIM with Microsoft Entra ID](./security-sso-entra-id-scim)
33+
- [How to configure SCIM with Microsoft Entra ID](./security-sso-entra-id-scim)
34+
- [How to configure SCIM with Okta](./security-sso-okta-scim)

docs/hub/security-sso-entra-id-scim.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,20 @@ This feature is part of the <a href="https://huggingface.co/contact/sales?from=e
5252
| `name.formatted` | `Join(" ", [givenName], [surname])` | |
5353
| `externalId` | `objectId` | `1` |
5454

55-
3. After configuring the user mappings, go back to the Provisioning screen and click on **Provision Microsoft Entra ID Groups** to review group mappings. The default settings for groups are usually sufficient.
55+
3. The Username needs to comply with the following rules.
56+
57+
<Tip warning={true}>
58+
<ul>
59+
<li>Only regular characters and `-` are accepted in the Username.</li>
60+
<li>`--` (double dash) is forbidden.</li>
61+
<li>`-` cannot start or end the name.</li>
62+
<li>Digit-only names are not accepted.</li>
63+
<li>Minimum length is 2 and maximum length is 42.</li>
64+
<li>Username has to be unique within your org.</li>
65+
</ul>
66+
</Tip>
67+
68+
4. After configuring the user mappings, go back to the Provisioning screen and click on **Provision Microsoft Entra ID Groups** to review group mappings. The default settings for groups are usually sufficient.
5669

5770
### Step 5: Start Provisioning
5871

docs/hub/security-sso-okta-scim.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# How to configure SCIM with Okta
2+
3+
This guide explains how to set up SCIM user and group provisioning between Okta and your Hugging Face organization using SCIM.
4+
5+
<Tip warning={true}>
6+
This feature is part of the <a href="https://huggingface.co/contact/sales?from=enterprise" target="_blank">Enterprise Plus</a> plan.
7+
</Tip>
8+
9+
### Step 1: Get SCIM configuration from Hugging Face
10+
11+
1. Navigate to your organization's settings page on Hugging Face.
12+
2. Go to the **SSO** tab, then click on the **SCIM** sub-tab.
13+
3. Copy the **SCIM Tenant URL**. You will need this for the Okta configuration.
14+
4. Click **Generate an access token**. A new SCIM token will be generated. Copy this token immediately and store it securely, as you will not be able to see it again.
15+
16+
<div class="flex justify-center">
17+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/sso/scim-settings.png"/>
18+
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/sso/scim-settings-dark.png"/>
19+
</div>
20+
21+
### Step 2: Enter Admin Credentials
22+
23+
1. In Okta, go to **Applications** and select your Hugging Face app.
24+
2. Go to the **General** tab and click **Edit** on App Settings
25+
3. For the Provisioning option select **SCIM**, click **Save**
26+
4. Go to the **Provisioning** tab and click **Edit**.
27+
5. Enter the **SCIM Tenant URL** as the SCIM connector base URL.
28+
6. Enter **userName** for Unique identifier field for users.
29+
7. Select all necessary actions for Supported provisioning actions.
30+
8. Select **HTTP Header** for Authentication Mode.
31+
9. Enter the **Access Token** you generated as the Authorization Bearer Token.
32+
10. Click **Test Connector Configuration** to verify the connection.
33+
11. Save your changes.
34+
35+
### Step 3: Configure Provisioning
36+
37+
1. In the **Provisioning** tab, click **To App** from the side nav.
38+
2. Click **Edit** and check to Enable all the features you need, i.e. Create, Update, Delete Users.
39+
3. Click **Save** at the bottom.
40+
41+
### Step 4: Configure Attribute Mappings
42+
1. While still in the **Provisioning** tab scroll down to Attribute Mappings section
43+
2. The default attribute mappings often require adjustments for robust provisioning. We recommend using the following configuration. You can delete attributes that are not here:
44+
45+
<div class="flex justify-center">
46+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/sso/scim-okta-mappings.png" alt="Okta SCIM mappings"/>
47+
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/sso/scim-okta-mappings-dark.png" alt="Okta SCIM mappings"/>
48+
</div>
49+
50+
### Step 5: Assign Users or Groups
51+
52+
1. Visit the **Assignments** tab, click **Assign**
53+
2. Click **Assign to People** or **Assign to Groups**
54+
3. After finding the User or Group that needs to be assigned, click **Assign** next to their name
55+
4. In the mapping modal the Username needs to be edited to comply with the following rules.
56+
57+
<Tip warning={true}>
58+
<ul>
59+
<li>Only regular characters and `-` are accepted in the Username.</li>
60+
<li>`--` (double dash) is forbidden.</li>
61+
<li>`-` cannot start or end the name.</li>
62+
<li>Digit-only names are not accepted.</li>
63+
<li>Minimum length is 2 and maximum length is 42.</li>
64+
<li>Username has to be unique within your org.</li>
65+
</ul>
66+
</Tip>
67+
68+
5. Scroll down and click **Save and Go Back**
69+
6. Click **Done**
70+
7. Confirm that users or groups are created, updated, or deactivated in your Hugging Face organization as expected.

0 commit comments

Comments
 (0)