InformationProtectionPolicy.Read
Allows an app to read information protection sensitivity labels and label policy settings, on behalf of the signed-in user.
Merill's Note
For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the
InformationProtectionPolicy.Readpermission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReportcommand. See How To: Run a quick OAuth app audit of your tenant
| Category | Application | Delegated |
|---|---|---|
| Identifier | - | 4ad84827-5578-4e18-ad7a-86530b12f884 |
| DisplayText | - | Read user sensitivity labels and label policies. |
| Description | - | Allows an app to read information protection sensitivity labels and label policy settings, on behalf of the signed-in user. |
| AdminConsentRequired | Yes | No |
Graph Methods
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
| Methods |
|---|
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
| Methods | |
|---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands |
|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands | |
|---|---|
Resources
Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
- addcontentfooteraction
- addcontentheaderaction
- applylabelaction
- classificationresult
- contentinfo
- customaction
- downgradejustification
- informationprotectionaction
- informationprotectioncontentlabel
- informationprotectionlabel
- justifyaction
- keyValuePair
- labelingoptions
- metadataaction
- protectadhocaction
- protectdonotforwardaction
- recommendlabelaction
- removecontentfooteraction
- removecontentheaderaction
- removeprotectionaction
- removewatermarkaction
- addContentFooterAction
- addContentHeaderAction
- addWatermarkAction
- applyLabelAction
- classificationResult
- contentInfo
- contentLabel
- customAction
- downgradeJustification
- informationProtectionAction
- informationProtectionPolicySetting
- justifyAction
- keyValuePair
- labelingOptions
- metadataAction
- protectAdhocAction
- protectByTemplateAction
- protectDoNotForwardAction
- recommendLabelAction
- removeContentFooterAction
- removeContentHeaderAction
- removeProtectionAction
- removeWatermarkAction
- sensitivityLabel
Graph reference: addcontentfooteraction
| Property | Type | Description |
|---|---|---|
| alignment | String | Possible values are: left, right, center. |
| fontColor | String | Color of the font to use for the footer. |
| fontName | String | Name of the font to use for the footer. |
| fontSize | Int32 | Font size to use for the footer. |
| margin | Int32 | The margin of the header from the bottom of the document. |
| text | String | The contents of the footer itself. |
| uiElementName | String | The name of the UI element where the footer should be placed. |
Graph reference: addcontentheaderaction
| Property | Type | Description |
|---|---|---|
| alignment | String | Possible values are: left, right, center. |
| fontColor | String | Color of the font to use for the header. |
| fontName | String | Name of the font to use for the header. |
| fontSize | Int32 | Font size to use for the header. |
| margin | Int32 | The margin of the header from the top of the document. |
| text | String | The contents of the header itself. |
| uiElementName | String | The name of the UI element where the header should be placed. |
Graph reference: applylabelaction
| Property | Type | Description |
|---|---|---|
| actionSource | String | Possible values are: manual, automatic, recommended, default. |
| actions | informationProtectionAction collection | The collection of specific actions that should be taken by the consuming application to label the document. See informationProtectionAction for the full list. |
| label | labelDetails | Object that describes the details of the label to apply. |
| responsibleSensitiveTypeIds | Guid collection | If the label was the result of an automatic classification, supply the list of sensitive info type GUIDs that resulted in the returned label. |
Graph reference: classificationresult
| Property | Type | Description |
|---|---|---|
| confidenceLevel | Int32 | The confidence level, 0 to 100, of the result. |
| count | Int32 | The number of instances of the specific information type in the input. |
| sensitiveTypeId | GUID | The GUID of the discovered sensitive information type. |
Graph reference: contentinfo
| Property | Type | Description |
|---|---|---|
| format | String | Possible values are: default, email. |
| identifier | String | Identifier used for Azure Information Protection Analytics. |
| metadata | keyValuePair collection | Existing Microsoft Purview Information Protection metadata is passed as key/value pairs, where the key is the MSIP_Label_GUID_PropName. |
| state | String | Possible values are: rest, motion, use. |
Graph reference: customaction
| Property | Type | Description |
|---|---|---|
| name | String | Name of the custom action. |
| properties | keyValuePair collection | Properties, in key value pair format, of the action. |
Graph reference: downgradejustification
| Property | Type | Description |
|---|---|---|
| isDowngradeJustified | Boolean | Indicates whether the downgrade is or isn't justified. |
| justificationMessage | String | Message that indicates why a downgrade is justified. The message appears in administrative logs. |
Graph reference: informationprotectionaction
Graph reference: informationprotectioncontentlabel
| Property | Type | Description |
|---|---|---|
| assignmentMethod | String | Possible values are: standard, privileged, auto. |
| creationDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| label | labelDetails | Details on the label that is currently applied to the file. |
Graph reference: informationprotectionlabel
| Property | Type | Description |
|---|---|---|
| color | String | The color that the UI should display for the label, if configured. |
| description | String | The admin-defined description for the label. |
| id | String | The label ID is a globally unique identifier (GUID) |
| isActive | Boolean | Indicates whether the label is active or not. Active labels should be hidden or disabled in UI. |
| name | String | The plaintext name of the label. |
| sensitivity | Int32 | The sensitivity value of the label, where lower is less sensitive. |
| tooltip | String | The tooltip that should be displayed for the label in a UI. |
| parent | labelDetails | The parent label associated with a child label. Null if label has no parent. |
Graph reference: justifyaction
Graph reference: keyValuePair
| Property | Type | Description |
|---|---|---|
| name | String | Name for this key-value pair |
| value | String | Value for this key-value pair |
Graph reference: labelingoptions
| Property | Type | Description |
|---|---|---|
| assignmentMethod | String | Possible values are: standard, privileged, auto. |
| downgradeJustification | downgradeJustification | The downgrade justification object that indicates if downgrade was justified and, if so, the reason. |
| extendedProperties | keyValuePair collection | Extended properties will be parsed and returned in the standard MIP labeled metadata format as part of the label information. |
| labelId | Guid | The GUID of the label that should be applied to the information. |
Graph reference: metadataaction
| Property | Type | Description |
|---|---|---|
| metadataToAdd | keyValuePair collection | A collection of key value pairs that should be added to the file. |
| metadataToRemove | String collection | A collection of strings that indicate which keys to remove from the file metadata. |
Graph reference: protectadhocaction
Graph reference: protectdonotforwardaction
Graph reference: recommendlabelaction
| Property | Type | Description |
|---|---|---|
| actionSource | String | Possible values are: manual, automatic, recommended, default. |
| actions | informationProtectionAction collection | Actions to take if the label is accepted by the user. |
| label | labelDetails | The label that is being recommended. |
| responsibleSensitiveTypeIds | Guid collection | The sensitive information type GUIDs that caused the recommendation to be given. |
Graph reference: removecontentfooteraction
| Property | Type | Description |
|---|---|---|
| uiElementNames | String collection | The name of the UI element of the footer to be removed. |
Graph reference: removecontentheaderaction
| Property | Type | Description |
|---|---|---|
| uiElementNames | String collection | The name of the UI element of the header to be removed. |
Graph reference: removeprotectionaction
Graph reference: removewatermarkaction
| Property | Type | Description |
|---|---|---|
| uiElementNames | String collection | The name of the UI element of footer to be removed. |
Graph reference: addContentFooterAction
| Property | Type | Description |
|---|---|---|
| alignment | String | The horizontal alignment of the footer. |
| fontColor | String | Color of the font to use for the footer. |
| fontName | String | Name of the font to use for the footer. |
| fontSize | Int32 | Font size to use for the footer. |
| margin | Int32 | The margin of the header from the bottom of the document. |
| text | String | The contents of the footer itself. |
| uiElementName | String | The name of the UI element where the footer should be placed. |
Graph reference: addContentHeaderAction
| Property | Type | Description |
|---|---|---|
| alignment | String | The horizontal alignment of the header. |
| fontColor | String | Color of the font to use for the header. |
| fontName | String | Name of the font to use for the header. |
| fontSize | Int32 | Font size to use for the header. |
| margin | Int32 | The margin of the header from the top of the document. |
| text | String | The contents of the header itself. |
| uiElementName | String | The name of the UI element where the header should be placed. |
Graph reference: addWatermarkAction
| Property | Type | Description |
|---|---|---|
| fontColor | String | Color of the font to use for the watermark. |
| fontName | String | Name of the font to use for the watermark. |
| fontSize | Int32 | Font size to use for the watermark. |
| layout | String | The layout of the watermark. Possible values are: horizontal, diagonal. |
| text | String | The contents of the watermark itself. |
| uiElementName | String | The name of the UI element where the watermark should be placed. |
Graph reference: applyLabelAction
| Property | Type | Description |
|---|---|---|
| actions | informationProtectionAction collection | The collection of actions that should be implemented by the caller. |
| actionSource | actionSource | Specifies why the label was selected. Possible values are: manual, automatic, recommended, default. |
| responsibleSensitiveTypeIds | GUID collection | If the label was the result of an automatic classification, supply the list of sensitive info type GUIDs that resulted in the returned label. |
Graph reference: classificationResult
| Property | Type | Description |
|---|---|---|
| confidenceLevel | Int32 | The confidence level, 0 to 100, of the result. |
| count | Int32 | The number of instances of the specific information type in the input. |
| sensitiveTypeId | GUID | The GUID of the discovered sensitive information type. |
Graph reference: contentInfo
| Property | Type | Description |
|---|---|---|
| contentFormat | String | The format of the content to be labeled. Possible values are: file, email. |
| identifier | String | Identifier used for Azure Information Protection Analytics. |
| metadata | keyValuePair collection | Existing Microsoft Purview Information Protection metadata is passed as key-value pairs, where the key is the MSIP_Label_GUID_PropName. |
| state | contentState | The usage state of the content. The possible values are: rest, motion, or use. |
Graph reference: contentLabel
| Property | Type | Description |
|---|---|---|
| assignmentMethod | String | Describes whether the label was applied by an automated (standard) process or a person (privileged). |
| creationDateTime | DateTimeOffset | Timestamp of when the **c |
Graph reference: customAction
| Property | Type | Description |
|---|---|---|
| name | String | Name of the custom action. |
| properties | keyValuePair collection | Properties, in key-value pair format, of the action. |
Graph reference: downgradeJustification
| Property | Type | Description |
|---|---|---|
| isDowngradeJustified | Boolean | Indicates whether the downgrade is or isn't justified. |
| justificationMessage | String | Message that indicates why a downgrade is justified. The message appears in administrative logs. |
Graph reference: informationProtectionAction
Graph reference: informationProtectionPolicySetting
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier for the policy. |
| isDowngradeJustificationRequired | Boolean | Exposes whether justification input is required on label downgrade. |
| isMandatory | Boolean | Exposes whether mandatory labeling is enabled. |
| moreInfoUrl | String | Exposes the more information URL that can be configured by the administrator. |
Graph reference: justifyAction
Graph reference: keyValuePair
| Property | Type | Description |
|---|---|---|
| name | String | Name for this key-value pair. |
| value | String | Value for this key-value pair. |
Graph reference: labelingOptions
| Property | Type | Description |
|---|---|---|
| assignmentMethod | String | Describes whether the label was applied by an automated (standard) process or a person (privileged). |
| downgradeJustification | downgradeJustification | The downgrade justification object that indicates if downgrade was justified and, if so, the reason. |
| extendedProperties | keyValuePair collection | Extended properties will be parsed and returned in the standard Microsoft Purview Information Protection labeled metadata format as part of the label information. |
| labelId | GUID | The GUID of the label that should be applied to the information. |
Graph reference: metadataAction
| Property | Type | Description |
|---|---|---|
| metadataToAdd | keyValuePair collection | A collection of key-value pairs that should be added to the file. |
| metadataToRemove | String collection | A collection of strings that indicate which keys to remove from the file metadata. |
Graph reference: protectAdhocAction
Graph reference: protectByTemplateAction
| Property | Type | Description |
|---|---|---|
| templateId | String | The unique identifier for a protection template in Microsoft Purview Information Protection to apply to the content. |
Graph reference: protectDoNotForwardAction
Graph reference: recommendLabelAction
| Property | Type | Description |
|---|---|---|
| actions | informationProtectionAction collection | Actions to take if the label is accepted by the user. |
| actionSource | String | Specifies why the label was selected. Possible values are: manual, automatic, recommended, default. |
| responsibleSensitiveTypeIds | GUID collection | The sensitive information type GUIDs that caused the recommendation to be given. |
Graph reference: removeContentFooterAction
| Property | Type | Description |
|---|---|---|
| uiElementNames | String collection | The name of the UI element of the footer to be removed. |
Graph reference: removeContentHeaderAction
| Property | Type | Description |
|---|---|---|
| uiElementNames | String collection | The name of the UI element of the header to be removed. |
Graph reference: removeProtectionAction
Graph reference: removeWatermarkAction
| Property | Type | Description |
|---|---|---|
| uiElementNames | String collection | The name of the UI element of watermark to be removed. |
Graph reference: sensitivityLabel
| Property | Type | Description |
|---|---|---|
| color | String | The color that the UI should display for the label, if configured. |
| contentFormats | String collection | Returns the supported content formats for the label. |
| description | String | The admin-defined description for the label. |
| hasProtection | Boolean | Indicates whether the label has protection actions configured. |
| id | String | The label ID is a globally unique identifier (GUID). |
| isActive | Boolean | Indicates whether the label is active or not. Active labels should be hidden or disabled in the UI. |
| isAppliable | Boolean | Indicates whether the label can be applied to content. False if the label is a parent with child labels. |
| name | String | The plaintext name of the label. |
| sensitivity | Int32 | The sensitivity value of the label, where lower is less sensitive. |
| tooltip | String | The tooltip that should be displayed for the label in a UI. |