Skip to content

Commit acd4d5b

Browse files
add okta configuration steps for scim
1 parent 32e229b commit acd4d5b

File tree

3 files changed

+66
-1
lines changed

3 files changed

+66
-1
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 in the Hub
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-okta-scim.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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 **Provisioning** tab and click **Integration** from the side nav.
25+
3. Check **Enable API Integration**.
26+
4. Enter the **SCIM Tenant URL** as the Base URL.
27+
5. Enter the **access token** you generated as the OAuth Bearer Token.
28+
6. Click **Test API Credentials** to verify the connection.
29+
7. Save your changes.
30+
31+
### Step 3: Configure Provisioning
32+
33+
1. In the **Provisioning** tab, click **To App** from the side nav.
34+
2. Click **Edit** and check to Enable all the features you need, i.e. Create, Update, Delete Users.
35+
3. Click **Save** at the bottom.
36+
37+
### Step 4: Configure Attribute Mappings
38+
1. While still in the **Provisioning** tab scroll down to Attribute Mappings section
39+
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:
40+
41+
<div class="flex justify-center">
42+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/blob/main/hub/sso/scim-okta-mappings.png" alt="Okta SCIM mappings"/>
43+
</div>
44+
45+
### Step 5: Test Assigning Users
46+
47+
1. Visit the **Assignments** tab, click **Assign**
48+
2. Click **Assign to People** or **Assign to Groups**
49+
3. After finding the User or Group that needs to be assigned, click **Assign** next to their name
50+
4. In the mapping modal the Username needs to be edited.
51+
52+
> **Note:**
53+
> Only regular characters and `-` are accepted in the Username.
54+
> - `--` (double dash) is forbidden.
55+
> - `-` cannot start or end the name.
56+
> - Digit-only names are not accepted.
57+
> - Minimum length is 2 and maximum length is 42.
58+
> - Username has to be unique
59+
60+
5. Scroll down and click **Save and Go Back**
61+
6. Click **Done**
62+
7. Confirm that users or groups are created, updated, or deactivated in your Hugging Face organization as expected.

0 commit comments

Comments
 (0)