# Epic SI-13 - Add SCIM server functionality to OpenProject via SCIM API

Project: Stream Integration Basics
Status: closed
URL: https://community.openproject.org/work_packages/SI-13

## Detailed specification

### Motivation and background information

We want OpenProject to support the SCIM protocol for management of users and groups, to allow for central provisioning of users and groups. In contrast to synchronising users through LDAP, where OpenProject has to pull information periodically, SCIM inverts the control flow, allowing for a push-based user provisioning and thus should make newly created users immediately available.

Related specifications:

*   [RFC 7642 (Higher level overview)](https://www.rfc-editor.org/rfc/rfc7642.html)
    
*   [RFC 7643 (Core Schema)](https://www.rfc-editor.org/rfc/rfc7643.html)
    
*   [RFC 7644 (Protocol)](https://www.rfc-editor.org/rfc/rfc7644.html)

### Acceptance criteria

### Out of scope

| Attribute | Value |
| --- | --- |
| Mockups |  |

## Planning

| Attribute | Value |
| --- | --- |
| Roadmap |  |
| Date |  |
| Votes | 4 |
| List |  |
| Target versions | 16.2.0 |
| Relevance |  |

## Subitems

| ID | Type | Subject | Status | Assignee | Target versions | Project | Priority | Spent time |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| SI-98 | Feature | Add SCIM server API  | closed |  | 16.2.0 | Stream Integration Basics | Medium |  |
| SI-117 | Feature | Accept client credentials token issued by OIDC IDP | closed |  | 16.2.0 | Stream Integration Basics | Medium |  |
| SI-120 | Feature | Allow managing SCIM clients | closed |  | 16.2.0 | Stream Integration Basics | Medium |  |
| SI-125 | Feature | Add authentication to SCIM server API | closed |  | 16.2.0 | Stream Integration Basics | Medium |  |
| SI-156 | Feature | Preserve user external accounts data | closed |  | 16.2.0 | Stream Integration Basics | Medium |  |
| SI-183 | Feature | Limit access to SCIM clients UI to enterprise customers | closed |  | 16.2.0 | Stream Integration Basics | Medium |  |
| SI-178 | Feature | Add deleted status to user. | closed |  | 16.4.0 | Stream Integration Basics | Medium |  |
| SI-197 | Feature | /ServiceProviderConfig endpoint responds with limited output without authorization. | closed |  | 16.4.0 | Stream Integration Basics | Medium |  |
| SI-202 | Feature | Responds with 403 and proper message when enterprise plan is not enough. | closed |  | 16.4.0 | Stream Integration Basics | Medium |  |
| SI-52 | Open Point | How should we behave for DELETE calls? | decided |  |  | Stream Integration Basics | Medium |  |
| SI-59 | Open Point | How to implement? Existing library to use? | decided |  |  | Stream Integration Basics | Medium |  |
| SI-99 | Open Point | Do the system-level tokens expire and how would we handle that? | decided |  |  | Stream Integration Basics | Medium |  |
| SI-100 | Open Point | Do we need to synchronize custom attributes from IdP to OpenProject? | resolved | Pavel Balashou |  | Stream Integration Basics | Medium |  |
| SI-101 | Open Point | Do we need a logging system for the user changes that come via SCIM API? | needs clarification | Pavel Balashou |  | Stream Integration Basics | Medium |  |
| SI-123 | Feature | Allow managing SCIM clients via API | in specification |  |  | Stream Integration Basics | Medium |  |
| SI-175 | Open Point | How to map multiple emails provided by SCIM to the one we have? | decided |  |  | Stream Integration Basics | Medium |  |

## Bugs and other work packages

| ID | Type | Subject | Status | Assignee | Target versions | Module |
| --- | --- | --- | --- | --- | --- | --- |
| SI-193 | Bug | Managing group membership does not work in Keycloak plugin setup. | closed |  | 16.2.0 | API / SCIM |
| SI-192 | Documentation | Add Keycloak SCIM plugin configuration screenshots to docs. | closed |  | 16.2.0 |  |
| SI-191 | Documentation | Document how to configure SCIM clients  | closed |  | 16.2.0 | API / SCIM |
| SI-190 | Bug | SCIM API /Schemas endpoint should have some fields marked as required | closed |  | 16.2.0 | API / SCIM |
| SI-184 | Bug | ScimClient access token and client credentials dialogs render wrong value | closed |  | 16.2.0 | API / SCIM |
| SI-182 | Documentation | Setting.users_deletable_by_admins is required for user deletion through SCIM Server API | closed |  | 16.2.0 | API / SCIM |
| SI-135 | Code maintenance | service_account_association should have foreign key constraints | closed |  | 16.2.0 | API / SCIM |
| SI-108 | Documentation | How to generate SCIM scoped token in OpenProject | closed |  | 16.2.0 | API / SCIM |
| SI-200 | Code maintenance | Use official Scimitar API to handle authentication | closed |  | 16.4.0 | API / SCIM |
| SI-208 | Bug | Do not use unspecified ServiceProviderConfig.AuthenticationSchemes.type | closed |  | 16.5.0 |  |
| SI-218 | Task | Prepare & execute demo for acceptance testing | closed |  |  |  |
| SI-203 | Task | Test OpenProject SCIM server API with Nubus | closed |  |  |  |
| SI-196 | Task | Investigate and report issues with Nextcloud SCIM-client | closed |  |  |  |
| SI-109 | Open Point | Do we need SCIM turn off checkbox admin setting? | rejected | Pavel Balashou |  |  |
| SI-175 | Open Point | How to map multiple emails provided by SCIM to the one we have? | decided |  |  |  |
| SI-99 | Open Point | Do the system-level tokens expire and how would we handle that? | decided |  |  |  |
| SI-59 | Open Point | How to implement? Existing library to use? | decided |  |  |  |
| SI-52 | Open Point | How should we behave for DELETE calls? | decided |  |  |  |
| SI-100 | Open Point | Do we need to synchronize custom attributes from IdP to OpenProject? | resolved | Pavel Balashou |  |  |
| SI-189 | Bug | Microsoft Entra user can not be found during sign in after being provisioned by SCIM client. | on hold | Pavel Balashou |  | API / SCIM |
| SI-204 | Code maintenance | Provider a PR to scimitar to support public authorization scheme. | specified |  |  |  |
| SI-101 | Open Point | Do we need a logging system for the user changes that come via SCIM API? | needs clarification | Pavel Balashou |  |  |

## Details

| Attribute | Value |
| --- | --- |
| Module | API / SCIM, Administration / User administration, API |
| Enterprise plan | Enterprise / Corporate (COR) |
| Labels |  |

## People

| Attribute | Value |
| --- | --- |
| Assignee | Pavel Balashou |
| Accountable | Dominic Bräunlein |
| Product manager |  |
| Feature Lead |  |
| Designer |  |
| Developers | OP Dev Titan Team |
| Requested by |  |
| Interest by |  |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| Work |  |

## Description

# User Problem

## User

*   Administrators managing user synchronization between OpenProject and their identity provider (IdP).
    

## Problem

*   Administrators need to keep OpenProject user data in sync with their IdP. Currently, they lack a standardized, automated way to handle user provisioning and de-provisioning.
    

## Pain

*   Manual user management processes are time-consuming and error-prone.
    
*   Lack of automation increases the risk of outdated or incorrect user data.
    
*   No current support for SCIM-standard synchronization leads to additional integration complexities.
    

# Business Case

## Reach

*   Medium: Affects enterprise customers using corporate IdPs needing automated user synchronization
    

## Impact

*   High: Streamlines user management, reduces manual workload, and ensures accurate user data.
    

## Confidence

*   Medium: Technical risks include ensuring API security and correct SCIM protocol implementation. Using an existing Ruby gem can mitigate some risks.
    

## Urgency and Priority

*   Medium: The feature is planned for Enterprise Corporate plans and part of a larger goal to achieve a seamless cross application experience for users.
    

## Solution

*   CRUD API endpoints implemented according to SCIM specification
    
*   Actions executed via a designated system-level user (SCIM system user) or clarified alternative
    
*   Only available for Enterprise (Corporate) plan customers
    
*   Administrators can create, manage, and delete &quot;system-level&quot; Bearer tokens specifically for authenticating SCIM API requests
    
*   System-level tokens restricted by scope, initially limited to SCIM API access
    
*   Token creation accessible via Admin Authentication settings
    

## Out of Scope for the MVC

*   Additional token scopes beyond SCIM API
    
*   Custom attribute synchronization from IdP to OpenProject (to be clarified)
    
*   Expiring tokens (to be clarified)
    

##   

# Launch and Growth

## Measures

*   Number of Enterprise customers adopting the SCIM API.
    
*   Feedback on API ease of use and integration.
    

## Messaging

<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><tbody><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Headline</p></th><td class="op-uc-table--cell"><p class="op-uc-p">Simplify User Management with SCIM API Integration for OpenProject</p></td></tr><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">First Paragraph</p></th><td class="op-uc-table--cell"><p class="op-uc-p">OpenProject now supports automated user synchronization via SCIM API, enabling seamless integration with your identity provider. Simplify and secure user provisioning and de-provisioning while ensuring accurate user data across systems.</p></td></tr><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Customer Quote</p></th><td class="op-uc-table--cell"><p class="op-uc-p"><br></p></td></tr></tbody></table></figure>

## Go to market

*   Inform partners and clients directly
    
*   Promote the feature in newsletter and blog post in product update blogs and webinars.
    
*   Highlight in the Enterprise plan feature list.
    
    <br>
    

<br>

_**Open Questions:**_  
_Should it be possible to deactivate the SCIM API?_  
_Should a dedicated &quot;SCIM User&quot; be used?_  
_What scopes will we have for the system-level baerer token?_  
_Do system-level bearer tokens also need Enterprise Corporate plan activated?_  
Do we need token expiration management?  
De we want custom attribute synchronization from IdP to OpenProject?
