Documentation

Provision groups with SCIM

Sync groups and their membership from your identity provider.
Read time 3 minutesLast updated a day ago

When you assign a group to your Unity application in your IdP, your IdP provisions the group in your Unity organization, adds its members, and keeps its name and membership in sync. Use these groups to grant project roles to everyone in the group: assign the roles to the group in the Unity Dashboard, and members gain or lose them as your IdP adds or removes them. For more about groups in the Unity Dashboard, refer to How do I create a group within my Unity organization?
Group provisioning uses the same service account, SCIM base connector URL, and Enable SCIM Provisioning setting as user provisioning. There's no separate setting to turn it on.

Prerequisites

Before you can provision groups, ensure that you meet these prerequisites:
  • You have set up and enabled SCIM provisioning for users. Unity accepts only members who are users in your validated domains, so provision users before their groups.
  • Your IdP supports pushing groups through SCIM. Unity has verified group support for Okta.

Set up group provisioning in your IdP

To set up group provisioning in Okta, follow the step Push Okta groups to Unity, in Set up SCIM with Okta.

Supported operations

Unity's SCIM endpoints support group resources for these operations:
  • Provision a group, with its members
  • List groups, or find a group by
    displayName
  • Retrieve a group and its members
  • Update or replace a group, including adding and removing members
  • Delete a group

Data mapping

This table shows the mapping from SCIM group attributes to Unity groups:

SCIM attribute

Unity group field

Comment

displayNameNameGroup names must be unique within your organization.
membersMembersEach member must be a user in one of your organization's validated domains. Provision users before their groups.

SCIM-controlled groups in the Unity Dashboard

Your IdP is the source of truth for the groups it provisions. On the Groups page of the Unity Dashboard, these groups have a SCIM badge, and you can't make these changes to them:
  • Add or remove members
  • Edit or delete the group
  • Invite users into the group
You can still assign and remove project roles on a SCIM-controlled group. Make all other changes in your IdP.
Groups that you create in the Unity Dashboard aren't affected. You manage them manually, as before, and your IdP can't read or change them.

Important considerations

Before you provision groups, consider these points:
  • Name conflicts with Dashboard groups. SCIM doesn't take over groups that you created in the Unity Dashboard. If your IdP pushes a group whose name matches a group created in the Dashboard, Unity rejects the request. Rename or delete the conflicting group, and then retry the sync.
  • Members outside your validated domains. Unity rejects a request that adds a member who isn't a user in one of your validated domains. If a SCIM-controlled group already contains users from outside your validated domains, SCIM doesn't remove them or return them to your IdP.
  • Nested groups. Unity doesn't support nested groups. If your IdP sends a group that contains another group, Unity creates the inner group as a separate group without members, and doesn't link the two. To populate the inner group, assign it to your Unity application in your IdP. Removing an inner group from its parent doesn't delete it.
  • Filtering. When your IdP lists groups, Unity supports only the
    displayName eq
    filter.
  • Group features. Groups grant project roles only. You can't use groups to assign organization roles or seats.
  • Enforcement. SCIM user provisioning enforcement applies to users only. Groups don't have an enforcement setting, and you can create groups in the Unity Dashboard whether or not you enforce SCIM user provisioning.

Next steps