For the complete documentation index, see llms.txt. This page is also available as Markdown.

SCIM with Microsoft Entra ID

Learn about configuring Couchdrop to sync with Azure for accounts

Overview

Couchdrop supports SCIM provisioning with Microsoft Entra ID to keep users and groups synchronized between Microsoft Entra and Couchdrop.

Once configured, changes made in Microsoft Entra can be pushed to Couchdrop automatically.

How provisioning works

Microsoft Entra remains the source for the users and groups assigned to the Enterprise Application.

When provisioning runs, supported user and group changes are pushed to Couchdrop through the SCIM endpoint:

https://api.couchdrop.io/scim/v2

This allows user creation, updates, deactivation, group creation, group updates, and group deactivation to be managed from Microsoft Entra rather than maintained separately in Couchdrop.

Configure SCIM provisioning

Before you start

1

Create a User Provisioning Token in Couchdrop

In Couchdrop, navigate to User Provisioning and create a new Provisioning Token.

Copy the token. You will use it when configuring provisioning in Microsoft Entra.

2

Create an Enterprise Application

In the Microsoft Entra admin center, navigate to Enterprise applications > New application > Create your own application.

Enter a meaningful name for the application and select Integrate any other application you don't find in the gallery (Non-gallery).

3

Assign users and groups

In the Enterprise Application, open Users and groups.

Select Add user/group, choose the users or groups that should be provisioned to Couchdrop, then select Assign.

Only users and groups assigned to the application will be included in provisioning.

4

Configure automatic provisioning

In the Enterprise Application, open Provisioning and select Get started.

Set Provisioning Mode to Automatic, then configure:

Microsoft Entra field
Value

Tenant URL

https://api.couchdrop.io/scim/v2

Secret Token

The Provisioning Token created in Couchdrop

Select Test Connection.

Microsoft Entra will attempt to connect to Couchdrop and retrieve the schema information required for user and group mappings.

If the connection test succeeds, select Save.

5

Configure user attribute mappings

Open Provision Azure Active Directory Users.

Couchdrop requires the following SCIM attributes to be mapped. Remove mappings that are not required.

Custom Application SSO Attribute

userName

active

emails[type eq "work"].value

name.givenName

name.familyName

externalId

Depending on your Microsoft Entra configuration, the externalId attribute may need to be mapped from mailNickname to objectId.

6

Configure group attribute mappings

Open Provision Azure Active Directory Groups.

Couchdrop requires the following SCIM attributes to be mapped:

Custom Application SSO Attribute

displayName

externalId

members

7

Start provisioning

Return to the Enterprise Application and open Provisioning.

Select Start provisioning.

After the first provisioning cycle completes, Microsoft Entra will display the number of users and groups provisioned to Couchdrop.

For additional detail, select View provisioning logs.

Supported features

Feature
Description

Push Users

Users created in Microsoft Entra are also created in Couchdrop.

Push User Updates

User updates in Microsoft Entra are pushed to the corresponding Couchdrop users.

User Deactivation

Users deactivated in Microsoft Entra are deactivated in Couchdrop.

Push Groups

Groups created in Microsoft Entra are also created in Couchdrop.

Push Group Updates

Group updates in Microsoft Entra are pushed to Couchdrop.

Group Deactivation

Groups deactivated in Microsoft Entra are deactivated in Couchdrop.

Last updated

Was this helpful?