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

SCIM & SSO with Auth0

Learn how to configure Couchdrop to sync with Auth0

Overview

Couchdrop supports integration with Auth0 for automated user provisioning and Single Sign-On (SSO).

You can use SCIM to manage Couchdrop users directly from Auth0 and SAML SSO to allow users to authenticate using their Auth0 credentials.

These are separate configurations that can be used together to centralize user management and authentication.

Configure SCIM Provisioning

SCIM allows Auth0 to automatically provision and manage Couchdrop users when accounts are created, updated, or deleted.

Couchdrop uses Auth0's outbound SCIM integration through Event Streams and Actions.

Before you start

1

Create an Event Stream in Auth0

In Auth0, navigate to Event Streams and select + Create Event Stream.

  1. Under Destinations, select Auth0 Actions.

  2. Enter a name such as Couchdrop SCIM.

  3. Under Select Events, enable:

    • user.created

    • user.updated

    • user.deleted

These events are used to synchronize changes from Auth0 to Couchdrop.

2

Configure the Couchdrop SCIM connection

In the Auth0 Actions Editor, open Secrets and configure the following values:

Setting
Value

SCIM_BASE_URL

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

SCIM_BEARER_TOKEN

Your Couchdrop SCIM token

The SCIM token is used to authenticate provisioning requests from Auth0 to Couchdrop.

Use your SCIM token from Couchdrop, not a standard Couchdrop API token.

3

Configure and deploy the SCIM Action

Follow Auth0's Outbound SCIM Provisioning Guide to configure the provisioning Action.

  1. Copy the outbound SCIM 2.0 user provisioning Action template.

  2. Paste the template into the Auth0 Actions Editor.

  3. Review the user attribute mappings.

  4. Save and deploy the Action.

The default template maps the Auth0 user's email address to the SCIM userName attribute.

4

Test SCIM Provisioning

Create a test user in Auth0 and verify that the user is provisioned in Couchdrop.

You can also test updating and deleting a user in Auth0 to verify that the corresponding changes are synchronized with Couchdrop.

Auth0's outbound SCIM Action handles user provisioning. Group provisioning is not included in the default Action template.

Existing Auth0 users must also be accounted for when enabling provisioning, as Event Streams do not automatically synchronize historical user creation events.

Configure SAML SSO

SAML SSO allows Couchdrop users to authenticate using Auth0 as their Identity Provider (IdP).

1

Enable SAML in Auth0

In your Auth0 Dashboard:

  1. Navigate to Applications > Applications.

  2. Select the application you want to configure.

  3. Open Addons.

  4. Select SAML2 Web App.

  5. Enable and configure the SAML add-on using the service provider details from Couchdrop.

2

Retrieve the SAML configuration

From the Auth0 SAML2 Web App configuration, retrieve the following values:

Auth0
Couchdrop

Issuer

IDP ENTITY ID

Identity Provider Login URL

SAML IDP SSO Url

Download Certificate

Identity Provider Certificate

These values are required to establish the SAML connection between Auth0 and Couchdrop.

3

Configure SAML in Couchdrop

Open your Couchdrop SAML SSO settings and provide the details collected from Auth0.

Configure the following fields:

  • IDP ENTITY ID: Enter the Auth0 Issuer.

  • SAML IDP SSO Url: Enter the Auth0 Identity Provider Login URL.

  • Identity Provider Certificate: Provide the certificate downloaded from Auth0.

For the email attribute, use:

http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress

This identifies the email address attribute used to match the Auth0 identity with the corresponding Couchdrop user.

Save the configuration.

4

Test SAML Authentication

Once configured, test the integration using an existing user.

  1. Open the Couchdrop login page.

  2. Select the SSO login option.

  3. Authenticate using Auth0.

  4. Verify that the user can access Couchdrop.

If authentication fails, check the SAML Issuer, SSO URL, Identity Provider Certificate, and email attribute configuration.

How SCIM and SAML work together

When SCIM and SAML are both enabled, Auth0 manages user provisioning and authentication for Couchdrop.

  • SCIM manages the creation, updating, and removal of user accounts.

  • SAML SSO authenticates users when they sign in.

This allows organizations to manage Couchdrop user identities through Auth0 while keeping file access and permissions controlled within Couchdrop.

For more information, refer to Auth0's Outbound SCIM documentation.

Last updated

Was this helpful?