From 8518825ac33e7d48a9b188c100b4d385c6fb70f4 Mon Sep 17 00:00:00 2001 From: samriddhiseth Date: Wed, 12 Jul 2023 15:01:04 -0700 Subject: [PATCH 1/5] v1 labels and fpd - resource and api --- .../api/security-authoritytemplate-get.md | 92 ++++++++++ ...y-categorytemplate-delete-subcategories.md | 82 +++++++++ .../v1.0/api/security-categorytemplate-get.md | 89 ++++++++++ ...ity-categorytemplate-list-subcategories.md | 92 ++++++++++ ...ity-categorytemplate-post-subcategories.md | 104 +++++++++++ .../v1.0/api/security-citationtemplate-get.md | 92 ++++++++++ .../api/security-departmenttemplate-get.md | 90 ++++++++++ .../security-fileplanreferencetemplate-get.md | 90 ++++++++++ .../security-labelsroot-delete-authorities.md | 73 ++++++++ .../security-labelsroot-delete-categories.md | 73 ++++++++ .../security-labelsroot-delete-citations.md | 72 ++++++++ .../security-labelsroot-delete-departments.md | 73 ++++++++ ...ty-labelsroot-delete-fileplanreferences.md | 73 ++++++++ .../security-labelsroot-list-authorities.md | 92 ++++++++++ .../security-labelsroot-list-categories.md | 91 ++++++++++ .../api/security-labelsroot-list-citations.md | 93 ++++++++++ .../security-labelsroot-list-departments.md | 90 ++++++++++ ...rity-labelsroot-list-fileplanreferences.md | 91 ++++++++++ ...security-labelsroot-list-retentionlabel.md | 111 ++++++++++++ .../security-labelsroot-post-authorities.md | 103 +++++++++++ .../security-labelsroot-post-categories.md | 103 +++++++++++ .../api/security-labelsroot-post-citations.md | 107 +++++++++++ .../security-labelsroot-post-departments.md | 103 +++++++++++ ...rity-labelsroot-post-fileplanreferences.md | 103 +++++++++++ ...security-labelsroot-post-retentionlabel.md | 166 ++++++++++++++++++ .../api/security-retentionlabel-delete.md | 72 ++++++++ .../v1.0/api/security-retentionlabel-get.md | 102 +++++++++++ .../api/security-retentionlabel-update.md | 113 ++++++++++++ .../api/security-subcategorytemplate-get.md | 89 ++++++++++ .../resources/security-appliedcategory.md | 44 +++++ .../v1.0/resources/security-authority.md | 40 +++++ .../resources/security-authoritytemplate.md | 58 ++++++ .../resources/security-categorytemplate.md | 63 +++++++ .../v1.0/resources/security-citation.md | 44 +++++ .../resources/security-citationtemplate.md | 63 +++++++ .../v1.0/resources/security-department.md | 40 +++++ .../resources/security-departmenttemplate.md | 59 +++++++ .../security-dispositionreviewstage.md | 56 ++++++ .../resources/security-fileplandescriptor.md | 73 ++++++++ .../security-fileplandescriptorbase.md | 37 ++++ .../security-fileplandescriptortemplate.md | 69 ++++++++ .../resources/security-fileplanreference.md | 40 +++++ .../security-fileplanreferencetemplate.md | 59 +++++++ .../v1.0/resources/security-labelsroot.md | 67 +++++++ .../resources/security-retentionduration.md | 38 ++++ .../security-retentiondurationforever.md | 36 ++++ .../security-retentiondurationindays.md | 39 ++++ .../v1.0/resources/security-retentionlabel.md | 92 ++++++++++ .../v1.0/resources/security-subcategory.md | 40 +++++ .../resources/security-subcategorytemplate.md | 59 +++++++ 50 files changed, 3840 insertions(+) create mode 100644 api-reference/v1.0/api/security-authoritytemplate-get.md create mode 100644 api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md create mode 100644 api-reference/v1.0/api/security-categorytemplate-get.md create mode 100644 api-reference/v1.0/api/security-categorytemplate-list-subcategories.md create mode 100644 api-reference/v1.0/api/security-categorytemplate-post-subcategories.md create mode 100644 api-reference/v1.0/api/security-citationtemplate-get.md create mode 100644 api-reference/v1.0/api/security-departmenttemplate-get.md create mode 100644 api-reference/v1.0/api/security-fileplanreferencetemplate-get.md create mode 100644 api-reference/v1.0/api/security-labelsroot-delete-authorities.md create mode 100644 api-reference/v1.0/api/security-labelsroot-delete-categories.md create mode 100644 api-reference/v1.0/api/security-labelsroot-delete-citations.md create mode 100644 api-reference/v1.0/api/security-labelsroot-delete-departments.md create mode 100644 api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md create mode 100644 api-reference/v1.0/api/security-labelsroot-list-authorities.md create mode 100644 api-reference/v1.0/api/security-labelsroot-list-categories.md create mode 100644 api-reference/v1.0/api/security-labelsroot-list-citations.md create mode 100644 api-reference/v1.0/api/security-labelsroot-list-departments.md create mode 100644 api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md create mode 100644 api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md create mode 100644 api-reference/v1.0/api/security-labelsroot-post-authorities.md create mode 100644 api-reference/v1.0/api/security-labelsroot-post-categories.md create mode 100644 api-reference/v1.0/api/security-labelsroot-post-citations.md create mode 100644 api-reference/v1.0/api/security-labelsroot-post-departments.md create mode 100644 api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md create mode 100644 api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md create mode 100644 api-reference/v1.0/api/security-retentionlabel-delete.md create mode 100644 api-reference/v1.0/api/security-retentionlabel-get.md create mode 100644 api-reference/v1.0/api/security-retentionlabel-update.md create mode 100644 api-reference/v1.0/api/security-subcategorytemplate-get.md create mode 100644 api-reference/v1.0/resources/security-appliedcategory.md create mode 100644 api-reference/v1.0/resources/security-authority.md create mode 100644 api-reference/v1.0/resources/security-authoritytemplate.md create mode 100644 api-reference/v1.0/resources/security-categorytemplate.md create mode 100644 api-reference/v1.0/resources/security-citation.md create mode 100644 api-reference/v1.0/resources/security-citationtemplate.md create mode 100644 api-reference/v1.0/resources/security-department.md create mode 100644 api-reference/v1.0/resources/security-departmenttemplate.md create mode 100644 api-reference/v1.0/resources/security-dispositionreviewstage.md create mode 100644 api-reference/v1.0/resources/security-fileplandescriptor.md create mode 100644 api-reference/v1.0/resources/security-fileplandescriptorbase.md create mode 100644 api-reference/v1.0/resources/security-fileplandescriptortemplate.md create mode 100644 api-reference/v1.0/resources/security-fileplanreference.md create mode 100644 api-reference/v1.0/resources/security-fileplanreferencetemplate.md create mode 100644 api-reference/v1.0/resources/security-labelsroot.md create mode 100644 api-reference/v1.0/resources/security-retentionduration.md create mode 100644 api-reference/v1.0/resources/security-retentiondurationforever.md create mode 100644 api-reference/v1.0/resources/security-retentiondurationindays.md create mode 100644 api-reference/v1.0/resources/security-retentionlabel.md create mode 100644 api-reference/v1.0/resources/security-subcategory.md create mode 100644 api-reference/v1.0/resources/security-subcategorytemplate.md diff --git a/api-reference/v1.0/api/security-authoritytemplate-get.md b/api-reference/v1.0/api/security-authoritytemplate-get.md new file mode 100644 index 0000000000000..6544abf429990 --- /dev/null +++ b/api-reference/v1.0/api/security-authoritytemplate-get.md @@ -0,0 +1,92 @@ +--- +title: "Get authorityTemplate" +description: "Read the properties and relationships of an authorityTemplate." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Get authorityTemplate +Namespace: microsoft.graph.security + +Read the properties and relationships of a [authorityTemplate](../resources/security-authoritytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/authorities/{authorityTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/authorityTemplate +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/authorities/{authorityTemplateId} +``` + + + +### Response +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } +} +``` + diff --git a/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md new file mode 100644 index 0000000000000..1ecfa92ec596b --- /dev/null +++ b/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md @@ -0,0 +1,82 @@ +--- +title: "Delete subCategoryTemplate" +description: "Delete a subCategoryTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Delete subCategoryTemplate +Namespace: microsoft.graph.security + +Delete a [subCategoryTemplate](../resources/security-subcategorytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}/$ref +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `204 No Content` response code. + +## Examples + +### Request +The following is an example of a request. + + +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +``` + +# [Java](#tab/java) +[!INCLUDE [sample-code](../includes/snippets/java/delete-subcategorytemplate-java-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [JavaScript](#tab/javascript) +[!INCLUDE [sample-code](../includes/snippets/javascript/delete-subcategorytemplate-javascript-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +--- + + +### Response +The following is an example of the response. +> + +``` http +HTTP/1.1 204 No Content +``` + diff --git a/api-reference/v1.0/api/security-categorytemplate-get.md b/api-reference/v1.0/api/security-categorytemplate-get.md new file mode 100644 index 0000000000000..13d4f66be969a --- /dev/null +++ b/api-reference/v1.0/api/security-categorytemplate-get.md @@ -0,0 +1,89 @@ +--- +title: "Get categoryTemplate" +description: "Read the properties and relationships of a categoryTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Get categoryTemplate +Namespace: microsoft.graph.security + +Read the properties and relationships of a [categoryTemplate](../resources/security-categorytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/categories/{categoryTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId} +``` + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } +} +``` + diff --git a/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md new file mode 100644 index 0000000000000..77c49bb5473bf --- /dev/null +++ b/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md @@ -0,0 +1,92 @@ +--- +title: "List subCategories" +description: "Get the subCategoryTemplate resources from the subCategories navigation property." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# List subCategories +Namespace: microsoft.graph.security + +Get a list of subcategories [subCategoryTemplate](../resources/security-subcategorytemplate.md) associated with a category template. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) objects in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +``` + + +### Response +The following is an example of the response. + +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } + ] +} +``` + diff --git a/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md new file mode 100644 index 0000000000000..3efbbace5b3ac --- /dev/null +++ b/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md @@ -0,0 +1,104 @@ +--- +title: "Create subCategoryTemplate" +description: "Create a new subCategoryTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Create subCategoryTemplate +Namespace: microsoft.graph.security + +Create a new [subCategoryTemplate](../resources/security-subcategorytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +POST /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +``` + +## 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 [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object. + +You can specify the following properties when creating a **subCategoryTemplate**. + +|Property|Type|Description| +|:---|:---|:---| +|displayName|String| Unique string that defines a sub-category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md). Optional.| + + + + +## Response + +If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +POST https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` + + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 201 Created +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/api/security-citationtemplate-get.md b/api-reference/v1.0/api/security-citationtemplate-get.md new file mode 100644 index 0000000000000..2083ee6d6803a --- /dev/null +++ b/api-reference/v1.0/api/security-citationtemplate-get.md @@ -0,0 +1,92 @@ +--- +title: "Get citationTemplate" +description: "Read the properties and relationships of a citationTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Get citationTemplate +Namespace: microsoft.graph.security + +Read the properties and relationships of a [citationTemplate](../resources/security-citationtemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/citations/{citationTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/citationTemplate +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/citations/{citationTemplateId} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": { + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "citationUrl": "String", + "citationJurisdiction": "String" + } +} +``` + diff --git a/api-reference/v1.0/api/security-departmenttemplate-get.md b/api-reference/v1.0/api/security-departmenttemplate-get.md new file mode 100644 index 0000000000000..c3608ed2593fc --- /dev/null +++ b/api-reference/v1.0/api/security-departmenttemplate-get.md @@ -0,0 +1,90 @@ +--- +title: "Get departmentTemplate" +description: "Read the properties and relationships of a departmentTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Get departmentTemplate +Namespace: microsoft.graph.security + +Read the properties and relationships of a [departmentTemplate](../resources/security-departmenttemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/departments/{departmentTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/departmentTemplate +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. +# [HTTP](#tab/http) + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/departments/{departmentTemplateId} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": { + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } +} +``` + diff --git a/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md b/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md new file mode 100644 index 0000000000000..2553da1234581 --- /dev/null +++ b/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md @@ -0,0 +1,90 @@ +--- +title: "Get filePlanReferenceTemplate" +description: "Read the properties and relationships of a filePlanReferenceTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Get filePlanReferenceTemplate +Namespace: microsoft.graph.security + +Read the properties and relationships of a [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/filePlanReferences/{filePlanReferenceTemplateId} +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/filePlanReferenceTemplate +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": { + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-delete-authorities.md b/api-reference/v1.0/api/security-labelsroot-delete-authorities.md new file mode 100644 index 0000000000000..f620a54e8a4bb --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-delete-authorities.md @@ -0,0 +1,73 @@ +--- +title: "Delete authorityTemplate" +description: "Delete an authorityTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Delete authorityTemplate +Namespace: microsoft.graph.security + +Delete a [authorityTemplate](../resources/security-authoritytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application| RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +DELETE /security/labels/authorities/{authorityTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/authorityTemplate/$ref +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `204 No Content` response code. + +## Examples + +### Request +The following is an example of a request. + + +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/authorities/{authorityTemplateId} +``` + + +### Response +The following is an example of the response. +> + +``` http +HTTP/1.1 204 No Content +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-delete-categories.md b/api-reference/v1.0/api/security-labelsroot-delete-categories.md new file mode 100644 index 0000000000000..0e550e7bbd3d3 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-delete-categories.md @@ -0,0 +1,73 @@ +--- +title: "Delete categoryTemplate" +description: "Delete a categoryTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Delete categoryTemplate +Namespace: microsoft.graph.security + +Delete a [categoryTemplate](../resources/security-categorytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +DELETE /security/labels/categories/{categoryTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/$ref +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `204 No Content` response code. + +## Examples + +### Request +The following is an example of a request. + + +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId} +``` + + +### Response +The following is an example of the response. +> + +``` http +HTTP/1.1 204 No Content +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-delete-citations.md b/api-reference/v1.0/api/security-labelsroot-delete-citations.md new file mode 100644 index 0000000000000..9007253db7363 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-delete-citations.md @@ -0,0 +1,72 @@ +--- +title: "Delete citationTemplate" +description: "Delete a citationTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Delete citationTemplate +Namespace: microsoft.graph.security + +Delete a [citationTemplate](../resources/security-citationtemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +DELETE /security/labels/citations/{citationTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/citationTemplate/$ref +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `204 No Content` response code. + +## Examples + +### Request +The following is an example of a request. + + +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/citations/{citationTemplateId} +``` + +### Response +The following is an example of the response. +> + +``` http +HTTP/1.1 204 No Content +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-delete-departments.md b/api-reference/v1.0/api/security-labelsroot-delete-departments.md new file mode 100644 index 0000000000000..b6470eb467133 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-delete-departments.md @@ -0,0 +1,73 @@ +--- +title: "Delete departmentTemplate" +description: "Delete a departmentTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Delete departmentTemplate +Namespace: microsoft.graph.security + +Delete a [departmentTemplate](../resources/security-departmenttemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +DELETE /security/labels/departments/{departmentTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/departmentTemplate/$ref +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `204 No Content` response code. + +## Examples + +### Request +The following is an example of a request. + + +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/departments/{departmentTemplateId} +``` + + +### Response +The following is an example of the response. +> + +``` http +HTTP/1.1 204 No Content +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md b/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md new file mode 100644 index 0000000000000..762b977c87605 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md @@ -0,0 +1,73 @@ +--- +title: "Delete filePlanReferenceTemplate" +description: "Delete a filePlanReferenceTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Delete filePlanReferenceTemplate +Namespace: microsoft.graph.security + +Delete a [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +DELETE /security/labels/filePlanReferences/{filePlanReferenceTemplateId}/$ref +DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/filePlanReferenceTemplate/$ref +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `204 No Content` response code. + +## Examples + +### Request +The following is an example of a request. + + +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +``` + + +### Response +The following is an example of the response. +> + +``` http +HTTP/1.1 204 No Content +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-list-authorities.md b/api-reference/v1.0/api/security-labelsroot-list-authorities.md new file mode 100644 index 0000000000000..b666b1ad4add1 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-list-authorities.md @@ -0,0 +1,92 @@ +--- +title: "List authorityTemplates" +description: "Get a list of the authorityTemplate objects and their properties." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# List authorityTemplates +Namespace: microsoft.graph.security + + +Get a list of the [authorityTemplate](../resources/security-authoritytemplate.md) objects and their properties. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/authorities +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) objects in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/authorities +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } + ] +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-list-categories.md b/api-reference/v1.0/api/security-labelsroot-list-categories.md new file mode 100644 index 0000000000000..14403cf1d2fb7 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-list-categories.md @@ -0,0 +1,91 @@ +--- +title: "List categoryTemplates" +description: "Get a list of the categoryTemplate objects and their properties." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# List categoryTemplates +Namespace: microsoft.graph.security + +Get a list of the [categoryTemplate](../resources/security-categorytemplate.md) objects and their properties. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/categories +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) objects in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/categories +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } + ] +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-list-citations.md b/api-reference/v1.0/api/security-labelsroot-list-citations.md new file mode 100644 index 0000000000000..eac74637cc038 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-list-citations.md @@ -0,0 +1,93 @@ +--- +title: "List citationTemplates" +description: "Get a list of the citationTemplate objects and their properties." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# List citationTemplates +Namespace: microsoft.graph.security + +Get a list of the [citationTemplate](../resources/security-citationtemplate.md) objects and their properties. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/citations +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) objects in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/citations +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "citationUrl": "String", + "citationJurisdiction": "String" + } + ] +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-list-departments.md b/api-reference/v1.0/api/security-labelsroot-list-departments.md new file mode 100644 index 0000000000000..ab9f5f8244bd8 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-list-departments.md @@ -0,0 +1,90 @@ +--- +title: "List departmentTemplates" +description: "Get a list of the departmentTemplate objects and their properties." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# List departmentTemplates +Namespace: microsoft.graph.security + +Get a list of the [departmentTemplate](../resources/security-departmenttemplate.md) objects and their properties. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/departments +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) objects in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/departments +``` + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } + ] +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md b/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md new file mode 100644 index 0000000000000..dfadb0efcdb88 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md @@ -0,0 +1,91 @@ +--- +title: "List filePlanReferenceTemplates" +description: "Get a list of the filePlanReferenceTemplate objects and their properties." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# List filePlanReferenceTemplates +Namespace: microsoft.graph.security + +Get a list of the [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects and their properties. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/filePlanReferences +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } + ] +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md new file mode 100644 index 0000000000000..e807d24f70923 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md @@ -0,0 +1,111 @@ +--- +title: "List retentionLabels" +description: "Get a list of the retentionLabel objects and their properties." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# List retentionLabels +Namespace: microsoft.graph.security + +Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|Not supported.| + +## HTTP request + + +``` http +GET /security/labels/retentionLabels +``` + +## Optional query parameters +This method supports the `expand` OData query parameter to help customize the response. + +For example: +- To retrieve the **retentionEventType** property, use `$expand=retentionEventType`. +- To retrieve the **descriptors** property, use `$expand=descriptors`. + +For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) objects in the response body. + +## Examples + +### Request + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels +``` + + +### Response +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": [ + { + "@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" + } + ] +} +``` + + diff --git a/api-reference/v1.0/api/security-labelsroot-post-authorities.md b/api-reference/v1.0/api/security-labelsroot-post-authorities.md new file mode 100644 index 0000000000000..174d48160f345 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-post-authorities.md @@ -0,0 +1,103 @@ +--- +title: "Create authorityTemplate" +description: "Create a new authorityTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Create authorityTemplate +Namespace: microsoft.graph.security + +Create a new [authorityTemplate](../resources/security-authoritytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +POST /security/labels/authorities +``` + +## 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 [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object. + +You can specify the following properties when creating a **authorityTemplate**. + +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines an authortiy name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| + + + + +## Response + +If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +POST https://graph.microsoft.com/v1.0/security/labels/authorities +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 201 Created +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-post-categories.md b/api-reference/v1.0/api/security-labelsroot-post-categories.md new file mode 100644 index 0000000000000..3210d66c535f3 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-post-categories.md @@ -0,0 +1,103 @@ +--- +title: "Create categoryTemplate" +description: "Create a new categoryTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Create categoryTemplate +Namespace: microsoft.graph.security + +Create a new [categoryTemplate](../resources/security-categorytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +POST /security/labels/categories +``` + +## 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 [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object. + +You can specify the following properties when creating a **categoryTemplate**. + +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| + + + + +## Response + +If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +POST https://graph.microsoft.com/v1.0/security/labels/categories +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 201 Created +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-post-citations.md b/api-reference/v1.0/api/security-labelsroot-post-citations.md new file mode 100644 index 0000000000000..b2c43d6e203e5 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-post-citations.md @@ -0,0 +1,107 @@ +--- +title: "Create citationTemplate" +description: "Create a new citationTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Create citationTemplate +Namespace: microsoft.graph.security + +Create a new [citationTemplate](../resources/security-citationtemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +POST /security/labels/citations +``` + +## 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 [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object. + +You can specify the following properties when creating a **citationTemplate**. + +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| +|citationUrl|String|Represents the URL to the published citation. Optional.| +|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation. Optional.| + + +## Response + +If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +POST https://graph.microsoft.com/v1.0/security/labels/citations +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.citationTemplate", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "citationUrl": "String", + "citationJurisdiction": "String" +} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 201 Created +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "citationUrl": "String", + "citationJurisdiction": "String" +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-post-departments.md b/api-reference/v1.0/api/security-labelsroot-post-departments.md new file mode 100644 index 0000000000000..d1a76f01704b8 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-post-departments.md @@ -0,0 +1,103 @@ +--- +title: "Create departmentTemplate" +description: "Create a new departmentTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Create departmentTemplate +Namespace: microsoft.graph.security + +Create a new [departmentTemplate](../resources/security-departmenttemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +POST /security/labels/departments +``` + +## 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 [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object. + +You can specify the following properties when creating a **departmentTemplate**. + +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| + + + + +## Response + +If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +POST https://graph.microsoft.com/v1.0/security/labels/departments +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 201 Created +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md b/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md new file mode 100644 index 0000000000000..515fac506ae9d --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md @@ -0,0 +1,103 @@ +--- +title: "Create filePlanReferenceTemplate" +description: "Create a new filePlanReferenceTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Create filePlanReferenceTemplate +Namespace: microsoft.graph.security + +Create a new [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +POST /security/labels/filePlanReferences +``` + +## 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 [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object. + +You can specify the following properties when creating a **filePlanReferenceTemplate**. + +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a file plan reference name. Inherited from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptor.md).| + + + + +## Response + +If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +POST https://graph.microsoft.com/v1.0/security/labels/filePlanReferences +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + } +} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 201 Created +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md new file mode 100644 index 0000000000000..0e60576081066 --- /dev/null +++ b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md @@ -0,0 +1,166 @@ +--- +title: "Create retentionLabel" +description: "Create a new retentionLabel object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Create retentionLabel +Namespace: microsoft.graph.security + +Create a new [retentionLabel](../resources/security-retentionlabel.md) object. + +To create a [disposition review stage](../resources/security-dispositionreviewstage.md), 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](/graph/permissions-reference). + +|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 + + +``` http +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](../resources/security-retentionlabel.md) 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](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained. | +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|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](../resources/security-retentionlabel.md) object in the response body. + +## Examples + +### Request + + + +``` http +POST https://graph.microsoft.com/v1.0/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", + "descriptors": { + "authorityTemplate@odata.bind" : "https://graph.microsoft.com/v1.0/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')", + "categoryTemplate@odata.bind" : "https://graph.microsoft.com/v1.0/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')", + "citationTemplate@odata.bind" : "https://graph.microsoft.com/v1.0/security/labels/citations('0e23f4fc-b966-4c40-94de-fb8a383658e4')", + "departmentTemplate@odata.bind" : "https://graph.microsoft.com/v1.0/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')", + "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/v1.0/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')" + }, +} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +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", + "descriptors": { + "authority": { + "displayName": "Business" + }, + "category": { + "displayName": "Accounts Payable", + }, + "citation": { + "displayName" : "Contoso Company Policy", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" + }, + "department": { + "displayName" : "Finance" + }, + "filePlanReference": { + "displayName" : "FIN 01-02-001" + } + } +} +``` + diff --git a/api-reference/v1.0/api/security-retentionlabel-delete.md b/api-reference/v1.0/api/security-retentionlabel-delete.md new file mode 100644 index 0000000000000..d64c3390b4c97 --- /dev/null +++ b/api-reference/v1.0/api/security-retentionlabel-delete.md @@ -0,0 +1,72 @@ +--- +title: "Delete retentionLabel" +description: "Deletes a retentionLabel object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Delete retentionLabel +Namespace: microsoft.graph.security + +Delete a [retentionLabel](../resources/security-retentionlabel.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|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 + + +``` http +DELETE /security/labels/retentionLabels/{retentionLabelId} + +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `204 No Content` response code. + +## Examples + +### Request + + + +``` http +DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId} +``` + + +### Response +> + +``` http +HTTP/1.1 204 No Content +``` + diff --git a/api-reference/v1.0/api/security-retentionlabel-get.md b/api-reference/v1.0/api/security-retentionlabel-get.md new file mode 100644 index 0000000000000..19e6bd4604380 --- /dev/null +++ b/api-reference/v1.0/api/security-retentionlabel-get.md @@ -0,0 +1,102 @@ +--- +title: "Get retentionLabel" +description: "Read the properties and relationships of a retentionLabel object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Get retentionLabel +Namespace: microsoft.graph.security + +Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not Supported.| +|Application|Not supported.| + +## HTTP request + + +``` http +GET /security/labels/retentionLabels/{retentionLabelId} +GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabelId} +``` + +## Optional query parameters +This method supports the expand OData query parameters to help customize the response. For example, to retrieve the **retentionEventType** property, you can use the `expand` parameter:`$expand=retentionEventType`. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body. + +## Examples + +### Request + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId} +``` + +### Response +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": { + "@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" + } +} +``` + diff --git a/api-reference/v1.0/api/security-retentionlabel-update.md b/api-reference/v1.0/api/security-retentionlabel-update.md new file mode 100644 index 0000000000000..a626dd688d8aa --- /dev/null +++ b/api-reference/v1.0/api/security-retentionlabel-update.md @@ -0,0 +1,113 @@ +--- +title: "Update retentionLabel" +description: "Update the properties of a retentionLabel object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Update retentionLabel +Namespace: microsoft.graph.security + +Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object. + +To update a [disposition review stage](../resources/security-dispositionreviewstage.md), 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](/graph/permissions-reference). + +|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 + + +``` http +PATCH /security/labels/retentionLabels/{retentionLabelId} + +``` + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| + +## Request body +[!INCLUDE [table-intro](../../includes/update-property-table-intro.md)] + + +|Property|Type|Description| +|:---|:---|:---| +|descriptionForAdmins|String|This is an optional property that provides the label information for the admin.| +|descriptionForUsers|String|This is an optional property that provides the label information for the user.| +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|Review stages during which reviewers are notified to determine whether a document must be deleted or retained.| +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|Specifies the number of days to retain the content.| +|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 `200 OK` response code and an updated [microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) object in the response body. + +## Examples + +### Request + + + +``` http +PATCH https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId} +Content-Type: application/json +Content-length: 555 + +{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` + +### Response +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration" + }, + "descriptionForAdmins": "String", + "descriptionForUsers": "String", + "labelToBeApplied": "String", + "defaultRecordBehavior": "String" +} +``` + diff --git a/api-reference/v1.0/api/security-subcategorytemplate-get.md b/api-reference/v1.0/api/security-subcategorytemplate-get.md new file mode 100644 index 0000000000000..a82145b1e3938 --- /dev/null +++ b/api-reference/v1.0/api/security-subcategorytemplate-get.md @@ -0,0 +1,89 @@ +--- +title: "Get subCategoryTemplate" +description: "Read the properties and relationships of a subCategoryTemplate object." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: apiPageType +--- + +# Get subCategoryTemplate +Namespace: microsoft.graph.security + +Read the properties and relationships of a [subCategoryTemplate](../resources/security-subcategorytemplate.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RecordsManagement.Read.All, RecordsManagement.ReadWrite.All| + +## HTTP request + + +``` http +GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +``` + +## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body +Do not supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object in the response body. + +## Examples + +### Request +The following is an example of a request. + + +``` http +GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +``` + + +### Response +The following is an example of the response. +>**Note:** The response object shown here might be shortened for readability. + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "value": { + "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" + } +} +``` + diff --git a/api-reference/v1.0/resources/security-appliedcategory.md b/api-reference/v1.0/resources/security-appliedcategory.md new file mode 100644 index 0000000000000..e372993694394 --- /dev/null +++ b/api-reference/v1.0/resources/security-appliedcategory.md @@ -0,0 +1,44 @@ +--- +title: "appliedCategory resource type" +description: "Represents the file plan descriptor of type category applied to a particular retention label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# appliedCategory resource type + +Namespace: microsoft.graph.security + +Represents the file plan descriptor of type category applied to a particular retention label. + + +Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a category name applied to the label. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|subCategory|[microsoft.graph.security.subCategory](../resources/security-subcategory.md)|Represents the file plan descriptor for a subcategory under a specific category, which has been assigned to a particular retention label.| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.appliedCategory", + "displayName": "String", + "subCategory": { + "@odata.type": "microsoft.graph.security.subCategory" + } +} +``` + diff --git a/api-reference/v1.0/resources/security-authority.md b/api-reference/v1.0/resources/security-authority.md new file mode 100644 index 0000000000000..710e7b7dfe35c --- /dev/null +++ b/api-reference/v1.0/resources/security-authority.md @@ -0,0 +1,40 @@ +--- +title: "authority resource type" +description: "Represents the file plan descriptor of type authority applied to a particular retention label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# authority resource type + +Namespace: microsoft.graph.security + +Represents the file plan descriptor of type authority applied to a particular retention label. + + +Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.authority", + "displayName": "String" +} +``` + diff --git a/api-reference/v1.0/resources/security-authoritytemplate.md b/api-reference/v1.0/resources/security-authoritytemplate.md new file mode 100644 index 0000000000000..ce9af418aeafa --- /dev/null +++ b/api-reference/v1.0/resources/security-authoritytemplate.md @@ -0,0 +1,58 @@ +--- +title: "authorityTemplate resource type" +description: "Specifies the underlying authority that describes the type of content to be retained and its retention schedule." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# authorityTemplate resource type + +Namespace: microsoft.graph.security + +Specifies the underlying authority that describes the type of content to be retained and its retention schedule. + +Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get a list of the [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) objects and their properties.| +|[Create authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Create a new [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| +|[Get authorities](../api/security-authoritytemplate-get.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| +|[Delete authorities](../api/security-labelsroot-delete-authorities.md)|None|Delete a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the authority. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|createdDateTime|DateTimeOffset|Represents the date and time in which the authority is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines an authority name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|id|String|Unique ID of the authority. Inherited from [microsoft.graph.entity](../resources/entity.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/resources/security-categorytemplate.md b/api-reference/v1.0/resources/security-categorytemplate.md new file mode 100644 index 0000000000000..6c91ed29aa633 --- /dev/null +++ b/api-reference/v1.0/resources/security-categorytemplate.md @@ -0,0 +1,63 @@ +--- +title: "categoryTemplate resource type" +description: "Specifies a group of similar types of content in a particular department." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# categoryTemplate resource type + +Namespace: microsoft.graph.security + +Specifies a group of similar types of content in a particular department. + + +Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get a list of the [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) objects and their properties.| +|[Create categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Create a new [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| +|[Get categories](../api/security-categorytemplate-get.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| +|[Delete categories](../api/security-labelsroot-delete-categories.md)|None|Delete a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| +|[List subCategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get the subCategoryTemplate resources from the subCategories navigation property.| +|[Create subCategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new subCategoryTemplate object.| + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the category. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|createdDateTime|DateTimeOffset|Represents the date and time in which the category is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines a category name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|id|String|Unique ID of the category. Inherited from [microsoft.graph.entity](../resources/entity.md).| + +## Relationships +|Relationship|Type|Description| +|:---|:---|:---| +|subCategories|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Represents all subcategories under a particular category.| + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/resources/security-citation.md b/api-reference/v1.0/resources/security-citation.md new file mode 100644 index 0000000000000..68b645b976732 --- /dev/null +++ b/api-reference/v1.0/resources/security-citation.md @@ -0,0 +1,44 @@ +--- +title: "citation resource type" +description: "Represents the file plan descriptor of type citation applied to a particular retention label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# citation resource type + +Namespace: microsoft.graph.security + +Represents the file plan descriptor of type citation applied to a particular retention label. + + +Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.| +|citationUrl|String|Represents the URL to the published citation.| +|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.citation", + "displayName": "String", + "citationUrl": "String", + "citationJurisdiction": "String" +} +``` + diff --git a/api-reference/v1.0/resources/security-citationtemplate.md b/api-reference/v1.0/resources/security-citationtemplate.md new file mode 100644 index 0000000000000..72f9949e723e9 --- /dev/null +++ b/api-reference/v1.0/resources/security-citationtemplate.md @@ -0,0 +1,63 @@ +--- +title: "citationTemplate resource type" +description: "The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# citationTemplate resource type + +Namespace: microsoft.graph.security + +The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. + + +Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get a list of the [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) objects and their properties.| +|[Create citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Create a new [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| +|[Get citations](../api/security-citationtemplate-get.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Read the properties and relationships of a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| +|[Delete citations](../api/security-labelsroot-delete-citations.md)|None|Delete a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|citationJurisdiction|String|Represents the jurisdiction or agency that published the citation.| +|citationUrl|String|Represents the URL to the published citation.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the citation. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|createdDateTime|DateTimeOffset|Represents the date and time in which the citation is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines a citation name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|id|String|Unique ID of the citation. Inherited from [microsoft.graph.entity](../resources/entity.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.citationTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "citationUrl": "String", + "citationJurisdiction": "String" +} +``` + diff --git a/api-reference/v1.0/resources/security-department.md b/api-reference/v1.0/resources/security-department.md new file mode 100644 index 0000000000000..d270698b4f135 --- /dev/null +++ b/api-reference/v1.0/resources/security-department.md @@ -0,0 +1,40 @@ +--- +title: "department resource type" +description: "Represents the file plan descriptor of type department applied to a particular retention label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# department resource type + +Namespace: microsoft.graph.security + +Represents the file plan descriptor of type department applied to a particular retention label. + + +Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.department", + "displayName": "String" +} +``` + diff --git a/api-reference/v1.0/resources/security-departmenttemplate.md b/api-reference/v1.0/resources/security-departmenttemplate.md new file mode 100644 index 0000000000000..1d75e9f93a04b --- /dev/null +++ b/api-reference/v1.0/resources/security-departmenttemplate.md @@ -0,0 +1,59 @@ +--- +title: "departmentTemplate resource type" +description: "Specifies the department or business unit of an organization to which a label belongs." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# departmentTemplate resource type + +Namespace: microsoft.graph.security + +Specifies the department or business unit of an organization to which a label belongs. + + +Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get a list of the [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) objects and their properties.| +|[Create departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Create a new [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| +|[Get departments](../api/security-departmenttemplate-get.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Read the properties and relationships of a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| +|[Delete departments](../api/security-labelsroot-delete-departments.md)|None|Delete a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the department. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|createdDateTime|DateTimeOffset|Represents the date and time in which the department is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines a department name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|id|String|Unique ID of the department. Inherited from [microsoft.graph.entity](../resources/entity.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.departmentTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/resources/security-dispositionreviewstage.md b/api-reference/v1.0/resources/security-dispositionreviewstage.md new file mode 100644 index 0000000000000..f9be4c6cf0490 --- /dev/null +++ b/api-reference/v1.0/resources/security-dispositionreviewstage.md @@ -0,0 +1,56 @@ +--- +title: "dispositionReviewStage resource type" +description: "Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item.." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "compliance" +doc_type: resourcePageType +--- + +# dispositionReviewStage resource type + +Namespace: microsoft.graph.security + +Represents a multi-level review process where the reviewers indicate at each stage of the disposition whether to delete or further retain the content item. +For details, see [Disposition of content](/microsoft-365/compliance/disposition). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object. | +|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the [retentionLabel](../resources/security-retentionlabel.md) object. | + + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|id|String|Unique ID for each stage. | +|name|String|Name representing each stage within a collection. | +|reviewersEmailAddresses|String collection|A collection of reviewers at each stage. | +|stageNumber|Int32|The sequence number for each stage of the disposition review. | + + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.dispositionReviewStage", + "id": "String (identifier)", + "stageNumber": "Integer", + "name": "String", + "reviewersEmailAddresses": [ + "String" + ] +} +``` diff --git a/api-reference/v1.0/resources/security-fileplandescriptor.md b/api-reference/v1.0/resources/security-fileplandescriptor.md new file mode 100644 index 0000000000000..13d3556064ddf --- /dev/null +++ b/api-reference/v1.0/resources/security-fileplandescriptor.md @@ -0,0 +1,73 @@ +--- +title: "filePlanDescriptor resource type" +description: "Represents a group of columns associated with a particular retention label, to improve the manageability and organization of the content you need to label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# filePlanDescriptor resource type + +Namespace: microsoft.graph.security + +Represents a group of columns to improve the manageability and organization of the content you need to label. + + +Inherits from [microsoft.graph.entity](../resources/entity.md). + +## Methods +None. + + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|authority|[microsoft.graph.security.authority](../resources/security-authority.md)|Represents the file plan descriptor of type authority applied to a particular retention label.| +|appliedcategory|[microsoft.graph.security.appliedCategory](../resources/security-appliedcategory.md)|Represents the file plan descriptor of type category applied to a particular retention label.| +|citation|[microsoft.graph.security.citation](../resources/security-citation.md)|Represents the file plan descriptor of type citation applied to a particular retention label.| +|department|[microsoft.graph.security.department](../resources/security-department.md)|Represents the file plan descriptor of type department applied to a particular retention label.| +|filePlanReference|[microsoft.graph.security.filePlanReference](../resources/security-fileplanreference.md)|Represents the file plan descriptor of type filePlanReference applied to a particular retention label.  | + + +## Relationships +|Relationship|Type|Description| +|:---|:---|:---| +|authorityTemplate|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)| Specifies the underlying authority that describes the type of content to be retained and its retention schedule.| +|categoryTemplate|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Specifies a group of similar types of content in a particular department.| +|citationTemplate|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|The specific rule or regulation created by a jurisdiction used to determine whether certain labels and content should be retained or deleted. | +|departmentTemplate|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Specifies the department or business unit of an organization to which a label belongs.| +|filePlanReferenceTemplate|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Specifies a unique alpha-numeric identifier for an organization’s retention schedule.| + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDescriptor", + "id": "String (identifier)", + "authority": { + "@odata.type": "microsoft.graph.security.authority" + }, + "category": { + "@odata.type": "microsoft.graph.security.appliedCategory" + }, + "citation": { + "@odata.type": "microsoft.graph.security.citation" + }, + "department": { + "@odata.type": "microsoft.graph.security.department" + }, + "filePlanReference": { + "@odata.type": "microsoft.graph.security.filePlanReference" + } +} +``` + diff --git a/api-reference/v1.0/resources/security-fileplandescriptorbase.md b/api-reference/v1.0/resources/security-fileplandescriptorbase.md new file mode 100644 index 0000000000000..d2a95ba97a4af --- /dev/null +++ b/api-reference/v1.0/resources/security-fileplandescriptorbase.md @@ -0,0 +1,37 @@ +--- +title: "filePlanDescriptorBase resource type" +description: "Represents the name for each file plan descriptor column associated with a particular label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# filePlanDescriptorBase resource type + +Namespace: microsoft.graph.security + +Represents the name for each [file plan descriptor](../resources/security-fileplandescriptor.md) column associated with a particular label. + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines the name for each [file plan descriptor](../resources/security-fileplandescriptor.md) associated with a particular retention label.| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDescriptorBase", + "displayName": "String" +} +``` + diff --git a/api-reference/v1.0/resources/security-fileplandescriptortemplate.md b/api-reference/v1.0/resources/security-fileplandescriptortemplate.md new file mode 100644 index 0000000000000..4b3b2fd942838 --- /dev/null +++ b/api-reference/v1.0/resources/security-fileplandescriptortemplate.md @@ -0,0 +1,69 @@ +--- +title: "filePlanDescriptorTemplate resource type" +description: "Represents a group of columns to improve the manageability and organization of the content you need to label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# filePlanDescriptorTemplate resource type + +Namespace: microsoft.graph.security + +Represents a group of columns to improve the manageability and organization of the content you need to label. + +Inherits from [microsoft.graph.entity](../resources/entity.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get the authorityTemplate resources from the authorityTemplate navigation property.| +|[Add authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Add authorityTemplate by posting to the authorityTemplate collection.| +|[Remove authorities](../api/security-labelsroot-delete-authorities.md)|None|Remove a [microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) object.| +|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get the categoryTemplate resources from the categoryTemplate navigation property.| +|[Add categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Add categoryTemplate by posting to the categoryTemplate collection.| +|[Remove categories](../api/security-labelsroot-delete-categories.md)|None|Remove a [microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) object.| +|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get the citationTemplate resources from the citationTemplate navigation property.| +|[Add citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Add citationTemplate by posting to the citationTemplate collection.| +|[Remove citations](../api/security-labelsroot-delete-citations.md)|None|Remove a [microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) object.| +|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get the departmentTemplate resources from the departmentTemplate navigation property.| +|[Add departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Add departmentTemplate by posting to the departmentTemplate collection.| +|[Remove departments](../api/security-labelsroot-delete-departments.md)|None|Remove a [microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) object.| +|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get the filePlanReferenceTemplate resources from the filePlanReferenceTemplate navigation property.| +|[Add filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Add filePlanReferenceTemplate by posting to the filePlanReferenceTemplate collection.| +|[Remove filePlanReferences](../api/security-labelsroot-delete-fileplanreferences.md)|None|Remove a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the filePlanDescriptorTemplate column.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanDescriptorTemplate is created.| +|displayName|String|Unique string that defines a filePlanDescriptorTemplate name.| +|id|String|Unique ID of the filePlanDecriptorTemplate column. Inherited from [microsoft.graph.entity](../resources/entity.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanDescriptorTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/resources/security-fileplanreference.md b/api-reference/v1.0/resources/security-fileplanreference.md new file mode 100644 index 0000000000000..0f6b1f067e5c7 --- /dev/null +++ b/api-reference/v1.0/resources/security-fileplanreference.md @@ -0,0 +1,40 @@ +--- +title: "filePlanReference resource type" +description: "Represents the file plan descriptor of type filePlanReference applied to a particular retention label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# filePlanReference resource type + +Namespace: microsoft.graph.security + +Represents the file plan descriptor of type filePlanReference applied to a particular retention label. + + +Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanReference", + "displayName": "String" +} +``` + diff --git a/api-reference/v1.0/resources/security-fileplanreferencetemplate.md b/api-reference/v1.0/resources/security-fileplanreferencetemplate.md new file mode 100644 index 0000000000000..ac910299cb174 --- /dev/null +++ b/api-reference/v1.0/resources/security-fileplanreferencetemplate.md @@ -0,0 +1,59 @@ +--- +title: "filePlanReferenceTemplate resource type" +description: "Specifies a unique alpha-numeric identifier for an organization’s retention schedule." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# filePlanReferenceTemplate resource type + +Namespace: microsoft.graph.security + +Specifies a unique alpha-numeric identifier for an organization’s retention schedule. + + +Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get a list of the [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) objects and their properties.| +|[Create filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Create a new [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| +|[Get filePlanReferences](../api/security-fileplanreferencetemplate-get.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Read the properties and relationships of a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| +|[Delete filePlanReferences](../api/security-labelsroot-delete-fileplanreferences.md)|None|Delete a [microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object.| + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the file plan reference. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|createdDateTime|DateTimeOffset|Represents the date and time in which the filePlanReference is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines a filePlanReference name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|id|String|Unique ID of the filePlanReference. Inherited from [microsoft.graph.entity](../resources/entity.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + diff --git a/api-reference/v1.0/resources/security-labelsroot.md b/api-reference/v1.0/resources/security-labelsroot.md new file mode 100644 index 0000000000000..07785dcae68b4 --- /dev/null +++ b/api-reference/v1.0/resources/security-labelsroot.md @@ -0,0 +1,67 @@ +--- +title: "labelsRoot resource type" +description: "Represents the entry point for the retentionLabels resource type." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# labelsRoot resource type + +Namespace: microsoft.graph.security + +Represents the entry point for the [retentionLabel](security-retentionlabel.md) resource type. + + +Inherits from [microsoft.graph.entity](../resources/entity.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List retentionLabels](../api/security-labelsroot-list-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection |Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.| +|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object.| +|[List authorities](../api/security-labelsroot-list-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Get the authorityTemplate resources from the authorities navigation property.| +|[Create authorities](../api/security-labelsroot-post-authorities.md)|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md)|Create a new authorityTemplate object.| +|[List categories](../api/security-labelsroot-list-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Get the categoryTemplate resources from the categories navigation property.| +|[Create categories](../api/security-labelsroot-post-categories.md)|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md)|Create a new categoryTemplate object.| +|[List citations](../api/security-labelsroot-list-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) collection|Get the citationTemplate resources from the citations navigation property.| +|[Create citations](../api/security-labelsroot-post-citations.md)|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md)|Create a new citationTemplate object.| +|[List departments](../api/security-labelsroot-list-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md) collection|Get the departmentTemplate resources from the departments navigation property.| +|[Create departments](../api/security-labelsroot-post-departments.md)|[microsoft.graph.security.departmentTemplate](../resources/security-departmenttemplate.md)|Create a new departmentTemplate object.| +|[List filePlanReferences](../api/security-labelsroot-list-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Get the filePlanReferenceTemplate resources from the filePlanReferences navigation property.| +|[Create filePlanReferences](../api/security-labelsroot-post-fileplanreferences.md)|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md)|Create a new filePlanReferenceTemplate object.| + +## Properties +None. + + + +## Relationships +|Relationship|Type|Description| +|:---|:---|:---| +|authorities|[microsoft.graph.security.authorityTemplate](../resources/security-authoritytemplate.md) collection|Specifies the underlying authority that describes the type of content to be retained and its retention schedule.| +|categories|[microsoft.graph.security.categoryTemplate](../resources/security-categorytemplate.md) collection|Specifies a group of similar types of content in a particular department.| +|citations|[microsoft.graph.security.citationTemplate](../resources/security-citationtemplate.md) 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](../resources/security-departmenttemplate.md) collection|Specifies the department or business unit of an organization to which a label belongs.| +|filePlanReferences|[microsoft.graph.security.filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) collection|Specifies a unique alpha-numeric identifier for an organization’s retention schedule.| +|retentionLabels|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection|Represents how customers can manage their data, whether and for how long to retain or delete it.| + + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.labelsRoot", + "id": "String (identifier)" +} +``` + diff --git a/api-reference/v1.0/resources/security-retentionduration.md b/api-reference/v1.0/resources/security-retentionduration.md new file mode 100644 index 0000000000000..c0251303463b4 --- /dev/null +++ b/api-reference/v1.0/resources/security-retentionduration.md @@ -0,0 +1,38 @@ +--- +title: "retentionDuration resource type" +description: "An abstract type that represents how long an item will be retained before it can be deleted." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# retentionDuration resource type + +Namespace: microsoft.graph.security + +An abstract type that represents how long an item will be retained before it can be deleted. + +Base type of +[retentionDurationForever](../resources/security-retentiondurationforever.md) and [retentionDurationInDays](../resources/security-retentiondurationindays.md). + +## Properties +None. + +## Relationships +None. + +## JSON representation for retentionDuration +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDuration" +} +``` + + diff --git a/api-reference/v1.0/resources/security-retentiondurationforever.md b/api-reference/v1.0/resources/security-retentiondurationforever.md new file mode 100644 index 0000000000000..71edd1a209080 --- /dev/null +++ b/api-reference/v1.0/resources/security-retentiondurationforever.md @@ -0,0 +1,36 @@ +--- +title: "retentionDurationForever resource type" +description: "Represents that content will be retained permanently and will not be deleted." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# retentionDurationForever resource type + +Namespace: microsoft.graph.security + +Indicates that content will be retained permanently and will not be deleted. + + +Inherits from [retentionDuration](../resources/security-retentionduration.md). + +## Properties +None. + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDurationForever" +} +``` diff --git a/api-reference/v1.0/resources/security-retentiondurationindays.md b/api-reference/v1.0/resources/security-retentiondurationindays.md new file mode 100644 index 0000000000000..f1acbc5645620 --- /dev/null +++ b/api-reference/v1.0/resources/security-retentiondurationindays.md @@ -0,0 +1,39 @@ +--- +title: "retentionDurationInDays resource type" +description: "Represents the number of days an item will be retained before it can be deleted" +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# retentionDurationInDays resource type + +Namespace: microsoft.graph.security + +Represents the number of days an item will be retained before it can be deleted. + + +Inherits from [retentionDuration](../resources/security-retentionduration.md). + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|days|Int32|Specifies the time period in days for which an item with the applied retention label will be retained for.| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionDurationInDays", + "days": "Integer" +} +``` \ No newline at end of file diff --git a/api-reference/v1.0/resources/security-retentionlabel.md b/api-reference/v1.0/resources/security-retentionlabel.md new file mode 100644 index 0000000000000..0ac339a64a9a2 --- /dev/null +++ b/api-reference/v1.0/resources/security-retentionlabel.md @@ -0,0 +1,92 @@ +--- +title: "retentionLabel resource type" +description: "Represents how customers can manage their data, whether and for how long to retain or delete it." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# retentionLabel resource type + +Namespace: microsoft.graph.security + +Represents how customers can manage their data, including whether and for how long to retain or delete it. + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List retentionLabels](../api/security-labelsroot-list-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md) collection|Get a list of the [retentionLabel](../resources/security-retentionlabel.md) objects and their properties.| +|[Create retentionLabel](../api/security-labelsroot-post-retentionlabel.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Create a new [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Get retentionLabel](../api/security-retentionlabel-get.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Read the properties and relationships of a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Update retentionLabel](../api/security-retentionlabel-update.md)|[microsoft.graph.security.retentionLabel](../resources/security-retentionlabel.md)|Update the properties of a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[Delete retentionLabel](../api/security-retentionlabel-delete.md)|None|Delete a [retentionLabel](../resources/security-retentionlabel.md) object.| +|[List retentionEventType](../api/security-retentioneventtype-list.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md) collection|Get the retentionEventType resources from the exapnd eventType navigation property.| +|[Add retentionEventType](../api/security-retentioneventtype-post.md)|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Add eventType by adding the relevant odata property when creating a label.| + + +## Properties +|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`.| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the retentionLabel.| +|createdDateTime|DateTimeOffset|Represents the date and time in which the retentionLabel is created.| +|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.| +|id|String|Unique ID of the retentionLabel. [entity](/graph/api/resources/entity).| +|isInUse|Boolean|Specifies whether the label is currently being used.| +|lastModifiedBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|The user who last modified the retentionLabel.| +|lastModifiedDateTime|DateTimeOffset|The latest date time when the retentionLabel was modified.| +|retentionDuration|[microsoft.graph.security.retentionDuration](../resources/security-retentionduration.md)|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. | + + +## Relationships +|Relationship|Type|Description| +|:---|:---|:---| +|dispositionReviewStages|[microsoft.graph.security.dispositionReviewStage](../resources/security-dispositionreviewstage.md) collection|When action at the end of retention is chosen as 'dispositionReview', dispositionReviewStages specifies a sequential set of stages with at least one reviewer in each stage.| +|retentionEventType|[microsoft.graph.security.retentionEventType](../resources/security-retentioneventtype.md)|Represents the type associated with a retention event.| +|descriptors|[microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md)|Represents out-of-the-box values that provide more options to improve the manageability and organization of the content you need to label.| + + + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "id": "String (identifier)", + "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" +} +``` diff --git a/api-reference/v1.0/resources/security-subcategory.md b/api-reference/v1.0/resources/security-subcategory.md new file mode 100644 index 0000000000000..56bdd53ea166b --- /dev/null +++ b/api-reference/v1.0/resources/security-subcategory.md @@ -0,0 +1,40 @@ +--- +title: "subCategory resource type" +description: "Represents a unique subcategory applied to a retention label." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# subCategory resource type + +Namespace: microsoft.graph.security + +Represents a unique subcategory applied to a retention label. + + +Inherits from [microsoft.graph.security.filePlanDescriptorBase](../resources/security-fileplandescriptorBase.md). + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.subCategory", + "displayName": "String" +} +``` + diff --git a/api-reference/v1.0/resources/security-subcategorytemplate.md b/api-reference/v1.0/resources/security-subcategorytemplate.md new file mode 100644 index 0000000000000..e01a62da24814 --- /dev/null +++ b/api-reference/v1.0/resources/security-subcategorytemplate.md @@ -0,0 +1,59 @@ +--- +title: "subCategoryTemplate resource type" +description: "Represents the file plan descriptor of type subcategory for retention labels." +author: "sseth" +ms.localizationpriority: medium +ms.prod: "security" +doc_type: resourcePageType +--- + +# subCategoryTemplate resource type + +Namespace: microsoft.graph.security + +Represents the file plan descriptor of type subcategory for retention labels. + + +Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). + +## Methods +|Method|Return type|Description| +|:---|:---|:---| +|[List subCategories](../api/security-categorytemplate-list-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) collection|Get a list of the [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) objects and their properties.| +|[Create subCategories](../api/security-categorytemplate-post-subcategories.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Create a new [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.| +|[Get subCategories](../api/security-subcategorytemplate-get.md)|[microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md)|Read the properties and relationships of a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.| +|[Delete subCategories](../api/security-categorytemplate-delete-subcategories.md)|None|Delete a [microsoft.graph.security.subCategoryTemplate](../resources/security-subcategorytemplate.md) object.| + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|createdBy|[microsoft.graph.identitySet](/graph/api/resources/identityset)|Represents the user who created the subcategory. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|createdDateTime|DateTimeOffset|Represents the date and time in which the subcategory is created. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|displayName|String|Unique string that defines a subcategory name. Inherited from [microsoft.graph.security.filePlanDescriptor](../resources/security-fileplandescriptor.md).| +|id|String|Unique ID of the subcategory. Inherited from [microsoft.graph.entity](../resources/entity.md).| + +## Relationships +None. + +## JSON representation +The following is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.security.subCategoryTemplate", + "id": "String (identifier)", + "displayName": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)" +} +``` + From 9c102228509ec87a1032e4888147aba1db10a248 Mon Sep 17 00:00:00 2001 From: samriddhiseth Date: Wed, 12 Jul 2023 15:10:00 -0700 Subject: [PATCH 2/5] v1 labels - toc --- ...y-categorytemplate-delete-subcategories.md | 11 -- api-reference/v1.0/toc.yml | 132 ++++++++++++++---- 2 files changed, 108 insertions(+), 35 deletions(-) diff --git a/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md index 1ecfa92ec596b..9f70c6e5249f5 100644 --- a/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md +++ b/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md @@ -57,17 +57,6 @@ The following is an example of a request. DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} ``` -# [Java](#tab/java) -[!INCLUDE [sample-code](../includes/snippets/java/delete-subcategorytemplate-java-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - -# [JavaScript](#tab/javascript) -[!INCLUDE [sample-code](../includes/snippets/javascript/delete-subcategorytemplate-javascript-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - ---- - - ### Response The following is an example of the response. > diff --git a/api-reference/v1.0/toc.yml b/api-reference/v1.0/toc.yml index 50cd6084ee2ed..839f1709a4da0 100644 --- a/api-reference/v1.0/toc.yml +++ b/api-reference/v1.0/toc.yml @@ -7968,32 +7968,116 @@ items: href: api/alert-update.md - name: Records management items: - - name: Overview - href: resources/security-recordsManagement-overview.md - - name: Retention event - href: resources/security-retentionevent.md + - name: Overview + href: resources/security-recordsmanagement-overview.md + - name: Label + href: resources/security-labelsroot.md + - name: Retention label + href: resources/security-retentionlabel.md + items: + - name: List + href: api/security-labelsroot-list-retentionlabel.md + - name: Create + href: api/security-labelsroot-post-retentionlabel.md + - name: Get + href: api/security-retentionlabel-get.md + - name: Update + href: api/security-retentionlabel-update.md + - name: Delete + href: api/security-retentionlabel-delete.md + - name: File plan descriptors + href: resources/security-fileplandescriptor.md + items: + - name: File plan reference + href: resources/security-fileplanreference.md items: - - name: List - href: api/security-retentionevent-list.md - - name: Create - href: api/security-retentionevent-post.md - - name: Get - href: api/security-retentionevent-get.md - - name: Delete - href: api/security-retentionevent-delete.md - - name: Retention event type - href: resources/security-retentioneventtype.md + - name: List + href: api/security-labelsroot-list-fileplanreferences.md + - name: Create + href: api/security-labelsroot-post-fileplanreferences.md + - name: Get + href: api/security-fileplanreferencetemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-fileplanreferences.md + - name: Authority + href: resources/security-authority.md items: - - name: List - href: api/security-retentioneventtype-list.md - - name: Create - href: api/security-retentioneventtype-post.md - - name: Get - href: api/security-retentioneventtype-get.md - - name: Update - href: api/security-retentioneventtype-update.md - - name: Delete - href: api/security-retentioneventtype-delete.md + - name: List + href: api/security-labelsroot-list-authorities.md + - name: Create + href: api/security-labelsroot-post-authorities.md + - name: Get + href: api/security-authoritytemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-authorities.md + - name: Category + href: resources/security-appliedcategory.md + items: + - name: List + href: api/security-labelsroot-list-categories.md + - name: Create + href: api/security-labelsroot-post-categories.md + - name: Get + href: api/security-categorytemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-categories.md + - name: Subcategory + href: resources/security-subcategory.md + items: + - name: List + href: api/security-categorytemplate-list-subcategories.md + - name: Create + href: api/security-categorytemplate-post-subcategories.md + - name: Get + href: api/security-subcategorytemplate-get.md + - name: Delete + href: api/security-categorytemplate-delete-subcategories.md + - name: Department + href: resources/security-department.md + items: + - name: List + href: api/security-labelsroot-list-departments.md + - name: Create + href: api/security-labelsroot-post-departments.md + - name: Get + href: api/security-departmenttemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-departments.md + - name: Citation + href: resources/security-citation.md + items: + - name: List + href: api/security-labelsroot-list-citations.md + - name: Create + href: api/security-labelsroot-post-citations.md + - name: Get + href: api/security-citationtemplate-get.md + - name: Delete + href: api/security-labelsroot-delete-citations.md + - name: Retention event + href: resources/security-retentionevent.md + items: + - name: List + href: api/security-retentionevent-list.md + - name: Create + href: api/security-retentionevent-post.md + - name: Get + href: api/security-retentionevent-get.md + - name: Delete + href: api/security-retentionevent-delete.md + - name: Retention event type + href: resources/security-retentioneventtype.md + items: + - name: List + href: api/security-retentioneventtype-list.md + - name: Create + href: api/security-retentioneventtype-post.md + - name: Get + href: api/security-retentioneventtype-get.md + - name: Update + href: api/security-retentioneventtype-update.md + - name: Delete + href: api/security-retentioneventtype-delete.md - name: Secure score href: resources/securescore.md items: From f2594e4f7851d2ad57fa888dfa00bf3d15bc48cc Mon Sep 17 00:00:00 2001 From: samriddhiseth Date: Wed, 12 Jul 2023 15:39:11 -0700 Subject: [PATCH 3/5] changelogs --- .../api/security-departmenttemplate-get.md | 2 +- .../Microsoft.Security.RecordsManagement.json | 236 +++++++++++++++++- 2 files changed, 236 insertions(+), 2 deletions(-) diff --git a/api-reference/v1.0/api/security-departmenttemplate-get.md b/api-reference/v1.0/api/security-departmenttemplate-get.md index c3608ed2593fc..3e2fa7278b2e0 100644 --- a/api-reference/v1.0/api/security-departmenttemplate-get.md +++ b/api-reference/v1.0/api/security-departmenttemplate-get.md @@ -51,7 +51,7 @@ If successful, this method returns a `200 OK` response code and a [microsoft.gra ### Request The following is an example of a request. -# [HTTP](#tab/http) +