MipSDK-File-Dotnet-Quickstart
This sample application demonstrates using the Microsoft Information Protection SDK .NET wrapper to label and read a label from a file.
This sample illustrates basic SDK functionality where it:
- Obtains the list of labels for the user
- Prompts to input one of the label IDs
- Prompts for a file path of a file to label
- Applies the label
- Reads the label from the document and displays metadata
Summary
This sample application illustrates using the MIP File SDK to list labels, apply a label, then read the label. All SDK actions are implemented in action.cs.
Getting Started
Prerequisites
- Visual Studio 2015 or later with Visual C# development features installed
Sample Setup
In Visual Studio 2019:
- Right-click the project and select Manage NuGet Packages
- On the Browse tab, search for Microsoft.InformationProtection.File
- Select the package and click Install
Create an Azure AD App Registration
Authentication against the Azure AD tenant requires creating a native application registration. The client ID created in this step is used in a later step to generate an OAuth2 token.
Skip this step if you've already created a registration for previous sample. You may continue to use that client ID.
- Go to https://portal.azure.com and log in as a global admin.
Your tenant may permit standard users to register applications. If you aren't a global admin, you can attempt these steps, but may need to work with a tenant administrator to have an application registered or be granted access to register applications.
- Select Azure Active Directory, then App Registrations on the left side menu.
- Select New registration
- For name, enter MipSdk-Sample-Apps
- Under Supported account types set Accounts in this organizational directory only
Optionally, set this to Accounts in any organizational directory.
- Select Register
The Application registration screen should now be displaying your new application.
Add API Permissions
- Select API Permissions
- Select Add a permission
- Select Azure Rights Management Services
- Select Delegated permissions
- Check user_impersonation and select Add permissions at the bottom of the screen.
- Select Add a permission
- Select APIs my organization uses
- In the search box, type Microsoft Information Protection Sync Service then select the service.
- Select Delegated permissions
- Check UnifiedPolicy.User.Read then select Add permissions
- In the API permissions menu, select Grant admin consent for and confirm.
Set Redirect URI
- Select Authentication.
- Select Add a platform.
- Select Mobile and desktop applications
- Select the default native client redirect URI, which should look similar to https://login.microsoftonline.com/common/oauth2/nativeclient.
- Select configure and be sure to save and changes if required.
Update Client ID, RedirectURI, and Application Name
- Open app.config.
- Replace YOUR CLIENT ID with the client ID copied from the AAD App Registration.3.
- Replace YOUR APP NAME with the friendly name for your application.
- Replace YOUR APP VERSION with the version of your application.
- If you set the applicaiton type to single-tenant, set the value of ida:IsMultiTenantApp to false. Otherwise set to true.
- If you set the application type to single-tenant, replace YOUR TENANT GUID with the GUID or name of your Azure Active Directly tenant.
Run the Sample
Press F5 to run the sample. The console application will start and after a brief moment displays the labels available for the user.
- Copy a label ID to the clipboard.
- Paste the label in to the input prompt.
- Next, the app asks for a path to a file. Enter the path to an Office document or PDF file.
- Finally, the app will display the name of the applied label.
- Attempt to open the file in a viewer that supports labeling or protection (Office or Adobe Reader)