SCIM user and group synchronization#

SEP can be configured to synchronize users and groups with external providers using the System for Cross-domain Identity Management (SCIM) protocol. Once users and groups have been added, use access control systems in SEP to provision access to data.

Note

SCIM user and group synchronization is a public preview feature. Contact Starburst support with questions or feedback.

Configuration#

To configure user and group synchronization with a SCIM provider, you must configure the following components:

  • Configure an internal group provider in SEP

  • Enable user provisioning with SCIM

  • Configure an external provider

Configure an internal group provider#

SEP requires a group provider configuration to handle imported users and groups internally. Create an etc/group-provider.properties configuration file on the coordinator with the following contents:

group-provider.name=starburst

The SEP group provider includes an optional cache for user/group lookups, which is enabled by default. It can be disabled with the following property:

starburst-group-provider.cache.enabled=false

When caching is enabled, the following optional properties are also available:

starburst-group-provider.cache.ttl=10s
starburst-group-provider.cache.maximum-size=1024

Enable user provisioning with SCIM#

Add the following configuration properties to config.properties to enable SCIM user provisioning in SEP and define a secret token for the provider to connect:

starburst.users.provisioning.type=SCIM
starburst.users.provisioning.scim.secret-token=secret_token

Configure an external provider#

The external identity provider service must be able to connect to the SEP coordinator, either directly or through a network proxy.

The following external identity providers are supported for user and group synchronzation with SCIM:

Azure Active Directory#

To connect Microsoft Azure Active Directory to SEP as a SCIM identity provider, follow these steps:

  1. In Azure, go to Enterprise applications and click New application.

  2. Click Create your own application.

  3. Provide a name for the application, select Integrate any other application you don’t find in the gallery (Non-gallery), and click Create.

  4. On the newly created application page, navigate to Provisioning and click Get started.

  5. Select Automatic in Provisioning Mode. Provide the SEP coordinator URL with /scim/v2 suffix in Tenant URL field, and the previously-configured token in the Secret token field.

  6. Click Test connection. If successful, click Save.

  7. Go to Overview page and select Start provisioning. The provisioning process is scheduled and may take some time to finish.

Okta#

To connect Okta to SEP as a SCIM identity provider, follow these steps:

  1. In Okta, go to Applications and click Create App Integration.

  2. Select SAML 2.0 and click Next.

    Note

    Okta does not support SCIM provisioning for OIDC - OpenID Connect applications. To use SCIM provisioning with OAuth 2.0 authentication you must create a second app integration with the SAML 2.0 sign in method.

  3. Provide a name for the integration and click Next.

  4. Provide a Single sign-on URL and Audience URI (SP Entity ID). These values are not used during provisioning; set them to the SEP coordinator URL and click Next.

  5. Select I’m an Okta customer adding an internal app and click Finish.

  6. Select the General tab, then click Edit in the App Settings section.

  7. Check the Enable SCIM provisioning checkbox and click Save.

  8. Select the Provisioning tab and click Edit.

  9. Provide the SEP coordinator URL with the /scim/v2 suffix in the SCIM connector base URL field, and a user identifier in Unique identifier field for users.

  10. Check Push New Users, Push Profile Updates, and Push Groups.

  11. Select the HTTP Header authentication mode and the previously-configured token in the Authorization field.

  12. Click Test Connector Configuration. If successful, click Save.

    Example of connection info for SCIM configuration in Okta

  13. On the Provisioning tab, click Edit again.

  14. Check Enable for Create Users, Update User Attributes, and Deactivate Users, then click Save.

Next steps#

Once provisioning is successful, users and groups from the external service should appear in SEP. You can now configure access control rules using Built-in access control overview that apply to these users and groups.