Note
Support for SCIM is available for eligible Uptrends Enterprise accounts.
Overview
SCIM What-if mode lets you run a sync from your identity provider (IdP) and review the result before Uptrends changes operators or operator groups.
Use this mode to preview which operators and operator groups will be created, updated, or deleted before enabling SCIM provisioning. This lets you review the expected changes without affecting your current setup.
For setup steps, see Set up SCIM provisioning in Uptrends. For details on how live SCIM works, see SCIM provisioning behavior in Uptrends.
Run a dry run
Creating the SCIM service account selects SCIM enabled. Switch to SCIM What-if mode before the IdP provisions. A sync that runs while SCIM enabled is selected changes operators and operator groups in the account.
- Open SCIM settings, depending on your view:
- Go to Account setup > SCIM settings.
- Go to Admin > Operators and groups > SCIM settings.
- Set SCIM mode to SCIM What-if mode.
- Start provisioning in your IdP.
Uptrends keeps the operators, operator groups, group membership, and permissions already in the account. It does not send welcome emails. Send welcome email to new operators is shown only while SCIM enabled is selected.
Review the result
Read the dry run in the Audit log. The Operators and Operator groups pages stay unchanged.
Each line describes something that would have happened:
- SCIM What-if mode: {EntityType} '{EntityName}' would have been created. No actual changes were made.
- SCIM What-if mode: {EntityType} '{EntityName}' would have been deleted. No actual changes were made.
- SCIM What-if mode: {EntityType} '{EntityName}' would have been updated. No actual changes were made.
During a dry run, an update or delete line refers to a user or group from this test. Uptrends does not create, update, or remove operators or operator groups. It leaves operators and operator groups that are already in the account unchanged.
Existing operators and groups
A dry run does not adopt an existing operator. If the IdP sends a username that already belongs to an operator in Uptrends, that operator stays under your control in Uptrends. It is not labeled Managed by your IdP.
The audit log still says that operator would have been created. On a later live sync, Uptrends does not add a second operator for that username. While SCIM enabled is selected, a matching userName brings the existing operator under SCIM management. See
How SCIM interacts with manual operators.
A dry run does not adopt an existing operator group either, including a group whose SCIM external ID already matches the IdP. The audit log says that group would have been created. See How SCIM interacts with manual groups.
Clear What-if data
Clear What-if data is shown only while SCIM What-if mode is selected. If you switch to SCIM enabled or SCIM disabled, switch back to SCIM What-if mode to use this button.
The confirmation states that Uptrends permanently removes the simulated users, simulated groups, and the audit log lines from the dry run. Operators and operator groups in the account stay in place. Audit log lines from a live sync stay in place.
Clear the data when the next test should start empty. After you clear it, start provisioning again in the IdP. The IdP still has the previous test and will otherwise keep sending changes for users and groups that Uptrends has removed.
Go live
Switching SCIM mode to SCIM enabled leaves the dry run as a test. The next live sync is what creates or updates operators and operator groups.
The IdP keeps the dry run and continues to send changes for those simulated users and groups. Uptrends does not turn that test into operators or operator groups. Clear the test, switch mode, and start provisioning again so the IdP sends the users and groups again.
- While SCIM What-if mode is selected, click Clear What-if data and confirm.
- Set SCIM mode to SCIM enabled.
- Start provisioning again in your IdP.
If Send welcome email to new operators is enabled, Uptrends sends an invitation to each new operator the live sync creates. Operators that already exist and are adopted into SCIM management do not receive that email.