Skip to content
All guides
User provisioning and SCIM4 min read

The developer’s guide to Directory Sync and SCIM

Protocol work looks tedious from the outside and turns out to be where the interesting failures live.

Protocol work looks tedious from the outside and turns out to be where the interesting failures live. The specification is short; the space of things implementers actually ship is not.

This piece walks through how we think about it at Paycux, what we have changed our minds about, and where the sharp edges are.

What is Directory Sync is and why you should care?

What is Directory Sync is and why you should care? deserves its own treatment. Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Treat anything the other side sends as untrusted input until it has been through validation you wrote. Signature checks, issuer checks, audience checks and expiry checks are four separate decisions, and skipping any one of them is a real vulnerability rather than a theoretical one.

Directory Sync is a single source of truth for identity

Consider directory sync is a single source of truth for identity. Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Version the assumption, not just the code. Write down what you expect from the peer, and make the failure loud when it stops being true, because the alternative is a connection that half works for six weeks.

  • Validate signature, issuer, audience and expiry as four separate checks
  • Normalize provider attributes into one internal shape
  • Fail loudly when a peer stops meeting a documented assumption
  • Keep a fixture per provider so regressions surface in CI

SCIM: the System for Cross Identity Management

SCIM: the System for Cross Identity Management is where this gets concrete. Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Directory Sync vs. JIT provisioning: activating your users

That brings us to directory sync vs. jit provisioning: activating your users. Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Version the assumption, not just the code. Write down what you expect from the peer, and make the failure loud when it stops being true, because the alternative is a connection that half works for six weeks.

Version the assumption, not just the code.

How to add Directory Sync to your app from scratch

That brings us to how to add directory sync to your app from scratch. Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

How to add Directory Sync to your app using a provider

Consider how to add directory sync to your app using a provider. Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Aquera

Aquera is where this gets concrete. Normalization is the whole job. Two providers can be perfectly compliant and still disagree about what a group membership is, whether a logout is meaningful, and which attribute carries the email address.

Version the assumption, not just the code. Write down what you expect from the peer, and make the failure loud when it stops being true, because the alternative is a connection that half works for six weeks.

Where this leaves us

The pattern repeats across every system we have looked at: the hard part is not the mechanism, it is keeping the mechanism honest as the surrounding assumptions change.

If you are working through the same problem and want to compare notes, the docs cover the mechanics and the console shows the behaviour on your own data.

Everything here, already built

Sign-in, enterprise SSO, directory provisioning, roles and an audit trail behind one API.

Stop reading, start shipping

The quickstart takes about ten minutes and leaves you with a working sign-in.