Allows an app to read information protection sensitivity labels and label policy settings, on behalf of the signed-in user.
Graph Methods
Type: A = Application Permission, D = Delegate Permission
Delegate Permission
|
|
Id |
4ad84827-5578-4e18-ad7a-86530b12f884 |
Consent Type |
User |
Display String |
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. |
Resources
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. |
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. |
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. |
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. |
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 . |
Property |
Type |
Description |
name |
String |
Name of the custom action. |
properties |
keyValuePair collection |
Properties, in key value pair format, of the action. |
Property |
Type |
Description |
isDowngradeJustified |
Boolean |
Indicates whether the downgrade is or is not justified. |
justificationMessage |
String |
Message that indicates why a downgrade is justified. The message will appear in administrative logs. |
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. |
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. |
Property |
Type |
Description |
name |
String |
Name for this key-value pair |
value |
String |
Value for this key-value pair |
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. |
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. |
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. |
Property |
Type |
Description |
uiElementNames |
String collection |
The name of the UI element of the footer to be removed. |
Property |
Type |
Description |
uiElementNames |
String collection |
The name of the UI element of the header to be removed. |
Property |
Type |
Description |
uiElementNames |
String collection |
The name of the UI element of footer to be removed. |
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. |
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. |
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. |
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. |
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. |
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 . |
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 |
Property |
Type |
Description |
name |
String |
Name of the custom action. |
properties |
keyValuePair collection |
Properties, in key-value pair format, of the action. |
Property |
Type |
Description |
isDowngradeJustified |
Boolean |
Indicates whether the downgrade is or is not justified. |
justificationMessage |
String |
Message that indicates why a downgrade is justified. The message will appear in administrative logs. |
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. |
Property |
Type |
Description |
name |
String |
Name for this key-value pair. |
value |
String |
Value for this key-value pair. |
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. |
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. |
Property |
Type |
Description |
templateId |
String |
The unique identifier for a protection template in Microsoft Purview Information Protection to apply to the content. |
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. |
Property |
Type |
Description |
uiElementNames |
String collection |
The name of the UI element of the footer to be removed. |
Property |
Type |
Description |
uiElementNames |
String collection |
The name of the UI element of the header to be removed. |
Property |
Type |
Description |
uiElementNames |
String collection |
The name of the UI element of watermark to be removed. |
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. |