Skip to content
Contact us
  • There are no suggestions because the search field is empty.

Setting up SCIM for User Management in Brevity

Automated user and team lifecycle management between Okta and Brevity using SCIM

If your organization uses Okta to to manage your employees’ access to tools and services, you can take advantage of Okta’s “Provisioning” feature to automatically grant access to Brevity to your users. This article walks through how to configure Brevity and your Okta instance.

Table of Contents

  1. Integration Features

    1. User Provisioning and Lifecycle Management
  2. Team Management
  3. Supported SCIM Attributes
  4. Step-by-Step Configuration

    1. Generate the SCIM Token in Brevity

    2. Configure Provisioning in Okta

    3. Helpful links to Okta Documentation
  5. FAQ
    1. Who can manage SCIM settings in Brevity?
    2. I already have an existing Organization in Brevity with active members. How do I enable SCIM provisioning without creating duplicates?
    3. Can I manually delete or manage users in Brevity once SCIM is enabled?
    4. Does deleting a user in Okta also delete the user in Brevity?
    5. Can I import existing Brevity Teams into Okta?

 

Integration Features

The SCIM integration between Okta (or any other IdP) and Brevity allows for automated provisioning and lifecycle management of users and their group memberships.

Organization-Level Scope: The SCIM connection is established at the Organization level. All users and teams provisioned via this connection will belong to the specific Brevity Organization associated with the API Token.

This integration supports the following key features:

User Provisioning and Lifecycle Management

  • Create Users: When a user is assigned to the Brevity app in Okta, they are automatically created in the corresponding Organization in Brevity.

  • Update User Attributes: Any changes made to a user's profile in Okta (e.g., name, email, job title) are instantly synchronized with Brevity.

  • De-provision Users (Membership Deactivation): When a user is unassigned from the Brevity app in Okta or their Okta account is deactivated, Brevity deactivates the user’s membership in the Organization. The user’s Brevity account remains active, but they no longer have access to the Organization or its Teams. All historical data is preserved.

 

Team Management (Push Groups)

Brevity supports Okta’s Push Groups functionality to manage internal team structures.

Sync Okta Groups to Brevity Teams: You can link existing Okta Groups to Brevity Teams.

Automated Membership: Adding or removing a user from an Okta Group will automatically add or remove them from the linked Team in Brevity.

Create Teams via SCIM: When an Okta Group is pushed, a new Team is automatically created within the user's Organization in Brevity.

 

Supported SCIM Attributes

Brevity uses a specific set of attributes to ensure user profiles are accurately synchronized. The following table outlines the mapping between Okta and Brevity:

 

Attribute

 

Description

 

Required

 

userName

The user's unique identifier (typically their email address).

Yes

emails[type eq "work"]

The primary work email address for notifications and login.

Yes

 

name.givenName

The user's first name.

Yes

name.familyName

The user's last name.

Yes

active

Indicates whether the user account is enabled or disabled.

Yes
 
 
 

Step-by-Step Configuration

Generate the SCIM Token in Brevity

Note: SCIM settings and API tokens are accessible only to Organization Administrators.

  1. Log in to Brevity with an account that has Organization Administrator privileges.

  2. Navigate to Organization Settings > SSO.


    image-png-Jan-16-2026-02-30-03-1224-PM

  3. Switch on "Enable SCIM for your organization".

  4. Copy the SCIM URL and the SCIM Token.

 

Configure Provisioning in Okta

Note on Deactivation Behavior
Okta’s Deactivate Users action removes the user’s access to the Brevity Organization. It does not delete the user’s Brevity account. This ensures historical data and audit records remain intact while immediately revoking access.

  1. In the Okta Admin Console, open the Brevity application and navigate to the Provisioning tab.

  2. Go to the Integration and click Configure API Integration.

  3. Check the Enable API Integration box.



  4. Enter the Base URL and API Token copied from your Brevity Admin panel.

  5. Click Test API Credentials. Once the connection is verified, click Save.

  6. Move to the 'To App' settings (under the Provisioning tab)

  7. Click Edit and enable:

    1. Create Users

    2. Update User Attributes

    3. Deactivate Users

  8. Click Save.



 

Importing Users from Your App into Okta (Import Feature)

Once SCIM provisioning is enabled between Okta and your Brevity instance, you’ll also see an Import tab in the Okta Admin Console. This import capability is important because it lets Okta pull user records from Brevity into Okta — not just push Okta users out to Brevity.

What “Import” Means

  • Importing users means that Okta can read user accounts that already exist in Brevity and bring them into your Okta org for matching or assignment.

  • This is distinct from typical provisioning (To App) which sends new users from Okta to Brevity — importing is the reverse direction (To Okta).

  • During an import, Okta will attempt to match imported Brevity users to existing Okta user accounts. If a match is found, Okta links them. If not, Okta can create new users.

Why It Matters for Brevity

For Brevity, this import step is critical to link Brevity users with Okta users — which enables the seamless provisioning experience you’re configuring:

  • If a user already exists in Brevity before you set up provisioning, running an import lets Okta discover that user and associate the Brevity user record with the corresponding Okta account.

  • Once linked, future provisioning actions (like adding the user to Brevity from Okta) work properly because Okta knows which Brevity account corresponds to which Okta identity.

How to Use Import

In the Okta Admin Console, open your Brevity SCIM integration.

  1. Go to the Import tab.

  2. Click Import Now to immediately pull users from Brevity. Okta will prompt you to review any matches before confirming.

Tips

  • After import completes, check that each imported user is correctly linked to an Okta account; correct matches ensure provisioning state is maintained correctly.

 

Helpful links to Okta Documentation:

 

FAQ

Q: Who can manage SCIM settings in Brevity?

A: Only users with the Organization Administrator role can view the SCIM integration tab, enable/disable the service, or generate new API tokens. If you do not see these options, please contact your Organization's primary administrator.

Q: I already have an existing Organization in Brevity with active members. How do I enable SCIM provisioning without creating duplicates?

A: To ensure a smooth transition and avoid synchronization errors for existing users, follow these steps:

  1. Enable SCIM: In Brevity, go to Organization Settings and switch on "Enable SCIM for your organization".

  2. Run an Import: Before enabling "Create Users" or "Update Attributes" in Okta, go to the Import tab of the Brevity app in the Okta Admin Console and click Import Now.

  3. Confirm Matches: Okta will pull the list of existing members from Brevity. Match these users with their corresponding Okta profiles. This links the Brevity externalId to the Okta user ID.

  4. Enable Provisioning Features: Once the existing users are linked (matched), you can safely go to the Provisioning tab and enable Create Users, Update User Attributes, and Deactivate Users.This process ensures that Okta "takes over" the management of existing accounts instead of trying to create them from scratch.

Q: Can I manually delete or manage users in Brevity once SCIM is enabled?

A: While you can still access user settings in Brevity, it is strongly recommended to manage all user lifecycles directly through Okta.

  • Source of Truth: Once SCIM is active, Okta becomes the authoritative source for your user data. Any manual changes made within Brevity (such as deactivating a member) may be overwritten by Okta during the next synchronization cycle.

  • Deactivation: If you need to remove a user's access, unassign them from the Brevity application in Okta or deactivate their Okta account. This will automatically trigger a membership deactivation in Brevity.

  • Consistency: Managing users through Okta ensures that your audit logs, Team memberships, and Organization access remain consistent across your entire enterprise identity infrastructure.

Q: Does deleting a user in Okta also delete the user in Brevity?

A: No. Okta de-provisioning results in organization membership deactivation, not user deletion.

  • What happens: When a user is deleted, deactivated, or unassigned from the Brevity app in Okta, Brevity removes the user’s membership from the Organization.

  • Account status: The user’s Brevity account remains active, but they have no access to the Organization or any Teams.

  • Data preservation: All historical activity (content, comments, audit logs) is retained.

  • Reactivation: If the same user is reassigned in Okta, their Organization membership can be restored without data loss.

 

Q: Can I import existing Brevity Teams into Okta?

A: Yes, you can import your existing Brevity Teams to manage them directly from Okta.

  • Run Import: In the Okta Admin Console, go to the Import tab of the Brevity app and click Import Now.

  • Link Groups: Okta will discover your existing Teams. You can then link them to existing Okta Groups or create new ones.

  • Enable Push Groups: Once linked, we recommend setting up Push Groups for these Teams. This allows Okta to remain the "source of truth," ensuring that any future membership changes in Okta are automatically reflected in your Brevity Teams.