About inbound SCIM
With Google Workspace, Workday, and BambooHR, Iru reads the directory on a schedule. Inbound SCIM works the other way. Your identity provider sends each change to Iru as it happens. Nothing is scheduled, and there is no Sync now. You give the provider two values from Iru: a SCIM base URL and an API key, sent as a bearer token. Users and groups the provider pushes are applied shortly after they arrive.Connect SCIM
Navigate to Directory
Select Connect Source
Select SCIM
Name the connection
Map the domain
"acme.com". Select Next.Username, email, and name start from the standard SCIM attributes: userName, name.givenName, name.familyName, name.middleName, and emails.primary. You can change those later on the connection’s Mapping tab. A custom attribute appears in that list after the provider pushes a user that includes it.Copy the SCIM base URL and API key
Select Finish
Set up your identity provider
Settings
Open the connection and select Edit.Review the SCIM base URL and API keys
Choose whether new users are invited
Choose whether groups sync
name and memberCount. Leave it empty to sync every group. For example, memberCount < 2 || name.startsWith("test-") skips groups with fewer than two members and groups whose names start with test-. See Sync groups.Review the attribute mapping
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, appears in the list after the provider pushes a user that includes it. Attributes left under Not mapped are not written to the user. On a mapped row, select Don’t overwrite when a later push should leave the value already stored in Iru as it is. See Attribute mapping.How Iru applies a push
Iru accepts the request, then applies it
Inactive and deleted users
Groups follow the provider
SCIM API
Iru follows SCIM 2.0 (RFC 7643, RFC 7644). Paths are relative to the connection’s SCIM base URL:Authorization: Bearer <api key>. Requests and responses use application/scim+json.
Discovery
{"value": "<id>", "type": "User"} or "type": "Group". Use the id Iru returned for that user or group.
Filtering, paging, and PATCH
- Filtering: one
eqcomparison. For users, filter onuserNameorexternalId. For groups, filter ondisplayNameorexternalId. For example,filter=userName eq "jane@acme.com". Any other filter returns400. - Paging:
startIndexstarts at 1.countsets the page size. A page holds 100 results by default and 200 at most. - PATCH:
add,replace, andremove. A path can be an attribute or sub-attribute (name.givenName), an extension attribute, or one list entry chosen by a singleeqfilter (emails[type eq "work"].value). A PATCH with no path sends an object of attributes.
Considerations
What Iru does not support
What Iru does not support
id, meta, and groups on a user. Filters other than one eq comparison on the attributes above are rejected.Request limits
Request limits
429 Too Many Requests and a Retry-After header.userName must be unique
userName must be unique
userName must be unique within the connection. A duplicate returns 409. A user created again with the same userName gets the old id back, and is a new person in Iru. A group created again gets a new id.A user missing a required value is not imported
A user missing a required value is not imported
Managers match by Iru id
Managers match by Iru id
id in the enterprise extension’s manager.value. An email address or a username does not match. Order does not matter. Iru links a user to their manager once that manager has arrived.Attribute names and the Iru role
Attribute names and the Iru role
userName, not UserName. Your own attribute names are case-insensitive.Put custom attributes in your own extension schema, or at the top level of the user. A top-level attribute with the same name as a standard one is ignored.The Iru role comes from roles. The mapped value must match a role’s name or slug, ignoring case. A user whose value matches no role is not imported or updated. A new user gets End User unless a role is mapped. The account owner’s role never changes through sync.