You can add Hosts to the FacilityOS Address Book by syncing employee records from Microsoft Entra ID or Microsoft Active Directory Domain Services (AD DS), depending on where your employee data is stored.
Security and confidentiality of data
This document falls under FacilityOS privacy and security policies, which require sufficient encryption and data segmentation throughout the platform. For the purposes of this document, follow these guidelines:
- Use a minimum of TLS 1.2 encryption for all data transfers.
- All data submissions must be uniquely tokenized or identified using a unique key ID and secret issued to a specific client. Clients may have more than one key, but each key can only be assigned to one client.
- Expired keys or tokens must not be reused.
- All data must travel from the customer system directly into the protected area of FacilityOS. Do not use intermediary servers or repositories unless they are in scope and part of the FacilityOS platform. Under no circumstances will FacilityOS request the client to post data to an insecure server, even temporarily.
- VPN and IP-restricted connections may be used to further safeguard the data.
Microsoft Entra ID
If your employee information is stored in Microsoft Entra ID, you can add those employees to the Address Book by syncing employee records from Microsoft Entra ID. For more information, see Integrate the Address Book with Microsoft Entra ID.
Microsoft Active Directory Domain Services
Microsoft Active Directory Domain Services (AD DS) is an on-premises directory service that runs inside your organization’s network or data center. It stores information about users, groups, devices, and access permissions.
The FacilityOS Address Book can integrate with AD DS by using API credentials. These credentials allow you to run a script that exports employee data to a CSV file and uploads it to your Address Book.
If your employee information is stored in AD DS, see Integrate the Address Book with Microsoft Active Directory Domain Services.
Other on-premises directory service systems
If your employee information is stored in another on-premises directory service system that supports exporting employee data to a CSV file, contact your Customer Success Manager to receive your API credentials. You can then run a PowerShell script for your system to export the information and upload it to the Address Book.
To know which data fields can be included in the CSV file, see the table in Prepare a CSV file.
Important:
If your Address Book already contains Hosts that were added manually, syncing with a directory service will not update their information. To ensure Host details are updated automatically, delete any manually added Hosts. To learn how, see Delete a Host.