This guide provides step-by-step instructions for integrating ApartmentIQ with Microsoft Entra ID (formerly Azure Active Directory) using SAML Single Sign-On (SSO). By following this configuration, you can enable your users to securely access ApartmentIQ using their existing corporate credentials, improving both security and the end-user experience.
This document will walk you through the following key phases:
- Initial Application Creation & Set Up: How to create a new non-gallery application named "ApartmentIQ" within your Entra ID tenant.
- SAML Configuration: Setting the necessary identifiers and reply URLs to establish the connection.
- Attributes & Claims Customization: Mapping user data like email, first name, and last name to ensure proper user identification within ApartmentIQ.
-
Final Hand-off & Testing in ApartmentIQ: Locating the App Federation Metadata URL to share with your Customer Success Manager and testing the final implementation.
Please Note
You will need to provide your CSM with your Metadata URL upon completion.
Initial Application Creation: Create a Non-Gallery Application
Open the applications section in the side panel and click on “Enterprise Applications”

Click on the “New Application” button

Click on “Create Your Own Application.”

In the Create your own application form, enter ApartmentIQ into the name of your app field, choose the Non-gallery option and click the “Create” button

Application Set Up
Assign Users
You can assign users to the application now. This document assumes that you know how to do this already.
Under Users and groups, you can assign individual users or groups. Each member of an assigned group can sign in. (If you also set up SCIM provisioning, turn off the group setting described in the SCIM Provisioning with Microsoft Entra ID guide.)
Set Up Single Sign On
Once users have been added, click “Set Up Single Sign On” in the Getting Started section.

Choose the "SAML" option on the next page

SAML Configuration
Click the edit button in the “Basic SAML Configuration”, section 1 of the SAML single sign up page.
Enter the following Identifier (Entity ID) and ReplyURL (Assertion Consumer Service URL) values:
-
Identifier: https://identity.apartmentiq.io
- Enter the Identifier exactly as shown above, without a trailing slash
- Reply URLs (Please add both):
Add these and save.

Attributes & Claims Customization
Click edit in the “Attributes & Claims”, section 2 in the single sign on set up page.
Leave the default claims as they are. ApartmentIQ reads Entra's default emailaddress, givenname and surname claims.
Claim names are case-sensitive, so do not rename them.
The first time a user signs in, ApartmentIQ finds that user by the emailaddress claim, so each user's mail attribute in Entra must hold the address ApartmentIQ invited.
After that first sign-in, ApartmentIQ recognizes the user by the Unique User Identifier (Name ID). Leave the Name ID at its default.
When you’re done the Attributes and Claims should look like this:

Final Hand-off and Testing In ApartmentIQ
Click edit in the “SAML Certificates” section, step 3 in the single sign on set up page.
Final Step
Copy the App Federation Metadata URL and send it to your CSM.
Send your CSM a list of your users and their roles. Signing in through SSO does not give a user access to your ApartmentIQ account; each user must first be added by your CSM, by an account admin under Manage Users, or by SCIM provisioning.
Admins: need a template? Feel free to make a copy of this template and email it to your CSM. (optional step)

Once your CSM has confirmed that ApartmentIQ is configured and that your user has been added, click "Test" on the Single sign-on page.

Testing For Normal Usage
Navigate to app.apartmentiq.io using your favorite browser. Enter the email address ApartmentIQ invited, and press Continue. (Do not use the Microsoft or Google button, since signing in with either button does not test SAML.)

Here’s an example of what your final settings should look like:

Before and after go-live:
- If your tenant has an existing ApartmentIQ application that your users sign in to with the Microsoft button, keep that application enabled until your users have signed in through SAML
- Each Entra tenant can be connected to only one ApartmentIQ account. If you have more than one ApartmentIQ account, contact your CSM before setup.
- Contact your CSM before you replace the ApartmentIQ enterprise application, renew its SAML signing certificate, change a user's email address or UPN, or give a user's account to a different person. After any of these changes, your users cannot sign in until ApartmentIQ updates its records.
Next Step: SCIM
If you intend to configure SCIM provisioning, your CSM will need to provide you with a token. We would be happy to arrange a call to discuss this further.
Should you have any questions, please contact your Customer Success Manager or our Support Team for assistance.