Passer au contenu principal

SCIM 2.0 syncer

The SCIM syncer reads users from an external SCIM 2.0 server and imports them into Casdoor. It is read-only: Casdoor pulls from the SCIM source but does not push changes back.

SCIM server vs. SCIM client

This page describes using Casdoor as a SCIM client (pulling users from an external SCIM server). For information on Casdoor acting as a SCIM service provider (receiving pushes from an external system), see SCIM provisioning.

Configuration

Create a new syncer in Casdoor (SyncersAdd) and fill in:

FieldValue
OrganizationTarget Casdoor organization
NameA unique name for this syncer
TypeSCIM
Server URLBase URL of the SCIM server (e.g. https://idp.example.com/scim/v2)
UsernameUsername for Basic Auth (optional)
Password / API TokenPassword for Basic Auth, or a Bearer token

If both Username and Password are provided, Casdoor uses HTTP Basic Auth. If only Password is set, it is sent as a Bearer token.

Field mappings

SCIM fieldCasdoor fieldNotes
idIdSCIM resource ID
userNameNameUsername
displayNameDisplayNameDisplay name; falls back to name.formatted then givenName + familyName
name.givenNameFirstNameFirst name
name.familyNameLastNameLast name
emails[primary].valueEmailPrimary email; falls back to first email if no primary
phoneNumbers[primary].valuePhonePrimary phone number
activeIsForbiddenactive: falseIsForbidden: true

Running the syncer

Click Test Connection to verify the server is reachable and credentials are accepted. Toggle Is enabled for scheduled sync, or click Sync to run immediately.

The syncer fetches users in pages of 100, iterating until all records are retrieved.