Skip to content
Zulip help center

SCIM provisioning

SCIM (System for Cross-domain Identity Management) is a standard protocol used by Single Sign-On (SSO) services and identity providers to provision/deprovision user accounts and groups. Zulip supports SCIM integration, both in Zulip Cloud and for self-hosted Zulip servers. This page describes how to configure SCIM provisioning for Zulip.

Configure SCIM

Section titled “Configure SCIM”
  1. Make sure your Zulip Cloud organization is on the Zulip Cloud Plus plan.
  2. Contact support@zulip.com to request the Bearer token that Okta will use to authenticate to your SCIM API.
  3. In your Okta Dashboard, go to Applications, and select Browse App Catalog.
  4. Search for SCIM and select SCIM 2.0 Test App (Header Auth).
  5. Click Add and choose your Application label. For example, you can name it “Zulip SCIM”.
  6. Continue to Sign-On Options. Leave the SAML options as they are. This type of Okta application doesn’t actually support SAML authentication, and you’ll need to set up a separate Okta app to activate SAML for your Zulip organization.
  7. In Credentials Details, specify the following fields:
    • Application username format: Email
    • Update application username on: Create and update
  8. In the Provisioning tab, click Configure API Integration, check the Enable API integration checkbox, and specify the following fields:
    • Base URL for Zulip Cloud: https://your-org.zulipchat.com/scim/v2
    • Base URL for self-hosting: https://zulip.example.com/scim/v2
    • API token: Bearer <token> (given to you by Zulip support) When you proceed to the next step, Okta will verify that these details are correct by making a SCIM request to the Zulip server.
  9. Enable the following Provisioning to App settings:
    • Create Users
    • Update User Attributes
    • Deactivate Users
  10. Remove all attributes in Attribute Mappings, except for the following:
    • userName
    • givenName
    • familyName
  11. Optional: If you’d like to also sync user role, you can do it by adding a custom attribute in Okta. Go to the Profile Editor, click into the entry of the SCIM app you’ve just set up and Add Attribute. Configure the following:
    • Data type: string
    • Variable name: role
    • External name: role
    • External namespace: urn:ietf:params:scim:schemas:core:2.0:User With the attribute added, you will now be able to set it for your users directly or configure an appropriate Attribute mapping in the app’s Provisioning section. The valid values are: owner, administrator, moderator, member, guest.
  12. Now that the integration is ready to manage Zulip user accounts, assign users to the SCIM app.
    • When you assign a user, Okta will check if the account exists in your Zulip organization. If it doesn’t, the account will be created.
    • Changes to the user’s email or name in Okta will automatically cause the Zulip account to be updated accordingly.
    • Unassigning a user from the app will deactivate their Zulip account.

Synchronizing group membership with SCIM

Section titled “Synchronizing group membership with SCIM”

You can enable group sync for any of your SCIM provider’s groups. When you do, the SCIM integration will create a user group in Zulip with the matching name and user memberships. When you add or remove users from the group in your SCIM provider, these changes will immediately be reflected in group memberships in Zulip.

In order to ensure consistent state, do not modify the name or user memberships of SCIM-managed groups inside of Zulip. Such groups are meant to be managed in your SCIM provider. Changes made on the Zulip side will not be reflected in your SCIM provider, and instead will cause the state of the Zulip group to become inconsistent with the state of the SCIM provider’s group.

Zulip supports adding user groups to other groups, but some SCIM providers (including Okta) do not. As a result, this concept is also not supported in Zulip’s SCIM integration. If you want to use nested groups, you can add groups to other groups in Zulip and manage the individual members of each subgroup in your SCIM provider.

  1. Follow the instructions above to configure SCIM.
  2. Rename any Zulip groups that have the same names as groups that you want to sync. If you push a group whose name matches an existing Zulip group, the request will fail.
  3. Open the Application you set up above for the Zulip SCIM integration, and go to the Push groups tab. This menu allows you to choose the Okta groups which should be synchronized with Zulip’s user groups.
Section titled “Related articles”