sensitivityLabel resource type

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Describes the information protection label that details how to properly apply a sensitivity label to information. The informationProtectionLabel resource describes the configuration of sensitivity labels that apply to a user or tenant.

Methods

Method	Return type	Description
List sensitivityLabels	microsoft.graph.security.sensitivityLabel collection	Get a list of the microsoft.graph.security.sensitivityLabel objects and their properties.
Get sensitivityLabel	microsoft.graph.security.sensitivityLabel	Read the properties and relationships of a microsoft.graph.security.sensitivityLabel object.
evaluateApplication	microsoft.graph.security.informationProtectionAction collection	Given an input of contentInfo and labelingOptions, compute the set of actions required to apply the label.
evaluateClassificationResults	microsoft.graph.security.informationProtectionAction collection	Given an input of contentInfo and classification results, compute the set of actions required to apply the label.
evaluateRemoval	microsoft.graph.security.informationProtectionAction collection	Given an input of contentInfo and downgradeJustification, compute the actions that should be taken to remove the label.
extractContentLabel	microsoft.graph.security.contentLabel	Given an input of contentInfo, return details on the informationProtectionLabel that the metadata represents.

Properties

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.

Relationships

Relationship	Type	Description
parent	microsoft.graph.security.sensitivityLabel	The parent label associated with a child label. Null if the label has no parent.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.security.sensitivityLabel",
  "color": "String",
  "contentFormats": [
    "String"
  ],
  "description": "String",
  "hasProtection": "Boolean",
  "id": "String (identifier)",
  "isActive": "Boolean",
  "isAppliable": "Boolean",
  "name": "String",
  "sensitivity": "Integer",
  "tooltip": "String"
}