This guide provides step-by-step instructions for configuring SCIM (System for Cross-domain Identity Management) provisioning for ApartmentIQ with Microsoft Entra ID (formerly Azure Active Directory). By setting up automated provisioning, you can streamline your identity lifecycle management by automatically creating, updating, and deleting user accounts as employees join, move, or leave your organization.
This document will walk you through the following key phases:
- Initial Setup & Credentials: How to obtain the necessary access tokens and Tenant URL from your Customer Success Manager (CSM) to establish a secure connection.
- Application Configuration: Instructions for enabling "Automatic" provisioning mode and connecting your Entra ID tenant to the ApartmentIQ API.
- Mapping & Customization: How to configure specific user attribute mappings (such as userName, email, and name) while disabling unnecessary group provisioning to ensure data flows correctly.
-
Activation & Monitoring: Final steps to start the provisioning cycle and verify successful synchronization through provisioning logs.
Before You Start: Requirements
To begin the process, please request the SCIM data points (access token and Tenant URL) from your ApartmentIQ Customer Success Manager.
Your CSM and a member of our Implementation Team will then reach out to schedule a SCIM strategy session. During this meeting, we will review your requirements, provide the necessary data points, and assist you with the technical setup.
Create a non-Gallery Application
Before starting, please ensure you have created your non-gallery application by following the steps in our SAML SSO with EntraID guide.
Application Setup
Provision User Accounts
Head over to Enterprise Apps > Overview. Click “Provision User Accounts.”
Choose “Automatic” in the Provisioning Mode select field
Configure Provisioning
Enter the Tenant URL provided by your CSM in the Tenant URL field.
Enter the Secret Token provided by your CSM in the Secret Token field and click “Save”
Update Mappings
Disable the Group provisioning
Update the User provisioning settings
ApartmentIQ supports the following fields:
- userName
- emails[type eq "work"].value
- name.givenName
- name.familyName
- externalId
Remove the rest
Click Start Provisioning
Final Notes on SCIM in ApartmentIQ
SCIM will handle access to ApartmentIQ, but does not assign user roles (Admin, Manager, Editor or Read Only), or access to specific features. The following must be done manually in the Manage Users section of ApartmentIQ:
- Assign Market Surveys: You must manually assign specific market surveys to new users.
- User Roles: You must select a role (Admin, Manager, Editor, or Read Only), as SCIM cannot currently automate role assignment.
- Premium Tools: To enable Research Pro or Explore Pro seats, you must contact your CSM/Support.
If you need additional support, please reach out to your CSM, or contact our Support Team.