logofirst
logofirst GitHub

Set up SCIM2 for Label Studio

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.

Using SCIM provider, you can manage access to Label Studio Enterprise workspaces, grant roles to individual users and groups.

Requirements

SCIM interacts with your SSO integration.

note

Okta or similar SSO providers have SCIM integration based on SSO.

important

If you do not have SSO set up yet, then follow Set up SSO.

Label Studio Enterprise uses SCIM Version 2.0 standard. As an example, this page uses integration with Okta. However, Label Studio Enterprise follows SCIM RFC 5741 and can be integrated with any access management services that support the standard.

Set up SCIM integration

Check this video tutorial about SCIM and Okta setup

To manage access to Label Studio Enterprise, add the application to your SCIM provider (Okta). Okta uses OAuth token to interact with REST API endpoints of the application to provision and deprovision access.

Add Label Studio Enterprise (if not complete)

  1. Navigate to Applications → Applications in Okta. Click Create App Integration.
  2. Select SAML 2.0. Fill App name (for example, Label Studio Enterprise).
  3. On the next step Configure SAML set up SAML integration following the instructions to Set up SSO guide.
  4. Make sure Label Studio Enterprise appears in the list of active applications.

Enable SCIM provisioning

  1. Navigate to Applications → Applications in Okta.
  2. Select Label Studio Enterprise.
  3. Go to General tab and check Enable SCIM provisioning.
  4. Switch to Provisioning tab.
  5. Select Integration in the left menu.
  6. Click Edit in the right corner.

Fill in the fields:

SCIM settings and application triggers

  1. On the application page navigate to Provisioning tab and select To App in the left menu. Click Edit in the right corner.
  2. Enable the following items:
    • Create Users
    • Update User Attributes
    • Deactivate Users
    • Sync Password

Assign the application to a single user

You can assign the application on both the user page and application page.

  1. On the application page navigate to Assignments tab.
  2. Click Assign and select Assign to People.
  3. Select the people you would like to be added to Label Studio Enterprise.
  4. Click Done.

After you click Done, Okta will send the requests to create users accordingly in the Label Studio Enterprise.

Unassigning the application for users

  1. On the application page navigate to Assignments tab.
  2. Select People in the left menu.
  3. Click the delete cross against the user you would like to unassign.
  4. Confirm the unassignment.

Assign the application to a group

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.

Set up group mapping

  1. In Label Studio open SCIM settings (Organization → SCIM).
  2. Update roles and workplaces mapping. If a workplace does not exist it will be created with the name of Okta group.

Assign a group to the application

  1. Using Okta, navigate to the application page and open the Assignments tab.
  2. Select Assign → Assign to Groups and choose the group.
  3. Set attribute Active to true.

After saving the group assignment, the update will be queued and sent to Label Studio.

note

Alternatively, you can push the changes immediately to Label Studio.

Sync groups to the application

  1. Using Okta, navigate to the application page and open the Push Groups tab.
  2. Click Push Groups and select Find groups by name.
  3. Find the group you would like to sync to Label Studio.
    1. Choose either Create Group or Link Group, if you already have a workplace with the same name as specified on the SCIM >> Settings page.

Unassigning the application for groups

To unassign a group from the application, follow the steps for [Unassigning the application for users](#Unassigning the application for users).

  1. On the application page, navigate to the Assignments tab.
  2. Select Group in the left menu.
  3. Click the delete cross against the group you would like to unassign.
  4. Confirm the unassignment.

Check this video tutorial to remove a user and group.