You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/guide/scim_setup.md
+40-45Lines changed: 40 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,66 +12,62 @@ parent: "admin_auth"
12
12
parent_enterprise: "admin_auth"
13
13
---
14
14
15
-
System for Cross-domain Identity Management (SCIM) is a popular protocol to manage access for services and applications across an organization. This guide helps to set up SCIM integration to manage access to Label Studio Enterprise in your organization.
15
+
System for Cross-domain Identity Management (SCIM) is a popular protocol to manage access for services and applications across an organization.
16
16
17
-
Using SCIM provider, you can manage access to Label Studio Enterprise workspaces, grant roles to individual users and groups.
17
+
Using a SCIM provider, you can manage access to Label Studio Enterprise workspaces, and grant roles to individual users and groups.
18
18
19
19
## Requirements
20
20
21
-
SCIM interacts with your SSO integration.
22
-
23
-
!!! note
24
-
Okta or similar SSO providers have SCIM integration based on SSO.
25
-
26
-
27
-
!!! attention "important"
28
-
If you do not have SSO set up yet, then follow [Set up SSO](auth_setup.html).
21
+
Label Studio Enterprise uses the SCIM Version 2.0 standard.
29
22
23
+
Label Studio Enterprise follows [SCIM RFC 5741](https://datatracker.ietf.org/doc/html/rfc7644#section-3.2) and can be integrated with any access management services that support the standard.
30
24
31
-
!!! attention "important"
32
-
Only owner's access token can be used for SCIM Identity Provider.
25
+
For more information on SCIM workflows, see [How SCIM works with Label Studio Enterprise](scim_workflow).
33
26
27
+
## Prerequisites
34
28
35
-
Label Studio Enterprise uses SCIM Version 2.0 standard. As an example, this page uses integration with [Okta](https://www.okta.com/integrate/). However, Label Studio Enterprise follows [SCIM RFC 5741](https://datatracker.ietf.org/doc/html/rfc7644#section-3.2) and can be integrated with any access management services that support the standard.
29
+
*SCIM interacts with your SSO integration. Before you begin, you must have SSO already configured. If you do not have SSO set up yet, then follow [Set up SSO](auth_setup.html).
36
30
37
-
For more information on how SCIM workflows, see [How SCIM works with Label Studio Enterprise](scim_workflow).
31
+
!!! note
32
+
Okta or similar SSO providers have SCIM integration based on SSO.
38
33
39
-
## Set up SCIM integration
34
+
* You will need to provide a [Legacy token](access_tokens#Legacy-tokens), and it must be associated with the Owner role of your organization.
40
35
41
-
<i>Check this video tutorial about SCIM and Okta setup.</i>
36
+
## Set up SCIM integration with Okta
42
37
43
38
!!! attention "important"
44
39
This video demonstrates the use of `userName` in the 'Unique Identifier Field for Users' field. It is essential to use `email` as the unique identifier instead of `userName`; otherwise, SCIM will not function correctly with users who were created prior to the SCIM integration.
45
40
46
41
<iframewidth="560"height="315"src="https://www.youtube.com/embed/MA3de3gu18A"title="YouTube video player"frameborder="0"allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"allowfullscreen></iframe>
47
42
48
-
To manage access to Label Studio Enterprise, add the application to your SCIM provider (Okta). Okta uses Bearer (request header should be `Authorization: Bearer <token>`) token to interact with REST API endpoints of the application to provision and deprovision access.
43
+
To manage access to Label Studio Enterprise, add the application to your SCIM provider (Okta).
44
+
45
+
Okta uses a Bearer (request header should be `Authorization: Bearer <token>`) token to interact with REST API endpoints of the application to provision and deprovision access.
49
46
50
-
### Add Label Studio Enterprise (if not complete)
47
+
### Add Label Studio Enterprise as an application (if not complete)
51
48
52
-
1. Navigate to **Applications → Applications** in Okta. Click **Create App Integration**.
53
-
2. Select **SAML 2.0**. Fill App name (for example, _Label Studio Enterprise_).
54
-
3.On the next step **Configure SAML** set up SAML integration following the instructions to[Set up SSO guide](auth_setup.html).
49
+
1. Navigate to **Applications > Applications** in Okta. Click **Create App Integration**.
50
+
2. Select **SAML 2.0**. Enter an app name (for example, _Label Studio Enterprise_).
51
+
3.Under **Configure SAML**, set up the SAML integration following the steps outlined in[Set up SSO guide](auth_setup.html).
55
52
4. Make sure Label Studio Enterprise appears in the list of active applications.
56
53
57
54
### Enable SCIM provisioning
58
55
59
-
1. Navigate to **Applications → Applications** in Okta.
56
+
1. Navigate to **Applications > Applications** in Okta.
60
57
2. Select **Label Studio Enterprise**.
61
-
3.Go to**General** tab and check**Enable SCIM provisioning**.
62
-
4.Switch to**Provisioning** tab.
58
+
3.Select the**General** tab and select**Enable SCIM provisioning**.
59
+
4.Select the**Provisioning** tab.
63
60
5. Select **Integration** in the left menu.
64
61
6. Click **Edit** in the right corner.
65
62
66
-
Fill in the fields:
67
-
-**SCIM connector base URL**: `https://<LABEL_STUDIO_BASE_URL>/scim/v2/` where `<LABEL_STUDIO_BASE_URL>` is the base URL of your Label Studio Enterprise instance.
68
-
-**Unique identifier field for users**: Use `email`. Label Studio Enterprise uses email as user identifier in this field.
69
-
-**Supported provisioning actions**: Select the following items:
70
-
- Import New Users and Profile Updates
71
-
- Push New Users
72
-
- Push Profile Updates
73
-
- Push Groups
74
-
-**HTTP Header → `Authorization: Bearer <token>`**: Put the Bearer token from the LSE owner's account profile. In case of Label Studio `Token` and `Bearer` are the same tokens. However, it's important to use `Bearer` instead of `Token` in the request header.
63
+
Complete the following fields:
64
+
65
+
| Field | Value/Description |
66
+
|-------|-------------------|
67
+
|**SCIM connector base URL**|`https://<LABEL_STUDIO_BASE_URL>/scim/v2/` where `<LABEL_STUDIO_BASE_URL>` is the base URL of your Label Studio Enterprise instance. |
68
+
|**Unique identifier field for users**| Use `email`. Label Studio Enterprise uses email as user identifier in this field. |
69
+
|**Supported provisioning actions**| Select the following items:<br>- Import New Users and Profile Updates<br>- Push New Users<br>- Push Profile Updates<br>- Push Groups |
70
+
|**HTTP Header → `Authorization: Bearer <token>`**| Enter the [Legacy token](access_tokens#Legacy-tokens) associated with the Owner account in Label Studio. <br />For Label Studio, `Token` and `Bearer` are the same tokens. However, it's important to use `Bearer` instead of `Token` in the request header. |
75
71
76
72
### SCIM settings and application triggers
77
73
@@ -81,7 +77,7 @@ Fill in the fields:
81
77
- Update User Attributes
82
78
- Deactivate Users
83
79
84
-
## Assign the application to a single user
80
+
###Assign the application to a single user
85
81
86
82
You can assign the application on both the **user** page and **application** page.
87
83
@@ -92,24 +88,21 @@ You can assign the application on both the **user** page and **application** pag
92
88
93
89
After you click **Done**, Okta will send the requests to create users accordingly in the Label Studio Enterprise.
94
90
95
-
## Unassigning the application for users
91
+
###Unassigning the application for users
96
92
97
93
1. On the application page navigate to **Assignments** tab.
98
94
2. Select **People** in the left menu.
99
95
3. Click the delete cross against the user you would like to unassign.
100
96
4. Confirm the unassignment.
101
97
102
-
## Assign the application to a group
98
+
###Assign the application to a group
103
99
104
100
The most convenient way to manage access to the application is via groups. You can assign Label Studio to groups and manage the groups in Okta. The changes will be propagated to the application.
105
101
106
-
### Set up group mapping
102
+
### Set up group mapping in Label Studio
107
103
108
104
1. In Label Studio, click the menu in the upper left and select **Organization**.
109
105
110
-

111
-
112
-
If you do not see the option to select **Organization**, you are not logged in with the appropriate role.
113
106
2. Select **SCIM** in the upper right.
114
107
3. Update roles and workspaces mapping. Ensure the group name you enter is the same as the group name being sent by your SCIM provider.
115
108
@@ -125,8 +118,6 @@ The most convenient way to manage access to the application is via groups. You c
125
118
126
119
If you select **Inherit**, the group will inherit the role set above under **Organization Roles to Groups Mapping.** If the group is inheriting the Not Activated role, the users are mapped to the project, but they are not actually assigned to the project until the group is synced (meaning that the user authenticates first).
127
120
128
-
129
-
130
121
### Assign a group to the application
131
122
132
123
1. Using Okta, navigate to the **application** page and open the **Assignments** tab.
@@ -145,7 +136,7 @@ After saving the group assignment, the update will be queued and sent to Label S
145
136
3. Find the group you would like to sync to Label Studio.
146
137
4.4. Choose either **Create Group** or **Link Group**, if you already have a workplace with the same name as specified on the **SCIM** >> **Settings** page.
147
138
148
-
## Unassigning the application for groups
139
+
###Unassigning the application for groups
149
140
150
141
To unassign a group from the application, follow the steps for [Unassigning the application for users](#Unassigning-the-application-for-users).
151
142
@@ -188,9 +179,13 @@ Label Studio Enterprise supports a limited set of SCIM user attributes for provi
188
179
2. Select your enterprise application.
189
180
3. Select **Provisioning** in the left menu.
190
181
4. Set the **Tenant URL** to `https://<LABEL_STUDIO_BASE_URL>/scim/v2/`.
191
-
5. Set the **Secret Token** to the Bearer token from the Label Studio owner's account profile.
182
+
5. Set the **Secret Token** to the [Legacy token](access_tokens#Legacy-tokens) associated with the Owner account in Label Studio.
183
+
184
+
This must be the Legacy token, not the Personal Access Token. It must also be associated with the user in the Owner role.
192
185
6. Under **Mappings**, open **Provision Microsoft Entra ID Users**.
193
-
7. Remove all attribute mappings except the supported ones listed above. Keep:
186
+
7. Remove all attribute mappings except the supported ones listed above.
0 commit comments