- A user sync, which brings your directory up to date with the users in each integration
- Two attribute syncs, which qualify users for your directory attributes
- A group and resource sync, which qualifies users for your groups and resources and writes the changes to each vendor
Sync Change Window
We want changes to happen during a change window that suits your business hours. Provisionr caches data from each vendor API on a recurring basis, based on the frequency that’s included with your subscription plan and the sync window that you choose. To avoid hourly API rate limits and to conserve CO2, we use a 3-hour time window for syncs instead of a 1-hour time window. The frequency of the sync is determined by your subscription plan.- Baseline plan, with a weekly sync. You choose the day of the week, along with the preferred and secondary time windows.
- Growth plan, with a daily sync. You choose the preferred and secondary time windows.
- Scale plan, with a sync every 3 hours.
User Sync
The user sync runs first, so that every stage after it works from the latest data in your integrations.User Fetch
Identity Changes
Dimension Changes
Attribute Changes
New Directory Users
Deprovisioned Directory Users
Manager Mapping
Attribute Syncs
A rule can have an Attribute Condition, which matches the users who hold another attribute. We run the attribute sync twice in a row to cover a user who qualifies for one attribute and also needs to qualify, in the same scheduled sync, for a rule that requires them to hold that attribute. The first attribute sync qualifies users for attributes through Identity, Manager, and User Conditions, and the second one qualifies users for the rules that use an Attribute Condition. Each attribute sync follows the qualification steps for every attribute ruleset.Attribute Rule Qualification
Attribute Ruleset Manifest
Attribute Policy User Changes
- A user who newly qualifies gets a new Policy User.
- A user whose Policy User was granted by a different rule, or who qualifies again while their Policy User is
expiring, gets a new Policy User, and the old one is expired. The new record is created first, so the user never leaves the manifest. - A user whose rule was deactivated, and who doesn’t qualify through another rule, is deactivated at once, without a grace period.
- A user who no longer qualifies is deprecated. Their Policy User moves to
expiring, and itsexpires_atis set to the end of their grace period.
expires_after_days, or the value it inherits from the ruleset, the dimension, and the workspace default, in that order. A grace period gives users time through changes, such as a department or team rename, so that a user who still has a business need for the access isn’t disrupted while back-office attributes or rules are changing.A Policy User is never made active again. Instead, each qualification gets its own record, so you can see the lifecycle of every qualification. Qualification explains each case in detail.Expired Attribute Policy Users
expiring Policy User whose expires_at has passed moves to expired, and the user leaves the attribute’s manifest. From that point on, rules that use the attribute in an Attribute Condition no longer match them.Group and Resource Sync
Once the user data is up to date and the attribute syncs have qualified users for every attribute, we can qualify users for the rules of your groups and resources. To keep this explanation clear, we use groups throughout, but the concept is the same for resources, such as a GitLab project, a Google Drive folder, a Google Doc, or a Slack channel. The badges on each step show which policies it applies to. The Ignored, Monitored, Additive, and Authoritative badges are the ruleset modes that Groups & Resources describes.Group Fetch
Group Changes
Group Member Fetch
Group Member Changes
UNMANAGED state. Any users in the Provisionr database who no longer appear in the vendor’s API response change to the DEPROVISIONED state. Together, these give you an audit trail of the users who are managed outside of Provisionr.Group Rule Qualification
Group Ruleset Manifest
Group Policy User Changes
- A user who newly qualifies gets a new Policy User.
- A user who now qualifies under a different rule, or who qualifies again while
expiring, gets a new Policy User that supersedes the old one. - A user whose rule was deactivated, and who doesn’t qualify through another rule, is deactivated at once, without a grace period.
- A user who no longer qualifies is deprecated.
expires_after_days, or the value it inherits from the ruleset, the integration, and the workspace default, in that order. A grace period gives users time through changes, such as a department or team rename, so that a user who still has a business need to be a member of the group or resource isn’t disrupted while back-office attributes or rules are changing.A grace period is there to protect users whose attributes changed, not users who have left. When a user leaves, they’re removed from the group in the vendor API on the same sync, whatever the grace period is. Removing Access for Leavers explains how.Expired Policy Users
expires_at date. If that date is in the past at the time of the sync, the Policy User moves to the expired state, and its record is soft deleted. This removes the user from the manifest, which is the list of users that the next steps sync with the vendor API, so Provisionr no longer considers them a member of the group.This keeps an audit trail of each user’s lifecycle and qualifications over time. It also gives administrators a grace period to fix any issues with rules or attributes that caused users to be deprovisioned, before those users are fully expired and removed from the group in the vendor API.Policy User Provisioning
Policy User Deprovisioning
UNMANAGED state, which ensures that pre-existing users aren’t removed in this step. For an authoritative group, any users who don’t match the policy are removed in the next step.Unmanaged User Deprovisioning
UNMANAGED state, doesn’t qualify for any rules, and is still a member of the group in the vendor API, we change their state to DEPROVISIONED in Provisionr and remove them from the group in the vendor API. This ensures that users who were added outside of Provisionr are removed, so the group keeps to least privilege access.Disabling Sync for a Group or Resource
When a group or resource is in any mode other thanignored, its ruleset has sync_enabled set to true by default.
You can disable the sync for a specific group or resource, temporarily or permanently, by changing sync_enabled to false on its ruleset. This prevents any changes from being made to that group or resource during the sync, so no users are added to it or removed from it in the integration, whether or not they match its rules and conditions. Each sync that’s skipped records a policy.ruleset.sync.process.skipped event with the reason.
sync_enabled back to true. Any changes that would have been made while the sync was disabled are applied during the next sync, based on the latest calculation of the ruleset’s Policy Users. Update Ruleset lists the options for this command.
This gives you more control over when changes are made to your groups and resources, so you can avoid unexpected changes during a critical time. It’s useful when you’re running into errors, when you have a planned data migration, or when you just want to freeze the data at its current point in time. It’s also useful for groups or resources that are archived or deprecated, which you’re no longer actively managing.
Data Retention Duration
Provisionr has a configurable retention policy for how long we keep the personally identifiable information (PII) of deprovisioned users in the database after they’re deprovisioned in the vendor API. In other words, a set number of days after an employee leaves the company, we scrub their PII and replace it with a Ghost User and null values where appropriate, while keeping the same user ID and vendor ID for any existing log records that are associated with that user. You can choose the number of days that works best for your organization’s internal processes and compliance requirements. This happens when we fetch users from the API. Users who were deprovisioned more than the retention duration ago aren’t imported or synced. Any existing log records stay mapped to the same user ID, but the user’s PII is scrubbed and replaced with a Ghost User and null values where appropriate. We do this to protect PII and to support GDPR compliance. Once we’ve verified that a user has left the company, and their access deprovisioning processes are completed and audited, we no longer have a business need to keep their data for role-based access control (RBAC). Each integration has its own retention duration, in days, in itsretention_days setting. The default is 90 for new integrations, and you can modify any of your existing integrations to decrease it, or to increase it up to 1095 (3 years). The lowest value that you can set is 10 days, which allows time for every deprovisioning lifecycle task and for your organization’s internal processes to complete, and which keeps the background API sync jobs, which are eventually consistent, working from reliable data.
If you increase the value, users who were previously outside the retention duration are imported during the next sync. If you decrease it, users who were previously included are archived, and their PII is scrubbed. If you increase it again later, those users are matched to their vendor_id, and their PII is restored on the existing database records. All of these changes are logged, and they trigger events for each of the users they affect.
This completes the Concepts learning path. When you need to go deeper on any topic, these pages are the place to return to.
- Users & Identities covers user identities, state mapping, and sync flows.
- Dimensions & Attributes covers dimension and attribute management.
- Policies & Rules covers rulesets, conditions, and rule priority.
- Qualification covers how each sync qualifies users, Policy User records, and grace periods.
- Integrations covers vendor support, workspace integrations, and configuration.