Inventorying Microsoft Office 365. Inventorying Microsoft Office 365 Information with Docusnap X

Transkript

1 Inventorying Microsoft Office 365 Inventorying Microsoft Office 365 Information with Docusnap X

2 TITEL Inventorying Microsoft Office 365 AUTOR Docusnap Consulting DATUM 09/27/2018 VERSION 1.0 valid as of September 20, 2018 Die Weitergabe, sowie Vervielfältigung dieser Unterlage, auch von Teilen, Verwertung und Mitteilung ihres Inhaltes ist nicht gestattet, soweit nicht ausdrücklich durch die itelio GmbH zugestanden. Zuwiderhandlung verpflichtet zu Schadenersatz. Alle Rechte vorbehalten. This document contains proprietary information and may not be reproduced in any form or parts whatsoever, nor may be used by or its contents divulged to third parties without written permission of itelio GmbH. All rights reserved. Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 2 von 26

3 TABLE OF CONTENTS Introduction 4 Microsoft Azure Preparations Creating the New Docusnap Office 365 Application Opening the New application registration dialog Creating the Docusnap Office 365 application Determining the application ID and saving it for the Docusnap scan dialog Opening the application settings Creating the application key and saving it for the Docusnap scan dialog Authorizing the Docusnap Office 365 application Azure Active Directory Determining the Directory ID Summary 13 Alternative: PowerShell Script 14 Inventorying Office 365 with Docusnap Docusnap Office 365 Inventory Wizard Prerequisite: proxy configuration The Docusnap Office 365 Inventory scan dialog Office 365 scan dialog Company Selection Office 365 scan dialog Domain Selection Office 365 Inventory Office 365 scan result in Docusnap 23 Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 3 von 26

4 Introduction In September Release 2018, Docusnap was enhanced with the Office 365 Inventory feature. The new added inventory collects data (users, groups and licenses) regarding Microsoft Office 365. In this document we describe which steps are necessary to map information of your Microsoft Office 365 environment in Docusnap. Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 4 von 26

5 Microsoft Azure Preparations The following chapters describe how to prepare the Microsoft Azure environment for inventorying Microsoft Office 365. Alternatively, a PowerShell script can be used for setup, as described in Chapter 3. Before you begin, make sure that the Azure user you are using is authorized as a Global Administrator. 2.1 Creating the New Docusnap Office 365 Application For the Docusnap Office 365 Inventory feature, a registered application is required. This application must have read access to the Microsoft Azure data. This section describes how to create such an application. In our example, the application is called Docusnap Office 365. You can choose any name you like, but it is recommended to enter a meaningful name. To grant the Docusnap Office 365 Inventory feature read access to the Windows Azure Service Management API, you need to create a new application of the Web App / API type Opening the New application registration dialog Select the Azure Active Directory item from the resource list at the left In the Azure Active Directory view, select the App registrations item under Manage Click the New application registration menu item Fig. 1 - App registration Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 5 von 26

6 2.1.2 Creating the Docusnap Office 365 application You now create the Docusnap Office 365 application in the Create dialog. Name field: Enter Docusnap Office 365 as the application name Application type field: Select the Web app / API type Sign-on URL field: Enter the URL here. Create: Click this button to create the Docusnap Office 365 application Fig. 2 - App creation Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 6 von 26

7 2.1.3 Determining the application ID and saving it for the Docusnap scan dialog When you have completed the creation process, the application will be displayed along with its Application Name, Application Type, and its Application ID in the Dashboard. Change to the application by clicking its name in the application view. Now, copy the application ID to your text editor. This value will later be needed for the inventory scan. With the focus on the ID, a copy symbol is displayed automatically. You can use it for copying. Fig. 3 - Docusnap Office 365 Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 7 von 26

8 2.1.4 Opening the application settings After copying the ID, click the Display Name. This opens an overview of your application. Now, click the Settings button to open the Settings dialog. There, select the Keys option in the API Access category. Fig. 4 - App settings Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 8 von 26

9 2.1.5 Creating the application key and saving it for the Docusnap scan dialog Now, create a key for the Docusnap Office 365 application and enter a meaningful name in the Description field. Then, select the validity period in the Expires field. For this example, we entered the following values: Description field: DS-Office365-Key Expires field: one year Save: Click the Save button at the upper left The key is displayed one single time in the Value field. Copy the key value to your text editor Note: If you lose the key value or if it becomes invalid, you need to create a new key. Fig. 5 - Key creation Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 9 von 26

10 2.1.6 Authorizing the Docusnap Office 365 application Now, the next step is to authorize the Docusnap Office 365 application for the Microsoft Graph API. Select the Required permissions option from the API Access group in the right-hand panel Click Add in the Required permissions panel In the first step, you need to select an API. Click 1 Select an API Select Microsoft Graph and then click Select In the next step select read directory data Fig. 6 - Assign permissions I Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 10 von 26

11 Fig. 7 - Assign permissions II Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 11 von 26

12 2.1.7 Azure Active Directory Determining the Directory ID Determining and saving the directory ID: Select the Azure Active Directory item from the resource list at the left In the Azure Active Directory view, select the Properties item under Manage Use the copy function to save the Directory ID shown in your text editor Fig. 8 - Directory ID Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 12 von 26

13 2.2 Summary The changes made up to now enable you to inventory your Microsoft Office 365 with Docusnap. Docusnap will use the Docusnap Office 365 application to inventory the desired information through the API and store it for further processing in the Docusnap database. Your text editor should now contain all the values saved in-between. These are required for the subsequent inventory process. (Parts of the keys were anonymized in this example.) Fig. 9 - Inventory Credentials Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 13 von 26

14 Alternative: PowerShell Script Alternatively, a PowerShell script can be used to perform the steps described above. The script is located in the installation directory of Docusnap C:\Program Files\Docusnap X\Tools\scripts\ o365.key.creation.ps1 Important: The PowerShell script must be run as an administrator! The following steps are necessary: 1. Start PowerShell Script and log in in the appearing window Fig 10 - PowerShell - login Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 14 von 26

15 2. Assign a name for the application: Docusnap Office 365 Fig PowerShell - application name 3. All required information (Application ID, Directory ID and Key) is displayed afterwards Fig PowerShell inventory credentials Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 15 von 26

16 4. You have to open the displayed URL in the browser and confirm the access. Fig PowerShell - confirm access Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 16 von 26

17 Inventorying Office 365 with Docusnap 4.1 Docusnap Office 365 Inventory Wizard Prerequisite: proxy configuration If your network uses a proxy, you must specify the proxy parameters in the connection settings. It is possible that you normally do not need these settings when using the other scan modules. Basically, the proxy settings must be suitable for the respective Docusnap Discovery Service (DDS). The settings shown in the exemplary screenshot are suitable for interactive Office 365 inventory scans. If you selected the Discovery Service of another location as the DDS, you would have to adjust the proxy settings for this DDS Adjusting the proxy settings: Click Docusnap in the upper left corner to open the Options panel Select the General Options item from the list of options In the Options dialog, click Connections. Under Proxy Settings: o select Set up manually o Under Address, enter your proxy URL including the Port number o Enter suitable values in the User and Password fields Click OK to confirm your changes Fig Docusnap Proxy Settings Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 17 von 26

18 4.1.2 The Docusnap Office 365 Inventory scan dialog The Docusnap ribbon has been extended: we added the Cloud Services group. Click Office 365 to open the scan dialog. Fig Docusnap Office 365 Inventory starting the wizard Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 18 von 26

19 4.1.3 Office 365 scan dialog Company Selection In the first step, select the company the Office 365 scan result will be assigned to. Alternatively, you can click Create new Company to create a new company (tenant). Multi-tenant capability is only available in the Docusnap X Ultimate Edition. Fig Office 365 Inventory - Company Selection Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 19 von 26

20 4.1.4 Office 365 scan dialog Domain Selection In the Domain Selection step, select the domain of the previously selected company the scan result will be assigned to. Alternatively, you can create a new domain for the selected company by clicking Create new Domain. In addition, a Discovery Service is defined for the execution. In this example, a client installation of Docusnap is configured and selected for scanning. This means that a scheduled execution is not possible. In this case, the wizard informs you with a warning. Fig Office 365 Inventory - Domain Selection Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 20 von 26

21 4.1.5 Office 365 Inventory Now, you need the previously collected IDs and key information that you saved in your text editor. The Display Name is only a placeholder and can therefore be chosen freely The Directory ID corresponds to the ID of your Azure Active Directory For the Application ID, enter the ID of the application you created previously In the Key field, enter the value of the key you created previously Fig Office 365 Inventory - credentials Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 21 von 26

22 Inventorying Microsoft Office 365 Information After confirming the dialog, the Office 365 website opens in your web browser, where you have to log in and accept the corresponding authorization request. Fig Office 365 Inventory - Accept permissions request Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 22 von 26

23 4.2 Office 365 scan result in Docusnap The scan result can be found in the inventory module as a separate node called Office 365 below the previously selected domain, within the infrastructure of your client. The screenshot below shows the top level of an Office 365 inventory: Fig Office 365 Inventory Scan result Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 23 von 26

24 ABBILDUNGSVERZEICHNIS FIG. 1 - APP REGISTRATION... 5 FIG. 2 - APP CREATION... 6 FIG. 3 - DOCUSNAP OFFICE FIG. 4 - APP SETTINGS... 8 FIG. 5 - KEY CREATION... 9 FIG. 6 - ASSIGN PERMISSIONS I...10 FIG. 7 - ASSIGN PERMISSIONS II FIG. 8 - DIRECTORY ID...12 FIG. 9 - INVENTORY CREDENTIALS...13 FIG 10 - POWERSHELL - LOGIN FIG POWERSHELL - APPLICATION NAME...15 FIG POWERSHELL INVENTORY CREDENTIALS...15 FIG POWERSHELL - CONFIRM ACCESS...16 FIG DOCUSNAP PROXY SETTINGS FIG DOCUSNAP OFFICE 365 INVENTORY STARTING THE WIZARD...18 FIG OFFICE 365 INVENTORY - COMPANY SELECTION...19 FIG OFFICE 365 INVENTORY - DOMAIN SELECTION FIG OFFICE 365 INVENTORY - CREDENTIALS...21 FIG OFFICE 365 INVENTORY - ACCEPT PERMISSIONS REQUEST FIG OFFICE 365 INVENTORY SCAN RESULT Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 24 von 26

25 VERSION HISTORY Date September 20, 2018 Description Document created Inventorying Microsoft Office Docusnap Alle Rechte vorbehalten Seite 25 von 26

26 itelio GmbH -