SCIM

SCIM Provisioning Setup Guide

Overview

Fairmarkit supports SCIM 2.0 for automated user provisioning and management. Integrating SCIM with your identity provider (IdP) allows your organization to automate user account creation, updates, and deactivation within Fairmarkit—ensuring user access remains synchronized across systems.


Prerequisites

To configure SCIM provisioning, you’ll need:

  • Admin access to your identity provider (IdP) portal

  • An application configured for Fairmarkit in your IdP

  • SCIM credentials from Fairmarkit:

    • SCIM Base URL: https://{environment}.fairmarkit.com/services/sso-gen/api/v3/scim

    • Bearer Token: (securely shared with your admin contact)

Supported Capabilities

  • User Provisioning: Automatically creates users when assigned in the IdP.

  • Deprovisioning: Automatically deactivates users when unassigned.

  • Attribute Updates: Syncs supported user profile fields.

  • Default Role Assignment: Applies a default Fairmarkit role upon user creation.


Using User Profile Attributes in Fairmarkit

User profiles provisioned via SCIM include key-value (kv) pairs that can be used to personalize and restrict access or input options in the Fairmarkit platform. You can also update user profiles via Public API.

1. Filtering Fields Based on Profile Data

Fields in forms or views can be filtered based on the user’s profile attributes.

Example: If a user’s profile contains department: it, then only data tagged with department: it will be shown in relevant fields or dropdowns.

2. Storing Profile Information on Requests

When a user submits a request, selected attributes from their profile (e.g., department, business unit) are written into the request data.

  • These values are fixed at the time of request creation.

  • Changes to the user profile do not retroactively affect existing requests.

  • This supports downstream integrations that rely on user-specific metadata.

3. Selectable Values From Profile

If a user has multiple values for a given attribute (e.g., multiple business units), the intake form can present those options for manual selection.

Example: John Doe belongs to both "Central IT" and "Ireland" business units. When creating a request, a dropdown will appear allowing John to select which business unit the request is for. These selectable options are sourced directly from the user’s profile.


Microsoft Azure AD Setup (Most Common)

Overview

This section outlines how to configure SCIM provisioning specifically in Microsoft Azure Active Directory (Azure AD)—one of the most commonly used IdPs.


Prerequisites

  • Admin access to your Azure AD portal

  • An Enterprise Application in Azure AD for Fairmarkit

  • SCIM credentials from Fairmarkit support


Step-by-Step Configuration

1. Access the Azure Portal

Navigate to Azure Active Directory > Enterprise Applications.

2. Select or Create an Application

Select the existing application for Fairmarkit or click + New Application to create one.

3. Open Provisioning Settings

In the left-hand menu, select Provisioning, then click Get Started.

4. Set Provisioning Mode

Set Provisioning Mode to Automatic.

5. Enter SCIM Connection Details

  • Tenant URL: https://{environment}.fairmarkit.com/services/sso-gen/api/v3/scim

  • Secret Token: (Paste the bearer token provided by Fairmarkit)

6. Test the Connection

Click Test Connection to validate the setup. If successful, click Save.

7. Enable Provisioning

In the Provisioning > Overview section, set Provisioning Status to On and click Save.

Need Help?

If you encounter issues or need SCIM credentials, please contact Fairmarkit Support.

Last updated

Was this helpful?