Edit

informationProtectionLabel resource type (deprecated)

  • Article

Namespace: microsoft.graph

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.

Caution

The Information Protection labels API is deprecated and will stop returning data on January 1, 2023. Please use the new informationProtection, sensitivityLabel, and associated resources.

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 informationProtectionLabel (deprecated) informationProtectionLabel collection List all configured information protection labels for a user or tenant.
Get informationProtectionLabel (deprecated) informationProtectionLabel Given a specific label ID, return the informationProtectionLabel.
evaluateapplication (deprecated) informationProtectionAction collection Given an input of contentInfo and labelingOptions, compute the set of actions require to apply the label.
evaluateClassificationResults (deprecated) informationProtectionAction collection Given an input of contentInfo and classification results, compute the set of actions require to apply the label.
evaluateRemoval (deprecated) informationProtectionAction collection Given an input of contentInfo and downgradeJustification, compute the actions that should be taken to remove the label.
extractLabel (deprecated) informationProtectionContentLabel 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.
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.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "color": "String",
  "description": "String",
  "id": "String (identifier)",
  "isActive": true,
  "name": "String",
  "sensitivity": 1024,
  "tooltip": "String",
  "parent": {"@odata.type": "microsoft.graph.labelDetails" }
}