Prerequisites
Identity Server supports integration with Brivo via an Application configured in the Brivo Access web page. In order to setup the integration a user with the Super Admin role will need to create a new application. Customers are also required to have a valid API agreement and Brivo developer user profile.
Acquiring an API key
To acquire an API key, a Brivo Developer user profile is required. Typically, an integrator will request that the API is enabled for an end-user by submitting a copy of the API Access Agreement Form to api@brivo.com. They will specify the Brivo Developer user profile that the key should be under. Keys for a production environment are a tiered subscription and start at Tier 0.
A registration page for a new API Management ID can be found here, https://developer.brivo.com/member/register.
Setup in Brivo
1. Login to access.brivo.com as a user with the Super Administrator role.
2. Click on Configuration then "Applications Management"
3. Enter the Application Name and Description of your choice. It should be something that will be recognizable for example "PI-IDS-Sync" and "Synchronization with the PI Identity Server".
Select "Password" for the Authentication Type, and leave "Redirect URI" blank.
Click on "Create Application"
4. Once the application is created, click on the information button for "Application Detail" for the appropriate application.
5. In the window that pops up, record the Client ID and Client Secret to be referenced later (older versions). In newer versions, it's located under Configuration > Integrations.
6. Close the Application Details page, and click on the admin's name circle in the lower left corner. Record the "Admin ID" by clicking the copy button.
7. Close the window and navigate to the Princeton Identity Identity Server (IDS).
Setup in the IDS
1. Login to the IDS from a web browser using a user with the admin role and click Settings.
2. On the Settings page, select Sync from the left-hand menu.
3. Click the SETUP SYNC button.
4. Select "Brivo" from the drop-down menu and click the CONTINUE button.
5. On the Brivo screen, the default settings will appear. Click Edit Settings.
6. Enter information into the relevant boxes, and select from the following options:
- Check for updates - Manual, or Full scan every 12 or 24 hours
- Selecting the full scan will enable a constant incremental sync between the IDS and Brivo
- API Key: Enter the API key associated with the appropriate Brivo Developer user profile.
- Enter the username and password for a user with the Administrator or Super Administrator role
- Note: The username is the "Admin ID" recorded earlier - it is not the email address used to login.
- Enter the Client Secret and Client Id captured from the Brivo interface
- Optionally enable "Delete missing people"
- This will remove any people that are present in the Identity Server who are not already associated with a person in Brivo
- It will also remove people from the Identity Server when they are removed from Brivo
- Optionally enable "Import portrait images" (recommend)
- Optionally enable "Enroll Portrait Images". This will biometrically enroll people into the IDS using their face pictures from Brivo. Note: All people in the Brivo system should consent to enrolling their biometrics prior to enabling this feature.
- Click the APPLY button
NOTE: When adding a user, you can add their portrait during the creation of the profile so that it is displayed. If you create a user first (as-is/without a portrait), then sync, the portrait won't be displayed until the next sync. A way around it is to run a manual full sync, then the image will show.
7. If you selected the 12 or 24 hour sync, the initial sync will start immediately. If you selected manual, you will need to click "Run Now" each time that you would like a sync to occur. Click that now.