Office 365: OneDrive for Business
This section covers the following topics:
Prerequisites
Component | Description |
---|---|
Proxy Agent | Proxy Agent host with direct internet access. Recommended Proxy Agents: • Windows Agent • Linux Agent |
TCP Allowed Connections | Port 443 |
Configure Microsoft 365 Account
This topic describes how to generate the client ID, tentant key ID, and client secret key. These are required to register DDC with Microsoft 365 account. The topic also describes how to grant API permisisons to DDC to access specific resource APIs.
Generate Client ID and Tenant ID
To generate the client ID and tenant ID:
Log on to the Azure app registration portal as an administrator. After you log on successfully, you are redirected to the home page.
In the left pane, select the Microsoft Entra ID service. Alternatively, you can search for Microsoft Entra ID in the search bar.
Under Manage, click App registrations. The App registrations page is displayed.
Click + New registration. The Register an application page is displayed.
Specify the following:
Name: Display name for your application.
Supported account types: Select Accounts in this organizational directory only.
Click Register. The Overview page of the newly registered application is displayed.
Note down the values of Application (client) ID and Directory (tenant) ID. These values will be required when configuring a connection for the data store.
Generate Client Secret Key
Under Manage, click Certificates & secrets.
On the Client secrets tab, click + New client secret. The Add a client secret dialog box is displayed.
Specify the following:
Description: Description for the client secret key.
Expires: Validity for the client secret key. The recommended validity is 180 days (6 months).
Click Add. The client secret key is added. The Value column displays the client secret key.
Copy the client secret key and save it to a secure location. This secret key will be required when configuring a connection for the data store.
Warning
Save the client secret key in a secure location. You cannot access this client secret key after you navigate away from the page.
Grant API Access
To scan OneDrive for Business targets, you need to grant permissions to DDC to access specific resource APIs.
Under Manage, click API permissions.
In the Configured permissions section, click + Add a permission. The Request API permissions dialog box is displayed.
On the Microsoft APIs tab, click Microsoft Graph > Application permissions.
Select the following API permissions for your app:
Permissions Description • Group.Read.All
• GroupMember.Read.All
• Directory.Read.All
• Files.Read.All
• Sites.Read.AllPermissions required for scanning OneDrive for Business targets. Tip
To add permissions:
In the search box, type the permission you want to add.
Select the check box to the left of the permission. Similarly, select all the required permissions.
Click Add permissions.
In the Configured permissions section, click Grant admin consent for <organization name>. The Grant admin consent confirmation dialog box is displayed.
Click Yes.
The Status column for all the newly added API permissions is updated to Granted for <organization name>.
Add OneDrive for Business Data Store
To add the OneDrive for Business data store:
Log on to the CipherTrust Manager GUI.
Open the Data Discovery & Classification application.
Click Data Stores > Data Stores > Add Data Store. The Add Data Store wizard is displayed.
Complete the following steps:
Select Store Type
Under Select Data Store Category, select Cloud.
From Select Cloud Type, select Office 365: OneDrive for Business.
Click Next.
Configure Connection
Specify the credentials of the OneDrive for Business domain:
Field Description OneDrive for Business Domain Microsoft 365 domain to scan (for example, example.onmicrosoft.com
).
Only accounts where the user principal name (UPN) shares the same domain as specified in the OneDrive for Business Domain field will be scanned.
For example, if OneDrive for Business Domain is set toexample.onmicrosoft.com
,user1@example2.onmicrosoft.com
will not be scanned even if the user belongs to a group in theexample.onmicrosoft.com
domain.
To scan multiple domains within your organization's Microsoft 365 environment, add these domains as separate OneDrive for Business targets.Client ID Client ID (application ID) of OneDrive for Business. For example, clientid-1234-5678-abcd-6d05bf28c2bf
. Refer to Generate Client ID and Tenant ID for the client ID.Client Secret Key OneDrive for Business client secret key. For example, client~secret.key-CHvV1B5YQfr~6zDjEyv
. Refer to Generate Client Secret Key for the client secret key.Tenant ID Tenant ID of OneDrive for Business. Your Microsoft 365 tenant ID is a globally unique identifier (GUID) that is different than your organization name or domain. For example, tenantid-1234-abcd-5678-02011df316f4
. Refer to Generate Client ID and Tenant ID for the tenant ID.In the Select Number of Agents field, set the minimum and maximum number of agents for the data store. Refer to Agents for more information.
Warning
- As there is no limit on the number of minimum and maximum agents that you can set, you should exercise caution so that you do not impact the system performance by using too many resources for a single scan.
- You will not be able to add a datastore if the minimum number of agents cannot be assigned.
- A scan will fail if the assigned agent is unavailable after adding the datastore.
- The minimum number of agents must be less than or equal to the maximum number of agents.
(Optional) In the Add Label field, enter a label. You can also remove an existing label.
Click Next.
General Info
Specify the following details:
Name: Name for the data store.
Description (Optional): Description for the data store.
Location: Location of the data store. Refer to Managing Branch Locations for details.
Sensitivity Level (Optional): Sensitivity level for the data store. Refer to Sensitivity Levels for details.
Enable Data Store: Whether to enable the newly added data store. Select the check box to enable the data store.
Click Next.
Add Tags & Access Control
(Optional) Grant the
All groups (default)
access for reports. Alternatively, select a group.Click Save.
The data store is added to the Data stores page. If the Ready to Scan column shows Ready, then data store is properly configured.
For more information on tags and access control, expand the section below.
Tags and Access Control
The Add Tags & Access Control screen in the Add Data Store wizard allows you to grant access rights to your data store and add tags. More details below:
ACCESS - select user groups that can access the data store. Access to a data store provides ability to see reports that include scans of that data store. The available options are:
All groups: All groups of users can access the data store through reports. This is the default setting.
Selected group/s: Specified user defined groups can access the data store through reports. When this option is selected, select a group from the drop-down list. This list shows existing user defined groups. The user defined groups must already exist on CipherTrust Manager. If no user defined groups exist, ask the administrator to create a group. If needed, you can select multiple groups. Start typing the name of the desired group and select from the suggested groups.
TAGS - select a tag from the Add Tag drop-down list. Please check the list of prebuilt tags in Predefined Tags.
Tip
New tags can also be added. Start typing a new tag, and click the New: <new_tag> link that appears below the drop-down list.
Add as many tags as needed.
To remove a tag, click the close icon in the tag name.
In the General Info screen of the wizard, specify the name, description, branch location, and sensitivity level for your data store. See "Configuring a Data Store - General Information" for details.
In the Add Tags & Access Control screen of the wizard, grant access rights to your data store and add metadata. See "Configuring a Data Store – Tags and Access Control" for details.
Click Save to create the data store. At any time during the configuration you can click Back to go to any of the previous wizard screens to update the configuration. The newly created data store appears on the Data Stores page. By default, data stores are displayed in alphabetic order by name. Depending on the number of entries per page, you might need to navigate to other pages to view the newly created data store.
Note
Only accounts where the user principal name (UPN) shares the same domain as specified in the OneDrive for Business Domain field will be scanned.
To scan multiple domains, you need to add the domains in a new data store and add this data store in the scan setting.
A group can have an email associated with it. If the group has a domain similar to the configured OneDrive for Business Domain, then only the group will be scanned.
A group may not have an email configured. The group will be scanned if the users in the group have the same domain as configured in OneDrive for Business Domain. Users with a different domain won't be scanned.
For example, security groups don't need an email, they will still be scanned. However, the users that belong to this group should have the same domain as the group domain to be scanned. Users that belong to this group, but have a different domain, will not be scanned.
A group, which has the same email as the group domain, may contain users with different domains. In this case, only the users that share the same domain as the group domain will be scanned.
Add OneDrive for Business Scan
To add a scan for the Exchange Online:
Open the Data Discovery & Classification application.
Click Scans > Add Scan. The Add Scan wizard is displayed.
Complete the following steps:
Refer to Scans for the description of screens of the Add Scan wizard.
General Info
Specify a Name for the scan.
(optional) Add a Description for the scan.
Expand Advanced Configuration and specify advanced configurations such Scan Priority, Memory Usage Limit, and Amount of Data Object Volume. Refer to Advanced Configuration for details.
Click Next.
Select Data Stores
Under Data Store Name, select the desired data store that is Ready for scanning. You can select multiple data stores, if required.
Click Next.
Add Targets
To add a scan target, do one of the following:
Under the Add Target field, specify the correct target path and click Apply.
If no specific target is added, the entire data store will be scanned. Full data store or selected paths will be remediated only if selected.
The following table lists target paths and syntax to specify them with examples.
Target Path to Scan Syntax Example Complete data store <Empty_Path> All user accounts <All Users> All Users All user accounts in a specific group <Group Display Name> TEST_GROUP Specific user account in group <Group Display Name>/<User Principal Name> TEST_GROUP/user1@example.onmicrosoft.com Specific folder for user account in group <Group Display Name>/<User Principal Name>/<Folder> TEST_GROUP/user1@example.onmicrosoft.com/ProjectA Specific file for user account in group <Group Display Name>/<User Principal Name>/<Folder>/<File> TEST_GROUP/user1@example.onmicrosoft.com/ProjectA/file.txt Note
Target paths are case-sensitive. A target path can be groups user principal name and specific folders and files.
If multiple Microsoft 365 groups with the same display name exist in your domain, then only the first instance of the group will be retrieved. For example, if three groups have the same display name, "TESTGROUP", then the first "TESTGROUP" group for the OneDrive for Business target will be scanned.
Navigate and add target paths.
Click Browse to navigate target paths from the root level.
Alternatively, provide an initial path in the Add Target Path field and click Browse to navigate targets from that point onward.
In the left pane, navigate and select the desired target path.
Click Add Path to add the target path to the right pane. Similarly, add other target paths.
Click Add.
Tip
Either navigate the target paths from the root level (without specifying any path in the Add Target Path field) or make sure you provide the correct path to navigate further locations within it.
Click Next.
Select Profiles
Under Classification Profile Name, select the desired classification profiles to search for in the data store. You can select multiple data stores, if required. Refer to Classification Profiles for details on classification profiles.
Click Next.
Add Filters
This step is optional.
Select the desired filter from the Select Filter drop-down list.
To filter the locations to scan a OneDrive for Business data store, consider the following syntax.
Note
Exclude locations by prefix, suffix, and expression filters support wildcard characters. See Using Wildcard Characters to learn how wildcards work.
Exclude locations by prefix
Excludes search locations and nested locations with paths that begin with a given string. Can be used to exclude entire directory trees. Specify
<string>
.Filter Item Syntax Group <Group_Name> User <Group_Name>/<user@example.onmicrosoft.com> Folder <Group_Name>/<user@example.onmicrosoft.com>/<foldername> File <Group_Name>/<user@example.onmicrosoft.com>/<foldername>/<filename> Exclude locations by suffix
Excludes search locations and nested locations with paths that end with a given string. Specify
<string>
.Filter Item Syntax Group <Group_Name> User <Group_Name>/<user@example.onmicrosoft.com> Folder <Group_Name>/<user@example.onmicrosoft.com>/<foldername> File <Group_Name>/<user@example.onmicrosoft.com>/<foldername>/<filename> Exclude locations by expression
This filter is majorly used with wildcard characters.
Excludes search locations and nested locations that matches the given expression. Specify
<string>
.For example, to exclude locations that contain 'blob' in their path, use expression *blob*.
Filter Item Syntax Group <Group_Name>* (You have to use a trailing *
to exclude a given location.)User <All Users>/<sample@sjcpl.onmicrosoft.com>* or *<sample@sjcpl.onmicrosoft.com*> Folder <All Users>/<sample@sjcpl.onmicrosoft.com>/<folder>* or *<folder>* File <All Users>/<sample@sjcpl.onmicrosoft.com>/<folder>/<file>* or *<file>* Include locations modified recently
Includes search locations modified within N number of days from the current date, where the value of N ranges from 1 to 99 days. After selecting this filter, specify Days from current date.
Exclude locations greater than file size
Excludes files that are larger than a given file size (in MB). After selecting this filter, specify the file size in MB.
Include locations within modification date
Includes search locations modified within a given range of dates. After selecting this filter, specify Start and End dates.
Click Apply.
Repeat the above steps to apply multiple filters. Click Remove to remove any applied filter.
Click Next.
Schedule Run
Specify the scan run frequency. The two options are:
Manual: This is the default option. Select this option run the scan manually. Select the Run Now check box to start the scan run after you save the changes.
Scheduled: Select this option to configure the scan to run automatically at the specified time.
Refer to Schedule Scan for more details on scheduling scan runs.
Click Save.
Note
API request default quota for OneDrive is 1000 per minute. If this limit is exceeded, API request will fail and scan run may encounter different issues.
Unsupported Types and Folders
Currently, DDC doesn't support the following types and folders for the OneDrive for Business target:
Notebooks
OneNote file types and folders stored in OneDrive for Business but outside the default Notebooks folder.