SCIM Provisioning with Okta

Provision users with Okta

Written By Jaime Dorn (Super Administrator)

Updated at November 13th, 2026

ApartmentIQ supports automated user provisioning via SCIM 2.0, allowing your IT team to manage the full lifecycle of user accounts directly from the Okta Admin Console. By integrating these platforms, you can automatically create, update, and deactivate users in ApartmentIQ based on their status in Okta.

Before you begin the provisioning setup, please ensure you have already completed the SAML SSO with Okta configuration steps. 

This guide will walk you through enabling API integration, mapping essential attributes, and assigning users to ensure a seamless synchronization process.

Before You Start: Requirements

Please request the SCIM data points (Base URL and API Token) from your ApartmentIQ Customer Success Manager to begin the process.

Your CSM and a member of our Implementation Team will reach out to schedule a SCIM strategy session. We’ll use this time to review your requirements, provide the data points, and assist with your Okta technical setup.

 

 

Enable Provisioning in Okta

  1. Log in to your Okta Admin Console.
  2. In the left navigation, go to Applications > Applications.
  3. Select your existing ApartmentIQ application.
  4. On the General tab, click Edit under App Settings, select SCIM under Provisioning, and click Save.
  5. Click on the Provisioning tab.
  6. Click the Integration tab.
  7. Check the box for Enable API Integration.


Configure API Settings

Enter the following values provided by your ApartmentIQ Customer Success Manager (CSM):

  • SCIM Base URL: Provided by your CSM
  • Unique Identifier Fields For Users: userName
  • Supported Provisioning Actions:
    • Import New Users and Profile Updates
    • Push New Users
    • Push User Profiles
    • Please note: Leave “Push Groups” and “Import Groups” unchecked
  • Authorization API Token: Paste the Bearer token provided by your CSM.

Click Test Connector Configuration API Credentials to verify the connection, then click Save.

 

Enable Provisioning Actions

After saving the API settings, select To App in the left sidebar of the Provisioning tab and click Edit. Enable the following features:

  • Create Users: Allows Okta to create users in ApartmentIQ.
  • Update User Attributes: Syncs profile changes (like name or email).
  • Deactivate Users: enable this setting. Users who are unassigned or deactivated in Okta currently keep their access to ApartmentIQ; to remove a user's access, an account admin must deactivate the user under Manage Users in app.

Click Save.

 

 

Attribute Mappings

ApartmentIQ requires specific SCIM attributes to identify users correctly. Ensure your mappings match the following table:

Okta Field

SCIM Field

userName

userName

email

emails[type eq "work"].value

givenName

name.givenName

familyName

name.familyName

 

⚠️ Important: Attribute names are case-sensitive and must match the ApartmentIQ schema exactly to prevent synchronization errors.

 

Assign Users 

Once provisioning is enabled, users assigned to the application will be automatically created in ApartmentIQ.

  1. Go to the Assignments tab in the ApartmentIQ app page.
  2. Click Assign and select:
    • Individual users
    • Groups: each member of an assigned group is provisioned as a user. Leave Push Groups unchecked.

 

Prevent Common Errors

To prevent common errors, please check:

  • API Token: if you see an error when you click Test Connector Configuration, contact your CSM.
  • Existing Users: if a user with the same email address already exists in ApartmentIQ, that user is added to your account, and a second user is not created.
  • Required Fields: Ensure all users have a First Name, Last Name, and Email populated in Okta before assignment.


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: Every user provisioned through SCIM is given the Read Only role. To give a user a different role, an account admin can change the role under Manage Users.
  • Premium Tools: To enable Research Pro or Explore Pro seats, you must contact your CSM/Support. (Self-service toggles are coming soon) .
  • Welcome email: Users provisioned through SCIM do not receive a welcome email. They sign in at https://app.apartmentiq.io by entering their email address and pressing Continue.

If you need additional support, please reach out to your CSM, or contact our Support Team.