labelsRoot 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.

A root resource for capabilities that support records management for Microsoft 365 data in an organization.

Those capabilities include using a retention label to configure retention and deletion settings for a type of content in the Microsoft 365 data, and using one or more file plan descriptors to supplement the retention label and provide additional options to better manage and organize the content.

Inherits from microsoft.graph.entity.

Methods

Method	Return type	Description
List retentionLabels	microsoft.graph.security.retentionLabel collection	Get a list of the retentionLabel objects and their properties.
Create retentionLabel	microsoft.graph.security.retentionLabel	Create a new retentionLabel object.
List authorities	microsoft.graph.security.authorityTemplate collection	Get the authorityTemplate resources from the authorities navigation property.
Create authorities	microsoft.graph.security.authorityTemplate	Create a new authorityTemplate object.
List categories	microsoft.graph.security.categoryTemplate collection	Get the categoryTemplate resources from the categories navigation property.
Create categories	microsoft.graph.security.categoryTemplate	Create a new categoryTemplate object.
List citations	microsoft.graph.security.citationTemplate collection	Get the citationTemplate resources from the citations navigation property.
Create citations	microsoft.graph.security.citationTemplate	Create a new citationTemplate object.
List departments	microsoft.graph.security.departmentTemplate collection	Get the departmentTemplate resources from the departments navigation property.
Create departments	microsoft.graph.security.departmentTemplate	Create a new departmentTemplate object.
List filePlanReferences	microsoft.graph.security.filePlanReferenceTemplate collection	Get the filePlanReferenceTemplate resources from the filePlanReferences navigation property.
Create filePlanReferences	microsoft.graph.security.filePlanReferenceTemplate	Create a new filePlanReferenceTemplate object.

Properties

None.

Relationships

Relationship	Type	Description
authorities	microsoft.graph.security.authorityTemplate collection	Specifies the underlying authority that describes the type of content to be retained and its retention schedule.
categories	microsoft.graph.security.categoryTemplate collection	Specifies a group of similar types of content in a particular department.
citations	microsoft.graph.security.citationTemplate collection	The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted.
departments	microsoft.graph.security.departmentTemplate collection	Specifies the department or business unit of an organization to which a label belongs.
filePlanReferences	microsoft.graph.security.filePlanReferenceTemplate collection	Specifies a unique alpha-numeric identifier for an organization’s retention schedule.
retentionLabels	microsoft.graph.security.retentionLabel collection	Represents how customers can manage their data, whether and for how long to retain or delete it.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.security.labelsRoot",
  "id": "String (identifier)"
}