Create retentionLabel

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.

Create a new retentionLabel object.

To create a disposition review stage, include the actionAfterRetentionPeriod property in the request body with one of the possible values specified.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	RecordsManagement.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	Not supported.

HTTP request

POST /security/labels/retentionLabels

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the retentionLabel object.

Specify the following properties when you create a retentionLabel.

Property	Type	Description
actionAfterRetentionPeriod	microsoft.graph.security.actionAfterRetentionPeriod	Specifies the action to take on a document with this label applied during the retention period. The possible values are: none, delete, startDispositionReview, unknownFutureValue.
behaviorDuringRetentionPeriod	microsoft.graph.security.behaviorDuringRetentionPeriod	Specifies how the behavior of a document with this label should be during the retention period. The possible values are: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
descriptionForAdmins	String	Provides label information for the admin. Optional.
descriptionForUsers	String	Provides the label information for the user. Optional.
displayName	String	Unique string that defines a label name.
dispositionReviewStages	microsoft.graph.security.dispositionReviewStage collection	Review stages during which reviewers are notified to determine whether a document must be deleted or retained.
retentionDuration	microsoft.graph.security.retentionDuration	Specifies the number of days to retain the content.
retentionTrigger	microsoft.graph.security.retentionTrigger	Specifies whether the retention duration is calculated from the content creation date, labeled date, or last modification date. The possible values are: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
defaultRecordBehavior	microsoft.graph.security.defaultRecordBehavior	Specifies the locked or unlocked state of a record label when it is created.The possible values are: startLocked, startUnlocked, unknownFutureValue.
labelToBeApplied	String	Specifies the replacement label to be applied automatically after the retention period of the current label ends.

Response

If successful, this method returns a 201 Created response code and a microsoft.graph.security.retentionLabel object in the response body.

Examples

Request

HTTP

POST https://graph.microsoft.com/beta/security/labels/retentionLabels
Content-Type: application/json
Content-length: 555

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "displayName": "String",
  "behaviorDuringRetentionPeriod": "String",
  "actionAfterRetentionPeriod": "String",
  "retentionTrigger": "String",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDuration"
  },
  "isInUse": "Boolean",
  "descriptionForAdmins": "String",
  "descriptionForUsers": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "labelToBeApplied": "String",
  "defaultRecordBehavior": "String"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Models.Security.RetentionLabel
{
	OdataType = "#microsoft.graph.security.retentionLabel",
	DisplayName = "String",
	BehaviorDuringRetentionPeriod = Microsoft.Graph.Beta.Models.Security.BehaviorDuringRetentionPeriod.DoNotRetain,
	ActionAfterRetentionPeriod = Microsoft.Graph.Beta.Models.Security.ActionAfterRetentionPeriod.None,
	RetentionTrigger = Microsoft.Graph.Beta.Models.Security.RetentionTrigger.DateLabeled,
	RetentionDuration = new Microsoft.Graph.Beta.Models.Security.RetentionDuration
	{
		OdataType = "microsoft.graph.security.retentionDuration",
	},
	IsInUse = boolean,
	DescriptionForAdmins = "String",
	DescriptionForUsers = "String",
	CreatedBy = new IdentitySet
	{
		OdataType = "microsoft.graph.identitySet",
	},
	LabelToBeApplied = "String",
	DefaultRecordBehavior = Microsoft.Graph.Beta.Models.Security.DefaultRecordBehavior.StartLocked,
};
var result = await graphClient.Security.Labels.RetentionLabels.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const retentionLabel = {
  '@odata.type': '#microsoft.graph.security.retentionLabel',
  displayName: 'String',
  behaviorDuringRetentionPeriod: 'String',
  actionAfterRetentionPeriod: 'String',
  retentionTrigger: 'String',
  retentionDuration: {
    '@odata.type': 'microsoft.graph.security.retentionDuration'
  },
  isInUse: 'Boolean',
  descriptionForAdmins: 'String',
  descriptionForUsers: 'String',
  createdBy: {
    '@odata.type': 'microsoft.graph.identitySet'
  },
  labelToBeApplied: 'String',
  defaultRecordBehavior: 'String'
};

await client.api('/security/labels/retentionLabels')
	.version('beta')
	.post(retentionLabel);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

RetentionLabel retentionLabel = new RetentionLabel();
retentionLabel.displayName = "String";
retentionLabel.behaviorDuringRetentionPeriod = BehaviorDuringRetentionPeriod.DO_NOT_RETAIN;
retentionLabel.actionAfterRetentionPeriod = ActionAfterRetentionPeriod.NONE;
retentionLabel.retentionTrigger = RetentionTrigger.DATE_LABELED;
RetentionDuration retentionDuration = new RetentionDuration();
retentionLabel.retentionDuration = retentionDuration;
retentionLabel.isInUse = false;
retentionLabel.descriptionForAdmins = "String";
retentionLabel.descriptionForUsers = "String";
IdentitySet createdBy = new IdentitySet();
retentionLabel.createdBy = createdBy;
retentionLabel.labelToBeApplied = "String";
retentionLabel.defaultRecordBehavior = DefaultRecordBehavior.START_LOCKED;

graphClient.security().labels().retentionLabels()
	.buildRequest()
	.post(retentionLabel);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient, err := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodelssecurity.NewRetentionLabel()
displayName := "String"
requestBody.SetDisplayName(&displayName) 
behaviorDuringRetentionPeriod := graphmodels.STRING_BEHAVIORDURINGRETENTIONPERIOD 
requestBody.SetBehaviorDuringRetentionPeriod(&behaviorDuringRetentionPeriod) 
actionAfterRetentionPeriod := graphmodels.STRING_ACTIONAFTERRETENTIONPERIOD 
requestBody.SetActionAfterRetentionPeriod(&actionAfterRetentionPeriod) 
retentionTrigger := graphmodels.STRING_RETENTIONTRIGGER 
requestBody.SetRetentionTrigger(&retentionTrigger) 
retentionDuration := graphmodelssecurity.NewRetentionDuration()
requestBody.SetRetentionDuration(retentionDuration)
isInUse := boolean
requestBody.SetIsInUse(&isInUse) 
descriptionForAdmins := "String"
requestBody.SetDescriptionForAdmins(&descriptionForAdmins) 
descriptionForUsers := "String"
requestBody.SetDescriptionForUsers(&descriptionForUsers) 
createdBy := graphmodels.NewIdentitySet()
requestBody.SetCreatedBy(createdBy)
labelToBeApplied := "String"
requestBody.SetLabelToBeApplied(&labelToBeApplied) 
defaultRecordBehavior := graphmodels.STRING_DEFAULTRECORDBEHAVIOR 
requestBody.SetDefaultRecordBehavior(&defaultRecordBehavior) 

result, err := graphClient.Security().Labels().RetentionLabels().Post(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Security

$params = @{
	"@odata.type" = "#microsoft.graph.security.retentionLabel"
	displayName = "String"
	behaviorDuringRetentionPeriod = "String"
	actionAfterRetentionPeriod = "String"
	retentionTrigger = "String"
	retentionDuration = @{
		"@odata.type" = "microsoft.graph.security.retentionDuration"
	}
	isInUse = "Boolean"
	descriptionForAdmins = "String"
	descriptionForUsers = "String"
	createdBy = @{
		"@odata.type" = "microsoft.graph.identitySet"
	}
	labelToBeApplied = "String"
	defaultRecordBehavior = "String"
}

New-MgSecurityLabelRetentionLabel -BodyParameter $params

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new RetentionLabel();
$requestBody->set@odatatype('#microsoft.graph.security.retentionLabel');

$requestBody->setDisplayName('String');

$requestBody->setBehaviorDuringRetentionPeriod(new BehaviorDuringRetentionPeriod('string'));

$requestBody->setActionAfterRetentionPeriod(new ActionAfterRetentionPeriod('string'));

$requestBody->setRetentionTrigger(new RetentionTrigger('string'));

$retentionDuration = new RetentionDuration();
$retentionDuration->set@odatatype('microsoft.graph.security.retentionDuration');


$requestBody->setRetentionDuration($retentionDuration);
$requestBody->setIsInUse(boolean);

$requestBody->setDescriptionForAdmins('String');

$requestBody->setDescriptionForUsers('String');

$createdBy = new IdentitySet();
$createdBy->set@odatatype('microsoft.graph.identitySet');


$requestBody->setCreatedBy($createdBy);
$requestBody->setLabelToBeApplied('String');

$requestBody->setDefaultRecordBehavior(new DefaultRecordBehavior('string'));



$result = $graphServiceClient->security()->labels()->retentionLabels()->post($requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

// THE PYTHON SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
client =  GraphServiceClient(request_adapter)

request_body = RetentionLabel()
request_body.@odata_type = '#microsoft.graph.security.retentionLabel'

request_body.display_name = 'String'

request_body.behaviorduringretentionperiod(BehaviorDuringRetentionPeriod.String('behaviorduringretentionperiod.string'))

request_body.actionafterretentionperiod(ActionAfterRetentionPeriod.String('actionafterretentionperiod.string'))

request_body.retentiontrigger(RetentionTrigger.String('retentiontrigger.string'))

retention_duration = RetentionDuration()
retention_duration.@odata_type = 'microsoft.graph.security.retentionDuration'


request_body.retention_duration = retention_duration
request_body.is_in_use = Boolean

request_body.description_for_admins = 'String'

request_body.description_for_users = 'String'

created_by = IdentitySet()
created_by.@odata_type = 'microsoft.graph.identitySet'


request_body.created_by = created_by
request_body.label_to_be_applied = 'String'

request_body.defaultrecordbehavior(DefaultRecordBehavior.String('defaultrecordbehavior.string'))




result = await client.security.labels.retention_labels.post(request_body = request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "id": "64a99fb4-07be-0481-8746-44c15c0eef1f",
  "displayName": "String",
  "behaviorDuringRetentionPeriod": "String",
  "actionAfterRetentionPeriod": "String",
  "retentionTrigger": "String",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDuration"
  },
  "isInUse": "Boolean",
  "descriptionForAdmins": "String",
  "descriptionForUsers": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "labelToBeApplied": "String",
  "defaultRecordBehavior": "String"
}