Enterprise Recon 2.12.0
Microsoft OneNote
This section covers the following topics:
- Overview
- Licensing
- Requirements
- Configure Microsoft 365 Account
- Set Up and Scan a Microsoft OneNote Target
- Edit Microsoft OneNote Target Path
- Matches in Attachments in Microsoft OneNote
- Microsoft OneNote Remediation
- Users in Multiple Groups
Overview
When Microsoft OneNote is added as a scan Target, ER2 returns the notebooks for all Microsoft 365 groups and user accounts. You can select specific groups, users, notebook folders, notebooks, sections, or pages when setting up the scan schedule.
You can also scan all users with Microsoft OneNote notebooks in your organization's domain by selecting the "All Users" group as a scan location.
Example of Microsoft OneNote structure:
Microsoft OneNote [domain: example.onmicrosoft.com]
+- Microsoft OneNote on target MS365:EXAMPLE.ONMICROSOFT.COM
+- Group Engineering
+- User A
+- Notebook A
+- Section A
+- Page 1
+- Page 2
+- Section B
+- Page 1
+- Page 2
+- Group Design
+- Group's Notebook
+- Notebook A
+- Section A
+- Page 1
+- Page 2
+- Section Group A
+- Section A
+- Section Group B
Licensing
For Sitewide Licenses, all scanned Microsoft OneNote Targets consume data from the Sitewide License data allowance limit.
For Non-Sitewide Licenses, Microsoft OneNote Targets require Client Licenses, and consume data from the Client License data allowance limit.
See Target Licenses for more information.
Requirements
Requirements | Description |
---|---|
Proxy Agent |
|
TCP Allowed Connections | Port 443 |
Configure Microsoft 365 Account
For ER 2.8.0 and above, you will need to perform the following setup to scan Microsoft OneNote Targets:
Generate Client ID and Tenant ID Key
- With your administrator account, log in to the Azure app registration portal.
- In the App registrations page, click + New registration.
-
In the Register an application page, fill in the following fields:
Field Description Name Enter a descriptive display name for ER2. For example, Enterprise Recon. Supported account types Select Accounts in this organizational directory only. - Click Register. You will be redirected to the Overview page for the newly registered app, Enterprise Recon.
-
Take down the Application (client) ID and Directory (tenant) ID. This is required when you want to Set Up and Scan a Microsoft OneNote Target.
Generate Client Secret Key
- With your administrator account, log in to the Azure app registration portal.
- In the App registrations page, go to the Owned applications tab. Click on the app that you registered (e.g. Enterprise Recon) when generating the Client ID and Tenant ID key.
- In the Manage panel, click Certificates & secrets.
- In the Client secrets section, click + New client secret.
-
In the Add a client secret page, fill in the following fields:
Field Description Description Enter a descriptive label for the Client Secret key. Expires Select a validity period for the Client Secret key. -
Click Add. The Value column will contain the Client Secret key.
-
Copy and save the Client Secret key to a secure location. This is required when you want to Set Up and Scan a Microsoft OneNote Target.
Save your Client Secret key in a secure location. You cannot access this Client Secret key once you navigate away from the page.
Grant API Access
To scan Microsoft OneNote Targets, you will need to grant ER2 permissions to access specific resource APIs.
- With your administrator account, log in to the Azure app registration portal.
- In the App registrations page, go to the Owned applications tab. Click on the app that you registered (e.g. Enterprise Recon) when generating the Client ID and Tenant ID key.
- In the Manage panel, click API permissions.
- In the Configured permissions section, click + Add a permission.
- In the Request API permissions page, select Microsoft Graph > Application permissions.
-
Select the following permissions for the Enterprise Recon app:
API Permissions Description - Group.Read.All
- User.Read.All
- Directory.Read.All
- Notes.Read.All
Required for probing and scanning Microsoft OneNote Targets. - Click Add permissions.
- In the Configured permissions page, click on Grant admin consent for <organization name>.
- In the Grant admin consent confirmation dialog, click Yes. The Status column for all the newly added API permissions will be updated to "Granted for <organization name>".
Set Up and Scan a Microsoft OneNote Target
This section describes how to set up Microsoft OneNote Targets for ER 2.8.0 and above.
- Configure Microsoft 365 Account.
- From the New Scan page, Add Targets.
- In the Select Target Type dialog box, select Microsoft 365 > Microsoft OneNote.
-
Fill in the following details:
Field Description OneNote Domain Enter the Microsoft 365 domain to scan.
Example: example.onmicrosoft.com
Only accounts where the user principal name (UPN) shares the same domain as specified in the OneNote Domain field will be scanned and/or listed when probing the Target.For example, if OneNote Domain is set to example.onmicrosoft.com, user1@example2.onmicrosoft.com will not be scanned and/or listed when probing the Target even if the user belongs to a group in the example.onmicrosoft.com domain.
To scan multiple domains within your organization's Microsoft 365 environment, add these domains as separate Microsoft OneNote Targets.
New Credential Label Enter a descriptive label for the Microsoft OneNote credential set.
Example: m365-microsoftonenote-exampledomain
Client ID Enter the Client ID.
Example: clientid-1234-5678-abcd-6d05bf28c2bf
See Generate Client ID and Tenant ID Key for more information.
Client Secret Key Enter the Client Secret key.
Example: client~secret.key-CHvV1B5YQfr~6zDjEyv
See Generate Client Secret Key for more information.
Tenant ID Enter the Tenant ID.
Example: tenantid-1234-abcd-5678-02011df316f4
See Generate Client ID and Tenant ID Key for more information.
Agent to act as proxy host Select a Windows, Linux or macOS Proxy Agent host with direct Internet access.
- Click Test. If ER2 can connect to the Target, the button changes to a Commit button.
- Click Commit to add the Target.
- Back in the New Scan page, locate the newly added Microsoft OneNote Target and click on the arrow next to it to display a list of available Microsoft 365 groups for the domain.
- Select the Target location(s) to scan:
-
If "All Users" is selected, ER2 scans all user accounts in the Microsoft 365 domain.
"All Users" is a default, non-configurable virtual group in ER2 that automatically includes all user accounts in the Microsoft 365 domain. If a similar "All Users" group pre-exists in your Microsoft 365 environment, we recommend that you change the display name for that group as it will be viewed as a duplicate group and will not be displayed in ER2. -
If only specific groups are selected, ER2 only scans notebooks from user accounts or notebook folders in the selected groups.
For Microsoft OneNote Target location paths that contain special characters (e.g. "#", "%", "&", etc…), probe the Target to add and scan the location. -
- Click Test. If ER2 can connect to the Target, the button changes to a Commit button.
- Click Commit to add the Target.
-
(Optional) On the Select Locations page, probe the Target to browse and select specific Target locations to scan.
- Click Next.
- On the Select Data Types page, select the Data Type Profiles to be included in your scan and click Next.
-
On the Set Schedule page, configure the parameters for your scan. See Set Schedule for more information.
- Click Next.
- On the Confirm Details page, review the details of the scan schedule, and click Start Scan to start the scan. Otherwise, click Back to modify the scan schedule settings.
Edit Microsoft OneNote Target Path
- Set Up and Scan a Microsoft OneNote Target.
-
In the Select Locations section, select your Microsoft OneNote Target location and click Edit.
For Microsoft OneNote Target location paths that contain special characters (e.g. "#", "%", "&", etc…), probe the Target instead to add and scan the location. -
In the Edit Microsoft OneNote dialog box, enter a (case sensitive) Path to scan. Use the following syntax:
Locations to Scan Path All notebooks for all users in all groups Syntax: All Users
Example: All Users
All notebooks for all users or in the notebook folder of a specific group Syntax: <Group Display Name>
Example: Engineering
All notebooks in the notebook folder of a specific group Syntax: <Group Display Name>/g
Example: Engineering/g
Specific notebook for a specific user in a specific group Syntax: <Group Display Name>/<User Principal Name>/<Notebook>
Example: Engineering/user1@example.onmicrosoft.com/Q1 Notebook
Specific notebook in the notebook folder of a specific group Syntax: <Group Display Name>/g/<Notebook>
Example: Engineering/g/Q1 Notebook
Specific section of a notebook for a specific user in a specific group Syntax: <Group Display Name>/<User Principal Name>/<Notebook>/<Section>
Example: Engineering/user1@example.onmicrosoft.com/Q1 Notebook/Section A
Specific section or section group of a notebook in the notebook folder of a specific group Syntax: <Group Display Name>/g/<Notebook>/<Section or Section Group>
Example: Engineering/g/Q1 Notebook/SG Branch
Specific section or nested section in a section group of a specific notebook in the notebook folder of a specific group Syntax: <Group Display Name>/<Notebook Folder>/<Notebook>/<Section Group>/<Section or Nested Section>
Example: Engineering/g/Q1 Notebook/SG Branch/Section A
Specific pages in a section of a specific notebook for a specific user in a specific group Syntax: <Group Display Name>/<User Principal Name>/<Notebook>/<Section>/<Page>
Example: Engineering/user1@example.onmicrosoft.com/Q1 Notebook/Section A/Page 1
Specific pages in a section of a specific notebook in the notebook folder of a specific group Syntax: <Group Display Name>/g/<Notebook>/<Section>/<Page>
Example: Engineering/g/Q1 Notebook/Section A/Page 1
If there are multiple Microsoft 365 groups with the same display name in your domain, ER2 will only retrieve the first group occurrence. For example, if there are three groups with the same display name, "Engineering", ER2 will only probe, scan and return results for the first "Engineering" group for the Microsoft OneNote Target. - Click Test and then Commit to save the path to the Target location.
Matches in Attachments in Microsoft OneNote
Matches that are found in attachments in notebooks are reported as distinct match locations from its parent page.
Example:
Page 1 in "Section A" of "Notebook A" contains the files "team-building.txt" and "members.txt". If matches are found in both files, ER2 reports this as two match locations, where "team-building.txt" and "members.txt" are distinct match locations.
Microsoft OneNote Remediation
The following remediation actions are supported for Microsoft OneNote Targets:
Users in Multiple Groups
This section describes the behavior of users that are members of multiple groups for the Microsoft OneNote Target.
License Consumption
A notebook owned by a user account that belongs to multiple groups
- is scanned each time a group the user belongs to is scanned.
- consumes only 1x data allowance usage regardless of how many times it is scanned as part of different groups.
When both "Engineering" and "Design" groups are added to the same scan, the notebook by "UserA" is scanned once when "Engineering" is scanned, and a second time when "Design" is scanned.
"UserA" consumes only one Client License, and 5 MB Client License data allowance despite having been scanned twice.
Scan Results
Matches that are found in notebooks owned by users that belong to multiple groups will be reported as a distinct match count for each group.
Take for example a simplified Microsoft OneNote Target for the domain "example.onmicrosoft.com" below:
EXAMPLE.ONMICROSOFT.COM 55 matches
+– Engineering 30 matches
+– UserA 10 matches
+– UserB 20 matches
+– Design 25 matches
+– UserA 10 matches
+– UserC 15 matches
Matches found in notebook owned by "UserA" will be included in the match count for both Engineering and Design groups.
PRO This feature is only available in Enterprise Recon PRO Edition. To find out more about upgrading your ER2 license, please contact Ground Labs Licensing. See Subscription License for more information.