From 8518825ac33e7d48a9b188c100b4d385c6fb70f4 Mon Sep 17 00:00:00 2001 From: samriddhiseth Date: Wed, 12 Jul 2023 15:01:04 -0700 Subject: [PATCH 001/204] 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 00000000000..6544abf4299 --- /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 00000000000..1ecfa92ec59 --- /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 00000000000..13d4f66be96 --- /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 00000000000..77c49bb5473 --- /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 00000000000..3efbbace5b3 --- /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 00000000000..2083ee6d680 --- /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 00000000000..c3608ed2593 --- /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 00000000000..2553da12345 --- /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 00000000000..f620a54e8a4 --- /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 00000000000..0e550e7bbd3 --- /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 00000000000..9007253db73 --- /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 00000000000..b6470eb4671 --- /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 00000000000..762b977c876 --- /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 00000000000..b666b1ad4ad --- /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 00000000000..14403cf1d2f --- /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 00000000000..eac74637cc0 --- /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 00000000000..ab9f5f8244b --- /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 00000000000..dfadb0efcdb --- /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 00000000000..e807d24f709 --- /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 00000000000..174d48160f3 --- /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 00000000000..3210d66c535 --- /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 00000000000..b2c43d6e203 --- /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 00000000000..d1a76f01704 --- /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 00000000000..515fac506ae --- /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 00000000000..0e605760810 --- /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 00000000000..d64c3390b4c --- /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 00000000000..19e6bd46043 --- /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 00000000000..a626dd688d8 --- /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 00000000000..a82145b1e39 --- /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 00000000000..e3729936943 --- /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 00000000000..710e7b7dfe3 --- /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 00000000000..ce9af418aea --- /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 00000000000..6c91ed29aa6 --- /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 00000000000..68b645b9767 --- /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 00000000000..72f9949e723 --- /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 00000000000..d270698b4f1 --- /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 00000000000..1d75e9f93a0 --- /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 00000000000..f9be4c6cf04 --- /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 00000000000..13d3556064d --- /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 00000000000..d2a95ba97a4 --- /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 00000000000..4b3b2fd9428 --- /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 00000000000..0f6b1f067e5 --- /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 00000000000..ac910299cb1 --- /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 00000000000..07785dcae68 --- /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 00000000000..c0251303463 --- /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 00000000000..71edd1a2090 --- /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 00000000000..f1acbc56456 --- /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 00000000000..0ac339a64a9 --- /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 00000000000..56bdd53ea16 --- /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 00000000000..e01a62da248 --- /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 002/204] 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 1ecfa92ec59..9f70c6e5249 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 50cd6084ee2..839f1709a4d 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 003/204] 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 c3608ed2593..3e2fa7278b2 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) + ``` http -GET https://graph.microsoft.com/beta/security/labels/authorities/{authorityTemplateId} +GET https://graph.microsoft.com/beta/security/labels/authorities/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) @@ -105,13 +105,16 @@ Content-Type: application/json { "value": { "@odata.type": "#microsoft.graph.security.authorityTemplate", - "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", - "displayName": "String", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Business", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/beta/api/security-categorytemplate-get.md b/api-reference/beta/api/security-categorytemplate-get.md index 9a51dd1821e..3f0757c5150 100644 --- a/api-reference/beta/api/security-categorytemplate-get.md +++ b/api-reference/beta/api/security-categorytemplate-get.md @@ -60,7 +60,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId} +GET https://graph.microsoft.com/beta/security/labels/categories/e2c79762-34a9-75ba-b6f0-a7c9a57978ef ``` # [C#](#tab/csharp) @@ -106,12 +106,15 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", - "displayName": "String", + "displayName": "Accounts payable", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/beta/api/security-citationtemplate-get.md b/api-reference/beta/api/security-citationtemplate-get.md index 1e7b761fbce..b686c1c7c9a 100644 --- a/api-reference/beta/api/security-citationtemplate-get.md +++ b/api-reference/beta/api/security-citationtemplate-get.md @@ -60,7 +60,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/beta/security/labels/citations/{citationTemplateId} +GET https://graph.microsoft.com/beta/security/labels/citations/c0475d01-d532-8a53-6e26-14ea58c640bf ``` # [C#](#tab/csharp) @@ -106,13 +106,16 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", - "displayName": "String", + "displayName": "Contoso Company Policy", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)", - "citationUrl": "String", - "citationJurisdiction": "String" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } } ``` diff --git a/api-reference/beta/api/security-departmenttemplate-get.md b/api-reference/beta/api/security-departmenttemplate-get.md index 16d1d5acdcd..efe0eeea0b3 100644 --- a/api-reference/beta/api/security-departmenttemplate-get.md +++ b/api-reference/beta/api/security-departmenttemplate-get.md @@ -60,7 +60,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/beta/security/labels/departments/{departmentTemplateId} +GET https://graph.microsoft.com/beta/security/labels/departments/11b44677-9f06-c85a-4a0b-766b66904bf8 ``` # [C#](#tab/csharp) @@ -106,12 +106,15 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", - "displayName": "String", + "displayName": "Finance", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/beta/api/security-fileplanreferencetemplate-get.md b/api-reference/beta/api/security-fileplanreferencetemplate-get.md index b4785e905c4..11243f9df1c 100644 --- a/api-reference/beta/api/security-fileplanreferencetemplate-get.md +++ b/api-reference/beta/api/security-fileplanreferencetemplate-get.md @@ -60,7 +60,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +GET https://graph.microsoft.com/beta/security/labels/filePlanReferences/b1f7b518-a44f-1d4b-c6f1-ab8771d3907c ``` # [C#](#tab/csharp) @@ -106,12 +106,15 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", - "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/beta/api/security-subcategorytemplate-get.md b/api-reference/beta/api/security-subcategorytemplate-get.md index 4f60ca37a0d..aec2ce6a70b 100644 --- a/api-reference/beta/api/security-subcategorytemplate-get.md +++ b/api-reference/beta/api/security-subcategorytemplate-get.md @@ -59,7 +59,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +GET https://graph.microsoft.com/beta/security/labels/retentionLabels/82d00422-1f60-46cd-9809-33ca0b4d2286/descriptors/categoryTemplate/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0 ``` # [Java](#tab/java) @@ -89,12 +89,16 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.subCategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", - "displayName": "String", + "displayName": "Vendor Invoice", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} + } ``` diff --git a/api-reference/v1.0/api/security-authoritytemplate-get.md b/api-reference/v1.0/api/security-authoritytemplate-get.md index 6544abf4299..483fb7eadc0 100644 --- a/api-reference/v1.0/api/security-authoritytemplate-get.md +++ b/api-reference/v1.0/api/security-authoritytemplate-get.md @@ -58,7 +58,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/authorities/{authorityTemplateId} +GET https://graph.microsoft.com/v1.0/security/labels/authorities/a94af2e3-853b-6fcc-c898-d61d3a6d9efc ``` @@ -83,10 +83,13 @@ Content-Type: application/json "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", "displayName": "String", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/v1.0/api/security-categorytemplate-get.md b/api-reference/v1.0/api/security-categorytemplate-get.md index 13d4f66be96..2e71f6d1516 100644 --- a/api-reference/v1.0/api/security-categorytemplate-get.md +++ b/api-reference/v1.0/api/security-categorytemplate-get.md @@ -58,7 +58,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId} +GET https://graph.microsoft.com/v1.0/security/labels/categories/e2c79762-34a9-75ba-b6f0-a7c9a57978ef ``` ### Response @@ -78,12 +78,15 @@ 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)" - } + "displayName": "Accounts payable", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/v1.0/api/security-citationtemplate-get.md b/api-reference/v1.0/api/security-citationtemplate-get.md index 2083ee6d680..0e38580456a 100644 --- a/api-reference/v1.0/api/security-citationtemplate-get.md +++ b/api-reference/v1.0/api/security-citationtemplate-get.md @@ -58,7 +58,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/citations/{citationTemplateId} +GET https://graph.microsoft.com/v1.0/security/labels/citations/c0475d01-d532-8a53-6e26-14ea58c640bf ``` @@ -79,13 +79,16 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", - "displayName": "String", + "displayName": "Contoso Company Policy", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)", - "citationUrl": "String", - "citationJurisdiction": "String" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } } ``` diff --git a/api-reference/v1.0/api/security-departmenttemplate-get.md b/api-reference/v1.0/api/security-departmenttemplate-get.md index 3e2fa7278b2..659d6048c5b 100644 --- a/api-reference/v1.0/api/security-departmenttemplate-get.md +++ b/api-reference/v1.0/api/security-departmenttemplate-get.md @@ -58,7 +58,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/departments/{departmentTemplateId} +GET https://graph.microsoft.com/v1.0/security/labels/departments/11b44677-9f06-c85a-4a0b-766b66904bf8 ``` @@ -79,12 +79,15 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", - "displayName": "String", + "displayName": "Finance", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md b/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md index 2553da12345..df68570f498 100644 --- a/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md +++ b/api-reference/v1.0/api/security-fileplanreferencetemplate-get.md @@ -58,7 +58,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +GET https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/b1f7b518-a44f-1d4b-c6f1-ab8771d3907c ``` @@ -81,10 +81,13 @@ Content-Type: application/json "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", "displayName": "String", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` diff --git a/api-reference/v1.0/api/security-subcategorytemplate-get.md b/api-reference/v1.0/api/security-subcategorytemplate-get.md index a82145b1e39..c0c239cbc30 100644 --- a/api-reference/v1.0/api/security-subcategorytemplate-get.md +++ b/api-reference/v1.0/api/security-subcategorytemplate-get.md @@ -57,7 +57,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/82d00422-1f60-46cd-9809-33ca0b4d2286/descriptors/categoryTemplate/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0 ``` @@ -78,12 +78,15 @@ Content-Type: application/json "value": { "@odata.type": "#microsoft.graph.security.subCategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", - "displayName": "String", + "displayName": "Vendor Invoice", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)" - } + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime" : "2021-03-24T02:09:08Z" +} } ``` From 1843fcfab7b6c687bb75daff28ce66f9425ff18d Mon Sep 17 00:00:00 2001 From: samriddhiseth Date: Thu, 17 Aug 2023 16:41:23 -0700 Subject: [PATCH 022/204] Fixing examples for for beta and v1 Template operations- LIST --- ...ity-categorytemplate-list-subcategories.md | 9 ++++--- .../security-labelsroot-list-authorities.md | 21 ++++++++++++--- .../security-labelsroot-list-categories.md | 23 +++++++++++++--- .../api/security-labelsroot-list-citations.md | 13 ++++++---- .../security-labelsroot-list-departments.md | 9 ++++--- ...rity-labelsroot-list-fileplanreferences.md | 9 ++++--- ...ity-categorytemplate-list-subcategories.md | 9 ++++--- .../security-labelsroot-list-authorities.md | 22 +++++++++++++--- .../security-labelsroot-list-categories.md | 26 ++++++++++++++----- .../api/security-labelsroot-list-citations.md | 13 ++++++---- .../security-labelsroot-list-departments.md | 9 ++++--- ...rity-labelsroot-list-fileplanreferences.md | 9 ++++--- 12 files changed, 127 insertions(+), 45 deletions(-) diff --git a/api-reference/beta/api/security-categorytemplate-list-subcategories.md b/api-reference/beta/api/security-categorytemplate-list-subcategories.md index 078fb518e9c..ef336352391 100644 --- a/api-reference/beta/api/security-categorytemplate-list-subcategories.md +++ b/api-reference/beta/api/security-categorytemplate-list-subcategories.md @@ -90,11 +90,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.subCategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", - "displayName": "String", + "displayName": "Vendor Invoice", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } diff --git a/api-reference/beta/api/security-labelsroot-list-authorities.md b/api-reference/beta/api/security-labelsroot-list-authorities.md index 6980c0f13bb..66cdda71a20 100644 --- a/api-reference/beta/api/security-labelsroot-list-authorities.md +++ b/api-reference/beta/api/security-labelsroot-list-authorities.md @@ -106,11 +106,26 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", - "displayName": "String", + "displayName": "Business", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Legal", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" } ] } diff --git a/api-reference/beta/api/security-labelsroot-list-categories.md b/api-reference/beta/api/security-labelsroot-list-categories.md index 0daf2674725..f3ce32a7366 100644 --- a/api-reference/beta/api/security-labelsroot-list-categories.md +++ b/api-reference/beta/api/security-labelsroot-list-categories.md @@ -106,12 +106,27 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", - "displayName": "String", + "displayName": "Accounts Payable", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" - } + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Accounts", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } ] } ``` diff --git a/api-reference/beta/api/security-labelsroot-list-citations.md b/api-reference/beta/api/security-labelsroot-list-citations.md index e99f0d3bca3..7d2c5c31350 100644 --- a/api-reference/beta/api/security-labelsroot-list-citations.md +++ b/api-reference/beta/api/security-labelsroot-list-citations.md @@ -106,13 +106,16 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", - "displayName": "String", + "displayName": "Contoso Company Policy", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)", - "citationUrl": "String", - "citationJurisdiction": "String" + "createdDateTime": "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } ] } diff --git a/api-reference/beta/api/security-labelsroot-list-departments.md b/api-reference/beta/api/security-labelsroot-list-departments.md index 0ee5984d2ae..945c1300b47 100644 --- a/api-reference/beta/api/security-labelsroot-list-departments.md +++ b/api-reference/beta/api/security-labelsroot-list-departments.md @@ -106,11 +106,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", - "displayName": "String", + "displayName": "Finance", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } diff --git a/api-reference/beta/api/security-labelsroot-list-fileplanreferences.md b/api-reference/beta/api/security-labelsroot-list-fileplanreferences.md index d8904304d0f..0e7bf0f5741 100644 --- a/api-reference/beta/api/security-labelsroot-list-fileplanreferences.md +++ b/api-reference/beta/api/security-labelsroot-list-fileplanreferences.md @@ -106,11 +106,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", - "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } diff --git a/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md index 77c49bb5473..0a9ab820214 100644 --- a/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md +++ b/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md @@ -80,11 +80,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.subCategoryTemplate", "id": "2ac39915-dbeb-e933-82e2-92b981835fa0", - "displayName": "String", + "displayName": "Vendor Invoice", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } diff --git a/api-reference/v1.0/api/security-labelsroot-list-authorities.md b/api-reference/v1.0/api/security-labelsroot-list-authorities.md index b666b1ad4ad..254994919b8 100644 --- a/api-reference/v1.0/api/security-labelsroot-list-authorities.md +++ b/api-reference/v1.0/api/security-labelsroot-list-authorities.md @@ -80,13 +80,27 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", - "displayName": "String", + "displayName": "Business", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.authorityTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Legal", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" } ] } ``` - diff --git a/api-reference/v1.0/api/security-labelsroot-list-categories.md b/api-reference/v1.0/api/security-labelsroot-list-categories.md index 14403cf1d2f..5acdb8e47a9 100644 --- a/api-reference/v1.0/api/security-labelsroot-list-categories.md +++ b/api-reference/v1.0/api/security-labelsroot-list-categories.md @@ -79,13 +79,27 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", - "displayName": "String", + "displayName": "Accounts Payable", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" - } + "createdDateTime": "2021-03-24T02:09:08Z" + }, + { + "@odata.type": "#microsoft.graph.security.categoryTemplate", + "id": "6cf65e55-6baf-44ff-5dcc-08d8de97b1d5", + "displayName": "Accounts", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } ] } -``` - +``` \ No newline at end of file diff --git a/api-reference/v1.0/api/security-labelsroot-list-citations.md b/api-reference/v1.0/api/security-labelsroot-list-citations.md index eac74637cc0..384b283af42 100644 --- a/api-reference/v1.0/api/security-labelsroot-list-citations.md +++ b/api-reference/v1.0/api/security-labelsroot-list-citations.md @@ -79,13 +79,16 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", - "displayName": "String", + "displayName": "Contoso Company Policy", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)", - "citationUrl": "String", - "citationJurisdiction": "String" + "createdDateTime": "2021-03-24T02:09:08Z", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } ] } diff --git a/api-reference/v1.0/api/security-labelsroot-list-departments.md b/api-reference/v1.0/api/security-labelsroot-list-departments.md index ab9f5f8244b..7deca83e200 100644 --- a/api-reference/v1.0/api/security-labelsroot-list-departments.md +++ b/api-reference/v1.0/api/security-labelsroot-list-departments.md @@ -78,11 +78,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", - "displayName": "String", + "displayName": "Finance", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } diff --git a/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md b/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md index dfadb0efcdb..8b828e9f7e6 100644 --- a/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md +++ b/api-reference/v1.0/api/security-labelsroot-list-fileplanreferences.md @@ -79,11 +79,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", - "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime": "2021-03-24T02:09:08Z" } ] } From 54deef46759d5b9a3206d780b48c9286ca5748dd Mon Sep 17 00:00:00 2001 From: samriddhiseth Date: Thu, 17 Aug 2023 17:14:46 -0700 Subject: [PATCH 023/204] fixing examples for template in POST - beta and v1 --- ...rity-categorytemplate-post-subcategories.md | 17 ++++++++++------- .../security-labelsroot-post-authorities.md | 11 +++++++---- .../api/security-labelsroot-post-categories.md | 11 +++++++---- .../api/security-labelsroot-post-citations.md | 18 +++++++++++------- .../security-labelsroot-post-departments.md | 11 +++++++---- ...urity-labelsroot-post-fileplanreferences.md | 11 +++++++---- ...rity-categorytemplate-post-subcategories.md | 17 ++++++++++------- .../security-labelsroot-post-authorities.md | 11 +++++++---- .../api/security-labelsroot-post-categories.md | 12 +++++++----- .../api/security-labelsroot-post-citations.md | 18 +++++++++++------- .../security-labelsroot-post-departments.md | 11 +++++++---- ...urity-labelsroot-post-fileplanreferences.md | 11 +++++++---- 12 files changed, 98 insertions(+), 61 deletions(-) diff --git a/api-reference/beta/api/security-categorytemplate-post-subcategories.md b/api-reference/beta/api/security-categorytemplate-post-subcategories.md index a1a22d3b323..e677724661c 100644 --- a/api-reference/beta/api/security-categorytemplate-post-subcategories.md +++ b/api-reference/beta/api/security-categorytemplate-post-subcategories.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.subCategoryTemplate", - "displayName": "String", + "displayName": "Vendor Invoice", } ``` @@ -99,11 +99,14 @@ 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)" -} + "displayName": "Vendor Invoice", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } ``` diff --git a/api-reference/beta/api/security-labelsroot-post-authorities.md b/api-reference/beta/api/security-labelsroot-post-authorities.md index 7c5c5cfacc7..67c24215b25 100644 --- a/api-reference/beta/api/security-labelsroot-post-authorities.md +++ b/api-reference/beta/api/security-labelsroot-post-authorities.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", - "displayName": "String", + "displayName": "Business", } ``` @@ -115,11 +115,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", - "displayName": "String", + "displayName": "Business", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` diff --git a/api-reference/beta/api/security-labelsroot-post-categories.md b/api-reference/beta/api/security-labelsroot-post-categories.md index b01df187d73..798fd2af1ea 100644 --- a/api-reference/beta/api/security-labelsroot-post-categories.md +++ b/api-reference/beta/api/security-labelsroot-post-categories.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", - "displayName": "String", + "displayName": "Accounts Payable", } ``` @@ -115,11 +115,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", - "displayName": "String", + "displayName": "Accounts Payable", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` diff --git a/api-reference/beta/api/security-labelsroot-post-citations.md b/api-reference/beta/api/security-labelsroot-post-citations.md index 2fc92be8a3d..4ca21e626b1 100644 --- a/api-reference/beta/api/security-labelsroot-post-citations.md +++ b/api-reference/beta/api/security-labelsroot-post-citations.md @@ -69,9 +69,9 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", - "displayName": "String", - "citationUrl": "String", - "citationJurisdiction": "String" + "displayName": "Contoso Company Policy", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } ``` @@ -117,12 +117,16 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", - "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "displayName": "Contoso Company Policy", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, + "createdDateTime" : "2021-03-24T02:09:08Z", "createdDateTime": "String (timestamp)", - "citationUrl": "String", + "citationUrl": "www.citationUrl.com", "citationJurisdiction": "String" } ``` diff --git a/api-reference/beta/api/security-labelsroot-post-departments.md b/api-reference/beta/api/security-labelsroot-post-departments.md index cb771bbdca2..44ca90cab96 100644 --- a/api-reference/beta/api/security-labelsroot-post-departments.md +++ b/api-reference/beta/api/security-labelsroot-post-departments.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", - "displayName": "String", + "displayName": "Finance", } ``` @@ -115,11 +115,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", - "displayName": "String", + "displayName": "Finance", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` diff --git a/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md b/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md index 1f1ce06a45f..faa62a10811 100644 --- a/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md +++ b/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", - "displayName": "String", + "displayName": "FIN 01-02-001", } ``` @@ -115,11 +115,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", - "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` diff --git a/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md index 0d021a43074..d358e2c3073 100644 --- a/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md +++ b/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.subCategoryTemplate", - "displayName": "String", + "displayName": "Vendor Invoice", } ``` @@ -91,11 +91,14 @@ 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)" -} + "displayName": "Vendor Invoice", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2021-03-24T02:09:08Z" + } ``` diff --git a/api-reference/v1.0/api/security-labelsroot-post-authorities.md b/api-reference/v1.0/api/security-labelsroot-post-authorities.md index 1cc38ad0a11..9b4c68fd2c1 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-authorities.md +++ b/api-reference/v1.0/api/security-labelsroot-post-authorities.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", - "displayName": "String", + "displayName": "Business", } ``` @@ -90,11 +90,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.authorityTemplate", "id": "a94af2e3-853b-6fcc-c898-d61d3a6d9efc", - "displayName": "String", + "displayName": "Business", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` diff --git a/api-reference/v1.0/api/security-labelsroot-post-categories.md b/api-reference/v1.0/api/security-labelsroot-post-categories.md index 954f1a05579..159712fab5d 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-categories.md +++ b/api-reference/v1.0/api/security-labelsroot-post-categories.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", - "displayName": "String", + "displayName": "Accounts Payable", } ``` @@ -90,11 +90,13 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.categoryTemplate", "id": "e2c79762-34a9-75ba-b6f0-a7c9a57978ef", - "displayName": "String", + "displayName": "Accounts Payable", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` - diff --git a/api-reference/v1.0/api/security-labelsroot-post-citations.md b/api-reference/v1.0/api/security-labelsroot-post-citations.md index 354074c65b4..66fc416615d 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-citations.md +++ b/api-reference/v1.0/api/security-labelsroot-post-citations.md @@ -69,9 +69,9 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", - "displayName": "String", - "citationUrl": "String", - "citationJurisdiction": "String" + "displayName": "Contoso Company Policy", + "citationUrl": "www.citationUrl.com", + "citationJurisdiction": "Contoso" } ``` @@ -92,12 +92,16 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.citationTemplate", "id": "c0475d01-d532-8a53-6e26-14ea58c640bf", - "displayName": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "displayName": "Contoso Company Policy", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, + "createdDateTime" : "2021-03-24T02:09:08Z", "createdDateTime": "String (timestamp)", - "citationUrl": "String", + "citationUrl": "www.citationUrl.com", "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 index 1d7f3976486..d5d76010570 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-departments.md +++ b/api-reference/v1.0/api/security-labelsroot-post-departments.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", - "displayName": "String", + "displayName": "Finance", } ``` @@ -90,11 +90,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.departmentTemplate", "id": "11b44677-9f06-c85a-4a0b-766b66904bf8", - "displayName": "String", + "displayName": "Finance", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` diff --git a/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md b/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md index cc7906aac12..a59b3c07bef 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md +++ b/api-reference/v1.0/api/security-labelsroot-post-fileplanreferences.md @@ -69,7 +69,7 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", - "displayName": "String", + "displayName": "FIN 01-02-001", } ``` @@ -90,11 +90,14 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.filePlanReferenceTemplate", "id": "b1f7b518-a44f-1d4b-c6f1-ab8771d3907c", - "displayName": "String", + "displayName": "FIN 01-02-001", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)" + "createdDateTime" : "2021-03-24T02:09:08Z" } ``` From 83029017c69e7e461f95cb430820d831e5b40a8c Mon Sep 17 00:00:00 2001 From: samriddhiseth Date: Thu, 17 Aug 2023 17:46:33 -0700 Subject: [PATCH 024/204] Fixing example values for beta and v1 'template' files - DELETE ++ fixing endpoints for subcategories added expand function descriptions where applicable --- .../api/security-categorytemplate-delete-subcategories.md | 4 ++-- api-reference/beta/api/security-categorytemplate-get.md | 2 +- .../beta/api/security-categorytemplate-list-subcategories.md | 4 ++-- .../beta/api/security-categorytemplate-post-subcategories.md | 4 ++-- .../beta/api/security-labelsroot-delete-authorities.md | 2 +- .../beta/api/security-labelsroot-delete-categories.md | 2 +- .../beta/api/security-labelsroot-delete-citations.md | 3 +-- .../beta/api/security-labelsroot-delete-departments.md | 2 +- .../beta/api/security-labelsroot-delete-fileplanreferences.md | 2 +- api-reference/beta/api/security-retentionlabel-get.md | 2 +- api-reference/beta/api/security-subcategorytemplate-get.md | 4 ++-- .../api/security-categorytemplate-delete-subcategories.md | 4 ++-- api-reference/v1.0/api/security-categorytemplate-get.md | 2 +- .../v1.0/api/security-categorytemplate-list-subcategories.md | 4 ++-- .../v1.0/api/security-categorytemplate-post-subcategories.md | 4 ++-- .../v1.0/api/security-labelsroot-delete-authorities.md | 2 +- .../v1.0/api/security-labelsroot-delete-categories.md | 2 +- .../v1.0/api/security-labelsroot-delete-citations.md | 2 +- .../v1.0/api/security-labelsroot-delete-departments.md | 2 +- .../v1.0/api/security-labelsroot-delete-fileplanreferences.md | 2 +- api-reference/v1.0/api/security-retentionlabel-get.md | 2 +- api-reference/v1.0/api/security-subcategorytemplate-get.md | 4 ++-- 22 files changed, 30 insertions(+), 31 deletions(-) diff --git a/api-reference/beta/api/security-categorytemplate-delete-subcategories.md b/api-reference/beta/api/security-categorytemplate-delete-subcategories.md index 0b162b2b340..14b91b24163 100644 --- a/api-reference/beta/api/security-categorytemplate-delete-subcategories.md +++ b/api-reference/beta/api/security-categorytemplate-delete-subcategories.md @@ -30,7 +30,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}/$ref +DELETE /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId}/$ref ``` ## Request headers @@ -56,7 +56,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/categories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5/subCategories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [Java](#tab/java) diff --git a/api-reference/beta/api/security-categorytemplate-get.md b/api-reference/beta/api/security-categorytemplate-get.md index 3f0757c5150..699cf7cddda 100644 --- a/api-reference/beta/api/security-categorytemplate-get.md +++ b/api-reference/beta/api/security-categorytemplate-get.md @@ -35,7 +35,7 @@ GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemp ``` ## 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). +This method supports some of the OData query parameters to help customize the response. For example, to retrieve the **subategories** property associated with this particular category, you can use the `expand` parameter:`$expand=subcategories`. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers |Name|Description| diff --git a/api-reference/beta/api/security-categorytemplate-list-subcategories.md b/api-reference/beta/api/security-categorytemplate-list-subcategories.md index ef336352391..46dfd4a58d9 100644 --- a/api-reference/beta/api/security-categorytemplate-list-subcategories.md +++ b/api-reference/beta/api/security-categorytemplate-list-subcategories.md @@ -30,7 +30,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +GET /security/labels/categories/{categoryTemplateId}/subCategories ``` ## Optional query parameters @@ -59,7 +59,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +GET https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}/subCategories ``` # [Java](#tab/java) diff --git a/api-reference/beta/api/security-categorytemplate-post-subcategories.md b/api-reference/beta/api/security-categorytemplate-post-subcategories.md index e677724661c..94a8c471e94 100644 --- a/api-reference/beta/api/security-categorytemplate-post-subcategories.md +++ b/api-reference/beta/api/security-categorytemplate-post-subcategories.md @@ -28,7 +28,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -POST /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +POST /security/labels/categories/{categoryTemplateId}/subCategories ``` ## Request headers @@ -64,7 +64,7 @@ The following is an example of a request. } --> ``` http -POST https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +POST https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId}/subCategories Content-Type: application/json { diff --git a/api-reference/beta/api/security-labelsroot-delete-authorities.md b/api-reference/beta/api/security-labelsroot-delete-authorities.md index 64b8042c37d..b85314290e7 100644 --- a/api-reference/beta/api/security-labelsroot-delete-authorities.md +++ b/api-reference/beta/api/security-labelsroot-delete-authorities.md @@ -57,7 +57,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/beta/security/labels/authorities/{authorityTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/authorities/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) diff --git a/api-reference/beta/api/security-labelsroot-delete-categories.md b/api-reference/beta/api/security-labelsroot-delete-categories.md index 1b9ed0b37f7..ef3599e96ed 100644 --- a/api-reference/beta/api/security-labelsroot-delete-categories.md +++ b/api-reference/beta/api/security-labelsroot-delete-categories.md @@ -57,7 +57,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/beta/security/labels/categories/{categoryTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/categories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) diff --git a/api-reference/beta/api/security-labelsroot-delete-citations.md b/api-reference/beta/api/security-labelsroot-delete-citations.md index 6705b460dc2..2ef884675d2 100644 --- a/api-reference/beta/api/security-labelsroot-delete-citations.md +++ b/api-reference/beta/api/security-labelsroot-delete-citations.md @@ -57,8 +57,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/beta/security/labels/citations/{citationTemplateId} -``` +DELETE https://graph.microsoft.com/beta/security/labels/citations/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/delete-citationtemplate-csharp-snippets.md)] diff --git a/api-reference/beta/api/security-labelsroot-delete-departments.md b/api-reference/beta/api/security-labelsroot-delete-departments.md index 316db695474..2a5d79a46a0 100644 --- a/api-reference/beta/api/security-labelsroot-delete-departments.md +++ b/api-reference/beta/api/security-labelsroot-delete-departments.md @@ -57,7 +57,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/beta/security/labels/departments/{departmentTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/departments/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) diff --git a/api-reference/beta/api/security-labelsroot-delete-fileplanreferences.md b/api-reference/beta/api/security-labelsroot-delete-fileplanreferences.md index 4f80d05ac71..0af202e88a7 100644 --- a/api-reference/beta/api/security-labelsroot-delete-fileplanreferences.md +++ b/api-reference/beta/api/security-labelsroot-delete-fileplanreferences.md @@ -57,7 +57,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +DELETE https://graph.microsoft.com/beta/security/labels/filePlanReferences/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5 ``` # [C#](#tab/csharp) diff --git a/api-reference/beta/api/security-retentionlabel-get.md b/api-reference/beta/api/security-retentionlabel-get.md index 4add35b5d43..bd62af25f68 100644 --- a/api-reference/beta/api/security-retentionlabel-get.md +++ b/api-reference/beta/api/security-retentionlabel-get.md @@ -35,7 +35,7 @@ GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabel ``` ## 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). +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` or `$expand=descriptors`. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers |Name|Description| diff --git a/api-reference/beta/api/security-subcategorytemplate-get.md b/api-reference/beta/api/security-subcategorytemplate-get.md index aec2ce6a70b..1cb4a16d6e3 100644 --- a/api-reference/beta/api/security-subcategorytemplate-get.md +++ b/api-reference/beta/api/security-subcategorytemplate-get.md @@ -30,7 +30,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +GET /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId} ``` ## Optional query parameters @@ -59,7 +59,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/beta/security/labels/retentionLabels/82d00422-1f60-46cd-9809-33ca0b4d2286/descriptors/categoryTemplate/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0 +GET https://graph.microsoft.com/beta/security/labels/categories/82d00422-1f60-46cd-9809-33ca0b4d2286/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0 ``` # [Java](#tab/java) 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 9f70c6e5249..edbe7be90f2 100644 --- a/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md +++ b/api-reference/v1.0/api/security-categorytemplate-delete-subcategories.md @@ -28,7 +28,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -DELETE /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId}/$ref +DELETE /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId}/$ref ``` ## Request headers @@ -54,7 +54,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +DELETE https://graph.microsoft.com/v1.0/security/labels/categories/f44dkle55-6baf-44ff-5dcc-08d8de97b1d5/subCategories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` ### Response diff --git a/api-reference/v1.0/api/security-categorytemplate-get.md b/api-reference/v1.0/api/security-categorytemplate-get.md index 2e71f6d1516..45dda793f39 100644 --- a/api-reference/v1.0/api/security-categorytemplate-get.md +++ b/api-reference/v1.0/api/security-categorytemplate-get.md @@ -33,7 +33,7 @@ GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemp ``` ## 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). +This method supports some of the OData query parameters to help customize the response. For example, to retrieve the **subategories** property associated with this particular category, you can use the `expand` parameter:`$expand=subcategories`. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers |Name|Description| diff --git a/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md index 0a9ab820214..9e8392f87e4 100644 --- a/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md +++ b/api-reference/v1.0/api/security-categorytemplate-list-subcategories.md @@ -28,7 +28,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +GET /security/labels/categories/{categoryTemplateId}/subCategories ``` ## Optional query parameters @@ -57,7 +57,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +GET https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId}/subCategories ``` diff --git a/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md b/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md index d358e2c3073..70815a309c4 100644 --- a/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md +++ b/api-reference/v1.0/api/security-categorytemplate-post-subcategories.md @@ -28,7 +28,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -POST /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +POST /security/labels/categories/{categoryTemplateId}/subCategories ``` ## Request headers @@ -64,7 +64,7 @@ The following is an example of a request. } --> ``` http -POST https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories +POST https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId}/subCategories Content-Type: application/json { diff --git a/api-reference/v1.0/api/security-labelsroot-delete-authorities.md b/api-reference/v1.0/api/security-labelsroot-delete-authorities.md index f620a54e8a4..5efd8e08532 100644 --- a/api-reference/v1.0/api/security-labelsroot-delete-authorities.md +++ b/api-reference/v1.0/api/security-labelsroot-delete-authorities.md @@ -55,7 +55,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/v1.0/security/labels/authorities/{authorityTemplateId} +DELETE https://graph.microsoft.com/v1.0/security/labels/authorities/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` diff --git a/api-reference/v1.0/api/security-labelsroot-delete-categories.md b/api-reference/v1.0/api/security-labelsroot-delete-categories.md index 0e550e7bbd3..fe1135e4edb 100644 --- a/api-reference/v1.0/api/security-labelsroot-delete-categories.md +++ b/api-reference/v1.0/api/security-labelsroot-delete-categories.md @@ -55,7 +55,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/v1.0/security/labels/categories/{categoryTemplateId} +DELETE https://graph.microsoft.com/v1.0/security/labels/categories/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` diff --git a/api-reference/v1.0/api/security-labelsroot-delete-citations.md b/api-reference/v1.0/api/security-labelsroot-delete-citations.md index 9007253db73..b136a0a9627 100644 --- a/api-reference/v1.0/api/security-labelsroot-delete-citations.md +++ b/api-reference/v1.0/api/security-labelsroot-delete-citations.md @@ -55,7 +55,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/v1.0/security/labels/citations/{citationTemplateId} +DELETE https://graph.microsoft.com/v1.0/security/labels/citations/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` ### Response diff --git a/api-reference/v1.0/api/security-labelsroot-delete-departments.md b/api-reference/v1.0/api/security-labelsroot-delete-departments.md index b6470eb4671..3ffe485f9e7 100644 --- a/api-reference/v1.0/api/security-labelsroot-delete-departments.md +++ b/api-reference/v1.0/api/security-labelsroot-delete-departments.md @@ -55,7 +55,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/v1.0/security/labels/departments/{departmentTemplateId} +DELETE https://graph.microsoft.com/v1.0/security/labels/departments/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` diff --git a/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md b/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md index 762b977c876..54baf18e389 100644 --- a/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md +++ b/api-reference/v1.0/api/security-labelsroot-delete-fileplanreferences.md @@ -55,7 +55,7 @@ The following is an example of a request. } --> ``` http -DELETE https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/{filePlanReferenceTemplateId} +DELETE https://graph.microsoft.com/v1.0/security/labels/filePlanReferences/6cf65e55-6baf-44ff-5dcc-08d8de97b1d5 ``` diff --git a/api-reference/v1.0/api/security-retentionlabel-get.md b/api-reference/v1.0/api/security-retentionlabel-get.md index 19e6bd46043..5bb5f9b9ab7 100644 --- a/api-reference/v1.0/api/security-retentionlabel-get.md +++ b/api-reference/v1.0/api/security-retentionlabel-get.md @@ -33,7 +33,7 @@ GET /security/triggers/retentionEvents/{retentionEventId}/labels/{retentionLabel ``` ## 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). +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` or `$expand=descriptors`. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers |Name|Description| diff --git a/api-reference/v1.0/api/security-subcategorytemplate-get.md b/api-reference/v1.0/api/security-subcategorytemplate-get.md index c0c239cbc30..d19e8409c59 100644 --- a/api-reference/v1.0/api/security-subcategorytemplate-get.md +++ b/api-reference/v1.0/api/security-subcategorytemplate-get.md @@ -28,7 +28,7 @@ One of the following permissions is required to call this API. To learn more, in } --> ``` http -GET /security/labels/retentionLabels/{retentionLabelId}/descriptors/categoryTemplate/subCategories/{subCategoryTemplateId} +GET /security/labels/categories/{categoryTemplateId}/subCategories/{subCategoryTemplateId} ``` ## Optional query parameters @@ -57,7 +57,7 @@ The following is an example of a request. } --> ``` http -GET https://graph.microsoft.com/v1.0/security/labels/retentionLabels/82d00422-1f60-46cd-9809-33ca0b4d2286/descriptors/categoryTemplate/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0 +GET https://graph.microsoft.com/v1.0/security/labels/categories/82d00422-1f60-46cd-9809-33ca0b4d2286/subCategories/2ac39915-dbeb-e933-82e2-92b981835fa0 ``` From 1534f075f6272723269baada0d56f4b26262925c Mon Sep 17 00:00:00 2001 From: Angelgolfer-ms Date: Sat, 19 Aug 2023 01:07:50 -0700 Subject: [PATCH 025/204] Rewrote conceptual content in the overview topics. --- .../beta/resources/security-api-overview.md | 3 +-- .../security-recordsmanagement-overview.md | 18 +++++++++++++++--- .../v1.0/resources/security-api-overview.md | 2 +- .../security-recordsmanagement-overview.md | 19 ++++++++++++++++--- 4 files changed, 33 insertions(+), 9 deletions(-) diff --git a/api-reference/beta/resources/security-api-overview.md b/api-reference/beta/resources/security-api-overview.md index 6ffc5c8b223..929dc507021 100644 --- a/api-reference/beta/resources/security-api-overview.md +++ b/api-reference/beta/resources/security-api-overview.md @@ -134,8 +134,7 @@ The  [incident](security-incident.md) resource and its APIs allow you to sort ## Records management -Microsoft Graph [Records management APIs](../resources/security-recordsmanagement-overview.md) help admin and developers to maintain records management systems with labels that are created, updated, and deleted periodically. Further, you can use file plan descriptors to improve the manageability of these retention labels. You can use the retention labels API to configure retention settings of a label, for example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. - +Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retenton labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. ## Secure Score diff --git a/api-reference/beta/resources/security-recordsmanagement-overview.md b/api-reference/beta/resources/security-recordsmanagement-overview.md index ebec4e5833d..8a3a439e37b 100644 --- a/api-reference/beta/resources/security-recordsmanagement-overview.md +++ b/api-reference/beta/resources/security-recordsmanagement-overview.md @@ -14,11 +14,23 @@ The Microsoft Purview records management APIs help organizations manage retentio The records mangement solution is a part of the Microsoft Purview compliance center. ## Manage retention labels -Record Management admins and developers need to keep their record management systems updated to the appropriate periods and retention categories which translates to creating, updating and deleting retention labels periodically. Developers can use the Microsoft Graph to perform create, updated, delete and retrieve operations on the retention label entity. -This may include creating and maintaining file plan descriptors like “Authority”, “Category” and others. +Most organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content. + +You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period. + +In addition, you can use [file plan descriptors](security-fileplandescriptor.md) to supplement a retention label and improve the manageability and organization of Microsoft 365 content. Examples of file plan descriptors include [authority](security-authority.md), [citation](security-citation.md), and [department](security-department.md). ## Trigger events for an existing label -Retention labels may have their retention period tied to external events, for example – an employee leaving the company, a project completing or the fiscal year ending. When using events, external systems which are aware of this change or information can be used to drive our service to start the clock for the retention period of items labeled. The Microsoft Graph allows creation of event types to be used in retention labels as well as triggering the specific event instances that happen externally which need to start the clock for a certain event type. For example, when an employee (with an employee ID of 1234) leaves Contoso, the information is updated in the HR management system. Let us assume that from the date of leaving, employment documentation must be retained for 5 years. These documents already have the label “Personnel information” applied to them which is already configured to listen to events of the type 'Employee_departure'. The developer can then use the Microsoft Graph to trigger a new instance of the 'Employee_departure' event type with the criteria of 'ComplianceAssetID:1234' which will ensure any items which are using the 'Personnel information' retention label and have the employee ID of 1234 in the 'Compliance Asset' column, will get their 5 year retention period started from the date specified. +Some scenarios require starting a retention period for certain documents upon a specific event, such as an employee leaving an organization, a contract expiring, or the fiscal year ending. + +You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period. + +As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. For each employee record, apply a **retentionLabel** configured as follows: +- A display name of "Personnel information" +- Listen to the **retentionEventType** named "Employee departure" +- A **retentionDuration** of 1827 days (5 years) + +When an employee with an employee ID of 1234 leaves Contoso, the information is updated in the HR management system. The record management system can then use the records management API to trigger a new instance of **retentionEvent** with the "Employee departure" event type and the criteria of 'ComplianceAssetID:1234'. This way, any items using the "Personnel information" retention label and have the employee ID of 1234 in the 'Compliance Asset' column, gets their 5 year retention period started from the date specified. ## Entities The records management API includes the following key entities. diff --git a/api-reference/v1.0/resources/security-api-overview.md b/api-reference/v1.0/resources/security-api-overview.md index 0171fbef4b0..9c0669d9130 100644 --- a/api-reference/v1.0/resources/security-api-overview.md +++ b/api-reference/v1.0/resources/security-api-overview.md @@ -119,7 +119,7 @@ The Microsoft Graph threat assessment API helps organizations to assess the thre ## Records management -Microsoft Graph [Records management APIs](../resources/security-recordsmanagement-overview.md) help admin and developers to maintain records management systems with labels that are created, updated, and deleted periodically. Further, you can use file plan descriptors to improve the manageability of these retention labels. You can use the retention labels API to configure retention settings of a label, for example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. +Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let people effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retenton labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. ## Secure Score diff --git a/api-reference/v1.0/resources/security-recordsmanagement-overview.md b/api-reference/v1.0/resources/security-recordsmanagement-overview.md index ebec4e5833d..3e09d20e9ad 100644 --- a/api-reference/v1.0/resources/security-recordsmanagement-overview.md +++ b/api-reference/v1.0/resources/security-recordsmanagement-overview.md @@ -14,11 +14,24 @@ The Microsoft Purview records management APIs help organizations manage retentio The records mangement solution is a part of the Microsoft Purview compliance center. ## Manage retention labels -Record Management admins and developers need to keep their record management systems updated to the appropriate periods and retention categories which translates to creating, updating and deleting retention labels periodically. Developers can use the Microsoft Graph to perform create, updated, delete and retrieve operations on the retention label entity. -This may include creating and maintaining file plan descriptors like “Authority”, “Category” and others. +Most organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content. + +You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period. + +In addition, you can use [file plan descriptors](security-fileplandescriptor.md) to supplement a retention label and improve the manageability and organization of Microsoft 365 content. Examples of file plan descriptors include [authority](security-authority.md), [citation](security-citation.md), and [department](security-department.md). ## Trigger events for an existing label -Retention labels may have their retention period tied to external events, for example – an employee leaving the company, a project completing or the fiscal year ending. When using events, external systems which are aware of this change or information can be used to drive our service to start the clock for the retention period of items labeled. The Microsoft Graph allows creation of event types to be used in retention labels as well as triggering the specific event instances that happen externally which need to start the clock for a certain event type. For example, when an employee (with an employee ID of 1234) leaves Contoso, the information is updated in the HR management system. Let us assume that from the date of leaving, employment documentation must be retained for 5 years. These documents already have the label “Personnel information” applied to them which is already configured to listen to events of the type 'Employee_departure'. The developer can then use the Microsoft Graph to trigger a new instance of the 'Employee_departure' event type with the criteria of 'ComplianceAssetID:1234' which will ensure any items which are using the 'Personnel information' retention label and have the employee ID of 1234 in the 'Compliance Asset' column, will get their 5 year retention period started from the date specified. +Some scenarios require starting a retention period for certain documents upon a specific event, such as an employee leaving an organization, a contract expiring, or the fiscal year ending. + +You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period. + +As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. For each employee record, apply a **retentionLabel** configured as follows: +- A display name of "Personnel information" +- Listen to the **retentionEventType** named "Employee departure" +- A **retentionDuration** of 1827 days (5 years) + +When an employee with an employee ID of 1234 leaves Contoso, the information is updated in the HR management system. The record management system can then use the records management API to trigger a new instance of **retentionEvent** with the "Employee departure" event type and the criteria of 'ComplianceAssetID:1234'. This way, any items using the "Personnel information" retention label and have the employee ID of 1234 in the 'Compliance Asset' column, gets their 5 year retention period started from the date specified. + ## Entities The records management API includes the following key entities. From fa12d15b8440989233e50b84c516d0dcf8da2a4c Mon Sep 17 00:00:00 2001 From: Angelgolfer-ms Date: Wed, 23 Aug 2023 20:56:21 -0700 Subject: [PATCH 026/204] Clarify API overview section. Fix link text. --- .../security-recordsmanagement-overview.md | 14 ++++++++------ .../beta/resources/security-retentionevent.md | 2 +- .../security-recordsmanagement-overview.md | 14 ++++++++------ 3 files changed, 17 insertions(+), 13 deletions(-) diff --git a/api-reference/beta/resources/security-recordsmanagement-overview.md b/api-reference/beta/resources/security-recordsmanagement-overview.md index 8a3a439e37b..0301e5d8da0 100644 --- a/api-reference/beta/resources/security-recordsmanagement-overview.md +++ b/api-reference/beta/resources/security-recordsmanagement-overview.md @@ -14,7 +14,7 @@ The Microsoft Purview records management APIs help organizations manage retentio The records mangement solution is a part of the Microsoft Purview compliance center. ## Manage retention labels -Most organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content. +Many organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content. You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period. @@ -25,12 +25,14 @@ Some scenarios require starting a retention period for certain documents upon a You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period. -As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. For each employee record, apply a **retentionLabel** configured as follows: -- A display name of "Personnel information" -- Listen to the **retentionEventType** named "Employee departure" -- A **retentionDuration** of 1827 days (5 years) +As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. Use the **retentionLabel** and **retentionEvent** APIs to do the following for each employee record when the employee starts: +1. Apply a **retentionLabel** configured as follows: + - A display name of "Personnel information" + - A **retentionDuration** of 1827 days (5 years) + - Listening to the **retentionEventType** named "Employee departure" +2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventqueries.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event. -When an employee with an employee ID of 1234 leaves Contoso, the information is updated in the HR management system. The record management system can then use the records management API to trigger a new instance of **retentionEvent** with the "Employee departure" event type and the criteria of 'ComplianceAssetID:1234'. This way, any items using the "Personnel information" retention label and have the employee ID of 1234 in the 'Compliance Asset' column, gets their 5 year retention period started from the date specified. +When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventqueries.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event. ## Entities The records management API includes the following key entities. diff --git a/api-reference/beta/resources/security-retentionevent.md b/api-reference/beta/resources/security-retentionevent.md index 2a17ff41529..5155e08a7c7 100644 --- a/api-reference/beta/resources/security-retentionevent.md +++ b/api-reference/beta/resources/security-retentionevent.md @@ -36,7 +36,7 @@ To learn more about it, see [Start retention when an event occurs](/microsoft-36 |description|String|Optional information about the event.| |displayName|String|Name of the event.| |eventPropagationResult|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md)|Represents the success status of a created event and additional information.| -|eventQueries|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|eventQueries|[microsoft.graph.security.eventQuery](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| |retentionEventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md) collection|Status of event propogation to the scoped locations after the event has been created.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |id|String|Represents the unique ID of the user who created the retentionEvent. [entity](/graph/api/resources/entity).| diff --git a/api-reference/v1.0/resources/security-recordsmanagement-overview.md b/api-reference/v1.0/resources/security-recordsmanagement-overview.md index 3e09d20e9ad..e62abc34511 100644 --- a/api-reference/v1.0/resources/security-recordsmanagement-overview.md +++ b/api-reference/v1.0/resources/security-recordsmanagement-overview.md @@ -14,7 +14,7 @@ The Microsoft Purview records management APIs help organizations manage retentio The records mangement solution is a part of the Microsoft Purview compliance center. ## Manage retention labels -Most organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content. +Many organizations need to manage their data to comply with industry regulations and internal policies, reduce risks of litigation or security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. Managing data commonly involves appropriately retaining or deleting different types of content. You can use [retention labels](security-retentionlabel.md) to configure retention and deletion settings for Microsoft 365 content. For example, you can set retention periods from when the content was labeled and you can set disposition review as the action at the end of the retention period. @@ -25,12 +25,14 @@ Some scenarios require starting a retention period for certain documents upon a You can use the [retentionLabel](security-retentionlabel.md) resource to support event-based retention, by setting the **retentionTrigger** property as `dateOfEvent` and associating the label with a [retentionEventType](security-retentioneventtype.md) resource. A [retentionEvent](security-retentionevent.md) is associated with a **retentionEventType** as well. When a triggering event happens, only content with that retention label applied is retained for the specified retention period. -As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. For each employee record, apply a **retentionLabel** configured as follows: -- A display name of "Personnel information" -- Listen to the **retentionEventType** named "Employee departure" -- A **retentionDuration** of 1827 days (5 years) +As an example: in an organization, when an employee leaves, employment records must be retained for 5 years. Use the **retentionLabel** and **retentionEvent** APIs to do the following for each employee record when the employee starts: +1. Apply a **retentionLabel** configured as follows: + - A display name of "Personnel information" + - A **retentionDuration** of 1827 days (5 years) + - Listening to the **retentionEventType** named "Employee departure" +2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventquery.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event. -When an employee with an employee ID of 1234 leaves Contoso, the information is updated in the HR management system. The record management system can then use the records management API to trigger a new instance of **retentionEvent** with the "Employee departure" event type and the criteria of 'ComplianceAssetID:1234'. This way, any items using the "Personnel information" retention label and have the employee ID of 1234 in the 'Compliance Asset' column, gets their 5 year retention period started from the date specified. +When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventquery.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event. ## Entities From 8da2da846676e3c645357eeab0a199b3b8824f76 Mon Sep 17 00:00:00 2001 From: Angelgolfer-ms Date: Wed, 23 Aug 2023 22:23:15 -0700 Subject: [PATCH 027/204] Fix references to wrong type name ...eventQueries. --- api-reference/beta/resources/security-eventqueries.md | 4 ++-- api-reference/beta/resources/security-retentionevent.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/api-reference/beta/resources/security-eventqueries.md b/api-reference/beta/resources/security-eventqueries.md index bd49d6666b7..9803f2ffc79 100644 --- a/api-reference/beta/resources/security-eventqueries.md +++ b/api-reference/beta/resources/security-eventqueries.md @@ -28,12 +28,12 @@ None. The following is a JSON representation of the resource. ``` json { - "@odata.type": "#microsoft.graph.security.eventQueries", + "@odata.type": "#microsoft.graph.security.eventQuery", "queryType": "String", "query": "String" } diff --git a/api-reference/beta/resources/security-retentionevent.md b/api-reference/beta/resources/security-retentionevent.md index 5155e08a7c7..1dcffe85133 100644 --- a/api-reference/beta/resources/security-retentionevent.md +++ b/api-reference/beta/resources/security-retentionevent.md @@ -67,7 +67,7 @@ The following is a JSON representation of the resource. "description": "String", "eventQueries": [ { - "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", From 05668dbf4fc31ae7c50f27949f7c01013ea426b3 Mon Sep 17 00:00:00 2001 From: Angelgolfer-ms Date: Wed, 23 Aug 2023 22:57:09 -0700 Subject: [PATCH 028/204] More fixes for ...eventQuery not ...eventQueries. --- api-reference/beta/api/security-retentionevent-get.md | 2 +- api-reference/beta/api/security-retentionevent-list.md | 2 +- api-reference/beta/api/security-retentionevent-post.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/api-reference/beta/api/security-retentionevent-get.md b/api-reference/beta/api/security-retentionevent-get.md index dd49d34d638..4fc5b2479c5 100644 --- a/api-reference/beta/api/security-retentionevent-get.md +++ b/api-reference/beta/api/security-retentionevent-get.md @@ -116,7 +116,7 @@ Content-Type: application/json "description": "String", "eventQueries": [ { - "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", diff --git a/api-reference/beta/api/security-retentionevent-list.md b/api-reference/beta/api/security-retentionevent-list.md index 43ee67b43ca..b8b4f9a5af8 100644 --- a/api-reference/beta/api/security-retentionevent-list.md +++ b/api-reference/beta/api/security-retentionevent-list.md @@ -119,7 +119,7 @@ Content-Type: application/json "description": "String", "eventQueries": [ { - "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", diff --git a/api-reference/beta/api/security-retentionevent-post.md b/api-reference/beta/api/security-retentionevent-post.md index 729db438c1f..8f935d55235 100644 --- a/api-reference/beta/api/security-retentionevent-post.md +++ b/api-reference/beta/api/security-retentionevent-post.md @@ -48,7 +48,7 @@ Specify the following properties when creating a **retentionEvent**. |:---|:---|:---| |description|String|Optional information about the event.| |displayName|String|Name of the event.| -|eventQuery|[microsoft.graph.security.eventQueries](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|eventQuery|[microsoft.graph.security.eventQuery](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |retentionEventType|String|Name of the event type associated with the event.| @@ -77,7 +77,7 @@ Content-length: 616 "description": "String", "eventQueries": [ { - "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", @@ -150,7 +150,7 @@ Content-Type: application/json "description": "String", "eventQueries": [ { - "@odata.type": "microsoft.graph.security.eventQueries" + "@odata.type": "microsoft.graph.security.eventQuery" } ], "eventTriggerDateTime": "String (timestamp)", From a28d3072814e72bfe5ca209db3891fd36d4cfea1 Mon Sep 17 00:00:00 2001 From: Angelgolfer-ms Date: Wed, 23 Aug 2023 23:20:35 -0700 Subject: [PATCH 029/204] Fixed link text typo. --- api-reference/beta/resources/security-api-overview.md | 2 +- api-reference/v1.0/resources/security-api-overview.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/beta/resources/security-api-overview.md b/api-reference/beta/resources/security-api-overview.md index 929dc507021..751d40556e0 100644 --- a/api-reference/beta/resources/security-api-overview.md +++ b/api-reference/beta/resources/security-api-overview.md @@ -134,7 +134,7 @@ The  [incident](security-incident.md) resource and its APIs allow you to sort ## Records management -Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retenton labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. +Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. ## Secure Score diff --git a/api-reference/v1.0/resources/security-api-overview.md b/api-reference/v1.0/resources/security-api-overview.md index 9c0669d9130..a00b183ce9e 100644 --- a/api-reference/v1.0/resources/security-api-overview.md +++ b/api-reference/v1.0/resources/security-api-overview.md @@ -119,7 +119,7 @@ The Microsoft Graph threat assessment API helps organizations to assess the thre ## Records management -Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let people effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retenton labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. +Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let people effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. ## Secure Score From b53eab40cb1a5ddae2069b8b7ad1c9fcaa39632b Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:19:08 -0700 Subject: [PATCH 030/204] Rename security-eventqueries.md to security-eventquery.md --- .../{security-eventqueries.md => security-eventquery.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename api-reference/beta/resources/{security-eventqueries.md => security-eventquery.md} (100%) diff --git a/api-reference/beta/resources/security-eventqueries.md b/api-reference/beta/resources/security-eventquery.md similarity index 100% rename from api-reference/beta/resources/security-eventqueries.md rename to api-reference/beta/resources/security-eventquery.md From 62ba6e2786c7b89a7328dd2dff77a8d1d03d70ca Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:21:02 -0700 Subject: [PATCH 031/204] Update security-retentionevent.md --- api-reference/beta/resources/security-retentionevent.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/beta/resources/security-retentionevent.md b/api-reference/beta/resources/security-retentionevent.md index 1dcffe85133..401941522eb 100644 --- a/api-reference/beta/resources/security-retentionevent.md +++ b/api-reference/beta/resources/security-retentionevent.md @@ -36,7 +36,7 @@ To learn more about it, see [Start retention when an event occurs](/microsoft-36 |description|String|Optional information about the event.| |displayName|String|Name of the event.| |eventPropagationResult|[microsoft.graph.security.eventPropagationResult](../resources/security-eventpropagationresult.md)|Represents the success status of a created event and additional information.| -|eventQueries|[microsoft.graph.security.eventQuery](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|eventQuery|[microsoft.graph.security.eventQuery](../resources/security-eventquery.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| |retentionEventStatus|[microsoft.graph.security.retentionEventStatus](../resources/security-retentioneventstatus.md) collection|Status of event propogation to the scoped locations after the event has been created.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |id|String|Represents the unique ID of the user who created the retentionEvent. [entity](/graph/api/resources/entity).| @@ -89,4 +89,4 @@ The following is a JSON representation of the resource. }, "lastStatusUpdateDateTime": "String (timestamp)" } -``` \ No newline at end of file +``` From d2072b2711793d25315d684f3edf9792e6e258de Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:21:54 -0700 Subject: [PATCH 032/204] Update security-authoritytemplate.md --- api-reference/beta/resources/security-authoritytemplate.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/resources/security-authoritytemplate.md b/api-reference/beta/resources/security-authoritytemplate.md index 77e291ff8f6..00652cabdd6 100644 --- a/api-reference/beta/resources/security-authoritytemplate.md +++ b/api-reference/beta/resources/security-authoritytemplate.md @@ -11,6 +11,8 @@ doc_type: resourcePageType Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Supports CRUD operations to apply and manage the [authority](security-authority.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **authority** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). From 501a09652a26e95cccbd4c0d7e1ef00c70bd6237 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:26:12 -0700 Subject: [PATCH 033/204] Update security-categorytemplate-post-subcategories.md --- .../beta/api/security-categorytemplate-post-subcategories.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/api/security-categorytemplate-post-subcategories.md b/api-reference/beta/api/security-categorytemplate-post-subcategories.md index 94a8c471e94..83b8173f589 100644 --- a/api-reference/beta/api/security-categorytemplate-post-subcategories.md +++ b/api-reference/beta/api/security-categorytemplate-post-subcategories.md @@ -10,6 +10,8 @@ doc_type: apiPageType # Create subCategoryTemplate Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Create a new [subCategoryTemplate](../resources/security-subcategorytemplate.md) object. ## Permissions From a7d18fc1313c490c1993815382a7ec64ca376dbd Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:28:01 -0700 Subject: [PATCH 034/204] Update security-labelsroot-post-categories.md --- api-reference/beta/api/security-labelsroot-post-categories.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/api/security-labelsroot-post-categories.md b/api-reference/beta/api/security-labelsroot-post-categories.md index 8be9d47c9e0..0f52174ec6f 100644 --- a/api-reference/beta/api/security-labelsroot-post-categories.md +++ b/api-reference/beta/api/security-labelsroot-post-categories.md @@ -10,6 +10,8 @@ doc_type: apiPageType # Create categoryTemplate Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Create a new [categoryTemplate](../resources/security-categorytemplate.md) object. ## Permissions From 2f5454324e4f2a78d0e3f14c702109b9ccc463f6 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:28:51 -0700 Subject: [PATCH 035/204] Update security-labelsroot-post-citations.md --- api-reference/beta/api/security-labelsroot-post-citations.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/api/security-labelsroot-post-citations.md b/api-reference/beta/api/security-labelsroot-post-citations.md index 2ae902d7330..5672cd5ac8d 100644 --- a/api-reference/beta/api/security-labelsroot-post-citations.md +++ b/api-reference/beta/api/security-labelsroot-post-citations.md @@ -10,6 +10,8 @@ doc_type: apiPageType # Create citationTemplate Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Create a new [citationTemplate](../resources/security-citationtemplate.md) object. ## Permissions From 4d6e6d3480354ffbe643f36fc088c8620078de6e Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:29:41 -0700 Subject: [PATCH 036/204] Update security-labelsroot-post-authorities.md --- api-reference/beta/api/security-labelsroot-post-authorities.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/api/security-labelsroot-post-authorities.md b/api-reference/beta/api/security-labelsroot-post-authorities.md index dd637f883ad..be983f9477c 100644 --- a/api-reference/beta/api/security-labelsroot-post-authorities.md +++ b/api-reference/beta/api/security-labelsroot-post-authorities.md @@ -10,6 +10,8 @@ doc_type: apiPageType # Create authorityTemplate Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Create a new [authorityTemplate](../resources/security-authoritytemplate.md) object. ## Permissions From 772fe971f8c0a6f590005cac555d7a28b78c1840 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:30:53 -0700 Subject: [PATCH 037/204] Update security-labelsroot-post-departments.md --- api-reference/beta/api/security-labelsroot-post-departments.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/api/security-labelsroot-post-departments.md b/api-reference/beta/api/security-labelsroot-post-departments.md index f78d8579268..f18ed1fec07 100644 --- a/api-reference/beta/api/security-labelsroot-post-departments.md +++ b/api-reference/beta/api/security-labelsroot-post-departments.md @@ -10,6 +10,8 @@ doc_type: apiPageType # Create departmentTemplate Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Create a new [departmentTemplate](../resources/security-departmenttemplate.md) object. ## Permissions From 67ddad36cbe14c73d91781e59aa275356e6ed453 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:31:42 -0700 Subject: [PATCH 038/204] Update security-labelsroot-post-fileplanreferences.md --- .../beta/api/security-labelsroot-post-fileplanreferences.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md b/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md index 0d680980595..d932f8e3c0d 100644 --- a/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md +++ b/api-reference/beta/api/security-labelsroot-post-fileplanreferences.md @@ -10,6 +10,8 @@ doc_type: apiPageType # Create filePlanReferenceTemplate Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Create a new [filePlanReferenceTemplate](../resources/security-fileplanreferencetemplate.md) object. ## Permissions From ae449432a66c318522953b6e6f0f9261c3497589 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:33:57 -0700 Subject: [PATCH 039/204] Update security-departmenttemplate.md --- api-reference/beta/resources/security-departmenttemplate.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/resources/security-departmenttemplate.md b/api-reference/beta/resources/security-departmenttemplate.md index cb8ed7f0115..1f3881fd084 100644 --- a/api-reference/beta/resources/security-departmenttemplate.md +++ b/api-reference/beta/resources/security-departmenttemplate.md @@ -11,6 +11,8 @@ doc_type: resourcePageType Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Supports CRUD operations to apply and manage the [department](security-department.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **department** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). From 6ef4d87c4e26cc5dc5970cc9b92542fd2490120c Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:35:44 -0700 Subject: [PATCH 040/204] Update security-fileplandescriptortemplate.md --- .../beta/resources/security-fileplandescriptortemplate.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/resources/security-fileplandescriptortemplate.md b/api-reference/beta/resources/security-fileplandescriptortemplate.md index 3cd35c6276a..ee089007449 100644 --- a/api-reference/beta/resources/security-fileplandescriptortemplate.md +++ b/api-reference/beta/resources/security-fileplandescriptortemplate.md @@ -11,6 +11,8 @@ doc_type: resourcePageType Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Specifies the properties common to the template resources for file plan descriptors. Base type for each of the template resources: [authorityTemplate](security-authoritytemplate.md), [categoryTemplate](security-categorytemplate.md), [citationTemplate](security-citationtemplate.md), [departmentTemplate](security-departmenttemplate.md), [filePlanReferenceTemplate](security-fileplanreferencetemplate.md), and [subCategoryTemplate](security-subcategorytemplate.md). Inherits from [microsoft.graph.entity](../resources/entity.md). From 10e9ed9f2305e3d53d774b161a28bf19efcc83c4 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:36:49 -0700 Subject: [PATCH 041/204] Update security-citationtemplate.md --- api-reference/beta/resources/security-citationtemplate.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/resources/security-citationtemplate.md b/api-reference/beta/resources/security-citationtemplate.md index 30bd7aab03b..21ebf3593c3 100644 --- a/api-reference/beta/resources/security-citationtemplate.md +++ b/api-reference/beta/resources/security-citationtemplate.md @@ -11,6 +11,8 @@ doc_type: resourcePageType Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Supports CRUD operations to apply and manage the [citation](security-citation.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **citation** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). From 0d67883143432206331dcc056b724f7f42c310d8 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:37:13 -0700 Subject: [PATCH 042/204] Update security-categorytemplate.md --- api-reference/beta/resources/security-categorytemplate.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/resources/security-categorytemplate.md b/api-reference/beta/resources/security-categorytemplate.md index 0ec57682a16..290f20c7a37 100644 --- a/api-reference/beta/resources/security-categorytemplate.md +++ b/api-reference/beta/resources/security-categorytemplate.md @@ -11,6 +11,8 @@ doc_type: resourcePageType Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Supports CRUD operations to apply and manage the [appliedCategory](security-appliedcategory.md) descriptor, and any [subCategory](security-subcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). These file plan descriptors supplement a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). From 181fbaed617281405f7126e9b6f7ebf25fd23680 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:37:39 -0700 Subject: [PATCH 043/204] Update security-subcategorytemplate.md --- api-reference/beta/resources/security-subcategorytemplate.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/resources/security-subcategorytemplate.md b/api-reference/beta/resources/security-subcategorytemplate.md index e607c82afd9..b26fa4bc743 100644 --- a/api-reference/beta/resources/security-subcategorytemplate.md +++ b/api-reference/beta/resources/security-subcategorytemplate.md @@ -11,6 +11,8 @@ doc_type: resourcePageType Namespace: microsoft.graph.security +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + Supports CRUD operations to apply and manage the [subCategory](security-subcategory.md) descriptor for a [retentionLabel](security-retentionlabel.md). The **subCategory** file plan descriptor supplements a retention label to improve the manageability and organization of Microsoft 365 content. Inherits from [microsoft.graph.security.filePlanDescriptorTemplate](../resources/security-fileplandescriptorTemplate.md). From c3011c86dac367ecfb3aa9ae0062628a28bb5ebf Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:38:35 -0700 Subject: [PATCH 044/204] Update security-recordsmanagement-overview.md --- .../beta/resources/security-recordsmanagement-overview.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/api-reference/beta/resources/security-recordsmanagement-overview.md b/api-reference/beta/resources/security-recordsmanagement-overview.md index 0301e5d8da0..241ae4d850f 100644 --- a/api-reference/beta/resources/security-recordsmanagement-overview.md +++ b/api-reference/beta/resources/security-recordsmanagement-overview.md @@ -9,6 +9,8 @@ doc_type: conceptualPageType # Use the Microsoft Graph records management APIs +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] + The Microsoft Purview records management APIs help organizations manage retention and deletion of data to meet their legal obligations and compliance regulations, and increases efficiency by enabling the regular disposition of items that no longer have to be retained. The records mangement solution is a part of the Microsoft Purview compliance center. From 6110e8f01a4f76253e55aaf77b30b1fabaf0d77e Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:41:26 -0700 Subject: [PATCH 045/204] Update security-recordsmanagement-overview.md --- .../beta/resources/security-recordsmanagement-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/beta/resources/security-recordsmanagement-overview.md b/api-reference/beta/resources/security-recordsmanagement-overview.md index 241ae4d850f..a5a7f574ce6 100644 --- a/api-reference/beta/resources/security-recordsmanagement-overview.md +++ b/api-reference/beta/resources/security-recordsmanagement-overview.md @@ -32,9 +32,9 @@ As an example: in an organization, when an employee leaves, employment records m - A display name of "Personnel information" - A **retentionDuration** of 1827 days (5 years) - Listening to the **retentionEventType** named "Employee departure" -2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventqueries.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event. +2. Define a **retentionEvent** with the same **retentionEventType** named "Employee departure", and as part of its [eventQuery](security-eventquery.md) collection, an `Asset ID` with an employee ID value as the ID information associated with the event. -When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventqueries.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event. +When an employee with an ID of 1234 leaves Contoso, the information is updated in the HR management system. The employee departure can trigger a new instance of **retentionEvent** with the "Employee departure" event type, and as part of its **eventQueries** property, an [eventQuery](security-eventquery.md) with a query string of 'AssetID:1234'. This way, employee record items using the "Personnel information" retention label and associated with the employee ID of 1234 get their 5 year retention period started from the date of the employee departure event. ## Entities The records management API includes the following key entities. From 98636abe5b80abe4d40baa6f1f8a469b833ca595 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:42:35 -0700 Subject: [PATCH 046/204] Update security-retentionevent-post.md --- api-reference/beta/api/security-retentionevent-post.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-retentionevent-post.md b/api-reference/beta/api/security-retentionevent-post.md index 8f935d55235..14fe4ae1036 100644 --- a/api-reference/beta/api/security-retentionevent-post.md +++ b/api-reference/beta/api/security-retentionevent-post.md @@ -48,7 +48,7 @@ Specify the following properties when creating a **retentionEvent**. |:---|:---|:---| |description|String|Optional information about the event.| |displayName|String|Name of the event.| -|eventQuery|[microsoft.graph.security.eventQuery](../resources/security-eventqueries.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| +|eventQuery|[microsoft.graph.security.eventQuery](../resources/security-eventquery.md) collection| Represents the workload (SharePoint Online, OneDrive for Business, Exchange Online) and identification information associated with a retention event.| |eventTriggerDateTime|DateTimeOffset|Optional time when the event should be triggered.| |retentionEventType|String|Name of the event type associated with the event.| From de172053f84ee1b0086e6bc423460e6158191b86 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:55:30 -0700 Subject: [PATCH 047/204] Update security-labelsroot-list-retentionlabel.md --- ...security-labelsroot-list-retentionlabel.md | 35 +++++++++++-------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/api-reference/beta/api/security-labelsroot-list-retentionlabel.md b/api-reference/beta/api/security-labelsroot-list-retentionlabel.md index 01c36f62c28..85eb2e091db 100644 --- a/api-reference/beta/api/security-labelsroot-list-retentionlabel.md +++ b/api-reference/beta/api/security-labelsroot-list-retentionlabel.md @@ -119,26 +119,33 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", - "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": "730" }, - "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", + "isInUse": "true", + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)", + "createdDateTime": "2017-11-27T02:10:12Z", "lastModifiedBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } }, - "lastModifiedDateTime": "String (timestamp)", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String" + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" } ] } From 9d6d6b6356235bc94976299ffc85e648fd2bd160 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:56:34 -0700 Subject: [PATCH 048/204] Update security-labelsroot-list-retentionlabel.md --- ...security-labelsroot-list-retentionlabel.md | 35 +++++++++++-------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md index e807d24f709..1b78339def5 100644 --- a/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md +++ b/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md @@ -83,26 +83,33 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", - "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": "730" }, - "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", + "isInUse": "true", + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } }, - "createdDateTime": "String (timestamp)", + "createdDateTime": "2017-11-27T02:10:12Z", "lastModifiedBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } }, - "lastModifiedDateTime": "String (timestamp)", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String" + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" } ] } From f09468c7ebd06dd571e7300e07b418240360f204 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:58:59 -0700 Subject: [PATCH 049/204] Update security-retentionlabel-get.md --- .../v1.0/api/security-retentionlabel-get.md | 47 +++++++++++-------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/api-reference/v1.0/api/security-retentionlabel-get.md b/api-reference/v1.0/api/security-retentionlabel-get.md index 5bb5f9b9ab7..bdbd4e2ae18 100644 --- a/api-reference/v1.0/api/security-retentionlabel-get.md +++ b/api-reference/v1.0/api/security-retentionlabel-get.md @@ -76,26 +76,33 @@ 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" + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": "730" + }, + "isInUse": "true", + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2017-11-27T02:10:12Z", + "lastModifiedBy": { + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } + }, + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" } } ``` From 234d40b6aa70c1a82ab0592e16aae60a43c8d037 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 16:59:30 -0700 Subject: [PATCH 050/204] Update security-retentionlabel-get.md --- .../beta/api/security-retentionlabel-get.md | 47 +++++++++++-------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/api-reference/beta/api/security-retentionlabel-get.md b/api-reference/beta/api/security-retentionlabel-get.md index 4fa1a4b00ed..e2106da280a 100644 --- a/api-reference/beta/api/security-retentionlabel-get.md +++ b/api-reference/beta/api/security-retentionlabel-get.md @@ -113,26 +113,33 @@ 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" + "displayName": "Retention Schedule 10004", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "relabel", + "retentionTrigger": "dateCreated", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDurationInDays", + "days": "730" + }, + "isInUse": "true", + "descriptionForAdmins": "creation based retention label for schedule 10004", + "descriptionForUsers": "retains for 2 years then relabeled", + "createdBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Admin" + } + }, + "createdDateTime": "2017-11-27T02:10:12Z", + "lastModifiedBy": { + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Records Manager" + } + }, + "lastModifiedDateTime": "2020-08-28T22:13:09Z", + "labelToBeApplied": "Retention schedule 10005", + "defaultRecordBehavior": "startLocked" } } ``` From 924f7029b1e3f3b4b26e8f0ff602a4dc67517314 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:20:56 -0700 Subject: [PATCH 051/204] Update security-labelsroot-post-retentionlabel.md --- ...security-labelsroot-post-retentionlabel.md | 74 +++++++++++-------- 1 file changed, 45 insertions(+), 29 deletions(-) diff --git a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md index df324a2c88c..e53cbf8475c 100644 --- a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md @@ -82,21 +82,26 @@ Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", - "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", + "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')" "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "days": 2555 }, - "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "labelToBeApplied": "String", - "defaultRecordBehavior": "String", + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", "descriptors": { "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')", "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')", @@ -104,6 +109,7 @@ Content-length: 555 "departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')", "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')" }, + "defaultRecordBehavior":"startLocked", } ``` @@ -157,26 +163,36 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", - "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "days": 2555 }, - "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "isInUse": "true", + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", + "defaultRecordBehavior":"startLocked", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)", - "lastModifiedBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Admin" + } }, - "lastModifiedDateTime": "String (timestamp)", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String", + "createdDateTime": "2021-08-23T16:43:55Z", + "labelToBeApplied": " ", + "defaultRecordBehavior": "startLocked", "descriptors": { "authority": { "displayName": "Business" From 283756c20bf2ffaafca82b2e59c08462857cf7d9 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:23:45 -0700 Subject: [PATCH 052/204] Update security-labelsroot-post-retentionlabel.md --- ...security-labelsroot-post-retentionlabel.md | 84 +++++++++++-------- 1 file changed, 50 insertions(+), 34 deletions(-) diff --git a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md index 0e605760810..8633909a8df 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md @@ -80,28 +80,34 @@ Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", - "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", + "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')" "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "days": 2555 }, - "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", - "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "labelToBeApplied": "String", - "defaultRecordBehavior": "String", + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", "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')" + "authorityTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/authorities('fie3f4fc-b966-4c40-94de-fb8a383658e4')", + "categoryTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/categories('0bjk8-b966-4c40-94de-fb8a383658e4')", + "citationTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/citations('0e23f4fc-b966-4c40-94de-fb8a383658e4')", + "departmentTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/departments('p99ef4fc-b966-4c40-94de-fb8a383658e4')", + "filePlanReferenceTemplate@odata.bind" : "https://graph.microsoft.com/beta/security/labels/filePlanReferences('e095f4fc-b966-4c40-94de-fb8a383658e4')" }, + "defaultRecordBehavior":"startLocked", } ``` @@ -122,26 +128,36 @@ Content-Type: application/json { "@odata.type": "#microsoft.graph.security.retentionLabel", "id": "64a99fb4-07be-0481-8746-44c15c0eef1f", - "displayName": "String", - "behaviorDuringRetentionPeriod": "String", - "actionAfterRetentionPeriod": "String", - "retentionTrigger": "String", + "displayName": "Retention Schedule 10005", + "behaviorDuringRetentionPeriod": "retain", + "actionAfterRetentionPeriod": "startDispositionReview", + "retentionTrigger": "dateOfEvent", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "days": 2555 }, - "isInUse": "Boolean", - "descriptionForAdmins": "String", - "descriptionForUsers": "String", + "dispositionReviewStages": [ + { + "stageNumber" : 1, + "name": "Stage1", + "reviewersEmailAddresses ": [ + "Admin@contoso.onmicrosoft.com" + ] + } + ], + "isInUse": "true", + "descriptionForAdmins": "retain for 7 years", + "descriptionForUsers": "retain for 7 years", + "defaultRecordBehavior":"startLocked", "createdBy": { - "@odata.type": "microsoft.graph.identitySet" - }, - "createdDateTime": "String (timestamp)", - "lastModifiedBy": { - "@odata.type": "microsoft.graph.identitySet" + "user": { + "id": "9563a605-e827-4324-a5a9-09efddff1e90", + "displayName": "Admin" + } }, - "lastModifiedDateTime": "String (timestamp)", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String", + "createdDateTime": "2021-08-23T16:43:55Z", + "labelToBeApplied": " ", + "defaultRecordBehavior": "startLocked", "descriptors": { "authority": { "displayName": "Business" From 4f92875e7666ba3036bd278b5052e6a1e0703940 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:24:55 -0700 Subject: [PATCH 053/204] Update security-retentionlabel-delete.md --- api-reference/beta/api/security-retentionlabel-delete.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-retentionlabel-delete.md b/api-reference/beta/api/security-retentionlabel-delete.md index 8ddf556784b..32fa975845a 100644 --- a/api-reference/beta/api/security-retentionlabel-delete.md +++ b/api-reference/beta/api/security-retentionlabel-delete.md @@ -57,7 +57,7 @@ If successful, this method returns a `204 No Content` response code. } --> ``` http -DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId} +DELETE https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 ``` # [C#](#tab/csharp) From 93e9d2882d454e5c423b288d65f1adc60997fa76 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:25:31 -0700 Subject: [PATCH 054/204] Update security-retentionlabel-delete.md --- api-reference/v1.0/api/security-retentionlabel-delete.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/security-retentionlabel-delete.md b/api-reference/v1.0/api/security-retentionlabel-delete.md index d64c3390b4c..41de60ab03d 100644 --- a/api-reference/v1.0/api/security-retentionlabel-delete.md +++ b/api-reference/v1.0/api/security-retentionlabel-delete.md @@ -55,7 +55,7 @@ If successful, this method returns a `204 No Content` response code. } --> ``` http -DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId} +DELETE https://graph.microsoft.com/v1.0/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 ``` From 2310724e52199c4569415abc110921bc643f41c2 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:38:08 -0700 Subject: [PATCH 055/204] Update security-retentionlabel-update.md --- .../api/security-retentionlabel-update.md | 29 ++++--------------- 1 file changed, 6 insertions(+), 23 deletions(-) diff --git a/api-reference/beta/api/security-retentionlabel-update.md b/api-reference/beta/api/security-retentionlabel-update.md index d242070287f..804c8536ef3 100644 --- a/api-reference/beta/api/security-retentionlabel-update.md +++ b/api-reference/beta/api/security-retentionlabel-update.md @@ -72,19 +72,16 @@ If successful, this method returns a `200 OK` response code and an updated [micr } --> ``` http -PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/{retentionLabelId} +PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 Content-Type: application/json Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "days": 2555 }, - "descriptionForAdmins": "String", - "descriptionForUsers": "String", - "labelToBeApplied": "String", - "defaultRecordBehavior": "String" } ``` @@ -123,27 +120,13 @@ Content-length: 555 --- ### 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" -} +HTTP/1.1 204 No Content ``` From e6fc6684a669d05cd582025bc448930f594b2271 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:40:04 -0700 Subject: [PATCH 056/204] Update security-retentionlabel-update.md --- .../api/security-retentionlabel-update.md | 29 ++++--------------- 1 file changed, 6 insertions(+), 23 deletions(-) diff --git a/api-reference/v1.0/api/security-retentionlabel-update.md b/api-reference/v1.0/api/security-retentionlabel-update.md index a626dd688d8..853013e472d 100644 --- a/api-reference/v1.0/api/security-retentionlabel-update.md +++ b/api-reference/v1.0/api/security-retentionlabel-update.md @@ -70,44 +70,27 @@ If successful, this method returns a `200 OK` response code and an updated [micr } --> ``` http -PATCH https://graph.microsoft.com/v1.0/security/labels/retentionLabels/{retentionLabelId} +PATCH https://graph.microsoft.com/beta/security/labels/retentionLabels/9563a605-e827-4324-a5a9-09efddff1e50 Content-Type: application/json Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration" + "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "days": 2555 }, - "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" -} +HTTP/1.1 204 No Content ``` From 9d37d7c93841087822e48f88c3bd4b5fdc52da94 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:44:37 -0700 Subject: [PATCH 057/204] Update security-labelsroot-post-retentionlabel.md --- .../beta/api/security-labelsroot-post-retentionlabel.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md index e53cbf8475c..56f0995fdb2 100644 --- a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md @@ -86,9 +86,9 @@ Content-length: 555 "behaviorDuringRetentionPeriod": "retain", "actionAfterRetentionPeriod": "startDispositionReview", "retentionTrigger": "dateOfEvent", - "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')" + "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": 2555 }, "dispositionReviewStages": [ From 1f10638197df345641076747dffd30f9096a4ebb Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:45:09 -0700 Subject: [PATCH 058/204] Update security-labelsroot-post-retentionlabel.md --- .../v1.0/api/security-labelsroot-post-retentionlabel.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md index 8633909a8df..f01a4fbe9f7 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md @@ -84,9 +84,9 @@ Content-length: 555 "behaviorDuringRetentionPeriod": "retain", "actionAfterRetentionPeriod": "startDispositionReview", "retentionTrigger": "dateOfEvent", - "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')" + "retentionEventType@odata.bind": "https://graph.microsoft.com/beta/security/triggerTypes/retentionEventTypes('e095f4fc-b966-4c40-94de-fb8a383658e4')", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": 2555 }, "dispositionReviewStages": [ From 186456834e2a54ebd2c0f255702f09425b2b4c6f Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:46:46 -0700 Subject: [PATCH 059/204] Update security-labelsroot-list-retentionlabel.md --- .../beta/api/security-labelsroot-list-retentionlabel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-labelsroot-list-retentionlabel.md b/api-reference/beta/api/security-labelsroot-list-retentionlabel.md index 85eb2e091db..3b16ec28ee7 100644 --- a/api-reference/beta/api/security-labelsroot-list-retentionlabel.md +++ b/api-reference/beta/api/security-labelsroot-list-retentionlabel.md @@ -127,7 +127,7 @@ Content-Type: application/json "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": "730" }, - "isInUse": "true", + "isInUse": true, "descriptionForAdmins": "creation based retention label for schedule 10004", "descriptionForUsers": "retains for 2 years then relabeled", "createdBy": { From 85b2bf7c1eb829a7ddf9bcda3a0da7b8be4f5a93 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:47:16 -0700 Subject: [PATCH 060/204] Update security-labelsroot-list-retentionlabel.md --- .../v1.0/api/security-labelsroot-list-retentionlabel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md index 1b78339def5..ab0a94c2c0c 100644 --- a/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md +++ b/api-reference/v1.0/api/security-labelsroot-list-retentionlabel.md @@ -91,7 +91,7 @@ Content-Type: application/json "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": "730" }, - "isInUse": "true", + "isInUse": true, "descriptionForAdmins": "creation based retention label for schedule 10004", "descriptionForUsers": "retains for 2 years then relabeled", "createdBy": { From 5f06f8046de8af62dcbf806b9fd99ec96f3610bb Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:48:22 -0700 Subject: [PATCH 061/204] Update security-retentionlabel-get.md --- api-reference/v1.0/api/security-retentionlabel-get.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/v1.0/api/security-retentionlabel-get.md b/api-reference/v1.0/api/security-retentionlabel-get.md index bdbd4e2ae18..8ecca6a6e05 100644 --- a/api-reference/v1.0/api/security-retentionlabel-get.md +++ b/api-reference/v1.0/api/security-retentionlabel-get.md @@ -82,9 +82,9 @@ Content-Type: application/json "retentionTrigger": "dateCreated", "retentionDuration": { "@odata.type": "microsoft.graph.security.retentionDurationInDays", - "days": "730" + "days": 730 }, - "isInUse": "true", + "isInUse": true, "descriptionForAdmins": "creation based retention label for schedule 10004", "descriptionForUsers": "retains for 2 years then relabeled", "createdBy": { From 964a5f5a1413d92a376fbc4894077f96b264a88d Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 17:48:57 -0700 Subject: [PATCH 062/204] Update security-retentionlabel-get.md --- api-reference/beta/api/security-retentionlabel-get.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/beta/api/security-retentionlabel-get.md b/api-reference/beta/api/security-retentionlabel-get.md index e2106da280a..66c3ad815cd 100644 --- a/api-reference/beta/api/security-retentionlabel-get.md +++ b/api-reference/beta/api/security-retentionlabel-get.md @@ -119,9 +119,9 @@ Content-Type: application/json "retentionTrigger": "dateCreated", "retentionDuration": { "@odata.type": "microsoft.graph.security.retentionDurationInDays", - "days": "730" + "days": 730 }, - "isInUse": "true", + "isInUse": true, "descriptionForAdmins": "creation based retention label for schedule 10004", "descriptionForUsers": "retains for 2 years then relabeled", "createdBy": { From 705eabb2d175f70880c4fe200ec4af8aa788f895 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 18:02:04 -0700 Subject: [PATCH 063/204] Update security-labelsroot-post-retentionlabel.md --- .../beta/api/security-labelsroot-post-retentionlabel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md index 56f0995fdb2..236604731b5 100644 --- a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md @@ -168,7 +168,7 @@ Content-Type: application/json "actionAfterRetentionPeriod": "startDispositionReview", "retentionTrigger": "dateOfEvent", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": 2555 }, "dispositionReviewStages": [ From 92f9238c076596201b65a9c864c9fac19244b544 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 18:02:32 -0700 Subject: [PATCH 064/204] Update security-labelsroot-post-retentionlabel.md --- .../v1.0/api/security-labelsroot-post-retentionlabel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md index f01a4fbe9f7..8bcaf041e15 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md @@ -133,7 +133,7 @@ Content-Type: application/json "actionAfterRetentionPeriod": "startDispositionReview", "retentionTrigger": "dateOfEvent", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": 2555 }, "dispositionReviewStages": [ From bdc6a7022b3689ec447e4f496f547e74b9bd7bcb Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 18:03:31 -0700 Subject: [PATCH 065/204] Update security-retentionlabel-update.md --- api-reference/beta/api/security-retentionlabel-update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-retentionlabel-update.md b/api-reference/beta/api/security-retentionlabel-update.md index 804c8536ef3..e615190e125 100644 --- a/api-reference/beta/api/security-retentionlabel-update.md +++ b/api-reference/beta/api/security-retentionlabel-update.md @@ -79,7 +79,7 @@ Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": 2555 }, } From 04ec176ef7f72e78ba329d7889864e8166225863 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 18:03:49 -0700 Subject: [PATCH 066/204] Update security-retentionlabel-update.md --- api-reference/v1.0/api/security-retentionlabel-update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/security-retentionlabel-update.md b/api-reference/v1.0/api/security-retentionlabel-update.md index 853013e472d..391f15542b1 100644 --- a/api-reference/v1.0/api/security-retentionlabel-update.md +++ b/api-reference/v1.0/api/security-retentionlabel-update.md @@ -77,7 +77,7 @@ Content-length: 555 { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDurationInDays" + "@odata.type": "microsoft.graph.security.retentionDurationInDays", "days": 2555 }, } From a4fa7d00ce504ff2e7272d3077093b7c4d8e5096 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 18:12:09 -0700 Subject: [PATCH 067/204] Update security-labelsroot-post-retentionlabel.md --- .../v1.0/api/security-labelsroot-post-retentionlabel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md index 8bcaf041e15..12daa4605a7 100644 --- a/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/v1.0/api/security-labelsroot-post-retentionlabel.md @@ -145,7 +145,7 @@ Content-Type: application/json ] } ], - "isInUse": "true", + "isInUse": true, "descriptionForAdmins": "retain for 7 years", "descriptionForUsers": "retain for 7 years", "defaultRecordBehavior":"startLocked", From 1cb45c2816c50e1d4957f968d733335afdb43237 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 18:12:13 -0700 Subject: [PATCH 068/204] Update security-labelsroot-post-retentionlabel.md --- .../beta/api/security-labelsroot-post-retentionlabel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md index 236604731b5..ef0ee3d69c0 100644 --- a/api-reference/beta/api/security-labelsroot-post-retentionlabel.md +++ b/api-reference/beta/api/security-labelsroot-post-retentionlabel.md @@ -180,7 +180,7 @@ Content-Type: application/json ] } ], - "isInUse": "true", + "isInUse": true, "descriptionForAdmins": "retain for 7 years", "descriptionForUsers": "retain for 7 years", "defaultRecordBehavior":"startLocked", From ad498fa7808ab40507c8f03b8d146e2a2333c96f Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Fri, 25 Aug 2023 18:26:31 -0700 Subject: [PATCH 069/204] Delete .gitignore --- .gitignore | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 .gitignore diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 63ec33090b8..00000000000 --- a/.gitignore +++ /dev/null @@ -1,14 +0,0 @@ -# Visual Studio Code Settings -.vscode/ - -# Test-Docs.ps1 related files -nuget.exe -*.nupkg -apidoc.exe -*.dll -.vs/ -.DS_Store - -# Unotes related files -.unotes/ -*.md From 5b09ddbbd94287b806f71ec06245f1478afc98ff Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Mon, 28 Aug 2023 09:00:25 -0700 Subject: [PATCH 070/204] Update security-retentionlabel-update.md --- .../beta/api/security-retentionlabel-update.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-retentionlabel-update.md b/api-reference/beta/api/security-retentionlabel-update.md index e615190e125..3b3637b5f4b 100644 --- a/api-reference/beta/api/security-retentionlabel-update.md +++ b/api-reference/beta/api/security-retentionlabel-update.md @@ -127,6 +127,14 @@ Content-length: 555 } --> ``` http -HTTP/1.1 204 No Content +HTTP/1.1 200 OK +Content-Type: application/json +{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration", + "days": 2555 + }, + } ``` From 3d8f8cbb96a1f39e200f712dc075699f888c8f31 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Mon, 28 Aug 2023 09:01:47 -0700 Subject: [PATCH 071/204] Update security-retentionlabel-update.md --- .../v1.0/api/security-retentionlabel-update.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/security-retentionlabel-update.md b/api-reference/v1.0/api/security-retentionlabel-update.md index 391f15542b1..e92b3260e76 100644 --- a/api-reference/v1.0/api/security-retentionlabel-update.md +++ b/api-reference/v1.0/api/security-retentionlabel-update.md @@ -91,6 +91,14 @@ Content-length: 555 } --> ``` http -HTTP/1.1 204 No Content +HTTP/1.1 200 OK +Content-Type: application/json +{ + "@odata.type": "#microsoft.graph.security.retentionLabel", + "retentionDuration": { + "@odata.type": "microsoft.graph.security.retentionDuration", + "days": 2555 + }, + } ``` From fdabcbe0a7a25f6ed65199bc8b75b8e20fb49821 Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Mon, 28 Aug 2023 14:43:39 -0700 Subject: [PATCH 072/204] Update security-retentionlabel-update.md --- api-reference/beta/api/security-retentionlabel-update.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/api-reference/beta/api/security-retentionlabel-update.md b/api-reference/beta/api/security-retentionlabel-update.md index 3b3637b5f4b..08c2bed335a 100644 --- a/api-reference/beta/api/security-retentionlabel-update.md +++ b/api-reference/beta/api/security-retentionlabel-update.md @@ -123,12 +123,14 @@ Content-length: 555 > ``` http HTTP/1.1 200 OK Content-Type: application/json + { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": { From 2041a03013880d8ef71f5e03ebb9be9bd9584a7f Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Mon, 28 Aug 2023 14:44:24 -0700 Subject: [PATCH 073/204] Update security-retentionlabel-update.md --- api-reference/v1.0/api/security-retentionlabel-update.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/security-retentionlabel-update.md b/api-reference/v1.0/api/security-retentionlabel-update.md index e92b3260e76..13ed2f96339 100644 --- a/api-reference/v1.0/api/security-retentionlabel-update.md +++ b/api-reference/v1.0/api/security-retentionlabel-update.md @@ -87,12 +87,14 @@ Content-length: 555 > ``` http HTTP/1.1 200 OK Content-Type: application/json + { "@odata.type": "#microsoft.graph.security.retentionLabel", "retentionDuration": { From 34f23eb6211dd3e0f9704250c986b98edd2f103a Mon Sep 17 00:00:00 2001 From: Samriddhi Seth <91155974+sseth-msft@users.noreply.github.com> Date: Mon, 28 Aug 2023 14:51:11 -0700 Subject: [PATCH 074/204] Add files via upload --- gitignore.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 gitignore.txt diff --git a/gitignore.txt b/gitignore.txt new file mode 100644 index 00000000000..94d146def5a --- /dev/null +++ b/gitignore.txt @@ -0,0 +1,13 @@ +# Visual Studio Code Settings +.vscode/ + +# Test-Docs.ps1 related files +nuget.exe +*.nupkg +apidoc.exe +*.dll +.vs/ +.DS_Store + +# Unotes related files +.unotes/ From 7d31201045c92862790ec0e35f580bb0e735e4ac Mon Sep 17 00:00:00 2001 From: Jason Johnston Date: Tue, 29 Aug 2023 10:16:48 -0400 Subject: [PATCH 075/204] Edits to address outstanding review items --- gitignore.txt => .gitignore | 0 .../api/security-retentionlabel-update.md | 21 +++++-------------- .../api/security-retentionlabel-update.md | 21 +++++-------------- 3 files changed, 10 insertions(+), 32 deletions(-) rename gitignore.txt => .gitignore (100%) diff --git a/gitignore.txt b/.gitignore similarity index 100% rename from gitignore.txt rename to .gitignore diff --git a/api-reference/beta/api/security-retentionlabel-update.md b/api-reference/beta/api/security-retentionlabel-update.md index 08c2bed335a..47bf8d685d1 100644 --- a/api-reference/beta/api/security-retentionlabel-update.md +++ b/api-reference/beta/api/security-retentionlabel-update.md @@ -52,14 +52,14 @@ PATCH /security/labels/retentionLabels/{retentionLabelId} |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`.| +|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. +If successful, this method returns a `204 No Content` response code. ## Examples @@ -120,23 +120,12 @@ Content-length: 555 --- ### Response -> + ``` http -HTTP/1.1 200 OK -Content-Type: application/json - -{ - "@odata.type": "#microsoft.graph.security.retentionLabel", - "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration", - "days": 2555 - }, - } +HTTP/1.1 204 No Content ``` diff --git a/api-reference/v1.0/api/security-retentionlabel-update.md b/api-reference/v1.0/api/security-retentionlabel-update.md index 13ed2f96339..f82835897d2 100644 --- a/api-reference/v1.0/api/security-retentionlabel-update.md +++ b/api-reference/v1.0/api/security-retentionlabel-update.md @@ -50,14 +50,14 @@ PATCH /security/labels/retentionLabels/{retentionLabelId} |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`.| +|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. +If successful, this method returns a `204 No Content` response code. ## Examples @@ -84,23 +84,12 @@ Content-length: 555 ``` ### Response -> + ``` http -HTTP/1.1 200 OK -Content-Type: application/json - -{ - "@odata.type": "#microsoft.graph.security.retentionLabel", - "retentionDuration": { - "@odata.type": "microsoft.graph.security.retentionDuration", - "days": 2555 - }, - } +HTTP/1.1 204 No Content ``` From b9d0a0e72c1a17af78f3b33c15bf64c0419af8cf Mon Sep 17 00:00:00 2001 From: kyracatwork <83306914+kyracatwork@users.noreply.github.com> Date: Wed, 18 Oct 2023 09:55:06 -0700 Subject: [PATCH 076/204] Update security-authoritytemplate-get.md Acrolynx --- api-reference/beta/api/security-authoritytemplate-get.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-reference/beta/api/security-authoritytemplate-get.md b/api-reference/beta/api/security-authoritytemplate-get.md index 951391ed066..dda6e372c95 100644 --- a/api-reference/beta/api/security-authoritytemplate-get.md +++ b/api-reference/beta/api/security-authoritytemplate-get.md @@ -45,7 +45,7 @@ This method supports some of the OData query parameters to help customize the re |Authorization|Bearer {token}. Required.| ## Request body -Do not supply a request body for this method. +Don't supply a request body for this method. ## Response @@ -54,7 +54,7 @@ If successful, this method returns a `200 OK` response code and a [microsoft.gra ## Examples ### Request -The following is an example of a request. +The following shows an example of a request. # [HTTP](#tab/http) -The Microsoft Graph API supports accessing data in users' _primary_ mailboxes and in [shared mailboxes](https://support.office.com/article/open-and-use-a-shared-mailbox-in-outlook-d94a8e9e-21f1-4240-808b-de9c9c088afd). The data can be calendar, mail, or personal contacts stored in a mailbox in the cloud on Exchange Online as part of Microsoft 365, or on Exchange on-premises in a [hybrid deployment](/graph/hybrid-rest-support). +The Microsoft Graph API supports accessing data in users' _primary_ mailboxes and in [shared mailboxes](https://support.office.com/article/open-and-use-a-shared-mailbox-in-outlook-d94a8e9e-21f1-4240-808b-de9c9c088afd). The data can be calendar, mail, or personal contacts stored in a mailbox in the cloud on Exchange Online as part of Microsoft 365. The API does _not_ support accessing in-place archive mailboxes, not [on Exchange Online](/office365/servicedescriptions/exchange-online-archiving-service-description/exchange-online-archiving-service-description#feature-availability-across-exchange-online-archiving-plans) nor [on Exchange Server](/exchange/policy-and-compliance/in-place-archiving/in-place-archiving). From 35a0e2592ca9dc2def7ab9d09a0ab9a2b22efa7d Mon Sep 17 00:00:00 2001 From: Mike Norman <1462796+MichaelNorman@users.noreply.github.com> Date: Tue, 27 Feb 2024 15:15:41 +0700 Subject: [PATCH 186/204] **Note:** -> [!NOTE] in many places and Acrolinx pass. --- .../beta/api/appcatalogs-list-teamsapps.md | 10 ++++---- .../beta/api/application-post-calls.md | 6 +++-- .../api/application-post-onlinemeetings.md | 5 ++-- .../beta/api/channel-post-messages.md | 6 +++-- .../beta/api/chat-delete-installedapps.md | 3 ++- api-reference/beta/api/chat-delete-members.md | 3 ++- api-reference/beta/api/chat-delete-tabs.md | 3 ++- .../beta/api/chat-get-installedapps.md | 6 ++--- api-reference/beta/api/chat-get-members.md | 9 ++++--- api-reference/beta/api/chat-get-tabs.md | 3 ++- api-reference/beta/api/chat-get.md | 3 ++- .../beta/api/chat-list-installedapps.md | 4 +-- api-reference/beta/api/chat-list-members.md | 3 ++- api-reference/beta/api/chat-list-messages.md | 5 ++-- .../beta/api/chat-list-operations.md | 3 ++- .../beta/api/chat-list-permissiongrants.md | 3 ++- api-reference/beta/api/chat-patch-tabs.md | 3 ++- api-reference/beta/api/chat-patch.md | 3 ++- .../beta/api/chat-post-installedapps.md | 2 +- api-reference/beta/api/chat-post-members.md | 3 ++- api-reference/beta/api/chat-post-tabs.md | 3 ++- .../beta/api/chat-sendactivitynotification.md | 3 ++- .../api/chat-teamsappinstallation-upgrade.md | 2 +- api-reference/beta/api/chatmessage-get.md | 5 ++-- .../api/chatmessage-list-hostedcontents.md | 5 ++-- .../beta/api/chatmessage-list-replies.md | 3 ++- .../beta/api/chatmessage-post-replies.md | 6 +++-- api-reference/beta/api/chatmessage-post.md | 6 +++-- api-reference/beta/api/chatmessage-update.md | 25 ++++++++++--------- .../beta/api/chatmessagehostedcontent-get.md | 5 ++-- .../v1.0/api/appcatalogs-list-teamsapps.md | 10 ++++---- .../v1.0/api/application-post-calls.md | 6 +++-- .../v1.0/api/channel-get-filesfolder.md | 3 ++- .../v1.0/api/channel-list-messages.md | 5 ++-- .../v1.0/api/channel-post-messages.md | 8 +++--- api-reference/v1.0/api/channel-post.md | 12 +++++---- .../v1.0/api/chat-get-installedapps.md | 6 ++--- .../v1.0/api/chat-list-installedapps.md | 4 +-- .../v1.0/api/chat-post-installedapps.md | 7 +++--- .../api/chat-teamsappinstallation-upgrade.md | 5 ++-- api-reference/v1.0/api/chatmessage-delta.md | 5 ++-- api-reference/v1.0/api/chatmessage-get.md | 5 ++-- .../api/chatmessage-list-hostedcontents.md | 5 ++-- .../v1.0/api/chatmessage-list-replies.md | 3 ++- .../v1.0/api/chatmessage-post-replies.md | 6 +++-- api-reference/v1.0/api/chatmessage-post.md | 6 +++-- api-reference/v1.0/api/chatmessage-update.md | 3 ++- .../v1.0/api/chatmessagehostedcontent-get.md | 5 ++-- .../v1.0/api/conversationmember-get.md | 3 ++- 49 files changed, 153 insertions(+), 103 deletions(-) diff --git a/api-reference/beta/api/appcatalogs-list-teamsapps.md b/api-reference/beta/api/appcatalogs-list-teamsapps.md index 761139d121d..57e19094f63 100644 --- a/api-reference/beta/api/appcatalogs-list-teamsapps.md +++ b/api-reference/beta/api/appcatalogs-list-teamsapps.md @@ -14,7 +14,7 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog. -This includes apps from the Microsoft Teams store, as well as apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. +This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. > [!NOTE] > In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource. @@ -28,8 +28,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/appcatalogs-list-teamsapps-permissions.md)] -> **Note**: -The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> [!NOTE] +> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request @@ -43,7 +43,7 @@ GET /appCatalogs/teamsApps This method supports the `$filter`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. -Using `$expand=AppDefinitions` will return more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app has been approved, rejected, or remains under review. +Using `$expand=AppDefinitions` returns more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app is approved, rejected, or remains under review. > **Note:** You can filter on any of the fields of the [teamsApp](../resources/teamsapp.md) object to shorten the list of results. You can use any of the following filter operations: Equal, not-equal, and, or, and not. @@ -307,7 +307,7 @@ Content-Type: application/json ### Example 4: List applications with a given ID, and return the submission review state -The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the app was approved by the admin, and `rejected` means the app was rejected by the admin. +The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the submission review state of the app. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the admin rejected app. #### Request diff --git a/api-reference/beta/api/application-post-calls.md b/api-reference/beta/api/application-post-calls.md index a7c9403378d..66e9a72b215 100644 --- a/api-reference/beta/api/application-post-calls.md +++ b/api-reference/beta/api/application-post-calls.md @@ -26,10 +26,12 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)] -> **Notes:** +> [!NOTE] > - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table. > - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. -> - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). + +> [!NOTE] +> The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/application-post-onlinemeetings.md b/api-reference/beta/api/application-post-onlinemeetings.md index 884b095c9f7..96a7dc70bb3 100644 --- a/api-reference/beta/api/application-post-onlinemeetings.md +++ b/api-reference/beta/api/application-post-onlinemeetings.md @@ -29,7 +29,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/application-post-onlinemeetings-permissions.md)] -To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path). +> [!NOTE] +> To use the OnlineMeetings.ReadWrite.All application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to a user to authorize the app configured in the policy to create online meetings on behalf of that user (with user ID specified in the request path). ## HTTP request @@ -41,7 +42,7 @@ POST /users/{userId}/onlineMeetings ``` > [!NOTE] ->- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy). +>- **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more information, see [Allow applications to access online meetings on behalf of a user](/graph/cloud-communication-online-meeting-application-access-policy). ## Request headers diff --git a/api-reference/beta/api/channel-post-messages.md b/api-reference/beta/api/channel-post-messages.md index 054942c0547..c5f5c0175f2 100644 --- a/api-reference/beta/api/channel-post-messages.md +++ b/api-reference/beta/api/channel-post-messages.md @@ -26,9 +26,11 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/channel-post-messages-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). +> [!NOTE] +> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. diff --git a/api-reference/beta/api/chat-delete-installedapps.md b/api-reference/beta/api/chat-delete-installedapps.md index 2c8e92d402c..5eba7cd434b 100644 --- a/api-reference/beta/api/chat-delete-installedapps.md +++ b/api-reference/beta/api/chat-delete-installedapps.md @@ -26,7 +26,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-delete-installedapps-permissions.md)] -> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-delete-members.md b/api-reference/beta/api/chat-delete-members.md index 1355e5850d7..ba592aba2f7 100644 --- a/api-reference/beta/api/chat-delete-members.md +++ b/api-reference/beta/api/chat-delete-members.md @@ -22,7 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-delete-members-permissions.md)] -> **Note**: The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-delete-tabs.md b/api-reference/beta/api/chat-delete-tabs.md index 8213353a77d..3792052b6af 100644 --- a/api-reference/beta/api/chat-delete-tabs.md +++ b/api-reference/beta/api/chat-delete-tabs.md @@ -25,7 +25,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-delete-tabs-permissions.md)] -> **Note**: The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.Delete.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-get-installedapps.md b/api-reference/beta/api/chat-get-installedapps.md index 7d113faf50b..3568501d435 100644 --- a/api-reference/beta/api/chat-get-installedapps.md +++ b/api-reference/beta/api/chat-get-installedapps.md @@ -24,8 +24,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-get-installedapps-permissions.md)] -> **Note**: -The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request @@ -125,7 +125,7 @@ Content-type: application/json ``` ### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat -The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameterd is required to show the consented permission set. +The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameter is required to show the consented permission set. #### Request diff --git a/api-reference/beta/api/chat-get-members.md b/api-reference/beta/api/chat-get-members.md index cf6ff097dac..45394d4b5b7 100644 --- a/api-reference/beta/api/chat-get-members.md +++ b/api-reference/beta/api/chat-get-members.md @@ -29,7 +29,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-get-members-permissions.md)] -> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat pPermissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request @@ -40,7 +41,7 @@ GET /users/{user-id | user-principal-name}/chats/{chat-id}/members/{membership-i ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers @@ -60,7 +61,7 @@ If successful, this method returns a `200 OK` response code and a [conversationM ### Request -Here is an example of the request. +The following example shows a request. @@ -110,7 +111,7 @@ GET https://graph.microsoft.com/beta/chats/19:b8577894a63548969c5c92bb9c80c5e1@t ### Response -Here is an example of the response. +The following example shows the response. [!INCLUDE [permissions-table](../includes/permissions/chat-get-tabs-permissions.md)] -> **Note**: The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.Read.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-get.md b/api-reference/beta/api/chat-get.md index 8357725e870..950f08aad6c 100644 --- a/api-reference/beta/api/chat-get.md +++ b/api-reference/beta/api/chat-get.md @@ -27,7 +27,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-get-permissions.md)] -> **Note**: The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-list-installedapps.md b/api-reference/beta/api/chat-list-installedapps.md index c343db73925..c3129b561b7 100644 --- a/api-reference/beta/api/chat-list-installedapps.md +++ b/api-reference/beta/api/chat-list-installedapps.md @@ -30,8 +30,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-list-installedapps-permissions.md)] -> **Note:** -The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat > - TeamsAppInstallation.ReadWriteAndConsentForChat > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All diff --git a/api-reference/beta/api/chat-list-members.md b/api-reference/beta/api/chat-list-members.md index 945a2ff00db..eaf0784d36f 100644 --- a/api-reference/beta/api/chat-list-members.md +++ b/api-reference/beta/api/chat-list-members.md @@ -31,7 +31,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-list-members-permissions.md)] -> **Note**: The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatMember.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-list-messages.md b/api-reference/beta/api/chat-list-messages.md index 77323b550e9..d44e87f4ecf 100644 --- a/api-reference/beta/api/chat-list-messages.md +++ b/api-reference/beta/api/chat-list-messages.md @@ -30,7 +30,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-list-messages-permissions.md)] -> **Note:** The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatMessage.Read.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request @@ -51,7 +52,7 @@ This method supports the following [OData query parameters](/graph/query-paramet | [$orderby](/graph/query-parameters#orderby-parameter) | Currently supports the **lastModifiedDateTime** (default) and **createdDateTime** properties in descending order. The ascending order is currently not supported.| | [$filter](/graph/query-parameters#filter-parameter) | Sets the date range filter for the **lastModifiedDateTime** and **createdDateTime** properties. The **lastModifiedDateTime** property supports the `gt` and `lt` operators. The **createdDateTime** property supports the `lt` operator. You can only filter results if the request URL contains the `$orderby` and `$filter` query parameters configured for the same property; otherwise, the `$filter` query option is ignored.| -The other [OData query parameters](/graph/query-parameters) are not currently supported. +The other [OData query parameters](/graph/query-parameters) aren't currently supported. ## Request headers diff --git a/api-reference/beta/api/chat-list-operations.md b/api-reference/beta/api/chat-list-operations.md index 25a9dee1b0e..d5db5c0b8dd 100644 --- a/api-reference/beta/api/chat-list-operations.md +++ b/api-reference/beta/api/chat-list-operations.md @@ -22,7 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-list-operations-permissions.md)] -> **Note:** The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatSettings.Read.Chat and ChatSettings.ReadWrite.Chat, and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request [!INCLUDE [permissions-table](../includes/permissions/chat-list-permissiongrants-permissions.md)] -> **Note**: The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.Read.Chat and Chat.Manage.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-patch-tabs.md b/api-reference/beta/api/chat-patch-tabs.md index 0597575e446..65c3e8ca589 100644 --- a/api-reference/beta/api/chat-patch-tabs.md +++ b/api-reference/beta/api/chat-patch-tabs.md @@ -27,7 +27,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-patch-tabs-permissions.md)] -> **Note:** The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-patch.md b/api-reference/beta/api/chat-patch.md index eae5317c12f..e18ddea4577 100644 --- a/api-reference/beta/api/chat-patch.md +++ b/api-reference/beta/api/chat-patch.md @@ -24,7 +24,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-patch-permissions.md)] -> **Note:**S The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChatSettings.ReadWrite.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-post-installedapps.md b/api-reference/beta/api/chat-post-installedapps.md index e8c3c3fb9ee..e3c13e6fab2 100644 --- a/api-reference/beta/api/chat-post-installedapps.md +++ b/api-reference/beta/api/chat-post-installedapps.md @@ -27,7 +27,7 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-post-installedapps-permissions.md)] -> **Notes:** +> [!NOTE] > - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). diff --git a/api-reference/beta/api/chat-post-members.md b/api-reference/beta/api/chat-post-members.md index 7e794575127..7eb3d986774 100644 --- a/api-reference/beta/api/chat-post-members.md +++ b/api-reference/beta/api/chat-post-members.md @@ -24,7 +24,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-post-members-permissions.md)] -> **Note:** The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-post-tabs.md b/api-reference/beta/api/chat-post-tabs.md index 3fcbd7e0042..111c6a288cb 100644 --- a/api-reference/beta/api/chat-post-tabs.md +++ b/api-reference/beta/api/chat-post-tabs.md @@ -26,7 +26,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-post-tabs-permissions.md)] -> **Note:** The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsTab.Create.Chat and TeamsTab.ReadWrite.Chat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-sendactivitynotification.md b/api-reference/beta/api/chat-sendactivitynotification.md index e372ca0c7ef..d0a869e3d00 100644 --- a/api-reference/beta/api/chat-sendactivitynotification.md +++ b/api-reference/beta/api/chat-sendactivitynotification.md @@ -22,7 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-sendactivitynotification-permissions.md)] ->**Note:** The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsActivity.Send.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chat-teamsappinstallation-upgrade.md b/api-reference/beta/api/chat-teamsappinstallation-upgrade.md index 2f7106dbd6a..77331c8894c 100644 --- a/api-reference/beta/api/chat-teamsappinstallation-upgrade.md +++ b/api-reference/beta/api/chat-teamsappinstallation-upgrade.md @@ -27,7 +27,7 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-teamsappinstallation-upgrade-permissions.md)] -> **Notes:** +> [!NOTE] > - The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. > - The Chat.Manage.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). diff --git a/api-reference/beta/api/chatmessage-get.md b/api-reference/beta/api/chatmessage-get.md index 84586becb9a..ea936da1590 100644 --- a/api-reference/beta/api/chatmessage-get.md +++ b/api-reference/beta/api/chatmessage-get.md @@ -39,7 +39,8 @@ One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All| -> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc). +> [!NOTE] +> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc). ## HTTP request @@ -59,7 +60,7 @@ GET /me/chats/{chat-id}/messages/{message-id} ``` ## Optional query parameters -This method does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers | Header | Value | diff --git a/api-reference/beta/api/chatmessage-list-hostedcontents.md b/api-reference/beta/api/chatmessage-list-hostedcontents.md index 3a5b18f9802..3779628ea2c 100644 --- a/api-reference/beta/api/chatmessage-list-hostedcontents.md +++ b/api-reference/beta/api/chatmessage-list-hostedcontents.md @@ -13,7 +13,7 @@ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md) +Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md).s [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] @@ -37,7 +37,8 @@ Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco |Delegated (personal Microsoft account)|Not supported.| |Application| ChatMessage.Read.Chat, Chat.Read.All, Chat.ReadWrite.All| -> **Note**: The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc). +> [!NOTE] +> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc). ## HTTP request diff --git a/api-reference/beta/api/chatmessage-list-replies.md b/api-reference/beta/api/chatmessage-list-replies.md index ea9a0f04ce1..01fade354b9 100644 --- a/api-reference/beta/api/chatmessage-list-replies.md +++ b/api-reference/beta/api/chatmessage-list-replies.md @@ -27,7 +27,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-list-replies-permissions.md)] -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/beta/api/chatmessage-post-replies.md b/api-reference/beta/api/chatmessage-post-replies.md index f75c8bb8b85..2f91c59eaeb 100644 --- a/api-reference/beta/api/chatmessage-post-replies.md +++ b/api-reference/beta/api/chatmessage-post-replies.md @@ -29,9 +29,11 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). +> [!NOTE] +> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ## HTTP request diff --git a/api-reference/beta/api/chatmessage-post.md b/api-reference/beta/api/chatmessage-post.md index b1037222a94..ca07796e2f4 100644 --- a/api-reference/beta/api/chatmessage-post.md +++ b/api-reference/beta/api/chatmessage-post.md @@ -29,9 +29,11 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ### Permissions for chat diff --git a/api-reference/beta/api/chatmessage-update.md b/api-reference/beta/api/chatmessage-update.md index 514007f10c7..c0591140313 100644 --- a/api-reference/beta/api/chatmessage-update.md +++ b/api-reference/beta/api/chatmessage-update.md @@ -17,7 +17,7 @@ You can update all the properties of **chatMessage** in delegated permissions sc Updating works only for chats where conversation members are Microsoft Teams users. If one of the members is using Skype, the operation fails. -This method does not support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message. +This method doesn't support federation. Only the user in the tenant who sent the message can perform data loss prevention (DLP) updates on the specified chat message. [!INCLUDE [teams-model-A-only-disclaimer](../../includes/teams-model-A-only-disclaimer.md)] @@ -35,7 +35,8 @@ One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | ChannelMessage.UpdatePolicyViolation.All, Group.ReadWrite.All** | -> **Note:** The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ### Permissions for chat @@ -73,7 +74,7 @@ PATCH /teams/(team-id)/channels/{channel-id}/messages/{message-id}/replies/{repl PATCH /chats/{chatThread-id}/messages/{message-id}?model=A ``` -If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) will be used. +If no `model` is specified, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) is used. ## Request headers @@ -175,7 +176,7 @@ Content-Type: application/json #### Response -Here is an example of the response. +The following example shows the response. @@ -59,7 +60,7 @@ GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages/{message-id} ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers diff --git a/api-reference/v1.0/api/appcatalogs-list-teamsapps.md b/api-reference/v1.0/api/appcatalogs-list-teamsapps.md index bcaa779e57a..969ea550b3b 100644 --- a/api-reference/v1.0/api/appcatalogs-list-teamsapps.md +++ b/api-reference/v1.0/api/appcatalogs-list-teamsapps.md @@ -12,7 +12,7 @@ doc_type: apiPageType Namespace: microsoft.graph List [apps](../resources/teamsapp.md) from the Microsoft Teams app catalog. -This includes apps from the Microsoft Teams store, as well as apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. +This includes apps from the Microsoft Teams store and apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify `organization` as the **distributionMethod** in the request. > [!NOTE] > In general, the **id** of a **teamsApp** resource is generated by the server. It is not the same as the **id** specified in a Teams app manifest, unless its **distributionMethod** is `store`. For other cases, the **id** provided by the developer as part of the Teams app manifest is stamped as the **externalId** in the **teamsApp** resource. @@ -26,8 +26,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/appcatalogs-list-teamsapps-permissions.md)] -> **Note**: -The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. +> [!NOTE] +> The Directory.Read.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using these permissions going forward. ## HTTP request @@ -41,7 +41,7 @@ GET /appCatalogs/teamsApps This method supports the `$filter`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. -Using `$expand=AppDefinitions` will return more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app has been approved, rejected, or remains under review. +Using `$expand=AppDefinitions` returns more information about the state of the app, such as the **publishingState**, which reflects the app submission review status and returns whether an app is approved, rejected, or remains under review. > **Note:** You can filter on any of the fields of the [teamsApp](../resources/teamsapp.md) object to shorten the list of results. You can use any of the following filter operations: Equal, not-equal, and, or, and not. @@ -303,7 +303,7 @@ Content-Type: application/json ### Example 4: List applications with a given ID, and return the submission review state -The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the app's submission review state. `Submitted` means the review is pending, `published` means the app was approved by the admin, and `rejected` means the app was rejected by the admin. +The following example lists applications with a given ID, and expands **appDefinitions** to return the **publishingState**, which reflects the app's submission review state. `Submitted` means the review is pending, `published` means the admin approved the app, and `rejected` means the admin rejected the app. #### Request diff --git a/api-reference/v1.0/api/application-post-calls.md b/api-reference/v1.0/api/application-post-calls.md index c372ab0c73f..05205b8ee1a 100644 --- a/api-reference/v1.0/api/application-post-calls.md +++ b/api-reference/v1.0/api/application-post-calls.md @@ -22,10 +22,12 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)] -> **Notes:** +> [!NOTE] > - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table. > - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. -> - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). + +> [!NOTE] +> The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/v1.0/api/channel-get-filesfolder.md b/api-reference/v1.0/api/channel-get-filesfolder.md index de7f5e272a5..f111197eb57 100644 --- a/api-reference/v1.0/api/channel-get-filesfolder.md +++ b/api-reference/v1.0/api/channel-get-filesfolder.md @@ -24,7 +24,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/channel-get-filesfolder-permissions.md)] -> **Note**: The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request diff --git a/api-reference/v1.0/api/channel-list-messages.md b/api-reference/v1.0/api/channel-list-messages.md index e6f7c6ca0e1..ffb87574857 100644 --- a/api-reference/v1.0/api/channel-list-messages.md +++ b/api-reference/v1.0/api/channel-list-messages.md @@ -28,7 +28,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/channel-list-messages-permissions.md)] -> **Note**: The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request @@ -119,7 +120,7 @@ GET https://graph.microsoft.com/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/ --- #### Response -The following is an example of the request. `@odata.nextLink` in the response can be used to get the next page of messages. +The following example shows a request. `@odata.nextLink` in the response can be used to get the next page of messages. [!INCLUDE [permissions-table](../includes/permissions/channel-post-messages-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). +> [!NOTE] +> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. @@ -51,7 +53,7 @@ POST /teams/{team-id}/channels/{channel-id}/messages ## Request body -In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. )ther properties are optional. +In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. Its properties are optional. ## Response diff --git a/api-reference/v1.0/api/channel-post.md b/api-reference/v1.0/api/channel-post.md index 6622a29f06a..079f9d5976e 100644 --- a/api-reference/v1.0/api/channel-post.md +++ b/api-reference/v1.0/api/channel-post.md @@ -11,7 +11,7 @@ doc_type: apiPageType Namespace: microsoft.graph -Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams. +Create a new [channel](../resources/channel.md) in a team, as specified in the request body. When you create a channel, the maximum length of the channel's `displayName` is 50 characters. This is the name that appears to the user in Microsoft Teams. If you're creating a private channel, you can add a maximum of 200 members. @@ -31,11 +31,13 @@ One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account) | Not supported. | |Application | Channel.Create.Group*, Channel.Create, Teamwork.Migrate.All, Group.ReadWrite.All, Directory.ReadWrite.All | -> **Notes**: +> [!NOTE] > The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). -> + +> [!NOTE] > This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. -> + +> [!NOTE] > In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported using Teamwork.Migrate.All and/or [migration APIs](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). @@ -330,7 +332,7 @@ Location: /teams('57fb72d0-d811-46f4-8947-305e6072eaa5')/channels('19:4b6bed8d24 #### Request -The following example shows a request to create a private channel and add a user as an team owner. +The following example shows a request to create a private channel and add a user as a team owner. # [HTTP](#tab/http) diff --git a/api-reference/v1.0/api/chat-get-installedapps.md b/api-reference/v1.0/api/chat-get-installedapps.md index 097f5c71872..bd33a2a2daf 100644 --- a/api-reference/v1.0/api/chat-get-installedapps.md +++ b/api-reference/v1.0/api/chat-get-installedapps.md @@ -22,8 +22,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-get-installedapps-permissions.md)] -> **Note:** -The TeamsAppInstallation.ReadWriteAndConsentSelfForChat and TeamsAppInstallation.ReadWriteAndConsentForChat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamsAppInstallation.ReadWriteAndConsentSelfForChat and TeamsAppInstallation.ReadWriteAndConsentForChat permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request @@ -123,7 +123,7 @@ Content-type: application/json ### Example 2: Get the set of resource-specific permissions consented for the app installed in the specified chat -The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameterd is required to show the consented permission set. +The following example gets the list of any [resource-specific permissions that were granted to an app](../resources/teamsapppermissionset.md) as part of installation. A `$select` query parameter is required to show the consented permission set. #### Request diff --git a/api-reference/v1.0/api/chat-list-installedapps.md b/api-reference/v1.0/api/chat-list-installedapps.md index 5af2370c0ba..8bf37b6a366 100644 --- a/api-reference/v1.0/api/chat-list-installedapps.md +++ b/api-reference/v1.0/api/chat-list-installedapps.md @@ -28,8 +28,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-list-installedapps-permissions.md)] -> **Note:** -The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): +> [!NOTE] +> The following permissions use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent): > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat > - TeamsAppInstallation.ReadWriteAndConsentForChat > - TeamsAppInstallation.ReadWriteAndConsentSelfForChat.All diff --git a/api-reference/v1.0/api/chat-post-installedapps.md b/api-reference/v1.0/api/chat-post-installedapps.md index 76b20029ebc..10cf561fbe7 100644 --- a/api-reference/v1.0/api/chat-post-installedapps.md +++ b/api-reference/v1.0/api/chat-post-installedapps.md @@ -25,7 +25,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-post-installedapps-permissions.md)] -> **Note:** These TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. +> [!NOTE] +> These TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions cannot be used to install apps that require consent to resource-specific permissions. ## HTTP request @@ -47,7 +48,7 @@ POST /chats/{chat-id}/installedApps ## Request body The request body should include the generated app ID of the catalog app. For more information, see [teamsApp properties](../resources/teamsapp.md#properties). -The following table lists additional parameters that can be used with the request body. +The following table lists other parameters that can be used with the request body. |Parameter|Type|Description| |:---|:---|:---| @@ -131,7 +132,7 @@ The following example shows the response. HTTP/1.1 201 Created ``` -### Example 2: Install app in a chat and and consent to the resource-specific permissions required by the app +### Example 2: Install app in a chat and consent to the resource-specific permissions required by the app To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). diff --git a/api-reference/v1.0/api/chat-teamsappinstallation-upgrade.md b/api-reference/v1.0/api/chat-teamsappinstallation-upgrade.md index e03bc70606f..60247741e04 100644 --- a/api-reference/v1.0/api/chat-teamsappinstallation-upgrade.md +++ b/api-reference/v1.0/api/chat-teamsappinstallation-upgrade.md @@ -25,7 +25,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chat-teamsappinstallation-upgrade-permissions.md)] -> **Note:** The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. +> [!NOTE] +> The TeamsAppInstallation.ReadWriteSelfForChat, TeamsAppInstallation.ReadWriteForChat, TeamsAppInstallation.ReadWriteSelfForChat.All, and TeamsAppInstallation.ReadWriteForChat.All permissions can't be used to install apps that require consent to resource-specific permissions. ## HTTP request @@ -45,7 +46,7 @@ POST /chats/{chat-id}/installedApps/{app-installation-id}/upgrade In the request body, supply a JSON representation of the parameters. -The following table lists additional parameters that can be used with the upgrade action. +The following table lists other parameters that can be used with the upgrade action. |Parameter|Type|Description| |:---|:---|:---| diff --git a/api-reference/v1.0/api/chatmessage-delta.md b/api-reference/v1.0/api/chatmessage-delta.md index a4192b2e7e4..17734244a78 100644 --- a/api-reference/v1.0/api/chatmessage-delta.md +++ b/api-reference/v1.0/api/chatmessage-delta.md @@ -37,7 +37,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-delta-permissions.md)] -> **Note**: The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request @@ -565,7 +566,7 @@ Content-type: application/json } ``` -### Example 2: Retrieving additional changes +### Example 2: Retrieving more changes Using the `@odata.deltaLink` from the last request in the last round, you can get only those messages that changed (by being added, or updated) in that channel since then. Your request should look like the following, assuming you prefer to keep the same maximum page size in the response: diff --git a/api-reference/v1.0/api/chatmessage-get.md b/api-reference/v1.0/api/chatmessage-get.md index f6f48dc74d8..e9a44b032a8 100644 --- a/api-reference/v1.0/api/chatmessage-get.md +++ b/api-reference/v1.0/api/chatmessage-get.md @@ -37,7 +37,8 @@ One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All| -> **Note:** The _ChannelMessage.Read.Group_ and _ChatMessage.Read.Chat_ permissions use [resource-specific consent]( https://aka.ms/teams-rsc). +> [!NOTE] +> The ChannelMessage.Read.Group and ChatMessage.Read.Chat permissions use [resource-specific consent]( https://aka.ms/teams-rsc). ## HTTP request @@ -57,7 +58,7 @@ GET /me/chats/{chat-id}/messages/{message-id} ``` ## Optional query parameters -This method does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This method doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers | Header | Value | diff --git a/api-reference/v1.0/api/chatmessage-list-hostedcontents.md b/api-reference/v1.0/api/chatmessage-list-hostedcontents.md index 28cff6f9dff..3a15a0c6b5d 100644 --- a/api-reference/v1.0/api/chatmessage-list-hostedcontents.md +++ b/api-reference/v1.0/api/chatmessage-list-hostedcontents.md @@ -11,7 +11,7 @@ doc_type: "apiPageType" Namespace: microsoft.graph -Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md) +Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedcontent.md) objects from a message. This API only lists the hosted content objects. To get the content bytes, see [get chatmessage hosted content](chatmessagehostedcontent-get.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] @@ -33,7 +33,8 @@ Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco |Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All| -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/v1.0/api/chatmessage-list-replies.md b/api-reference/v1.0/api/chatmessage-list-replies.md index b3da66f1848..e18f3d6a3a6 100644 --- a/api-reference/v1.0/api/chatmessage-list-replies.md +++ b/api-reference/v1.0/api/chatmessage-list-replies.md @@ -25,7 +25,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-list-replies-permissions.md)] -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request diff --git a/api-reference/v1.0/api/chatmessage-post-replies.md b/api-reference/v1.0/api/chatmessage-post-replies.md index d2ad34c570f..4dc601e1760 100644 --- a/api-reference/v1.0/api/chatmessage-post-replies.md +++ b/api-reference/v1.0/api/chatmessage-post-replies.md @@ -27,9 +27,11 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)] -> **Note**: The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). +> [!NOTE] +> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ## HTTP request diff --git a/api-reference/v1.0/api/chatmessage-post.md b/api-reference/v1.0/api/chatmessage-post.md index 157068f464d..2b61a766640 100644 --- a/api-reference/v1.0/api/chatmessage-post.md +++ b/api-reference/v1.0/api/chatmessage-post.md @@ -27,9 +27,11 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)] -> **Note**: The Group.ReadWrite.All permissino is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table. -> **Note**: Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported. +> [!NOTE] +> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported. ### Permissions for chat diff --git a/api-reference/v1.0/api/chatmessage-update.md b/api-reference/v1.0/api/chatmessage-update.md index 9a4b9745532..ba8f87411b5 100644 --- a/api-reference/v1.0/api/chatmessage-update.md +++ b/api-reference/v1.0/api/chatmessage-update.md @@ -33,7 +33,8 @@ One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | ChannelMessage.UpdatePolicyViolation.All, Group.ReadWrite.All** | -> **Note:** The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ### Permissions for chat diff --git a/api-reference/v1.0/api/chatmessagehostedcontent-get.md b/api-reference/v1.0/api/chatmessagehostedcontent-get.md index 2873fd38244..f6eabff59c2 100644 --- a/api-reference/v1.0/api/chatmessagehostedcontent-get.md +++ b/api-reference/v1.0/api/chatmessagehostedcontent-get.md @@ -35,7 +35,8 @@ One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| Chat.Read.All, Chat.ReadWrite.All| -> **Note:** The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request @@ -55,7 +56,7 @@ GET /users/{user-id | user-principal-name}/chats/{chat-id}/messages/{message-id} ## Optional query parameters -This operation does not support the [OData query parameters](/graph/query-parameters) to customize the response. +This operation doesn't support the [OData query parameters](/graph/query-parameters) to customize the response. ## Request headers diff --git a/api-reference/v1.0/api/conversationmember-get.md b/api-reference/v1.0/api/conversationmember-get.md index 72e25de3118..fcb5e25ebb3 100644 --- a/api-reference/v1.0/api/conversationmember-get.md +++ b/api-reference/v1.0/api/conversationmember-get.md @@ -25,7 +25,8 @@ One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account)|Not supported.| |Application| For **user** or **chat** resource: Not supported.

For **channel** resource: TeamMember.Read.Group, ChannelMember.Read.All, ChannelMember.ReadWrite.All | -> **Note:** The TeamMember.Read.Group permmission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> [!NOTE] +> The TeamMember.Read.Group permmission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request From c6c248cebe30685b38c347acb0549b8c65d7797e Mon Sep 17 00:00:00 2001 From: Mike Norman <1462796+MichaelNorman@users.noreply.github.com> Date: Wed, 28 Feb 2024 15:16:26 +0700 Subject: [PATCH 187/204] Fixed and demoted some notes. --- api-reference/beta/api/application-post-calls.md | 5 ++--- api-reference/beta/api/channel-post-messages.md | 5 +---- .../beta/api/chatmessage-list-hostedcontents.md | 3 ++- api-reference/beta/api/chatmessage-post-replies.md | 7 ++----- api-reference/beta/api/chatmessage-post.md | 6 ++---- api-reference/v1.0/api/application-post-calls.md | 5 ++--- api-reference/v1.0/api/channel-post-messages.md | 5 +---- api-reference/v1.0/api/channel-post.md | 11 +++-------- api-reference/v1.0/api/chatmessage-post-replies.md | 3 +-- api-reference/v1.0/api/chatmessage-post.md | 6 ++---- 10 files changed, 18 insertions(+), 38 deletions(-) diff --git a/api-reference/beta/api/application-post-calls.md b/api-reference/beta/api/application-post-calls.md index 66e9a72b215..c59f1ab3814 100644 --- a/api-reference/beta/api/application-post-calls.md +++ b/api-reference/beta/api/application-post-calls.md @@ -27,11 +27,10 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)] > [!NOTE] +> The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). > - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table. -> - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. -> [!NOTE] -> The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. ## HTTP request diff --git a/api-reference/beta/api/channel-post-messages.md b/api-reference/beta/api/channel-post-messages.md index c5f5c0175f2..4c6d1ecaf0b 100644 --- a/api-reference/beta/api/channel-post-messages.md +++ b/api-reference/beta/api/channel-post-messages.md @@ -28,10 +28,7 @@ Choose the permission or permissions marked as least privileged for this API. Us > [!NOTE] > The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. - -> [!NOTE] -> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. diff --git a/api-reference/beta/api/chatmessage-list-hostedcontents.md b/api-reference/beta/api/chatmessage-list-hostedcontents.md index 3779628ea2c..00ce7a0469b 100644 --- a/api-reference/beta/api/chatmessage-list-hostedcontents.md +++ b/api-reference/beta/api/chatmessage-list-hostedcontents.md @@ -27,7 +27,8 @@ Retrieve the list of [chatMessageHostedContent](../resources/chatmessagehostedco |Delegated (personal Microsoft account)|Not supported.| |Application| ChannelMessage.Read.Group, ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | -> **Note**: The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> [!NOTE] +> The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ### Permissions for chat diff --git a/api-reference/beta/api/chatmessage-post-replies.md b/api-reference/beta/api/chatmessage-post-replies.md index 2f91c59eaeb..8f2b3528edf 100644 --- a/api-reference/beta/api/chatmessage-post-replies.md +++ b/api-reference/beta/api/chatmessage-post-replies.md @@ -30,11 +30,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-replies-permissions.md)] > [!NOTE] -> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. - -> [!NOTE] -> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ## HTTP request diff --git a/api-reference/beta/api/chatmessage-post.md b/api-reference/beta/api/chatmessage-post.md index ca07796e2f4..f398a87689f 100644 --- a/api-reference/beta/api/chatmessage-post.md +++ b/api-reference/beta/api/chatmessage-post.md @@ -30,10 +30,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)] > [!NOTE] -> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. - -> [!NOTE] -> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ### Permissions for chat diff --git a/api-reference/v1.0/api/application-post-calls.md b/api-reference/v1.0/api/application-post-calls.md index 05205b8ee1a..f6677ca2aca 100644 --- a/api-reference/v1.0/api/application-post-calls.md +++ b/api-reference/v1.0/api/application-post-calls.md @@ -24,10 +24,9 @@ Choose the permission or permissions marked as least privileged for this API. Us > [!NOTE] > - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table. -> - Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. +> - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). -> [!NOTE] -> The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. ## HTTP request diff --git a/api-reference/v1.0/api/channel-post-messages.md b/api-reference/v1.0/api/channel-post-messages.md index d57ccc9fb3f..9da88357d49 100644 --- a/api-reference/v1.0/api/channel-post-messages.md +++ b/api-reference/v1.0/api/channel-post-messages.md @@ -26,10 +26,7 @@ Choose the permission or permissions marked as least privileged for this API. Us > [!NOTE] > The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. - -> [!NOTE] -> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. diff --git a/api-reference/v1.0/api/channel-post.md b/api-reference/v1.0/api/channel-post.md index 079f9d5976e..e4f14cec728 100644 --- a/api-reference/v1.0/api/channel-post.md +++ b/api-reference/v1.0/api/channel-post.md @@ -29,17 +29,12 @@ One of the following permissions is required to call this API. To learn more, in |:--------------------|:---------------------------------------------------------| |Delegated (work or school account) | Channel.Create, Group.ReadWrite.All, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. | -|Application | Channel.Create.Group*, Channel.Create, Teamwork.Migrate.All, Group.ReadWrite.All, Directory.ReadWrite.All | +|Application | Channel.Create.Group, Channel.Create, Teamwork.Migrate.All, Group.ReadWrite.All, Directory.ReadWrite.All | > [!NOTE] -> The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> - The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. > - The Channel.Create.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported using Teamwork.Migrate.All and/or [migration APIs](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -> [!NOTE] -> This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. - -> [!NOTE] -> In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported -using Teamwork.Migrate.All and/or [migration APIs](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). +This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request diff --git a/api-reference/v1.0/api/chatmessage-post-replies.md b/api-reference/v1.0/api/chatmessage-post-replies.md index 4dc601e1760..da9519bf798 100644 --- a/api-reference/v1.0/api/chatmessage-post-replies.md +++ b/api-reference/v1.0/api/chatmessage-post-replies.md @@ -31,8 +31,7 @@ Choose the permission or permissions marked as least privileged for this API. Us > The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. > [!NOTE] -> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). -In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. +> Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft may require you or your customers to pay additional fees based on the amount of data imported. ## HTTP request diff --git a/api-reference/v1.0/api/chatmessage-post.md b/api-reference/v1.0/api/chatmessage-post.md index 2b61a766640..89e05e2ddc6 100644 --- a/api-reference/v1.0/api/chatmessage-post.md +++ b/api-reference/v1.0/api/chatmessage-post.md @@ -28,10 +28,8 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/chatmessage-post-permissions.md)] > [!NOTE] -> The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table. - -> [!NOTE] -> Application permissions are *only* supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported. +> - The Group.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use the alternative permissions listed in the table. +> - Application permissions are only supported for [migration](/microsoftteams/platform/graph-api/import-messages/import-external-messages-to-teams). In the future, Microsoft might require you or your customers to pay additional fees based on the amount of data imported. ### Permissions for chat From 7cd20dcaf44fe137fa8e1b339d1c0d9fda76c558 Mon Sep 17 00:00:00 2001 From: Mike Norman <1462796+MichaelNorman@users.noreply.github.com> Date: Wed, 28 Feb 2024 18:23:54 +0700 Subject: [PATCH 188/204] Fixing link error to match beta/v1.0 files. --- api-reference/v1.0/api/chatmessage-delta.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/chatmessage-delta.md b/api-reference/v1.0/api/chatmessage-delta.md index 17734244a78..8424256930b 100644 --- a/api-reference/v1.0/api/chatmessage-delta.md +++ b/api-reference/v1.0/api/chatmessage-delta.md @@ -566,7 +566,7 @@ Content-type: application/json } ``` -### Example 2: Retrieving more changes +### Example 2: Retrieving additional changes Using the `@odata.deltaLink` from the last request in the last round, you can get only those messages that changed (by being added, or updated) in that channel since then. Your request should look like the following, assuming you prefer to keep the same maximum page size in the response: From 96a8403dd73eb4894331a0c86a29f07e10fdcd1d Mon Sep 17 00:00:00 2001 From: Mike Norman <1462796+MichaelNorman@users.noreply.github.com> Date: Wed, 28 Feb 2024 05:53:54 -0600 Subject: [PATCH 189/204] Apply suggestions from code review --- api-reference/v1.0/api/channel-post-messages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/api/channel-post-messages.md b/api-reference/v1.0/api/channel-post-messages.md index 9da88357d49..19a981bc3e8 100644 --- a/api-reference/v1.0/api/channel-post-messages.md +++ b/api-reference/v1.0/api/channel-post-messages.md @@ -50,7 +50,7 @@ POST /teams/{team-id}/channels/{channel-id}/messages ## Request body -In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. Its properties are optional. +In the request body, supply a JSON representation of a [chatMessage](../resources/chatmessage.md) object. Only the body property is mandatory. All other properties are optional. ## Response From 0c386a1051a62c0d79aa5d1cc12e6823efad951d Mon Sep 17 00:00:00 2001 From: Josh Douglas Date: Mon, 18 Mar 2024 19:07:34 -0700 Subject: [PATCH 190/204] initial commit --- ...antaccesspolicyconfigurationdefault-get.md | 9 ++ ...accesspolicyconfigurationdefault-update.md | 99 +++++++++++++------ .../crosstenantaccesspolicy-overview.md | 21 ++++ ...stenantaccesspolicyconfigurationdefault.md | 4 + ...redemptionidentityproviderconfiguration.md | 43 ++++++++ api-reference/v1.0/resources/enums.md | 12 +++ ...redemptionidentityproviderconfiguration.md | 57 +++++++++++ 7 files changed, 215 insertions(+), 30 deletions(-) create mode 100644 api-reference/v1.0/resources/defaultinvitationredemptionidentityproviderconfiguration.md create mode 100644 api-reference/v1.0/resources/invitationredemptionidentityproviderconfiguration.md diff --git a/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-get.md b/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-get.md index ea32667eb1f..7c9db941f90 100644 --- a/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-get.md +++ b/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-get.md @@ -215,6 +215,15 @@ Content-Type: application/json } ] } + }, + "invitationRedemptionIdentityProviderConfiguration": + { + "primaryIdentityProviderPrecedenceOrder": [ + "externalFederation", + "azureActiveDirectory", + "socialIdentityProviders" + ], + "fallbackIdentityProvider": "defaultConfiguredIdp" } } ``` diff --git a/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md b/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md index eaa8d522a53..36bbbfc00cc 100644 --- a/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md +++ b/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md @@ -58,18 +58,17 @@ If successful, this method returns a `204 No Content` response code. ## Examples -### Request +### Example 1: Block outbound B2B collaboration for a group of users +#### Request -# [HTTP](#tab/http) - ``` http -PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default +PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default Content-Type: application/json { @@ -99,41 +98,81 @@ Content-Type: application/json } ``` -# [C#](#tab/csharp) -[!INCLUDE [sample-code](../includes/snippets/csharp/update-crosstenantaccesspolicyconfigurationdefault-csharp-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +#### Response -# [CLI](#tab/cli) -[!INCLUDE [sample-code](../includes/snippets/cli/update-crosstenantaccesspolicyconfigurationdefault-cli-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + -# [Go](#tab/go) -[!INCLUDE [sample-code](../includes/snippets/go/update-crosstenantaccesspolicyconfigurationdefault-go-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +``` http +HTTP/1.1 204 No Content +``` -# [Java](#tab/java) -[!INCLUDE [sample-code](../includes/snippets/java/update-crosstenantaccesspolicyconfigurationdefault-java-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +### Example 2: Update default invitation redemption configuration -# [JavaScript](#tab/javascript) -[!INCLUDE [sample-code](../includes/snippets/javascript/update-crosstenantaccesspolicyconfigurationdefault-javascript-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +#### Request -# [PHP](#tab/php) -[!INCLUDE [sample-code](../includes/snippets/php/update-crosstenantaccesspolicyconfigurationdefault-php-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +``` http +PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default +Content-Type: application/json -# [PowerShell](#tab/powershell) -[!INCLUDE [sample-code](../includes/snippets/powershell/update-crosstenantaccesspolicyconfigurationdefault-powershell-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +{ + "invitationRedemptionIdentityProviderConfiguration": { + "primaryIdentityProviderPrecedenceOrder": [ + "externalFederation", + "azureActiveDirectory", + "socialIdentityProviders" + ], + "fallbackIdentityProvider": "defaultConfiguredIdp" + } +} +``` -# [Python](#tab/python) -[!INCLUDE [sample-code](../includes/snippets/python/update-crosstenantaccesspolicyconfigurationdefault-python-snippets.md)] -[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +#### Response ---- + + +``` http +HTTP/1.1 204 No Content +``` + +### Example 3: Disallow Microsoft accounts as an option for redeeming B2B invitations + +#### Request + + +``` http +PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default +Content-Type: application/json + +{ + "invitationRedemptionIdentityProviderConfiguration": { + "primaryIdentityProviderPrecedenceOrder": [ + "externalFederation", + "azureActiveDirectory", + "socialIdentityProviders" + ], + "fallbackIdentityProvider": "emailOneTimePasscode" + } +} +``` -### Response +#### Response + +``` json +{ + "primaryIdentityProviderPrecedenceOrder": ["String"], + "fallbackIdentityProvider": "String" +} +``` diff --git a/api-reference/v1.0/resources/enums.md b/api-reference/v1.0/resources/enums.md index f7839737ece..8d0bea1f342 100644 --- a/api-reference/v1.0/resources/enums.md +++ b/api-reference/v1.0/resources/enums.md @@ -3219,3 +3219,15 @@ Possible values for user account types (group membership), per Windows definitio | assigned | | unknownFutureValue | | inactive | + +### b2bIdentityProvidersType values + +|Member| +|:-----| +|azureActiveDirectory| +|externalFederation| +|socialIdentityProviders| +|emailOneTimePasscode| +|microsoftAccount| +|defaultConfiguredIdp| +|unknownFutureValue| \ No newline at end of file diff --git a/api-reference/v1.0/resources/invitationredemptionidentityproviderconfiguration.md b/api-reference/v1.0/resources/invitationredemptionidentityproviderconfiguration.md new file mode 100644 index 00000000000..e04007733d3 --- /dev/null +++ b/api-reference/v1.0/resources/invitationredemptionidentityproviderconfiguration.md @@ -0,0 +1,57 @@ +--- +title: "invitationRedemptionIdentityProviderConfiguration resource type" +description: "Defines the invitation redemption provider configuration base type to set redemption flow settings for Microsoft Entra ID B2B collaboration." +author: "jkdouglas" +ms.localizationpriority: medium +ms.subservice: "entra-sign-in" +doc_type: resourcePageType +--- + +# invitationRedemptionIdentityProviderConfiguration resource type + +Namespace: microsoft.graph + +Defines the invitation redemption provider configuration base type to set redemption flow settings for Microsoft Entra ID B2B collaboration. + +Two types of identity providers are in the precedence order: primary identity providers and fallback identity providers. Fallback identity providers are used when no primary identity provider is available and must always be specified. + +The primary identity providers are: + +- azureActiveDirectory: Any user located in another Microsoft Entra ID tenant. +- externalFederation: Any user located in an identity provider associated with a SAML or WS-Federation relationship. +- socialIdentityProviders: Any user using a gmail.com account when Google Federation is configured. + +The fallback identity providers are: + +- defaultConfiguredIdp: Check for an existing Microsoft account, then use a one-time email passcode (if enabled), and finally, create a new Microsoft account if no primary identity providers are available for the user. +- emailOneTimePasscode: Always use one-time email passcode if no primary identity providers are available for the user. +- microsoftAccount: Always use an existing Microsoft account or create a new Microsoft account if no primary identity providers are available for the user. + +## Properties + +|Property|Type|Description| +|:---|:---|:---| +| primaryIdentityProviderPrecedenceOrder | b2bIdentityProvidersType collection | Collection of identity providers in priority order of preference to be used for guest invitation redemption. Possible values are: `azureActiveDirectory`, `externalFederation`, or `socialIdentityProviders`. | +| fallbackIdentityProvider | b2bIdentityProvidersType | The fallback identity provider to be used in case no primary identity provider can be used for guest invitation redemption. Possible values are: `defaultConfiguredIdp`, `emailOneTimePasscode`, or `microsoftAccount`. | + +## Relationships + +None. + +## JSON representation + +The following JSON representation shows the resource type. + +``` json +{ + "@odata.type": "#microsoft.graph.invitationRedemptionIdentityProviderConfiguration", + "primaryIdentityProviderPrecedenceOrder": [ + "String" + ], + "fallbackIdentityProvider": "String" +} +``` From a62dab6b8f8180272383384adf074fe934262238 Mon Sep 17 00:00:00 2001 From: Josh Douglas Date: Wed, 20 Mar 2024 15:08:37 -0700 Subject: [PATCH 191/204] changelog --- changelog/Microsoft.DirectoryServices.json | 42 ++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/changelog/Microsoft.DirectoryServices.json b/changelog/Microsoft.DirectoryServices.json index add281adafc..9df858236f4 100644 --- a/changelog/Microsoft.DirectoryServices.json +++ b/changelog/Microsoft.DirectoryServices.json @@ -1,5 +1,47 @@ { "changelog": [ + { + "ChangeList": [ + { + "Id": "77c6af58-c093-4350-8664-d2ee116fb949", + "ApiChange": "Enumeration", + "ChangedApiName": "b2bIdentityProvidersType", + "ChangeType": "Addition", + "Description": "Added the **b2bIdentityProvidersType** enumeration type.", + "Target": "b2bIdentityProvidersType" + }, + { + "Id": "77c6af58-c093-4350-8664-d2ee116fb949", + "ApiChange": "Resource", + "ChangedApiName": "defaultInvitationRedemptionIdentityProviderConfiguration", + "ChangeType": "Addition", + "Description": "Added the [defaultInvitationRedemptionIdentityProviderConfiguration](https://learn.microsoft.com/en-us/graph/api/resources/defaultInvitationRedemptionIdentityProviderConfiguration?view=graph-rest-1.0) resource type.", + "Target": "defaultInvitationRedemptionIdentityProviderConfiguration" + }, + { + "Id": "77c6af58-c093-4350-8664-d2ee116fb949", + "ApiChange": "Resource", + "ChangedApiName": "invitationRedemptionIdentityProviderConfiguration", + "ChangeType": "Addition", + "Description": "Added the [invitationRedemptionIdentityProviderConfiguration](https://learn.microsoft.com/en-us/graph/api/resources/invitationRedemptionIdentityProviderConfiguration?view=graph-rest-1.0) resource type.", + "Target": "invitationRedemptionIdentityProviderConfiguration" + }, + { + "Id": "77c6af58-c093-4350-8664-d2ee116fb949", + "ApiChange": "Property", + "ChangedApiName": "invitationRedemptionIdentityProviderConfiguration", + "ChangeType": "Addition", + "Description": "Added the `invitationRedemptionIdentityProviderConfiguration` property to the [crossTenantAccessPolicyConfigurationDefault](https://learn.microsoft.com/en-us/graph/api/resources/crossTenantAccessPolicyConfigurationDefault?view=graph-rest-1.0) resource.", + "Target": "crossTenantAccessPolicyConfigurationDefault" + } + ], + "Id": "77c6af58-c093-4350-8664-d2ee116fb949", + "Cloud": "Prod", + "Version": "v1.0", + "CreatedDateTime": "2024-03-31T16:45:20.304139Z", + "WorkloadArea": "Identity and access", + "SubArea": "Identity and sign-in" + }, { "ChangeList": [ { From 7fb4477e774c6b955df67f1de8d22e5d08c05937 Mon Sep 17 00:00:00 2001 From: Josh Douglas Date: Wed, 20 Mar 2024 15:11:51 -0700 Subject: [PATCH 192/204] acrolinx --- .../crosstenantaccesspolicyconfigurationdefault.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md b/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md index 03edcdacd0b..b3889794778 100644 --- a/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md +++ b/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md @@ -25,14 +25,14 @@ The default configuration defined for inbound and outbound settings of Microsoft |Property|Type|Description| |:---|:---|:---| -| automaticUserConsentSettings | [inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md) | Determines the default configuration for automatic user consent settings. The **inboundAllowed** and **outboundAllowed** properties are always `false` and cannot be updated in the default configuration. Read-only. | +| automaticUserConsentSettings | [inboundOutboundPolicyConfiguration](../resources/inboundoutboundpolicyconfiguration.md) | Determines the default configuration for automatic user consent settings. The **inboundAllowed** and **outboundAllowed** properties are always `false` and can't be updated in the default configuration. Read-only. | | b2bCollaborationInbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B collaboration. | | b2bCollaborationOutbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B collaboration. | | b2bDirectConnectInbound |[crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) | Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B direct connect. | | b2bDirectConnectOutbound | [crossTenantAccessPolicyB2BSetting](../resources/crosstenantaccesspolicyb2bsetting.md) |Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B direct connect. | | inboundTrust | [crossTenantAccessPolicyInboundTrust](../resources/crosstenantaccesspolicyinboundtrust.md) | Determines the default configuration for trusting other Conditional Access claims from external Microsoft Entra organizations. | | invitationRedemptionIdentityProviderConfiguration | [defaultInvitationRedemptionIdentityProviderConfiguration](../resources/defaultInvitationRedemptionIdentityProviderConfiguration.md) | Defines the priority order based on which an identity provider is selected during invitation redemption for a guest user. | -| isServiceDefault | Boolean | If `true`, the default configuration is set to the system default configuration. If `false`, the default settings have been customized. | +| isServiceDefault | Boolean | If `true`, the default configuration is set to the system default configuration. If `false`, the default settings are customized. | ## Relationships @@ -40,7 +40,7 @@ None. ## JSON representation -The following is a JSON representation of the resource. +Below is a JSON representation of the resource. From 4bf2ce15c1c87a8eb1b429d3df59660e926af0ba Mon Sep 17 00:00:00 2001 From: Josh Douglas Date: Thu, 21 Mar 2024 11:34:56 -0700 Subject: [PATCH 194/204] fix beta references --- .../crosstenantaccesspolicyconfigurationdefault-update.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md b/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md index 36bbbfc00cc..82d320ddd4d 100644 --- a/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md +++ b/api-reference/v1.0/api/crosstenantaccesspolicyconfigurationdefault-update.md @@ -68,7 +68,7 @@ If successful, this method returns a `204 No Content` response code. } --> ``` http -PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default +PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default Content-Type: application/json { @@ -120,7 +120,7 @@ HTTP/1.1 204 No Content } --> ``` http -PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default +PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default Content-Type: application/json { @@ -157,7 +157,7 @@ HTTP/1.1 204 No Content } --> ``` http -PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default +PATCH https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/default Content-Type: application/json { From d3a6f07f407e181f69b8d882de0f1d3ea025bbcf Mon Sep 17 00:00:00 2001 From: Namrata Rajiv Kedia Date: Tue, 26 Mar 2024 15:14:43 -0700 Subject: [PATCH 195/204] Update api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md Co-authored-by: Faith Moraa Ombongi --- .../resources/crosstenantaccesspolicyconfigurationdefault.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md b/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md index b3889794778..78cc147b195 100644 --- a/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md +++ b/api-reference/v1.0/resources/crosstenantaccesspolicyconfigurationdefault.md @@ -40,7 +40,7 @@ None. ## JSON representation -Below is a JSON representation of the resource. +The following JSON representation shows the resource type. ``` http -GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=healthIssueType eq 'global' -GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=healthIssueType eq 'sensor' +GET /security/identities/healthIssues?$filter=Status eq 'open' and healthIssueType eq 'global' +GET /security/identities/healthIssues?$filter=Status eq 'open' and healthIssueType eq 'sensor' ``` See open health alerts based on severity. @@ -72,8 +72,8 @@ See open health alerts based on severity. } --> ``` http -GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=severity eq 'medium' -GET /security/identities/healthIssues?$filter=Status eq 'open'&$filter=severity eq 'low' +GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq 'medium' +GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq 'low' ``` See open global health alerts that domain name \ sensor DNS name ends with spesific value (name=contoso.com) @@ -82,8 +82,8 @@ See open global health alerts that domain name \ sensor DNS name ends with spesi } --> ``` http -GET /security/identities/healthissues?$filter=Status eq 'open'&$filter=healthIssueType eq 'global'&$filter=domainNames/any(s:endswith(s,'contoso.com')) -GET /security/identities/healthissues?$filter=Status eq 'open'&$filter=healthIssueType eq 'global'&$filter=sensorDNSNames/any(s:endswith(s,'contoso.com')) +GET /security/identities/healthissues?$filter=Status eq 'open' and healthIssueType eq 'global' and domainNames/any(s:endswith(s,'contoso.com')) +GET /security/identities/healthissues?$filter=Status eq 'open' and healthIssueType eq 'global' and sensorDNSNames/any(s:endswith(s,'contoso.com')) ``` For general information, see [OData query parameters](/graph/query-parameters). From e40d13b229463e1ed3dd127ea54532cccab905af Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Tue, 2 Apr 2024 11:14:50 +0000 Subject: [PATCH 197/204] Update generated permissions tables with build 141826 --- api-reference/beta/api/channel-archive.md | 9 +++------ api-reference/beta/api/channel-unarchive.md | 9 +++------ .../permissions/channel-archive-permissions.md | 11 +++++++++++ .../permissions/channel-unarchive-permissions.md | 11 +++++++++++ 4 files changed, 28 insertions(+), 12 deletions(-) create mode 100644 api-reference/beta/includes/permissions/channel-archive-permissions.md create mode 100644 api-reference/beta/includes/permissions/channel-unarchive-permissions.md diff --git a/api-reference/beta/api/channel-archive.md b/api-reference/beta/api/channel-archive.md index 65c5ad2afda..1c5e12c59cf 100644 --- a/api-reference/beta/api/channel-archive.md +++ b/api-reference/beta/api/channel-archive.md @@ -24,13 +24,10 @@ A channel without an owner, or that belongs to a [group](../resources/group.md) To restore a channel from its archived state, use the [unarchive](channel-unarchive.md) method. A channel can’t be archived or unarchived if its team is archived. ## 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). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -|Permission type | Permissions (from least to most privileged) | -|:--------------------|:---------------------------------------------------------| -|Delegated (work or school account) | ChannelSettings.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | ChannelSettings.ReadWrite.All | + +[!INCLUDE [permissions-table](../includes/permissions/channel-archive-permissions.md)] > **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. diff --git a/api-reference/beta/api/channel-unarchive.md b/api-reference/beta/api/channel-unarchive.md index aaac43ff703..a957038244d 100644 --- a/api-reference/beta/api/channel-unarchive.md +++ b/api-reference/beta/api/channel-unarchive.md @@ -21,13 +21,10 @@ Unarchiving is an asynchronous operation; a channel is unarchived when the async ## 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). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -|Permission type | Permissions (from least to most privileged) | -|:--------------------|:---------------------------------------------------------| -|Delegated (work or school account) | ChannelSettings.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | ChannelSettings.ReadWrite.All | + +[!INCLUDE [permissions-table](../includes/permissions/channel-unarchive-permissions.md)] > **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. diff --git a/api-reference/beta/includes/permissions/channel-archive-permissions.md b/api-reference/beta/includes/permissions/channel-archive-permissions.md new file mode 100644 index 00000000000..bcfeb5d7f30 --- /dev/null +++ b/api-reference/beta/includes/permissions/channel-archive-permissions.md @@ -0,0 +1,11 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +ms.topic: include +ms.localizationpriority: medium +--- + +|Permission type|Least privileged permissions|Higher privileged permissions| +|:---|:---|:---| +|Delegated (work or school account)|ChannelSettings.ReadWrite.All|Not available.| +|Delegated (personal Microsoft account)|Not supported.|Not supported.| +|Application|ChannelSettings.ReadWrite.All|Not available.| \ No newline at end of file diff --git a/api-reference/beta/includes/permissions/channel-unarchive-permissions.md b/api-reference/beta/includes/permissions/channel-unarchive-permissions.md new file mode 100644 index 00000000000..bcfeb5d7f30 --- /dev/null +++ b/api-reference/beta/includes/permissions/channel-unarchive-permissions.md @@ -0,0 +1,11 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +ms.topic: include +ms.localizationpriority: medium +--- + +|Permission type|Least privileged permissions|Higher privileged permissions| +|:---|:---|:---| +|Delegated (work or school account)|ChannelSettings.ReadWrite.All|Not available.| +|Delegated (personal Microsoft account)|Not supported.|Not supported.| +|Application|ChannelSettings.ReadWrite.All|Not available.| \ No newline at end of file From 6a0c296ba479a5c910989eac135d0643e6eb7280 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Tue, 2 Apr 2024 12:44:41 +0000 Subject: [PATCH 198/204] Update generated files with build 141843 --- ...simulationroot-delete-trainingcampaigns.md | 35 ++++ ...cksimulationroot-list-trainingcampaigns.md | 35 ++++ ...cksimulationroot-post-trainingcampaigns.md | 33 +++- api-reference/beta/api/channel-archive.md | 35 ++++ api-reference/beta/api/channel-unarchive.md | 35 ++++ .../api/cloudpcprovisioningpolicy-apply.md | 35 ++++ .../cloudpcprovisioningpolicy-applyconfig.md | 35 ++++ ...ngealertrecordsportalnotificationassent.md | 35 ++++ api-reference/beta/api/listitem-delta.md | 35 ++++ .../beta/api/trainingcampaign-get.md | 177 +++++++++++++++++- .../beta/api/trainingcampaign-update.md | 31 +++ .../api/usertrainingcampaigndetails-list.md | 7 + ...dsportalnotificationassent-cli-snippets.md | 10 + ...-cloudpcprovisioningpolicy-cli-snippets.md | 13 ++ .../cli/archive-channel-cli-snippets.md | 2 +- ...oningpolicythisapplyconfig-cli-snippets.md | 17 ++ ...onnectionhistoricalreports-cli-snippets.md | 4 +- ...ate-trainingcampaign-from--cli-snippets.md | 67 +++++++ .../delete-trainingcampaign-cli-snippets.md | 10 + ...loudpcprovisioningpolicy-3-cli-snippets.md | 2 +- .../cli/get-trainingcampaign-cli-snippets.md | 10 + .../cli/list-trainingcampaign-cli-snippets.md | 2 +- .../cli/unarchive-channel-cli-snippets.md | 2 +- .../update-trainingcampaign-cli-snippets.md | 67 +++++++ ...ortalnotificationassent-csharp-snippets.md | 25 +++ ...oudpcprovisioningpolicy-csharp-snippets.md | 22 +++ .../csharp/archive-channel-csharp-snippets.md | 2 +- ...ngpolicythisapplyconfig-csharp-snippets.md | 27 +++ ...-trainingcampaign-from--csharp-snippets.md | 108 +++++++++++ ...delete-trainingcampaign-csharp-snippets.md | 13 ++ ...dpcprovisioningpolicy-3-csharp-snippets.md | 2 +- .../get-trainingcampaign-csharp-snippets.md | 13 ++ .../list-trainingcampaign-csharp-snippets.md | 2 +- .../unarchive-channel-csharp-snippets.md | 2 +- ...update-trainingcampaign-csharp-snippets.md | 108 +++++++++++ ...rdsportalnotificationassent-go-snippets.md | 28 +++ ...y-cloudpcprovisioningpolicy-go-snippets.md | 26 +++ .../go/archive-channel-go-snippets.md | 4 +- ...ioningpolicythisapplyconfig-go-snippets.md | 31 +++ .../go/delete-trainingcampaign-go-snippets.md | 21 +++ ...cloudpcprovisioningpolicy-3-go-snippets.md | 2 +- .../go/get-trainingcampaign-go-snippets.md | 21 +++ .../go/list-trainingcampaign-go-snippets.md | 21 +++ .../go/unarchive-channel-go-snippets.md | 21 +++ ...sportalnotificationassent-java-snippets.md | 19 ++ ...cloudpcprovisioningpolicy-java-snippets.md | 16 ++ .../java/archive-channel-java-snippets.md | 2 +- ...ningpolicythisapplyconfig-java-snippets.md | 20 ++ ...te-trainingcampaign-from--java-snippets.md | 78 ++++++++ .../delete-trainingcampaign-java-snippets.md | 4 +- ...oudpcprovisioningpolicy-3-java-snippets.md | 2 +- .../get-trainingcampaign-java-snippets.md | 14 ++ .../list-trainingcampaign-java-snippets.md | 14 ++ .../java/unarchive-channel-java-snippets.md | 2 +- .../update-trainingcampaign-java-snippets.md | 78 ++++++++ ...lnotificationassent-javascript-snippets.md | 25 +++ ...cprovisioningpolicy-javascript-snippets.md | 21 +++ .../archive-channel-javascript-snippets.md | 5 +- ...licythisapplyconfig-javascript-snippets.md | 25 +++ ...onhistoricalreports-javascript-snippets.md | 4 +- ...egorytemplate-from--javascript-snippets.md | 4 +- ...iningcampaign-from--javascript-snippets.md | 75 ++++++++ ...te-trainingcampaign-javascript-snippets.md | 3 +- ...rovisioningpolicy-3-javascript-snippets.md | 2 +- ...subcategorytemplate-javascript-snippets.md | 2 +- ...rainingcampaign-eun-javascript-snippets.md | 17 ++ ...ign-excludedtargets-javascript-snippets.md | 17 ++ ...ign-includedtargets-javascript-snippets.md | 17 ++ ...et-trainingcampaign-javascript-snippets.md | 17 ++ ...ngcampaign-training-javascript-snippets.md | 17 ++ ...ampaignusersdetails-javascript-snippets.md | 17 ++ ...subcategorytemplate-javascript-snippets.md | 2 +- ...st-trainingcampaign-javascript-snippets.md | 4 +- .../unarchive-channel-javascript-snippets.md | 5 +- ...te-trainingcampaign-javascript-snippets.md | 75 ++++++++ ...dsportalnotificationassent-php-snippets.md | 17 ++ ...-cloudpcprovisioningpolicy-php-snippets.md | 17 ++ .../php/archive-channel-php-snippets.md | 2 +- ...oningpolicythisapplyconfig-php-snippets.md | 18 ++ ...ate-trainingcampaign-from--php-snippets.md | 76 ++++++++ .../delete-trainingcampaign-php-snippets.md | 15 ++ ...loudpcprovisioningpolicy-3-php-snippets.md | 2 +- .../php/get-trainingcampaign-php-snippets.md | 15 ++ .../php/list-trainingcampaign-php-snippets.md | 2 +- .../php/unarchive-channel-php-snippets.md | 15 ++ .../update-trainingcampaign-php-snippets.md | 76 ++++++++ ...lnotificationassent-powershell-snippets.md | 18 ++ ...cprovisioningpolicy-powershell-snippets.md | 15 ++ .../archive-channel-powershell-snippets.md | 11 ++ ...licythisapplyconfig-powershell-snippets.md | 19 ++ ...iningcampaign-from--powershell-snippets.md | 69 +++++++ ...te-trainingcampaign-powershell-snippets.md | 11 ++ ...rovisioningpolicy-3-powershell-snippets.md | 2 +- ...et-trainingcampaign-powershell-snippets.md | 11 ++ ...st-trainingcampaign-powershell-snippets.md | 11 ++ .../unarchive-channel-powershell-snippets.md | 11 ++ ...te-trainingcampaign-powershell-snippets.md | 69 +++++++ ...ortalnotificationassent-python-snippets.md | 22 +++ ...oudpcprovisioningpolicy-python-snippets.md | 19 ++ .../python/archive-channel-python-snippets.md | 15 ++ ...ngpolicythisapplyconfig-python-snippets.md | 23 +++ ...-trainingcampaign-from--python-snippets.md | 84 +++++++++ ...delete-trainingcampaign-python-snippets.md | 15 ++ ...dpcprovisioningpolicy-3-python-snippets.md | 2 +- .../get-trainingcampaign-python-snippets.md | 15 ++ .../list-trainingcampaign-python-snippets.md | 2 +- .../unarchive-channel-python-snippets.md | 2 +- ...update-trainingcampaign-python-snippets.md | 84 +++++++++ api-reference/v1.0/api/listitem-delta.md | 105 +++++++++++ ...portroot-getrelyingpartydetailedsummary.md | 35 ++++ ...est-datalink-tokenislatest-cli-snippets.md | 2 +- .../get-listitem-delta-first-cli-snippets.md | 10 + .../get-listitem-delta-last-cli-snippets.md | 10 + ...elyingpartydetailedsummary-cli-snippets.md | 2 +- ...-datalink-tokenislatest-csharp-snippets.md | 4 +- ...et-listitem-delta-first-csharp-snippets.md | 13 ++ ...get-listitem-delta-last-csharp-snippets.md | 4 +- ...ingpartydetailedsummary-csharp-snippets.md | 13 ++ ...test-datalink-tokenislatest-go-snippets.md | 31 +++ .../get-listitem-delta-first-go-snippets.md | 2 +- .../go/get-listitem-delta-last-go-snippets.md | 31 +++ ...relyingpartydetailedsummary-go-snippets.md | 3 +- ...st-datalink-tokenislatest-java-snippets.md | 4 +- .../get-listitem-delta-first-java-snippets.md | 14 ++ .../get-listitem-delta-last-java-snippets.md | 16 ++ ...lyingpartydetailedsummary-java-snippets.md | 2 +- ...alink-tokenislatest-javascript-snippets.md | 16 ++ ...istitem-delta-first-javascript-snippets.md | 16 ++ ...listitem-delta-last-javascript-snippets.md | 16 ++ ...artydetailedsummary-javascript-snippets.md | 3 +- ...est-datalink-tokenislatest-php-snippets.md | 20 ++ .../get-listitem-delta-first-php-snippets.md | 15 ++ .../get-listitem-delta-last-php-snippets.md | 20 ++ ...elyingpartydetailedsummary-php-snippets.md | 2 +- ...alink-tokenislatest-powershell-snippets.md | 11 ++ ...istitem-delta-first-powershell-snippets.md | 11 ++ ...listitem-delta-last-powershell-snippets.md | 11 ++ ...artydetailedsummary-powershell-snippets.md | 11 ++ ...-datalink-tokenislatest-python-snippets.md | 23 +++ ...et-listitem-delta-first-python-snippets.md | 15 ++ ...get-listitem-delta-last-python-snippets.md | 23 +++ ...ingpartydetailedsummary-python-snippets.md | 2 +- concepts/tutorial-access-package-api.md | 125 +++++-------- concepts/tutorial-riskdetection-api.md | 2 +- ...t-get-accesspackagecatalog-cli-snippets.md | 10 - ...accesspackageresourceroles-cli-snippets.md | 10 - ...sspackageresourcerolescope-cli-snippets.md | 24 --- ...get-accesspackageresources-cli-snippets.md | 10 - ...ement-create-accesspackage-cli-snippets.md | 2 +- ...entmanagement-create-group-cli-snippets.md | 17 -- ...mentmanagement-create-user-cli-snippets.md | 20 -- ...t-get-accesspackagecatalog-cli-snippets.md | 10 + ...cesspackageresourcerequest-cli-snippets.md | 4 +- ...accesspackageresourceroles-cli-snippets.md | 10 + ...get-accesspackageresources-cli-snippets.md | 10 + ...-riskdetection-create-user-cli-snippets.md | 20 -- ...riskdetection-delete-group-cli-snippets.md | 2 +- ...spackageresourcerequest-csharp-snippets.md | 31 --- ...ackageresourcerolescope-csharp-snippets.md | 38 ---- ...nt-create-accesspackage-csharp-snippets.md | 9 +- ...management-create-group-csharp-snippets.md | 25 --- ...tmanagement-create-user-csharp-snippets.md | 29 --- ...et-accesspackagecatalog-csharp-snippets.md | 2 +- ...spackageresourcerequest-csharp-snippets.md | 38 ++++ ...esspackageresourceroles-csharp-snippets.md | 6 +- ...-accesspackageresources-csharp-snippets.md | 4 +- ...skdetection-create-user-csharp-snippets.md | 29 --- ...kdetection-delete-group-csharp-snippets.md | 2 +- ...nt-get-accesspackagecatalog-go-snippets.md | 31 --- ...ccesspackageresourcerequest-go-snippets.md | 41 ---- ...-accesspackageresourceroles-go-snippets.md | 32 ---- ...esspackageresourcerolescope-go-snippets.md | 47 ----- ...-get-accesspackageresources-go-snippets.md | 31 --- ...gement-create-accesspackage-go-snippets.md | 10 +- ...mentmanagement-create-group-go-snippets.md | 33 ---- ...ementmanagement-create-user-go-snippets.md | 37 ---- ...nt-get-accesspackagecatalog-go-snippets.md | 31 +++ ...ccesspackageresourcerequest-go-snippets.md | 38 ++++ ...-accesspackageresourceroles-go-snippets.md | 32 ++++ ...-get-accesspackageresources-go-snippets.md | 31 +++ ...l-riskdetection-create-user-go-snippets.md | 37 ---- ...-riskdetection-delete-group-go-snippets.md | 2 +- ...n-get-riskdetections-filter-go-snippets.md | 31 --- ...iskdetection-riskyuserslist-go-snippets.md | 31 --- ...ccesspackageresourceroles-java-snippets.md | 17 -- ...spackageresourcerolescope-java-snippets.md | 30 --- ...ment-create-accesspackage-java-snippets.md | 4 +- ...ntmanagement-create-group-java-snippets.md | 20 -- ...entmanagement-create-user-java-snippets.md | 23 --- ...-get-accesspackagecatalog-java-snippets.md | 2 +- ...esspackageresourcerequest-java-snippets.md | 16 +- ...ccesspackageresourceroles-java-snippets.md | 17 ++ ...et-accesspackageresources-java-snippets.md | 4 +- ...riskdetection-create-user-java-snippets.md | 23 --- ...iskdetection-delete-group-java-snippets.md | 2 +- ...ackageresourceroles-javascript-snippets.md | 19 -- ...geresourcerolescope-javascript-snippets.md | 32 ---- ...esspackageresources-javascript-snippets.md | 18 -- ...reate-accesspackage-javascript-snippets.md | 1 - ...gement-create-group-javascript-snippets.md | 24 --- ...agement-create-user-javascript-snippets.md | 27 --- ...ccesspackagecatalog-javascript-snippets.md | 3 +- ...kageresourcerequest-javascript-snippets.md | 5 +- ...ackageresourceroles-javascript-snippets.md | 18 ++ ...esspackageresources-javascript-snippets.md | 17 ++ ...t-get-group-members-javascript-snippets.md | 2 +- ...tection-create-user-javascript-snippets.md | 27 --- ...ection-delete-group-javascript-snippets.md | 2 +- ...cesspackageresourcerequest-php-snippets.md | 26 --- ...accesspackageresourceroles-php-snippets.md | 21 --- ...sspackageresourcerolescope-php-snippets.md | 31 --- ...get-accesspackageresources-php-snippets.md | 20 -- ...ement-create-accesspackage-php-snippets.md | 5 +- ...entmanagement-create-group-php-snippets.md | 21 --- ...mentmanagement-create-user-php-snippets.md | 24 --- ...t-get-accesspackagecatalog-php-snippets.md | 6 +- ...cesspackageresourcerequest-php-snippets.md | 27 +++ ...accesspackageresourceroles-php-snippets.md | 21 +++ ...get-accesspackageresources-php-snippets.md | 20 ++ ...-riskdetection-create-user-php-snippets.md | 24 --- ...riskdetection-delete-group-php-snippets.md | 2 +- ...-get-riskdetections-filter-php-snippets.md | 20 -- ...skdetection-riskyuserslist-php-snippets.md | 20 -- ...ccesspackagecatalog-powershell-snippets.md | 11 -- ...ackageresourceroles-powershell-snippets.md | 11 -- ...geresourcerolescope-powershell-snippets.md | 29 --- ...esspackageresources-powershell-snippets.md | 11 -- ...reate-accesspackage-powershell-snippets.md | 4 +- ...gement-create-group-powershell-snippets.md | 19 -- ...agement-create-user-powershell-snippets.md | 22 --- ...gement-delete-group-powershell-snippets.md | 11 -- ...agement-delete-user-powershell-snippets.md | 11 -- ...ccesspackagecatalog-powershell-snippets.md | 11 ++ ...kageresourcerequest-powershell-snippets.md | 6 +- ...ackageresourceroles-powershell-snippets.md | 11 ++ ...esspackageresources-powershell-snippets.md | 11 ++ ...tection-create-user-powershell-snippets.md | 22 --- ...ection-delete-group-powershell-snippets.md | 4 +- ...tection-delete-user-powershell-snippets.md | 11 -- ...skdetections-filter-powershell-snippets.md | 11 -- ...tion-riskyuserslist-powershell-snippets.md | 11 -- ...et-accesspackagecatalog-python-snippets.md | 23 --- ...spackageresourcerequest-python-snippets.md | 29 --- ...esspackageresourceroles-python-snippets.md | 24 --- ...ackageresourcerolescope-python-snippets.md | 36 ---- ...-accesspackageresources-python-snippets.md | 23 --- ...nt-create-accesspackage-python-snippets.md | 4 +- ...management-create-group-python-snippets.md | 23 --- ...tmanagement-create-user-python-snippets.md | 27 --- ...et-accesspackagecatalog-python-snippets.md | 23 +++ ...spackageresourcerequest-python-snippets.md | 28 +++ ...esspackageresourceroles-python-snippets.md | 24 +++ ...-accesspackageresources-python-snippets.md | 23 +++ ...skdetection-create-user-python-snippets.md | 27 --- ...kdetection-delete-group-python-snippets.md | 2 +- ...t-riskdetections-filter-python-snippets.md | 23 --- ...etection-riskyuserslist-python-snippets.md | 23 --- 257 files changed, 3638 insertions(+), 1713 deletions(-) create mode 100644 api-reference/beta/includes/snippets/cli/alertrecordthischangealertrecordsportalnotificationassent-cli-snippets.md create mode 100644 api-reference/beta/includes/snippets/cli/apply-cloudpcprovisioningpolicy-cli-snippets.md rename includes/snippets/cli/v1/tutorial-riskdetection-delete-user-cli-snippets.md => api-reference/beta/includes/snippets/cli/archive-channel-cli-snippets.md (61%) create mode 100644 api-reference/beta/includes/snippets/cli/cloudpcprovisioningpolicythisapplyconfig-cli-snippets.md create mode 100644 api-reference/beta/includes/snippets/cli/create-trainingcampaign-from--cli-snippets.md create mode 100644 api-reference/beta/includes/snippets/cli/delete-trainingcampaign-cli-snippets.md create mode 100644 api-reference/beta/includes/snippets/cli/get-trainingcampaign-cli-snippets.md rename includes/snippets/cli/v1/tutorial-entitlementmanagement-delete-user-cli-snippets.md => api-reference/beta/includes/snippets/cli/list-trainingcampaign-cli-snippets.md (68%) rename includes/snippets/cli/v1/tutorial-riskdetection-riskyuserslist-cli-snippets.md => api-reference/beta/includes/snippets/cli/unarchive-channel-cli-snippets.md (60%) create mode 100644 api-reference/beta/includes/snippets/cli/update-trainingcampaign-cli-snippets.md create mode 100644 api-reference/beta/includes/snippets/csharp/alertrecordthischangealertrecordsportalnotificationassent-csharp-snippets.md create mode 100644 api-reference/beta/includes/snippets/csharp/apply-cloudpcprovisioningpolicy-csharp-snippets.md rename includes/snippets/csharp/v1/tutorial-riskdetection-delete-user-csharp-snippets.md => api-reference/beta/includes/snippets/csharp/archive-channel-csharp-snippets.md (77%) create mode 100644 api-reference/beta/includes/snippets/csharp/cloudpcprovisioningpolicythisapplyconfig-csharp-snippets.md create mode 100644 api-reference/beta/includes/snippets/csharp/create-trainingcampaign-from--csharp-snippets.md create mode 100644 api-reference/beta/includes/snippets/csharp/delete-trainingcampaign-csharp-snippets.md create mode 100644 api-reference/beta/includes/snippets/csharp/get-trainingcampaign-csharp-snippets.md rename includes/snippets/csharp/v1/tutorial-entitlementmanagement-delete-user-csharp-snippets.md => api-reference/beta/includes/snippets/csharp/list-trainingcampaign-csharp-snippets.md (77%) rename includes/snippets/csharp/v1/tutorial-entitlementmanagement-delete-group-csharp-snippets.md => api-reference/beta/includes/snippets/csharp/unarchive-channel-csharp-snippets.md (77%) create mode 100644 api-reference/beta/includes/snippets/csharp/update-trainingcampaign-csharp-snippets.md create mode 100644 api-reference/beta/includes/snippets/go/alertrecordthischangealertrecordsportalnotificationassent-go-snippets.md create mode 100644 api-reference/beta/includes/snippets/go/apply-cloudpcprovisioningpolicy-go-snippets.md rename includes/snippets/go/v1/tutorial-entitlementmanagement-delete-user-go-snippets.md => api-reference/beta/includes/snippets/go/archive-channel-go-snippets.md (53%) create mode 100644 api-reference/beta/includes/snippets/go/cloudpcprovisioningpolicythisapplyconfig-go-snippets.md create mode 100644 api-reference/beta/includes/snippets/go/delete-trainingcampaign-go-snippets.md create mode 100644 api-reference/beta/includes/snippets/go/get-trainingcampaign-go-snippets.md create mode 100644 api-reference/beta/includes/snippets/go/list-trainingcampaign-go-snippets.md create mode 100644 api-reference/beta/includes/snippets/go/unarchive-channel-go-snippets.md create mode 100644 api-reference/beta/includes/snippets/java/alertrecordthischangealertrecordsportalnotificationassent-java-snippets.md create mode 100644 api-reference/beta/includes/snippets/java/apply-cloudpcprovisioningpolicy-java-snippets.md rename includes/snippets/java/v1/tutorial-entitlementmanagement-delete-user-java-snippets.md => api-reference/beta/includes/snippets/java/archive-channel-java-snippets.md (69%) create mode 100644 api-reference/beta/includes/snippets/java/cloudpcprovisioningpolicythisapplyconfig-java-snippets.md create mode 100644 api-reference/beta/includes/snippets/java/create-trainingcampaign-from--java-snippets.md rename includes/snippets/java/v1/tutorial-riskdetection-riskyuserslist-java-snippets.md => api-reference/beta/includes/snippets/java/delete-trainingcampaign-java-snippets.md (54%) create mode 100644 api-reference/beta/includes/snippets/java/get-trainingcampaign-java-snippets.md create mode 100644 api-reference/beta/includes/snippets/java/list-trainingcampaign-java-snippets.md rename includes/snippets/java/v1/tutorial-entitlementmanagement-delete-group-java-snippets.md => api-reference/beta/includes/snippets/java/unarchive-channel-java-snippets.md (70%) create mode 100644 api-reference/beta/includes/snippets/java/update-trainingcampaign-java-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/alertrecordthischangealertrecordsportalnotificationassent-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/apply-cloudpcprovisioningpolicy-javascript-snippets.md rename includes/snippets/javascript/v1/tutorial-entitlementmanagement-delete-user-javascript-snippets.md => api-reference/beta/includes/snippets/javascript/archive-channel-javascript-snippets.md (63%) create mode 100644 api-reference/beta/includes/snippets/javascript/cloudpcprovisioningpolicythisapplyconfig-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/create-trainingcampaign-from--javascript-snippets.md rename includes/snippets/javascript/v1/tutorial-riskdetection-delete-user-javascript-snippets.md => api-reference/beta/includes/snippets/javascript/delete-trainingcampaign-javascript-snippets.md (62%) create mode 100644 api-reference/beta/includes/snippets/javascript/get-trainingcampaign-eun-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/get-trainingcampaign-excludedtargets-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/get-trainingcampaign-includedtargets-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/get-trainingcampaign-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/get-trainingcampaign-training-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/javascript/list-campaignusersdetails-javascript-snippets.md rename includes/snippets/javascript/v1/tutorial-riskdetection-riskyuserslist-javascript-snippets.md => api-reference/beta/includes/snippets/javascript/list-trainingcampaign-javascript-snippets.md (59%) rename includes/snippets/javascript/v1/tutorial-entitlementmanagement-delete-group-javascript-snippets.md => api-reference/beta/includes/snippets/javascript/unarchive-channel-javascript-snippets.md (62%) create mode 100644 api-reference/beta/includes/snippets/javascript/update-trainingcampaign-javascript-snippets.md create mode 100644 api-reference/beta/includes/snippets/php/alertrecordthischangealertrecordsportalnotificationassent-php-snippets.md create mode 100644 api-reference/beta/includes/snippets/php/apply-cloudpcprovisioningpolicy-php-snippets.md rename includes/snippets/php/v1/tutorial-entitlementmanagement-delete-user-php-snippets.md => api-reference/beta/includes/snippets/php/archive-channel-php-snippets.md (58%) create mode 100644 api-reference/beta/includes/snippets/php/cloudpcprovisioningpolicythisapplyconfig-php-snippets.md create mode 100644 api-reference/beta/includes/snippets/php/create-trainingcampaign-from--php-snippets.md create mode 100644 api-reference/beta/includes/snippets/php/delete-trainingcampaign-php-snippets.md create mode 100644 api-reference/beta/includes/snippets/php/get-trainingcampaign-php-snippets.md rename includes/snippets/php/v1/tutorial-riskdetection-delete-user-php-snippets.md => api-reference/beta/includes/snippets/php/list-trainingcampaign-php-snippets.md (62%) create mode 100644 api-reference/beta/includes/snippets/php/unarchive-channel-php-snippets.md create mode 100644 api-reference/beta/includes/snippets/php/update-trainingcampaign-php-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/alertrecordthischangealertrecordsportalnotificationassent-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/apply-cloudpcprovisioningpolicy-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/archive-channel-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/cloudpcprovisioningpolicythisapplyconfig-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/create-trainingcampaign-from--powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/delete-trainingcampaign-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/get-trainingcampaign-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/list-trainingcampaign-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/unarchive-channel-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/powershell/update-trainingcampaign-powershell-snippets.md create mode 100644 api-reference/beta/includes/snippets/python/alertrecordthischangealertrecordsportalnotificationassent-python-snippets.md create mode 100644 api-reference/beta/includes/snippets/python/apply-cloudpcprovisioningpolicy-python-snippets.md create mode 100644 api-reference/beta/includes/snippets/python/archive-channel-python-snippets.md create mode 100644 api-reference/beta/includes/snippets/python/cloudpcprovisioningpolicythisapplyconfig-python-snippets.md create mode 100644 api-reference/beta/includes/snippets/python/create-trainingcampaign-from--python-snippets.md create mode 100644 api-reference/beta/includes/snippets/python/delete-trainingcampaign-python-snippets.md create mode 100644 api-reference/beta/includes/snippets/python/get-trainingcampaign-python-snippets.md rename includes/snippets/python/v1/tutorial-entitlementmanagement-delete-group-python-snippets.md => api-reference/beta/includes/snippets/python/list-trainingcampaign-python-snippets.md (69%) rename includes/snippets/python/v1/tutorial-entitlementmanagement-delete-user-python-snippets.md => api-reference/beta/includes/snippets/python/unarchive-channel-python-snippets.md (64%) create mode 100644 api-reference/beta/includes/snippets/python/update-trainingcampaign-python-snippets.md rename includes/snippets/cli/v1/tutorial-riskdetection-get-riskdetections-filter-cli-snippets.md => api-reference/v1.0/includes/snippets/cli/get-delta-latest-datalink-tokenislatest-cli-snippets.md (57%) create mode 100644 api-reference/v1.0/includes/snippets/cli/get-listitem-delta-first-cli-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/cli/get-listitem-delta-last-cli-snippets.md rename includes/snippets/cli/v1/tutorial-entitlementmanagement-delete-group-cli-snippets.md => api-reference/v1.0/includes/snippets/cli/reportrootthisgetrelyingpartydetailedsummary-cli-snippets.md (60%) rename includes/snippets/csharp/v1/tutorial-riskdetection-riskyuserslist-csharp-snippets.md => api-reference/v1.0/includes/snippets/csharp/get-delta-latest-datalink-tokenislatest-csharp-snippets.md (61%) create mode 100644 api-reference/v1.0/includes/snippets/csharp/get-listitem-delta-first-csharp-snippets.md rename includes/snippets/csharp/v1/tutorial-riskdetection-get-riskdetections-filter-csharp-snippets.md => api-reference/v1.0/includes/snippets/csharp/get-listitem-delta-last-csharp-snippets.md (60%) create mode 100644 api-reference/v1.0/includes/snippets/csharp/reportrootthisgetrelyingpartydetailedsummary-csharp-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/go/get-delta-latest-datalink-tokenislatest-go-snippets.md rename includes/snippets/go/v1/tutorial-entitlementmanagement-delete-group-go-snippets.md => api-reference/v1.0/includes/snippets/go/get-listitem-delta-first-go-snippets.md (63%) create mode 100644 api-reference/v1.0/includes/snippets/go/get-listitem-delta-last-go-snippets.md rename includes/snippets/go/v1/tutorial-riskdetection-delete-user-go-snippets.md => api-reference/v1.0/includes/snippets/go/reportrootthisgetrelyingpartydetailedsummary-go-snippets.md (54%) rename includes/snippets/java/v1/tutorial-riskdetection-get-riskdetections-filter-java-snippets.md => api-reference/v1.0/includes/snippets/java/get-delta-latest-datalink-tokenislatest-java-snippets.md (53%) create mode 100644 api-reference/v1.0/includes/snippets/java/get-listitem-delta-first-java-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/java/get-listitem-delta-last-java-snippets.md rename includes/snippets/java/v1/tutorial-riskdetection-delete-user-java-snippets.md => api-reference/v1.0/includes/snippets/java/reportrootthisgetrelyingpartydetailedsummary-java-snippets.md (71%) create mode 100644 api-reference/v1.0/includes/snippets/javascript/get-delta-latest-datalink-tokenislatest-javascript-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/javascript/get-listitem-delta-first-javascript-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/javascript/get-listitem-delta-last-javascript-snippets.md rename includes/snippets/javascript/v1/tutorial-riskdetection-get-riskdetections-filter-javascript-snippets.md => api-reference/v1.0/includes/snippets/javascript/reportrootthisgetrelyingpartydetailedsummary-javascript-snippets.md (58%) create mode 100644 api-reference/v1.0/includes/snippets/php/get-delta-latest-datalink-tokenislatest-php-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/php/get-listitem-delta-first-php-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/php/get-listitem-delta-last-php-snippets.md rename includes/snippets/php/v1/tutorial-entitlementmanagement-delete-group-php-snippets.md => api-reference/v1.0/includes/snippets/php/reportrootthisgetrelyingpartydetailedsummary-php-snippets.md (59%) create mode 100644 api-reference/v1.0/includes/snippets/powershell/get-delta-latest-datalink-tokenislatest-powershell-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/powershell/get-listitem-delta-first-powershell-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/powershell/get-listitem-delta-last-powershell-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/powershell/reportrootthisgetrelyingpartydetailedsummary-powershell-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/python/get-delta-latest-datalink-tokenislatest-python-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/python/get-listitem-delta-first-python-snippets.md create mode 100644 api-reference/v1.0/includes/snippets/python/get-listitem-delta-last-python-snippets.md rename includes/snippets/python/v1/tutorial-riskdetection-delete-user-python-snippets.md => api-reference/v1.0/includes/snippets/python/reportrootthisgetrelyingpartydetailedsummary-python-snippets.md (64%) delete mode 100644 includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md delete mode 100644 includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md delete mode 100644 includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-cli-snippets.md delete mode 100644 includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md rename includes/snippets/cli/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md (77%) delete mode 100644 includes/snippets/cli/v1/tutorial-entitlementmanagement-create-group-cli-snippets.md delete mode 100644 includes/snippets/cli/v1/tutorial-entitlementmanagement-create-user-cli-snippets.md create mode 100644 includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md rename includes/snippets/cli/{beta => v1}/tutorial-entitlementmanagement-get-accesspackageresourcerequest-cli-snippets.md (68%) create mode 100644 includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md create mode 100644 includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md delete mode 100644 includes/snippets/cli/v1/tutorial-riskdetection-create-user-cli-snippets.md delete mode 100644 includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md delete mode 100644 includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-csharp-snippets.md rename includes/snippets/csharp/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md (78%) delete mode 100644 includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-group-csharp-snippets.md delete mode 100644 includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-user-csharp-snippets.md rename includes/snippets/csharp/{beta => v1}/tutorial-entitlementmanagement-get-accesspackagecatalog-csharp-snippets.md (87%) create mode 100644 includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md rename includes/snippets/csharp/{beta => v1}/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md (56%) rename includes/snippets/csharp/{beta => v1}/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md (63%) delete mode 100644 includes/snippets/csharp/v1/tutorial-riskdetection-create-user-csharp-snippets.md delete mode 100644 includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md delete mode 100644 includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md delete mode 100644 includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md delete mode 100644 includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-go-snippets.md delete mode 100644 includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md rename includes/snippets/go/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md (67%) delete mode 100644 includes/snippets/go/v1/tutorial-entitlementmanagement-create-group-go-snippets.md delete mode 100644 includes/snippets/go/v1/tutorial-entitlementmanagement-create-user-go-snippets.md create mode 100644 includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md create mode 100644 includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md create mode 100644 includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md create mode 100644 includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md delete mode 100644 includes/snippets/go/v1/tutorial-riskdetection-create-user-go-snippets.md delete mode 100644 includes/snippets/go/v1/tutorial-riskdetection-get-riskdetections-filter-go-snippets.md delete mode 100644 includes/snippets/go/v1/tutorial-riskdetection-riskyuserslist-go-snippets.md delete mode 100644 includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md delete mode 100644 includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-java-snippets.md rename includes/snippets/java/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md (73%) delete mode 100644 includes/snippets/java/v1/tutorial-entitlementmanagement-create-group-java-snippets.md delete mode 100644 includes/snippets/java/v1/tutorial-entitlementmanagement-create-user-java-snippets.md rename includes/snippets/java/{beta => v1}/tutorial-entitlementmanagement-get-accesspackagecatalog-java-snippets.md (80%) rename includes/snippets/java/{beta => v1}/tutorial-entitlementmanagement-get-accesspackageresourcerequest-java-snippets.md (50%) create mode 100644 includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md rename includes/snippets/java/{beta => v1}/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md (53%) delete mode 100644 includes/snippets/java/v1/tutorial-riskdetection-create-user-java-snippets.md delete mode 100644 includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md delete mode 100644 includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-javascript-snippets.md delete mode 100644 includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md rename includes/snippets/javascript/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md (96%) delete mode 100644 includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-group-javascript-snippets.md delete mode 100644 includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-user-javascript-snippets.md rename includes/snippets/javascript/{beta => v1}/tutorial-entitlementmanagement-get-accesspackagecatalog-javascript-snippets.md (61%) rename includes/snippets/javascript/{beta => v1}/tutorial-entitlementmanagement-get-accesspackageresourcerequest-javascript-snippets.md (72%) create mode 100644 includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md create mode 100644 includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md delete mode 100644 includes/snippets/javascript/v1/tutorial-riskdetection-create-user-javascript-snippets.md delete mode 100644 includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md delete mode 100644 includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md delete mode 100644 includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-php-snippets.md delete mode 100644 includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md rename includes/snippets/php/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md (77%) delete mode 100644 includes/snippets/php/v1/tutorial-entitlementmanagement-create-group-php-snippets.md delete mode 100644 includes/snippets/php/v1/tutorial-entitlementmanagement-create-user-php-snippets.md rename includes/snippets/php/{beta => v1}/tutorial-entitlementmanagement-get-accesspackagecatalog-php-snippets.md (56%) create mode 100644 includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md create mode 100644 includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md create mode 100644 includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md delete mode 100644 includes/snippets/php/v1/tutorial-riskdetection-create-user-php-snippets.md delete mode 100644 includes/snippets/php/v1/tutorial-riskdetection-get-riskdetections-filter-php-snippets.md delete mode 100644 includes/snippets/php/v1/tutorial-riskdetection-riskyuserslist-php-snippets.md delete mode 100644 includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md delete mode 100644 includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md delete mode 100644 includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-powershell-snippets.md delete mode 100644 includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md rename includes/snippets/powershell/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md (66%) delete mode 100644 includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-group-powershell-snippets.md delete mode 100644 includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-user-powershell-snippets.md delete mode 100644 includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-group-powershell-snippets.md delete mode 100644 includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-user-powershell-snippets.md create mode 100644 includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md rename includes/snippets/powershell/{beta => v1}/tutorial-entitlementmanagement-get-accesspackageresourcerequest-powershell-snippets.md (61%) create mode 100644 includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md create mode 100644 includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md delete mode 100644 includes/snippets/powershell/v1/tutorial-riskdetection-create-user-powershell-snippets.md delete mode 100644 includes/snippets/powershell/v1/tutorial-riskdetection-delete-user-powershell-snippets.md delete mode 100644 includes/snippets/powershell/v1/tutorial-riskdetection-get-riskdetections-filter-powershell-snippets.md delete mode 100644 includes/snippets/powershell/v1/tutorial-riskdetection-riskyuserslist-powershell-snippets.md delete mode 100644 includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md delete mode 100644 includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md delete mode 100644 includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md delete mode 100644 includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-python-snippets.md delete mode 100644 includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md rename includes/snippets/python/{beta => v1}/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md (85%) delete mode 100644 includes/snippets/python/v1/tutorial-entitlementmanagement-create-group-python-snippets.md delete mode 100644 includes/snippets/python/v1/tutorial-entitlementmanagement-create-user-python-snippets.md create mode 100644 includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md create mode 100644 includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md create mode 100644 includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md create mode 100644 includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md delete mode 100644 includes/snippets/python/v1/tutorial-riskdetection-create-user-python-snippets.md delete mode 100644 includes/snippets/python/v1/tutorial-riskdetection-get-riskdetections-filter-python-snippets.md delete mode 100644 includes/snippets/python/v1/tutorial-riskdetection-riskyuserslist-python-snippets.md diff --git a/api-reference/beta/api/attacksimulationroot-delete-trainingcampaigns.md b/api-reference/beta/api/attacksimulationroot-delete-trainingcampaigns.md index f2b70bc43e5..e9f12abd067 100644 --- a/api-reference/beta/api/attacksimulationroot-delete-trainingcampaigns.md +++ b/api-reference/beta/api/attacksimulationroot-delete-trainingcampaigns.md @@ -55,6 +55,7 @@ If successful, this method returns a `204 No Content` response code. ### Request The following example shows a request. +# [HTTP](#tab/http) ```msgraph-interactive GET https://graph.microsoft.com/beta/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest ``` +# [C#](#tab/csharp) +[!INCLUDE [sample-code](../includes/snippets/csharp/get-delta-latest-datalink-tokenislatest-csharp-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [CLI](#tab/cli) +[!INCLUDE [sample-code](../includes/snippets/cli/get-delta-latest-datalink-tokenislatest-cli-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Go](#tab/go) +[!INCLUDE [sample-code](../includes/snippets/go/get-delta-latest-datalink-tokenislatest-go-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Java](#tab/java) +[!INCLUDE [sample-code](../includes/snippets/java/get-delta-latest-datalink-tokenislatest-java-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [JavaScript](#tab/javascript) +[!INCLUDE [sample-code](../includes/snippets/javascript/get-delta-latest-datalink-tokenislatest-javascript-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PHP](#tab/php) +[!INCLUDE [sample-code](../includes/snippets/php/get-delta-latest-datalink-tokenislatest-php-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PowerShell](#tab/powershell) +[!INCLUDE [sample-code](../includes/snippets/powershell/get-delta-latest-datalink-tokenislatest-powershell-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Python](#tab/python) +[!INCLUDE [sample-code](../includes/snippets/python/get-delta-latest-datalink-tokenislatest-python-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +--- + #### Response The following example shows the response. diff --git a/api-reference/beta/api/trainingcampaign-get.md b/api-reference/beta/api/trainingcampaign-get.md index d5a548f443e..b5871fab7f8 100644 --- a/api-reference/beta/api/trainingcampaign-get.md +++ b/api-reference/beta/api/trainingcampaign-get.md @@ -62,6 +62,7 @@ The following example shows how to get an attack simulation campaign for a tenan #### Request +# [HTTP](#tab/http) ```msgraph-interactive GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta ``` +# [C#](#tab/csharp) +[!INCLUDE [sample-code](../includes/snippets/csharp/get-listitem-delta-first-csharp-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [CLI](#tab/cli) +[!INCLUDE [sample-code](../includes/snippets/cli/get-listitem-delta-first-cli-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Go](#tab/go) +[!INCLUDE [sample-code](../includes/snippets/go/get-listitem-delta-first-go-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Java](#tab/java) +[!INCLUDE [sample-code](../includes/snippets/java/get-listitem-delta-first-java-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [JavaScript](#tab/javascript) +[!INCLUDE [sample-code](../includes/snippets/javascript/get-listitem-delta-first-javascript-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PHP](#tab/php) +[!INCLUDE [sample-code](../includes/snippets/php/get-listitem-delta-first-php-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PowerShell](#tab/powershell) +[!INCLUDE [sample-code](../includes/snippets/powershell/get-listitem-delta-first-powershell-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Python](#tab/python) +[!INCLUDE [sample-code](../includes/snippets/python/get-listitem-delta-first-python-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +--- + #### Response The following example shows the response that includes the first page of changes and the **@odata.nextLink** property that indicates that no more items are available in the current set of items. Your app should continue to request the URL value of **@odata.nextLink** until all pages of items have been retrieved. @@ -188,12 +223,47 @@ The following example shows a request that gets the last page in a set and how t The following example shows a request after the initial request. +# [HTTP](#tab/http) ```msgraph-interactive GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=1230919asd190410jlka ``` +# [C#](#tab/csharp) +[!INCLUDE [sample-code](../includes/snippets/csharp/get-listitem-delta-last-csharp-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [CLI](#tab/cli) +[!INCLUDE [sample-code](../includes/snippets/cli/get-listitem-delta-last-cli-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Go](#tab/go) +[!INCLUDE [sample-code](../includes/snippets/go/get-listitem-delta-last-go-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Java](#tab/java) +[!INCLUDE [sample-code](../includes/snippets/java/get-listitem-delta-last-java-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [JavaScript](#tab/javascript) +[!INCLUDE [sample-code](../includes/snippets/javascript/get-listitem-delta-last-javascript-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PHP](#tab/php) +[!INCLUDE [sample-code](../includes/snippets/php/get-listitem-delta-last-php-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PowerShell](#tab/powershell) +[!INCLUDE [sample-code](../includes/snippets/powershell/get-listitem-delta-last-powershell-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Python](#tab/python) +[!INCLUDE [sample-code](../includes/snippets/python/get-listitem-delta-last-python-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +--- + #### Response The following example shows the response that indicates that the item named `TestItemB.txt` was deleted and the item `TestFolder` was either added or modified between the initial request and this request to update the local state. @@ -259,12 +329,47 @@ To retrieve the latest `deltaLink`, call `delta` with the query string parameter The following example shows a request. +# [HTTP](#tab/http) ```msgraph-interactive GET https://graph.microsoft.com/v1.0/sites/contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE/lists/22e03ef3-6ef4-424d-a1d3-92a337807c30/items/delta?token=latest ``` +# [C#](#tab/csharp) +[!INCLUDE [sample-code](../includes/snippets/csharp/get-delta-latest-datalink-tokenislatest-csharp-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [CLI](#tab/cli) +[!INCLUDE [sample-code](../includes/snippets/cli/get-delta-latest-datalink-tokenislatest-cli-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Go](#tab/go) +[!INCLUDE [sample-code](../includes/snippets/go/get-delta-latest-datalink-tokenislatest-go-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Java](#tab/java) +[!INCLUDE [sample-code](../includes/snippets/java/get-delta-latest-datalink-tokenislatest-java-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [JavaScript](#tab/javascript) +[!INCLUDE [sample-code](../includes/snippets/javascript/get-delta-latest-datalink-tokenislatest-javascript-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PHP](#tab/php) +[!INCLUDE [sample-code](../includes/snippets/php/get-delta-latest-datalink-tokenislatest-php-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [PowerShell](#tab/powershell) +[!INCLUDE [sample-code](../includes/snippets/powershell/get-delta-latest-datalink-tokenislatest-powershell-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +# [Python](#tab/python) +[!INCLUDE [sample-code](../includes/snippets/python/get-delta-latest-datalink-tokenislatest-python-snippets.md)] +[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] + +--- + #### Response The following example shows the response. diff --git a/api-reference/v1.0/api/reportroot-getrelyingpartydetailedsummary.md b/api-reference/v1.0/api/reportroot-getrelyingpartydetailedsummary.md index b705b4414de..418e318d30c 100644 --- a/api-reference/v1.0/api/reportroot-getrelyingpartydetailedsummary.md +++ b/api-reference/v1.0/api/reportroot-getrelyingpartydetailedsummary.md @@ -67,6 +67,7 @@ If successful, this function returns a `200 OK` response code and a [relyingPart ### Request The following example shows a request. +# [HTTP](#tab/http) -```http +```msgraph-interactive GET https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/catalogs/cec5d6ab-c75d-47c0-9c1c-92e89f66e384/resources?$filter=originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487' ``` # [C#](#tab/csharp) -[!INCLUDE [sample-code](../includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) -[!INCLUDE [sample-code](../includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) -[!INCLUDE [sample-code](../includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) -[!INCLUDE [sample-code](../includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) -[!INCLUDE [sample-code](../includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) -[!INCLUDE [sample-code](../includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) -[!INCLUDE [sample-code](../includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) -[!INCLUDE [sample-code](../includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] --- @@ -297,40 +297,40 @@ In the request, use the **id** of the catalog and the **id** of the group resour "blockType": "request", "name": "tutorial_entitlementmanagement_get_accesspackageresourceroles" }--> -```http +```msgraph-interactive GET https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/catalogs/ede67938-cda7-4127-a9ca-7c7bf86a19b7/resourceRoles?$filter=(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')&$expand=resource ``` # [C#](#tab/csharp) -[!INCLUDE [sample-code](../includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) -[!INCLUDE [sample-code](../includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) -[!INCLUDE [sample-code](../includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) -[!INCLUDE [sample-code](../includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) -[!INCLUDE [sample-code](../includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) -[!INCLUDE [sample-code](../includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) -[!INCLUDE [sample-code](../includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) -[!INCLUDE [sample-code](../includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] --- @@ -394,35 +394,35 @@ Content-type: application/json ``` # [C#](#tab/csharp) -[!INCLUDE [sample-code](../includes/snippets/csharp/beta/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) -[!INCLUDE [sample-code](../includes/snippets/cli/beta/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/cli/v1/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) -[!INCLUDE [sample-code](../includes/snippets/go/beta/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/go/v1/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) -[!INCLUDE [sample-code](../includes/snippets/java/beta/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/java/v1/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) -[!INCLUDE [sample-code](../includes/snippets/javascript/beta/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) -[!INCLUDE [sample-code](../includes/snippets/php/beta/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/php/v1/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) -[!INCLUDE [sample-code](../includes/snippets/powershell/beta/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) -[!INCLUDE [sample-code](../includes/snippets/python/beta/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md)] +[!INCLUDE [sample-code](../includes/snippets/python/v1/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] --- @@ -453,7 +453,6 @@ Content-type: application/json #### Request -# [HTTP](#tab/http) -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentRequests/a6bb6942-3ae1-4259-9908-0133aaee9377 ``` @@ -831,7 +796,7 @@ You can also use the **id** of the access package policy that you created to see "blockType": "request", "name": "tutorial_entitlementmanagement_get_accesspackageassignment" }--> -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignments?$filter=accessPackageAssignmentPolicy/Id eq 'db440482-1210-4a60-9b55-3ac7a72f63ba'&$expand=target,accessPackageAssignmentResourceRoles ``` @@ -916,7 +881,7 @@ After the request has been granted, you can use the **id** that you recorded for "blockType": "request", "name": "tutorial_entitlementmanagement_get_group_members" }--> -```http +```msgraph-interactive GET https://graph.microsoft.com/v1.0/groups/f4892fac-e81c-4712-bdf2-a4450008a4b0/members ``` diff --git a/concepts/tutorial-riskdetection-api.md b/concepts/tutorial-riskdetection-api.md index 8748c34a0bd..503f6f2e04b 100644 --- a/concepts/tutorial-riskdetection-api.md +++ b/concepts/tutorial-riskdetection-api.md @@ -465,7 +465,7 @@ Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/python/v1/tutorial-riskdetection-riskyusersdismiss-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] ---- +--- After dismissing the risk user, you can rerun the request in Step 2 and will notice that the **MyTestUser1** user account now has a risk level of `none` and a riskState of `dismissed`. diff --git a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md b/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md deleted file mode 100644 index 66ebdc2e7c8..00000000000 --- a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```bash - -// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc-beta identity-governance entitlement-management access-package-catalogs list --filter "(displayName eq 'General')" - -``` \ No newline at end of file diff --git a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md b/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md deleted file mode 100644 index b0ec9817084..00000000000 --- a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```bash - -// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc-beta identity-governance entitlement-management access-package-catalogs access-package-resource-roles list --access-package-catalog-id {accessPackageCatalog-id} --filter "(originSystem eq 'AadGroup' and accessPackageResource/id eq '4a1e21c5-8a76-4578-acb1-641160e076e8' and displayName eq 'Member')" --expand "accessPackageResource" - -``` \ No newline at end of file diff --git a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-cli-snippets.md b/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-cli-snippets.md deleted file mode 100644 index 6c43b80f063..00000000000 --- a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-cli-snippets.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```bash - -// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc-beta identity-governance entitlement-management access-packages access-package-resource-role-scopes create --access-package-id {accessPackage-id} --body '{ \ - "accessPackageResourceRole": { \ - "originId":"Member_e93e24d1-2b65-4a6c-a1dd-654a12225487", \ - "displayName":"Member", \ - "originSystem":"AadGroup", \ - "accessPackageResource": { \ - "id":"4a1e21c5-8a76-4578-acb1-641160e076e8","resourceType":"Security Group", \ - "originId":"e93e24d1-2b65-4a6c-a1dd-654a12225487","originSystem":"AadGroup" \ - } \ - }, \ - "accessPackageResourceScope": { \ - "originId":"e93e24d1-2b65-4a6c-a1dd-654a12225487","originSystem":"AadGroup" \ - } \ -} \ -' - -``` \ No newline at end of file diff --git a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md b/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md deleted file mode 100644 index 27752730a75..00000000000 --- a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```bash - -// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc-beta identity-governance entitlement-management access-package-catalogs access-package-resources list --access-package-catalog-id {accessPackageCatalog-id} --filter "(displayName eq 'Marketing resources')" - -``` \ No newline at end of file diff --git a/includes/snippets/cli/beta/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md b/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md similarity index 77% rename from includes/snippets/cli/beta/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md rename to includes/snippets/cli/v1/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md index 99d97432a3b..487f00ff5f8 100644 --- a/includes/snippets/cli/beta/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md +++ b/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-accesspackage-cli-snippets.md @@ -5,7 +5,7 @@ description: "Automatically generated file. DO NOT MODIFY" ```bash // THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc-beta identity-governance entitlement-management access-packages create --body '{ \ +mgc identity-governance entitlement-management access-packages create --body '{ \ "catalogId": "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", \ "displayName": "Marketing Campaign", \ "description": "Access to resources for the campaign" \ diff --git a/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-group-cli-snippets.md b/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-group-cli-snippets.md deleted file mode 100644 index 74521e258c3..00000000000 --- a/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-group-cli-snippets.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```bash - -// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc groups create --body '{ \ - "description":"Marketing group", \ - "displayName":"Marketing resources", \ - "mailEnabled":false, \ - "mailNickname":"markres", \ - "securityEnabled":true \ -} \ -' - -``` \ No newline at end of file diff --git a/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-user-cli-snippets.md b/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-user-cli-snippets.md deleted file mode 100644 index 7821c5a802b..00000000000 --- a/includes/snippets/cli/v1/tutorial-entitlementmanagement-create-user-cli-snippets.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```bash - -// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc users create --body '{ \ - "accountEnabled":true, \ - "displayName":"Requestor1", \ - "mailNickname":"Requestor1", \ - "userPrincipalName":"Requestor1@contoso.com", \ - "passwordProfile": { \ - "forceChangePasswordNextSignIn":true, \ - "password":"Contoso1234" \ - } \ -} \ -' - -``` \ No newline at end of file diff --git a/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md new file mode 100644 index 00000000000..e93362d559b --- /dev/null +++ b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-cli-snippets.md @@ -0,0 +1,10 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```bash + +// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY +mgc identity-governance entitlement-management catalogs list --filter "(displayName eq 'General')" + +``` \ No newline at end of file diff --git a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-cli-snippets.md b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-cli-snippets.md similarity index 68% rename from includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-cli-snippets.md rename to includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-cli-snippets.md index c2d33fc2547..ed3afa05653 100644 --- a/includes/snippets/cli/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-cli-snippets.md +++ b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-cli-snippets.md @@ -5,13 +5,11 @@ description: "Automatically generated file. DO NOT MODIFY" ```bash // THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc-beta identity-governance entitlement-management access-package-resource-requests create --body '{ \ +mgc identity-governance entitlement-management resource-requests create --body '{ \ "catalogId":"cec5d6ab-c75d-47c0-9c1c-92e89f66e384", \ "requestType": "AdminAdd", \ "justification": "", \ "accessPackageResource": { \ - "displayName": "Marketing resources", \ - "description": "Marketing group", \ "resourceType": "AadGroup", \ "originId": "e93e24d1-2b65-4a6c-a1dd-654a12225487", \ "originSystem": "AadGroup" \ diff --git a/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md new file mode 100644 index 00000000000..feefde172c1 --- /dev/null +++ b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-cli-snippets.md @@ -0,0 +1,10 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```bash + +// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY +mgc identity-governance entitlement-management catalogs resource-roles list --access-package-catalog-id {accessPackageCatalog-id} --filter "(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')" --expand "resource" + +``` \ No newline at end of file diff --git a/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md new file mode 100644 index 00000000000..7d4f3634ce9 --- /dev/null +++ b/includes/snippets/cli/v1/tutorial-entitlementmanagement-get-accesspackageresources-cli-snippets.md @@ -0,0 +1,10 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```bash + +// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY +mgc identity-governance entitlement-management catalogs resources list --access-package-catalog-id {accessPackageCatalog-id} --filter "originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487'" + +``` \ No newline at end of file diff --git a/includes/snippets/cli/v1/tutorial-riskdetection-create-user-cli-snippets.md b/includes/snippets/cli/v1/tutorial-riskdetection-create-user-cli-snippets.md deleted file mode 100644 index ff8af66d585..00000000000 --- a/includes/snippets/cli/v1/tutorial-riskdetection-create-user-cli-snippets.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```bash - -// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc users create --body '{ \ - "accountEnabled":true, \ - "displayName":"MyTestUser1", \ - "mailNickname":"MyTestUser1", \ - "userPrincipalName":"MyTestUser1@contoso.com", \ - "passwordProfile": { \ - "forceChangePasswordNextSignIn":true, \ - "password":"Contoso1234" \ - } \ -} \ -' - -``` \ No newline at end of file diff --git a/includes/snippets/cli/v1/tutorial-riskdetection-delete-group-cli-snippets.md b/includes/snippets/cli/v1/tutorial-riskdetection-delete-group-cli-snippets.md index 86665e2a1b9..f581b48ca27 100644 --- a/includes/snippets/cli/v1/tutorial-riskdetection-delete-group-cli-snippets.md +++ b/includes/snippets/cli/v1/tutorial-riskdetection-delete-group-cli-snippets.md @@ -5,6 +5,6 @@ description: "Automatically generated file. DO NOT MODIFY" ```bash // THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY -mgc groups delete --group-id {group-id} +mgc identity conditional-access policies delete --conditional-access-policy-id {conditionalAccessPolicy-id} ``` \ No newline at end of file diff --git a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md b/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md deleted file mode 100644 index 25b64d5e752..00000000000 --- a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```csharp - -// Code snippets are only available for the latest version. Current version is 5.x - -// Dependencies -using Microsoft.Graph.Beta.Models; - -var requestBody = new AccessPackageResourceRequest -{ - CatalogId = "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", - RequestType = "AdminAdd", - Justification = "", - AccessPackageResource = new AccessPackageResource - { - DisplayName = "Marketing resources", - Description = "Marketing group", - ResourceType = "AadGroup", - OriginId = "e93e24d1-2b65-4a6c-a1dd-654a12225487", - OriginSystem = "AadGroup", - }, -}; - -// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.IdentityGovernance.EntitlementManagement.AccessPackageResourceRequests.PostAsync(requestBody); - - -``` \ No newline at end of file diff --git a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-csharp-snippets.md b/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-csharp-snippets.md deleted file mode 100644 index 3c36b49b648..00000000000 --- a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-csharp-snippets.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```csharp - -// Code snippets are only available for the latest version. Current version is 5.x - -// Dependencies -using Microsoft.Graph.Beta.Models; - -var requestBody = new AccessPackageResourceRoleScope -{ - AccessPackageResourceRole = new AccessPackageResourceRole - { - OriginId = "Member_e93e24d1-2b65-4a6c-a1dd-654a12225487", - DisplayName = "Member", - OriginSystem = "AadGroup", - AccessPackageResource = new AccessPackageResource - { - Id = "4a1e21c5-8a76-4578-acb1-641160e076e8", - ResourceType = "Security Group", - OriginId = "e93e24d1-2b65-4a6c-a1dd-654a12225487", - OriginSystem = "AadGroup", - }, - }, - AccessPackageResourceScope = new AccessPackageResourceScope - { - OriginId = "e93e24d1-2b65-4a6c-a1dd-654a12225487", - OriginSystem = "AadGroup", - }, -}; - -// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.IdentityGovernance.EntitlementManagement.AccessPackages["{accessPackage-id}"].AccessPackageResourceRoleScopes.PostAsync(requestBody); - - -``` \ No newline at end of file diff --git a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md similarity index 78% rename from includes/snippets/csharp/beta/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md rename to includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md index 8014ef209af..877c1373bc2 100644 --- a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md +++ b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-accesspackage-csharp-snippets.md @@ -7,13 +7,18 @@ description: "Automatically generated file. DO NOT MODIFY" // Code snippets are only available for the latest version. Current version is 5.x // Dependencies -using Microsoft.Graph.Beta.Models; +using Microsoft.Graph.Models; var requestBody = new AccessPackage { - CatalogId = "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", DisplayName = "Marketing Campaign", Description = "Access to resources for the campaign", + AdditionalData = new Dictionary + { + { + "catalogId" , "cec5d6ab-c75d-47c0-9c1c-92e89f66e384" + }, + }, }; // To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp diff --git a/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-group-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-group-csharp-snippets.md deleted file mode 100644 index caedcd9b106..00000000000 --- a/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-group-csharp-snippets.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```csharp - -// Code snippets are only available for the latest version. Current version is 5.x - -// Dependencies -using Microsoft.Graph.Models; - -var requestBody = new Group -{ - Description = "Marketing group", - DisplayName = "Marketing resources", - MailEnabled = false, - MailNickname = "markres", - SecurityEnabled = true, -}; - -// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.Groups.PostAsync(requestBody); - - -``` \ No newline at end of file diff --git a/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-user-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-user-csharp-snippets.md deleted file mode 100644 index 2293ea68829..00000000000 --- a/includes/snippets/csharp/v1/tutorial-entitlementmanagement-create-user-csharp-snippets.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```csharp - -// Code snippets are only available for the latest version. Current version is 5.x - -// Dependencies -using Microsoft.Graph.Models; - -var requestBody = new User -{ - AccountEnabled = true, - DisplayName = "Requestor1", - MailNickname = "Requestor1", - UserPrincipalName = "Requestor1@contoso.com", - PasswordProfile = new PasswordProfile - { - ForceChangePasswordNextSignIn = true, - Password = "Contoso1234", - }, -}; - -// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.Users.PostAsync(requestBody); - - -``` \ No newline at end of file diff --git a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-csharp-snippets.md similarity index 87% rename from includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-csharp-snippets.md rename to includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-csharp-snippets.md index 5200dd6d534..75b7891ab2a 100644 --- a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-csharp-snippets.md +++ b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-csharp-snippets.md @@ -7,7 +7,7 @@ description: "Automatically generated file. DO NOT MODIFY" // Code snippets are only available for the latest version. Current version is 5.x // To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.IdentityGovernance.EntitlementManagement.AccessPackageCatalogs.GetAsync((requestConfiguration) => +var result = await graphClient.IdentityGovernance.EntitlementManagement.Catalogs.GetAsync((requestConfiguration) => { requestConfiguration.QueryParameters.Filter = "(displayName eq 'General')"; }); diff --git a/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md new file mode 100644 index 00000000000..e7a58e8a6de --- /dev/null +++ b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-csharp-snippets.md @@ -0,0 +1,38 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```csharp + +// Code snippets are only available for the latest version. Current version is 5.x + +// Dependencies +using Microsoft.Graph.Models; + +var requestBody = new AccessPackageResourceRequest +{ + RequestType = AccessPackageRequestType.AdminAdd, + AdditionalData = new Dictionary + { + { + "catalogId" , "cec5d6ab-c75d-47c0-9c1c-92e89f66e384" + }, + { + "justification" , "" + }, + { + "accessPackageResource" , new + { + ResourceType = "AadGroup", + OriginId = "e93e24d1-2b65-4a6c-a1dd-654a12225487", + OriginSystem = "AadGroup", + } + }, + }, +}; + +// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp +var result = await graphClient.IdentityGovernance.EntitlementManagement.ResourceRequests.PostAsync(requestBody); + + +``` \ No newline at end of file diff --git a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md similarity index 56% rename from includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md rename to includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md index a00ad76a36f..bbc3121ae18 100644 --- a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md +++ b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-csharp-snippets.md @@ -7,10 +7,10 @@ description: "Automatically generated file. DO NOT MODIFY" // Code snippets are only available for the latest version. Current version is 5.x // To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.IdentityGovernance.EntitlementManagement.AccessPackageCatalogs["{accessPackageCatalog-id}"].AccessPackageResourceRoles.GetAsync((requestConfiguration) => +var result = await graphClient.IdentityGovernance.EntitlementManagement.Catalogs["{accessPackageCatalog-id}"].ResourceRoles.GetAsync((requestConfiguration) => { - requestConfiguration.QueryParameters.Filter = "(originSystem eq 'AadGroup' and accessPackageResource/id eq '4a1e21c5-8a76-4578-acb1-641160e076e8' and displayName eq 'Member')"; - requestConfiguration.QueryParameters.Expand = new string []{ "accessPackageResource" }; + requestConfiguration.QueryParameters.Filter = "(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')"; + requestConfiguration.QueryParameters.Expand = new string []{ "resource" }; }); diff --git a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md similarity index 63% rename from includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md rename to includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md index 57bb2a994c9..f283f659ea6 100644 --- a/includes/snippets/csharp/beta/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md +++ b/includes/snippets/csharp/v1/tutorial-entitlementmanagement-get-accesspackageresources-csharp-snippets.md @@ -7,9 +7,9 @@ description: "Automatically generated file. DO NOT MODIFY" // Code snippets are only available for the latest version. Current version is 5.x // To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.IdentityGovernance.EntitlementManagement.AccessPackageCatalogs["{accessPackageCatalog-id}"].AccessPackageResources.GetAsync((requestConfiguration) => +var result = await graphClient.IdentityGovernance.EntitlementManagement.Catalogs["{accessPackageCatalog-id}"].Resources.GetAsync((requestConfiguration) => { - requestConfiguration.QueryParameters.Filter = "(displayName eq 'Marketing resources')"; + requestConfiguration.QueryParameters.Filter = "originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487'"; }); diff --git a/includes/snippets/csharp/v1/tutorial-riskdetection-create-user-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-riskdetection-create-user-csharp-snippets.md deleted file mode 100644 index 9772c9b583d..00000000000 --- a/includes/snippets/csharp/v1/tutorial-riskdetection-create-user-csharp-snippets.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```csharp - -// Code snippets are only available for the latest version. Current version is 5.x - -// Dependencies -using Microsoft.Graph.Models; - -var requestBody = new User -{ - AccountEnabled = true, - DisplayName = "MyTestUser1", - MailNickname = "MyTestUser1", - UserPrincipalName = "MyTestUser1@contoso.com", - PasswordProfile = new PasswordProfile - { - ForceChangePasswordNextSignIn = true, - Password = "Contoso1234", - }, -}; - -// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -var result = await graphClient.Users.PostAsync(requestBody); - - -``` \ No newline at end of file diff --git a/includes/snippets/csharp/v1/tutorial-riskdetection-delete-group-csharp-snippets.md b/includes/snippets/csharp/v1/tutorial-riskdetection-delete-group-csharp-snippets.md index 9ed66e60b40..e6feb6cbe90 100644 --- a/includes/snippets/csharp/v1/tutorial-riskdetection-delete-group-csharp-snippets.md +++ b/includes/snippets/csharp/v1/tutorial-riskdetection-delete-group-csharp-snippets.md @@ -7,7 +7,7 @@ description: "Automatically generated file. DO NOT MODIFY" // Code snippets are only available for the latest version. Current version is 5.x // To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp -await graphClient.Groups["{group-id}"].DeleteAsync(); +await graphClient.Identity.ConditionalAccess.Policies["{conditionalAccessPolicy-id}"].DeleteAsync(); ``` \ No newline at end of file diff --git a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md b/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md deleted file mode 100644 index 1229a589024..00000000000 --- a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go" - graphidentitygovernance "github.com/microsoftgraph/msgraph-beta-sdk-go/identitygovernance" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - - -requestFilter := "(displayName eq 'General')" - -requestParameters := &graphidentitygovernance.IdentityGovernanceEntitlementManagementAccessPackageCatalogsRequestBuilderGetQueryParameters{ - Filter: &requestFilter, -} -configuration := &graphidentitygovernance.IdentityGovernanceEntitlementManagementAccessPackageCatalogsRequestBuilderGetRequestConfiguration{ - QueryParameters: requestParameters, -} - -accessPackageCatalogs, err := graphClient.IdentityGovernance().EntitlementManagement().AccessPackageCatalogs().Get(context.Background(), configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md b/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md deleted file mode 100644 index aba459c2ea9..00000000000 --- a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go" - graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - -requestBody := graphmodels.NewAccessPackageResourceRequest() -catalogId := "cec5d6ab-c75d-47c0-9c1c-92e89f66e384" -requestBody.SetCatalogId(&catalogId) -requestType := "AdminAdd" -requestBody.SetRequestType(&requestType) -justification := "" -requestBody.SetJustification(&justification) -accessPackageResource := graphmodels.NewAccessPackageResource() -displayName := "Marketing resources" -accessPackageResource.SetDisplayName(&displayName) -description := "Marketing group" -accessPackageResource.SetDescription(&description) -resourceType := "AadGroup" -accessPackageResource.SetResourceType(&resourceType) -originId := "e93e24d1-2b65-4a6c-a1dd-654a12225487" -accessPackageResource.SetOriginId(&originId) -originSystem := "AadGroup" -accessPackageResource.SetOriginSystem(&originSystem) -requestBody.SetAccessPackageResource(accessPackageResource) - -accessPackageResourceRequests, err := graphClient.IdentityGovernance().EntitlementManagement().AccessPackageResourceRequests().Post(context.Background(), requestBody, nil) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md b/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md deleted file mode 100644 index c479c902086..00000000000 --- a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go" - graphidentitygovernance "github.com/microsoftgraph/msgraph-beta-sdk-go/identitygovernance" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - - -requestFilter := "(originSystem eq 'AadGroup' and accessPackageResource/id eq '4a1e21c5-8a76-4578-acb1-641160e076e8' and displayName eq 'Member')" - -requestParameters := &graphidentitygovernance.IdentityGovernanceEntitlementManagementAccessPackageCatalogItemAccessPackageResourceRolesRequestBuilderGetQueryParameters{ - Filter: &requestFilter, - Expand: [] string {"accessPackageResource"}, -} -configuration := &graphidentitygovernance.IdentityGovernanceEntitlementManagementAccessPackageCatalogItemAccessPackageResourceRolesRequestBuilderGetRequestConfiguration{ - QueryParameters: requestParameters, -} - -accessPackageResourceRoles, err := graphClient.IdentityGovernance().EntitlementManagement().AccessPackageCatalogs().ByAccessPackageCatalogId("accessPackageCatalog-id").AccessPackageResourceRoles().Get(context.Background(), configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-go-snippets.md b/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-go-snippets.md deleted file mode 100644 index e12742602a7..00000000000 --- a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-go-snippets.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go" - graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - -requestBody := graphmodels.NewAccessPackageResourceRoleScope() -accessPackageResourceRole := graphmodels.NewAccessPackageResourceRole() -originId := "Member_e93e24d1-2b65-4a6c-a1dd-654a12225487" -accessPackageResourceRole.SetOriginId(&originId) -displayName := "Member" -accessPackageResourceRole.SetDisplayName(&displayName) -originSystem := "AadGroup" -accessPackageResourceRole.SetOriginSystem(&originSystem) -accessPackageResource := graphmodels.NewAccessPackageResource() -id := "4a1e21c5-8a76-4578-acb1-641160e076e8" -accessPackageResource.SetId(&id) -resourceType := "Security Group" -accessPackageResource.SetResourceType(&resourceType) -originId := "e93e24d1-2b65-4a6c-a1dd-654a12225487" -accessPackageResource.SetOriginId(&originId) -originSystem := "AadGroup" -accessPackageResource.SetOriginSystem(&originSystem) -accessPackageResourceRole.SetAccessPackageResource(accessPackageResource) -requestBody.SetAccessPackageResourceRole(accessPackageResourceRole) -accessPackageResourceScope := graphmodels.NewAccessPackageResourceScope() -originId := "e93e24d1-2b65-4a6c-a1dd-654a12225487" -accessPackageResourceScope.SetOriginId(&originId) -originSystem := "AadGroup" -accessPackageResourceScope.SetOriginSystem(&originSystem) -requestBody.SetAccessPackageResourceScope(accessPackageResourceScope) - -accessPackageResourceRoleScopes, err := graphClient.IdentityGovernance().EntitlementManagement().AccessPackages().ByAccessPackageId("accessPackage-id").AccessPackageResourceRoleScopes().Post(context.Background(), requestBody, nil) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md b/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md deleted file mode 100644 index c7f239da5a2..00000000000 --- a/includes/snippets/go/beta/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go" - graphidentitygovernance "github.com/microsoftgraph/msgraph-beta-sdk-go/identitygovernance" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - - -requestFilter := "(displayName eq 'Marketing resources')" - -requestParameters := &graphidentitygovernance.IdentityGovernanceEntitlementManagementAccessPackageCatalogItemAccessPackageResourcesRequestBuilderGetQueryParameters{ - Filter: &requestFilter, -} -configuration := &graphidentitygovernance.IdentityGovernanceEntitlementManagementAccessPackageCatalogItemAccessPackageResourcesRequestBuilderGetRequestConfiguration{ - QueryParameters: requestParameters, -} - -accessPackageResources, err := graphClient.IdentityGovernance().EntitlementManagement().AccessPackageCatalogs().ByAccessPackageCatalogId("accessPackageCatalog-id").AccessPackageResources().Get(context.Background(), configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/beta/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md b/includes/snippets/go/v1/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md similarity index 67% rename from includes/snippets/go/beta/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md rename to includes/snippets/go/v1/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md index c2183259566..1ead796e701 100644 --- a/includes/snippets/go/beta/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md +++ b/includes/snippets/go/v1/tutorial-entitlementmanagement-create-accesspackage-go-snippets.md @@ -7,8 +7,8 @@ description: "Automatically generated file. DO NOT MODIFY" import ( "context" - msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go" - graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models" + msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" + graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models" //other-imports ) @@ -16,12 +16,14 @@ graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) requestBody := graphmodels.NewAccessPackage() -catalogId := "cec5d6ab-c75d-47c0-9c1c-92e89f66e384" -requestBody.SetCatalogId(&catalogId) displayName := "Marketing Campaign" requestBody.SetDisplayName(&displayName) description := "Access to resources for the campaign" requestBody.SetDescription(&description) +additionalData := map[string]interface{}{ + "catalogId" : "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", +} +requestBody.SetAdditionalData(additionalData) accessPackages, err := graphClient.IdentityGovernance().EntitlementManagement().AccessPackages().Post(context.Background(), requestBody, nil) diff --git a/includes/snippets/go/v1/tutorial-entitlementmanagement-create-group-go-snippets.md b/includes/snippets/go/v1/tutorial-entitlementmanagement-create-group-go-snippets.md deleted file mode 100644 index 44f19c11c05..00000000000 --- a/includes/snippets/go/v1/tutorial-entitlementmanagement-create-group-go-snippets.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" - graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - -requestBody := graphmodels.NewGroup() -description := "Marketing group" -requestBody.SetDescription(&description) -displayName := "Marketing resources" -requestBody.SetDisplayName(&displayName) -mailEnabled := false -requestBody.SetMailEnabled(&mailEnabled) -mailNickname := "markres" -requestBody.SetMailNickname(&mailNickname) -securityEnabled := true -requestBody.SetSecurityEnabled(&securityEnabled) - -groups, err := graphClient.Groups().Post(context.Background(), requestBody, nil) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-entitlementmanagement-create-user-go-snippets.md b/includes/snippets/go/v1/tutorial-entitlementmanagement-create-user-go-snippets.md deleted file mode 100644 index 88d1327a5eb..00000000000 --- a/includes/snippets/go/v1/tutorial-entitlementmanagement-create-user-go-snippets.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" - graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - -requestBody := graphmodels.NewUser() -accountEnabled := true -requestBody.SetAccountEnabled(&accountEnabled) -displayName := "Requestor1" -requestBody.SetDisplayName(&displayName) -mailNickname := "Requestor1" -requestBody.SetMailNickname(&mailNickname) -userPrincipalName := "Requestor1@contoso.com" -requestBody.SetUserPrincipalName(&userPrincipalName) -passwordProfile := graphmodels.NewPasswordProfile() -forceChangePasswordNextSignIn := true -passwordProfile.SetForceChangePasswordNextSignIn(&forceChangePasswordNextSignIn) -password := "Contoso1234" -passwordProfile.SetPassword(&password) -requestBody.SetPasswordProfile(passwordProfile) - -users, err := graphClient.Users().Post(context.Background(), requestBody, nil) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md new file mode 100644 index 00000000000..aeb41a560f9 --- /dev/null +++ b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-go-snippets.md @@ -0,0 +1,31 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```go + + +import ( + "context" + msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" + graphidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/identitygovernance" + //other-imports +) + +graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) + + + +requestFilter := "(displayName eq 'General')" + +requestParameters := &graphidentitygovernance.IdentityGovernanceEntitlementManagementCatalogsRequestBuilderGetQueryParameters{ + Filter: &requestFilter, +} +configuration := &graphidentitygovernance.IdentityGovernanceEntitlementManagementCatalogsRequestBuilderGetRequestConfiguration{ + QueryParameters: requestParameters, +} + +catalogs, err := graphClient.IdentityGovernance().EntitlementManagement().Catalogs().Get(context.Background(), configuration) + + +``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md new file mode 100644 index 00000000000..3c5bf8599f2 --- /dev/null +++ b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-go-snippets.md @@ -0,0 +1,38 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```go + + +import ( + "context" + msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" + graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models" + //other-imports +) + +graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) + + +requestBody := graphmodels.NewAccessPackageResourceRequest() +requestType := graphmodels.ADMINADD_ACCESSPACKAGEREQUESTTYPE +requestBody.SetRequestType(&requestType) +additionalData := map[string]interface{}{ + "catalogId" : "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", + "justification" : "", +accessPackageResource := graphmodels.New() +resourceType := "AadGroup" +accessPackageResource.SetResourceType(&resourceType) +originId := "e93e24d1-2b65-4a6c-a1dd-654a12225487" +accessPackageResource.SetOriginId(&originId) +originSystem := "AadGroup" +accessPackageResource.SetOriginSystem(&originSystem) + requestBody.SetAccessPackageResource(accessPackageResource) +} +requestBody.SetAdditionalData(additionalData) + +resourceRequests, err := graphClient.IdentityGovernance().EntitlementManagement().ResourceRequests().Post(context.Background(), requestBody, nil) + + +``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md new file mode 100644 index 00000000000..d7815717ba1 --- /dev/null +++ b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-go-snippets.md @@ -0,0 +1,32 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```go + + +import ( + "context" + msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" + graphidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/identitygovernance" + //other-imports +) + +graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) + + + +requestFilter := "(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')" + +requestParameters := &graphidentitygovernance.IdentityGovernanceEntitlementManagementCatalogItemResourceRolesRequestBuilderGetQueryParameters{ + Filter: &requestFilter, + Expand: [] string {"resource"}, +} +configuration := &graphidentitygovernance.IdentityGovernanceEntitlementManagementCatalogItemResourceRolesRequestBuilderGetRequestConfiguration{ + QueryParameters: requestParameters, +} + +resourceRoles, err := graphClient.IdentityGovernance().EntitlementManagement().Catalogs().ByAccessPackageCatalogId("accessPackageCatalog-id").ResourceRoles().Get(context.Background(), configuration) + + +``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md new file mode 100644 index 00000000000..534d81abc43 --- /dev/null +++ b/includes/snippets/go/v1/tutorial-entitlementmanagement-get-accesspackageresources-go-snippets.md @@ -0,0 +1,31 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```go + + +import ( + "context" + msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" + graphidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/identitygovernance" + //other-imports +) + +graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) + + + +requestFilter := "originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487'" + +requestParameters := &graphidentitygovernance.IdentityGovernanceEntitlementManagementCatalogItemResourcesRequestBuilderGetQueryParameters{ + Filter: &requestFilter, +} +configuration := &graphidentitygovernance.IdentityGovernanceEntitlementManagementCatalogItemResourcesRequestBuilderGetRequestConfiguration{ + QueryParameters: requestParameters, +} + +resources, err := graphClient.IdentityGovernance().EntitlementManagement().Catalogs().ByAccessPackageCatalogId("accessPackageCatalog-id").Resources().Get(context.Background(), configuration) + + +``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-riskdetection-create-user-go-snippets.md b/includes/snippets/go/v1/tutorial-riskdetection-create-user-go-snippets.md deleted file mode 100644 index a91eeba78b9..00000000000 --- a/includes/snippets/go/v1/tutorial-riskdetection-create-user-go-snippets.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" - graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - -requestBody := graphmodels.NewUser() -accountEnabled := true -requestBody.SetAccountEnabled(&accountEnabled) -displayName := "MyTestUser1" -requestBody.SetDisplayName(&displayName) -mailNickname := "MyTestUser1" -requestBody.SetMailNickname(&mailNickname) -userPrincipalName := "MyTestUser1@contoso.com" -requestBody.SetUserPrincipalName(&userPrincipalName) -passwordProfile := graphmodels.NewPasswordProfile() -forceChangePasswordNextSignIn := true -passwordProfile.SetForceChangePasswordNextSignIn(&forceChangePasswordNextSignIn) -password := "Contoso1234" -passwordProfile.SetPassword(&password) -requestBody.SetPasswordProfile(passwordProfile) - -users, err := graphClient.Users().Post(context.Background(), requestBody, nil) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-riskdetection-delete-group-go-snippets.md b/includes/snippets/go/v1/tutorial-riskdetection-delete-group-go-snippets.md index 15659d1e1ff..06afae8a4f1 100644 --- a/includes/snippets/go/v1/tutorial-riskdetection-delete-group-go-snippets.md +++ b/includes/snippets/go/v1/tutorial-riskdetection-delete-group-go-snippets.md @@ -15,7 +15,7 @@ graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) -graphClient.Groups().ByGroupId("group-id").Delete(context.Background(), nil) +graphClient.Identity().ConditionalAccess().Policies().ByConditionalAccessPolicyId("conditionalAccessPolicy-id").Delete(context.Background(), nil) ``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-riskdetection-get-riskdetections-filter-go-snippets.md b/includes/snippets/go/v1/tutorial-riskdetection-get-riskdetections-filter-go-snippets.md deleted file mode 100644 index 796a2e7dc56..00000000000 --- a/includes/snippets/go/v1/tutorial-riskdetection-get-riskdetections-filter-go-snippets.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" - graphidentityprotection "github.com/microsoftgraph/msgraph-sdk-go/identityprotection" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - - -requestFilter := "userDisplayName eq 'MyTestUser1'" - -requestParameters := &graphidentityprotection.IdentityProtectionRiskDetectionsRequestBuilderGetQueryParameters{ - Filter: &requestFilter, -} -configuration := &graphidentityprotection.IdentityProtectionRiskDetectionsRequestBuilderGetRequestConfiguration{ - QueryParameters: requestParameters, -} - -riskDetections, err := graphClient.IdentityProtection().RiskDetections().Get(context.Background(), configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/go/v1/tutorial-riskdetection-riskyuserslist-go-snippets.md b/includes/snippets/go/v1/tutorial-riskdetection-riskyuserslist-go-snippets.md deleted file mode 100644 index b5ab73c447c..00000000000 --- a/includes/snippets/go/v1/tutorial-riskdetection-riskyuserslist-go-snippets.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```go - - -import ( - "context" - msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" - graphidentityprotection "github.com/microsoftgraph/msgraph-sdk-go/identityprotection" - //other-imports -) - -graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes) - - - -requestFilter := "userDisplayName eq 'MyTestUser1'" - -requestParameters := &graphidentityprotection.IdentityProtectionRiskyUsersRequestBuilderGetQueryParameters{ - Filter: &requestFilter, -} -configuration := &graphidentityprotection.IdentityProtectionRiskyUsersRequestBuilderGetRequestConfiguration{ - QueryParameters: requestParameters, -} - -riskyUsers, err := graphClient.IdentityProtection().RiskyUsers().Get(context.Background(), configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md b/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md deleted file mode 100644 index f2b1823c72b..00000000000 --- a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```java - -// Code snippets are only available for the latest version. Current version is 6.x - -GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); - -AccessPackageResourceRoleCollectionResponse result = graphClient.identityGovernance().entitlementManagement().accessPackageCatalogs().byAccessPackageCatalogId("{accessPackageCatalog-id}").accessPackageResourceRoles().get(requestConfiguration -> { - requestConfiguration.queryParameters.filter = "(originSystem eq 'AadGroup' and accessPackageResource/id eq '4a1e21c5-8a76-4578-acb1-641160e076e8' and displayName eq 'Member')"; - requestConfiguration.queryParameters.expand = new String []{"accessPackageResource"}; -}); - - -``` \ No newline at end of file diff --git a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-java-snippets.md b/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-java-snippets.md deleted file mode 100644 index 96e4ad1fa31..00000000000 --- a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-java-snippets.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```java - -// Code snippets are only available for the latest version. Current version is 6.x - -GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); - -AccessPackageResourceRoleScope accessPackageResourceRoleScope = new AccessPackageResourceRoleScope(); -AccessPackageResourceRole accessPackageResourceRole = new AccessPackageResourceRole(); -accessPackageResourceRole.setOriginId("Member_e93e24d1-2b65-4a6c-a1dd-654a12225487"); -accessPackageResourceRole.setDisplayName("Member"); -accessPackageResourceRole.setOriginSystem("AadGroup"); -AccessPackageResource accessPackageResource = new AccessPackageResource(); -accessPackageResource.setId("4a1e21c5-8a76-4578-acb1-641160e076e8"); -accessPackageResource.setResourceType("Security Group"); -accessPackageResource.setOriginId("e93e24d1-2b65-4a6c-a1dd-654a12225487"); -accessPackageResource.setOriginSystem("AadGroup"); -accessPackageResourceRole.setAccessPackageResource(accessPackageResource); -accessPackageResourceRoleScope.setAccessPackageResourceRole(accessPackageResourceRole); -AccessPackageResourceScope accessPackageResourceScope = new AccessPackageResourceScope(); -accessPackageResourceScope.setOriginId("e93e24d1-2b65-4a6c-a1dd-654a12225487"); -accessPackageResourceScope.setOriginSystem("AadGroup"); -accessPackageResourceRoleScope.setAccessPackageResourceScope(accessPackageResourceScope); -AccessPackageResourceRoleScope result = graphClient.identityGovernance().entitlementManagement().accessPackages().byAccessPackageId("{accessPackage-id}").accessPackageResourceRoleScopes().post(accessPackageResourceRoleScope); - - -``` \ No newline at end of file diff --git a/includes/snippets/java/beta/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md b/includes/snippets/java/v1/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md similarity index 73% rename from includes/snippets/java/beta/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md rename to includes/snippets/java/v1/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md index f7fbbaa1e5b..f5ca4d526a1 100644 --- a/includes/snippets/java/beta/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md +++ b/includes/snippets/java/v1/tutorial-entitlementmanagement-create-accesspackage-java-snippets.md @@ -9,9 +9,11 @@ description: "Automatically generated file. DO NOT MODIFY" GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); AccessPackage accessPackage = new AccessPackage(); -accessPackage.setCatalogId("cec5d6ab-c75d-47c0-9c1c-92e89f66e384"); accessPackage.setDisplayName("Marketing Campaign"); accessPackage.setDescription("Access to resources for the campaign"); +HashMap additionalData = new HashMap(); +additionalData.put("catalogId", "cec5d6ab-c75d-47c0-9c1c-92e89f66e384"); +accessPackage.setAdditionalData(additionalData); AccessPackage result = graphClient.identityGovernance().entitlementManagement().accessPackages().post(accessPackage); diff --git a/includes/snippets/java/v1/tutorial-entitlementmanagement-create-group-java-snippets.md b/includes/snippets/java/v1/tutorial-entitlementmanagement-create-group-java-snippets.md deleted file mode 100644 index a437c950673..00000000000 --- a/includes/snippets/java/v1/tutorial-entitlementmanagement-create-group-java-snippets.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```java - -// Code snippets are only available for the latest version. Current version is 6.x - -GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); - -Group group = new Group(); -group.setDescription("Marketing group"); -group.setDisplayName("Marketing resources"); -group.setMailEnabled(false); -group.setMailNickname("markres"); -group.setSecurityEnabled(true); -Group result = graphClient.groups().post(group); - - -``` \ No newline at end of file diff --git a/includes/snippets/java/v1/tutorial-entitlementmanagement-create-user-java-snippets.md b/includes/snippets/java/v1/tutorial-entitlementmanagement-create-user-java-snippets.md deleted file mode 100644 index a6da997a518..00000000000 --- a/includes/snippets/java/v1/tutorial-entitlementmanagement-create-user-java-snippets.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```java - -// Code snippets are only available for the latest version. Current version is 6.x - -GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); - -User user = new User(); -user.setAccountEnabled(true); -user.setDisplayName("Requestor1"); -user.setMailNickname("Requestor1"); -user.setUserPrincipalName("Requestor1@contoso.com"); -PasswordProfile passwordProfile = new PasswordProfile(); -passwordProfile.setForceChangePasswordNextSignIn(true); -passwordProfile.setPassword("Contoso1234"); -user.setPasswordProfile(passwordProfile); -User result = graphClient.users().post(user); - - -``` \ No newline at end of file diff --git a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-java-snippets.md b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-java-snippets.md similarity index 80% rename from includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-java-snippets.md rename to includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-java-snippets.md index 85778f2afcf..f63e7764254 100644 --- a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-java-snippets.md +++ b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-java-snippets.md @@ -8,7 +8,7 @@ description: "Automatically generated file. DO NOT MODIFY" GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); -AccessPackageCatalogCollectionResponse result = graphClient.identityGovernance().entitlementManagement().accessPackageCatalogs().get(requestConfiguration -> { +AccessPackageCatalogCollectionResponse result = graphClient.identityGovernance().entitlementManagement().catalogs().get(requestConfiguration -> { requestConfiguration.queryParameters.filter = "(displayName eq 'General')"; }); diff --git a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-java-snippets.md b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-java-snippets.md similarity index 50% rename from includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-java-snippets.md rename to includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-java-snippets.md index 20963174fbb..1791d003126 100644 --- a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-java-snippets.md +++ b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-java-snippets.md @@ -9,17 +9,17 @@ description: "Automatically generated file. DO NOT MODIFY" GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); AccessPackageResourceRequest accessPackageResourceRequest = new AccessPackageResourceRequest(); -accessPackageResourceRequest.setCatalogId("cec5d6ab-c75d-47c0-9c1c-92e89f66e384"); -accessPackageResourceRequest.setRequestType("AdminAdd"); -accessPackageResourceRequest.setJustification(""); -AccessPackageResource accessPackageResource = new AccessPackageResource(); -accessPackageResource.setDisplayName("Marketing resources"); -accessPackageResource.setDescription("Marketing group"); +accessPackageResourceRequest.setRequestType(AccessPackageRequestType.AdminAdd); +HashMap additionalData = new HashMap(); +additionalData.put("catalogId", "cec5d6ab-c75d-47c0-9c1c-92e89f66e384"); +additionalData.put("justification", ""); + accessPackageResource = new (); accessPackageResource.setResourceType("AadGroup"); accessPackageResource.setOriginId("e93e24d1-2b65-4a6c-a1dd-654a12225487"); accessPackageResource.setOriginSystem("AadGroup"); -accessPackageResourceRequest.setAccessPackageResource(accessPackageResource); -AccessPackageResourceRequest result = graphClient.identityGovernance().entitlementManagement().accessPackageResourceRequests().post(accessPackageResourceRequest); +additionalData.put("accessPackageResource", accessPackageResource); +accessPackageResourceRequest.setAdditionalData(additionalData); +AccessPackageResourceRequest result = graphClient.identityGovernance().entitlementManagement().resourceRequests().post(accessPackageResourceRequest); ``` \ No newline at end of file diff --git a/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md new file mode 100644 index 00000000000..0137f149526 --- /dev/null +++ b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-java-snippets.md @@ -0,0 +1,17 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```java + +// Code snippets are only available for the latest version. Current version is 6.x + +GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); + +AccessPackageResourceRoleCollectionResponse result = graphClient.identityGovernance().entitlementManagement().catalogs().byAccessPackageCatalogId("{accessPackageCatalog-id}").resourceRoles().get(requestConfiguration -> { + requestConfiguration.queryParameters.filter = "(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')"; + requestConfiguration.queryParameters.expand = new String []{"resource"}; +}); + + +``` \ No newline at end of file diff --git a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md similarity index 53% rename from includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md rename to includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md index 5bc752bce5a..634a59baf59 100644 --- a/includes/snippets/java/beta/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md +++ b/includes/snippets/java/v1/tutorial-entitlementmanagement-get-accesspackageresources-java-snippets.md @@ -8,8 +8,8 @@ description: "Automatically generated file. DO NOT MODIFY" GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); -AccessPackageResourceCollectionResponse result = graphClient.identityGovernance().entitlementManagement().accessPackageCatalogs().byAccessPackageCatalogId("{accessPackageCatalog-id}").accessPackageResources().get(requestConfiguration -> { - requestConfiguration.queryParameters.filter = "(displayName eq 'Marketing resources')"; +AccessPackageResourceCollectionResponse result = graphClient.identityGovernance().entitlementManagement().catalogs().byAccessPackageCatalogId("{accessPackageCatalog-id}").resources().get(requestConfiguration -> { + requestConfiguration.queryParameters.filter = "originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487'"; }); diff --git a/includes/snippets/java/v1/tutorial-riskdetection-create-user-java-snippets.md b/includes/snippets/java/v1/tutorial-riskdetection-create-user-java-snippets.md deleted file mode 100644 index 79bdd8824ce..00000000000 --- a/includes/snippets/java/v1/tutorial-riskdetection-create-user-java-snippets.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```java - -// Code snippets are only available for the latest version. Current version is 6.x - -GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); - -User user = new User(); -user.setAccountEnabled(true); -user.setDisplayName("MyTestUser1"); -user.setMailNickname("MyTestUser1"); -user.setUserPrincipalName("MyTestUser1@contoso.com"); -PasswordProfile passwordProfile = new PasswordProfile(); -passwordProfile.setForceChangePasswordNextSignIn(true); -passwordProfile.setPassword("Contoso1234"); -user.setPasswordProfile(passwordProfile); -User result = graphClient.users().post(user); - - -``` \ No newline at end of file diff --git a/includes/snippets/java/v1/tutorial-riskdetection-delete-group-java-snippets.md b/includes/snippets/java/v1/tutorial-riskdetection-delete-group-java-snippets.md index 92cdd269a65..adb169d9aa7 100644 --- a/includes/snippets/java/v1/tutorial-riskdetection-delete-group-java-snippets.md +++ b/includes/snippets/java/v1/tutorial-riskdetection-delete-group-java-snippets.md @@ -8,7 +8,7 @@ description: "Automatically generated file. DO NOT MODIFY" GraphServiceClient graphClient = new GraphServiceClient(requestAdapter); -graphClient.groups().byGroupId("{group-id}").delete(); +graphClient.identity().conditionalAccess().policies().byConditionalAccessPolicyId("{conditionalAccessPolicy-id}").delete(); ``` \ No newline at end of file diff --git a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md b/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md deleted file mode 100644 index b5c70b00c30..00000000000 --- a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```javascript - -const options = { - authProvider, -}; - -const client = Client.init(options); - -let accessPackageResourceRoles = await client.api('/identityGovernance/entitlementManagement/accessPackageCatalogs/cec5d6ab-c75d-47c0-9c1c-92e89f66e384/accessPackageResourceRoles') - .version('beta') - .filter('(originSystem eq \'AadGroup\' and accessPackageResource/id eq \'4a1e21c5-8a76-4578-acb1-641160e076e8\' and displayName eq \'Member\')') - .expand('accessPackageResource/id eq \'4a1e21c5-8a76-4578-acb1-641160e076e8\' and displayName eq \'Member\')') - .get(); - -``` \ No newline at end of file diff --git a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-javascript-snippets.md b/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-javascript-snippets.md deleted file mode 100644 index 7ff101ecdd3..00000000000 --- a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-javascript-snippets.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```javascript - -const options = { - authProvider, -}; - -const client = Client.init(options); - -const accessPackageResourceRoleScope = { - accessPackageResourceRole: { - originId: 'Member_e93e24d1-2b65-4a6c-a1dd-654a12225487', - displayName: 'Member', - originSystem: 'AadGroup', - accessPackageResource: { - id: '4a1e21c5-8a76-4578-acb1-641160e076e8',resourceType: 'Security Group', - originId: 'e93e24d1-2b65-4a6c-a1dd-654a12225487',originSystem: 'AadGroup' - } - }, - accessPackageResourceScope: { - originId: 'e93e24d1-2b65-4a6c-a1dd-654a12225487',originSystem: 'AadGroup' - } -}; - -await client.api('/identityGovernance/entitlementManagement/accessPackages/88203d16-0e31-41d4-87b2-dd402f1435e9/accessPackageResourceRoleScopes') - .version('beta') - .post(accessPackageResourceRoleScope); - -``` \ No newline at end of file diff --git a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md b/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md deleted file mode 100644 index b934f7be957..00000000000 --- a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```javascript - -const options = { - authProvider, -}; - -const client = Client.init(options); - -let accessPackageResources = await client.api('/identityGovernance/entitlementManagement/accessPackageCatalogs/cec5d6ab-c75d-47c0-9c1c-92e89f66e384/accessPackageResources') - .version('beta') - .filter('(displayName eq \'Marketing resources\')') - .get(); - -``` \ No newline at end of file diff --git a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md similarity index 96% rename from includes/snippets/javascript/beta/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md rename to includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md index 2db66d6736b..6385590c632 100644 --- a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md +++ b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-accesspackage-javascript-snippets.md @@ -17,7 +17,6 @@ const accessPackage = { }; await client.api('/identityGovernance/entitlementManagement/accessPackages') - .version('beta') .post(accessPackage); ``` \ No newline at end of file diff --git a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-group-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-group-javascript-snippets.md deleted file mode 100644 index cf6e94bd882..00000000000 --- a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-group-javascript-snippets.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```javascript - -const options = { - authProvider, -}; - -const client = Client.init(options); - -const group = { - description: 'Marketing group', - displayName: 'Marketing resources', - mailEnabled: false, - mailNickname: 'markres', - securityEnabled: true -}; - -await client.api('/groups') - .post(group); - -``` \ No newline at end of file diff --git a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-user-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-user-javascript-snippets.md deleted file mode 100644 index d73dc5a7e02..00000000000 --- a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-create-user-javascript-snippets.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```javascript - -const options = { - authProvider, -}; - -const client = Client.init(options); - -const user = { - accountEnabled: true, - displayName: 'Requestor1', - mailNickname: 'Requestor1', - userPrincipalName: 'Requestor1@contoso.com', - passwordProfile: { - forceChangePasswordNextSignIn: true, - password: 'Contoso1234' - } -}; - -await client.api('/users') - .post(user); - -``` \ No newline at end of file diff --git a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-javascript-snippets.md similarity index 61% rename from includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-javascript-snippets.md rename to includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-javascript-snippets.md index 280e41e9b2e..10329004e18 100644 --- a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-javascript-snippets.md +++ b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-javascript-snippets.md @@ -10,8 +10,7 @@ const options = { const client = Client.init(options); -let accessPackageCatalogs = await client.api('/identityGovernance/entitlementManagement/accessPackageCatalogs') - .version('beta') +let catalogs = await client.api('/identityGovernance/entitlementManagement/catalogs') .filter('(displayName eq \'General\')') .get(); diff --git a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-javascript-snippets.md similarity index 72% rename from includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-javascript-snippets.md rename to includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-javascript-snippets.md index de9b30772ff..b210af01c93 100644 --- a/includes/snippets/javascript/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-javascript-snippets.md +++ b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-javascript-snippets.md @@ -15,16 +15,13 @@ const accessPackageResourceRequest = { requestType: 'AdminAdd', justification: '', accessPackageResource: { - displayName: 'Marketing resources', - description: 'Marketing group', resourceType: 'AadGroup', originId: 'e93e24d1-2b65-4a6c-a1dd-654a12225487', originSystem: 'AadGroup' } }; -await client.api('/identityGovernance/entitlementManagement/accessPackageResourceRequests') - .version('beta') +await client.api('/identityGovernance/entitlementManagement/resourceRequests') .post(accessPackageResourceRequest); ``` \ No newline at end of file diff --git a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md new file mode 100644 index 00000000000..8f595d080ad --- /dev/null +++ b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-javascript-snippets.md @@ -0,0 +1,18 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```javascript + +const options = { + authProvider, +}; + +const client = Client.init(options); + +let resourceRoles = await client.api('/identityGovernance/entitlementManagement/catalogs/ede67938-cda7-4127-a9ca-7c7bf86a19b7/resourceRoles') + .filter('(originSystem eq \'AadGroup\' and displayName eq \'Member\' and resource/id eq \'274a1e21c5-8a76-4578-acb1-641160e076e\')') + .expand('resource/id eq \'274a1e21c5-8a76-4578-acb1-641160e076e\')') + .get(); + +``` \ No newline at end of file diff --git a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md new file mode 100644 index 00000000000..47432aa7add --- /dev/null +++ b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-accesspackageresources-javascript-snippets.md @@ -0,0 +1,17 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```javascript + +const options = { + authProvider, +}; + +const client = Client.init(options); + +let resources = await client.api('/identityGovernance/entitlementManagement/catalogs/cec5d6ab-c75d-47c0-9c1c-92e89f66e384/resources') + .filter('originId eq \'e93e24d1-2b65-4a6c-a1dd-654a12225487\'') + .get(); + +``` \ No newline at end of file diff --git a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-group-members-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-group-members-javascript-snippets.md index 902d7586c47..4a4189db1fa 100644 --- a/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-group-members-javascript-snippets.md +++ b/includes/snippets/javascript/v1/tutorial-entitlementmanagement-get-group-members-javascript-snippets.md @@ -10,7 +10,7 @@ const options = { const client = Client.init(options); -let members = await client.api('/groups/e93e24d1-2b65-4a6c-a1dd-654a12225487/members') +let members = await client.api('/groups/f4892fac-e81c-4712-bdf2-a4450008a4b0/members') .get(); ``` \ No newline at end of file diff --git a/includes/snippets/javascript/v1/tutorial-riskdetection-create-user-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-riskdetection-create-user-javascript-snippets.md deleted file mode 100644 index 78a37e258d1..00000000000 --- a/includes/snippets/javascript/v1/tutorial-riskdetection-create-user-javascript-snippets.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```javascript - -const options = { - authProvider, -}; - -const client = Client.init(options); - -const user = { - accountEnabled: true, - displayName: 'MyTestUser1', - mailNickname: 'MyTestUser1', - userPrincipalName: 'MyTestUser1@contoso.com', - passwordProfile: { - forceChangePasswordNextSignIn: true, - password: 'Contoso1234' - } -}; - -await client.api('/users') - .post(user); - -``` \ No newline at end of file diff --git a/includes/snippets/javascript/v1/tutorial-riskdetection-delete-group-javascript-snippets.md b/includes/snippets/javascript/v1/tutorial-riskdetection-delete-group-javascript-snippets.md index 1b74a31b970..4100084d946 100644 --- a/includes/snippets/javascript/v1/tutorial-riskdetection-delete-group-javascript-snippets.md +++ b/includes/snippets/javascript/v1/tutorial-riskdetection-delete-group-javascript-snippets.md @@ -10,7 +10,7 @@ const options = { const client = Client.init(options); -await client.api('/groups/9ad78153-b1f8-4714-adc1-1445727678a8') +await client.api('/identity/conditionalAccess/policies/9ad78153-b1f8-4714-adc1-1445727678a8') .delete(); ``` \ No newline at end of file diff --git a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md b/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md deleted file mode 100644 index 4a892ddc94b..00000000000 --- a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -setCatalogId('cec5d6ab-c75d-47c0-9c1c-92e89f66e384'); -$requestBody->setRequestType('AdminAdd'); -$requestBody->setJustification(''); -$accessPackageResource = new AccessPackageResource(); -$accessPackageResource->setDisplayName('Marketing resources'); -$accessPackageResource->setDescription('Marketing group'); -$accessPackageResource->setResourceType('AadGroup'); -$accessPackageResource->setOriginId('e93e24d1-2b65-4a6c-a1dd-654a12225487'); -$accessPackageResource->setOriginSystem('AadGroup'); -$requestBody->setAccessPackageResource($accessPackageResource); - -$result = $graphServiceClient->identityGovernance()->entitlementManagement()->accessPackageResourceRequests()->post($requestBody)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md b/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md deleted file mode 100644 index 318804d5c29..00000000000 --- a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -filter = "(originSystem eq 'AadGroup' and accessPackageResource/id eq '4a1e21c5-8a76-4578-acb1-641160e076e8' and displayName eq 'Member')"; -$queryParameters->expand = ["accessPackageResource"]; -$requestConfiguration->queryParameters = $queryParameters; - - -$result = $graphServiceClient->identityGovernance()->entitlementManagement()->accessPackageCatalogs()->byAccessPackageCatalogId('accessPackageCatalog-id')->accessPackageResourceRoles()->get($requestConfiguration)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-php-snippets.md b/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-php-snippets.md deleted file mode 100644 index 04ca84c7591..00000000000 --- a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-php-snippets.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -setOriginId('Member_e93e24d1-2b65-4a6c-a1dd-654a12225487'); -$accessPackageResourceRole->setDisplayName('Member'); -$accessPackageResourceRole->setOriginSystem('AadGroup'); -$accessPackageResourceRoleAccessPackageResource = new AccessPackageResource(); -$accessPackageResourceRoleAccessPackageResource->setId('4a1e21c5-8a76-4578-acb1-641160e076e8'); -$accessPackageResourceRoleAccessPackageResource->setResourceType('Security Group'); -$accessPackageResourceRoleAccessPackageResource->setOriginId('e93e24d1-2b65-4a6c-a1dd-654a12225487'); -$accessPackageResourceRoleAccessPackageResource->setOriginSystem('AadGroup'); -$accessPackageResourceRole->setAccessPackageResource($accessPackageResourceRoleAccessPackageResource); -$requestBody->setAccessPackageResourceRole($accessPackageResourceRole); -$accessPackageResourceScope = new AccessPackageResourceScope(); -$accessPackageResourceScope->setOriginId('e93e24d1-2b65-4a6c-a1dd-654a12225487'); -$accessPackageResourceScope->setOriginSystem('AadGroup'); -$requestBody->setAccessPackageResourceScope($accessPackageResourceScope); - -$result = $graphServiceClient->identityGovernance()->entitlementManagement()->accessPackages()->byAccessPackageId('accessPackage-id')->accessPackageResourceRoleScopes()->post($requestBody)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md b/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md deleted file mode 100644 index f4f12ca1cb6..00000000000 --- a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -filter = "(displayName eq 'Marketing resources')"; -$requestConfiguration->queryParameters = $queryParameters; - - -$result = $graphServiceClient->identityGovernance()->entitlementManagement()->accessPackageCatalogs()->byAccessPackageCatalogId('accessPackageCatalog-id')->accessPackageResources()->get($requestConfiguration)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/beta/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md b/includes/snippets/php/v1/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md similarity index 77% rename from includes/snippets/php/beta/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md rename to includes/snippets/php/v1/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md index a337b79e482..97e9afe8a28 100644 --- a/includes/snippets/php/beta/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md +++ b/includes/snippets/php/v1/tutorial-entitlementmanagement-create-accesspackage-php-snippets.md @@ -10,9 +10,12 @@ description: "Automatically generated file. DO NOT MODIFY" $graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes); $requestBody = new AccessPackage(); -$requestBody->setCatalogId('cec5d6ab-c75d-47c0-9c1c-92e89f66e384'); $requestBody->setDisplayName('Marketing Campaign'); $requestBody->setDescription('Access to resources for the campaign'); +$additionalData = [ + 'catalogId' => 'cec5d6ab-c75d-47c0-9c1c-92e89f66e384', +]; +$requestBody->setAdditionalData($additionalData); $result = $graphServiceClient->identityGovernance()->entitlementManagement()->accessPackages()->post($requestBody)->wait(); diff --git a/includes/snippets/php/v1/tutorial-entitlementmanagement-create-group-php-snippets.md b/includes/snippets/php/v1/tutorial-entitlementmanagement-create-group-php-snippets.md deleted file mode 100644 index 19f8b3af9a3..00000000000 --- a/includes/snippets/php/v1/tutorial-entitlementmanagement-create-group-php-snippets.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -setDescription('Marketing group'); -$requestBody->setDisplayName('Marketing resources'); -$requestBody->setMailEnabled(false); -$requestBody->setMailNickname('markres'); -$requestBody->setSecurityEnabled(true); - -$result = $graphServiceClient->groups()->post($requestBody)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-entitlementmanagement-create-user-php-snippets.md b/includes/snippets/php/v1/tutorial-entitlementmanagement-create-user-php-snippets.md deleted file mode 100644 index a352785a1a0..00000000000 --- a/includes/snippets/php/v1/tutorial-entitlementmanagement-create-user-php-snippets.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -setAccountEnabled(true); -$requestBody->setDisplayName('Requestor1'); -$requestBody->setMailNickname('Requestor1'); -$requestBody->setUserPrincipalName('Requestor1@contoso.com'); -$passwordProfile = new PasswordProfile(); -$passwordProfile->setForceChangePasswordNextSignIn(true); -$passwordProfile->setPassword('Contoso1234'); -$requestBody->setPasswordProfile($passwordProfile); - -$result = $graphServiceClient->users()->post($requestBody)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-php-snippets.md b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-php-snippets.md similarity index 56% rename from includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-php-snippets.md rename to includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-php-snippets.md index e9fe0258a1e..d001b145a0d 100644 --- a/includes/snippets/php/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-php-snippets.md +++ b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-php-snippets.md @@ -9,12 +9,12 @@ description: "Automatically generated file. DO NOT MODIFY" $graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes); -$requestConfiguration = new AccessPackageCatalogsRequestBuilderGetRequestConfiguration(); -$queryParameters = AccessPackageCatalogsRequestBuilderGetRequestConfiguration::createQueryParameters(); +$requestConfiguration = new CatalogsRequestBuilderGetRequestConfiguration(); +$queryParameters = CatalogsRequestBuilderGetRequestConfiguration::createQueryParameters(); $queryParameters->filter = "(displayName eq 'General')"; $requestConfiguration->queryParameters = $queryParameters; -$result = $graphServiceClient->identityGovernance()->entitlementManagement()->accessPackageCatalogs()->get($requestConfiguration)->wait(); +$result = $graphServiceClient->identityGovernance()->entitlementManagement()->catalogs()->get($requestConfiguration)->wait(); ``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md new file mode 100644 index 00000000000..0f9619176b7 --- /dev/null +++ b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-php-snippets.md @@ -0,0 +1,27 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```php + +setRequestType(new AccessPackageRequestType('adminAdd')); +$additionalData = [ + 'catalogId' => 'cec5d6ab-c75d-47c0-9c1c-92e89f66e384', + 'justification' => '', + 'accessPackageResource' => [ + 'resourceType' => 'AadGroup', + 'originId' => 'e93e24d1-2b65-4a6c-a1dd-654a12225487', + 'originSystem' => 'AadGroup', + ], +]; +$requestBody->setAdditionalData($additionalData); + +$result = $graphServiceClient->identityGovernance()->entitlementManagement()->resourceRequests()->post($requestBody)->wait(); + +``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md new file mode 100644 index 00000000000..941b62adfd6 --- /dev/null +++ b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-php-snippets.md @@ -0,0 +1,21 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```php + +filter = "(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')"; +$queryParameters->expand = ["resource"]; +$requestConfiguration->queryParameters = $queryParameters; + + +$result = $graphServiceClient->identityGovernance()->entitlementManagement()->catalogs()->byAccessPackageCatalogId('accessPackageCatalog-id')->resourceRoles()->get($requestConfiguration)->wait(); + +``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md new file mode 100644 index 00000000000..1cc3fa90518 --- /dev/null +++ b/includes/snippets/php/v1/tutorial-entitlementmanagement-get-accesspackageresources-php-snippets.md @@ -0,0 +1,20 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```php + +filter = "originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487'"; +$requestConfiguration->queryParameters = $queryParameters; + + +$result = $graphServiceClient->identityGovernance()->entitlementManagement()->catalogs()->byAccessPackageCatalogId('accessPackageCatalog-id')->resources()->get($requestConfiguration)->wait(); + +``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-riskdetection-create-user-php-snippets.md b/includes/snippets/php/v1/tutorial-riskdetection-create-user-php-snippets.md deleted file mode 100644 index c76e0f2bc26..00000000000 --- a/includes/snippets/php/v1/tutorial-riskdetection-create-user-php-snippets.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -setAccountEnabled(true); -$requestBody->setDisplayName('MyTestUser1'); -$requestBody->setMailNickname('MyTestUser1'); -$requestBody->setUserPrincipalName('MyTestUser1@contoso.com'); -$passwordProfile = new PasswordProfile(); -$passwordProfile->setForceChangePasswordNextSignIn(true); -$passwordProfile->setPassword('Contoso1234'); -$requestBody->setPasswordProfile($passwordProfile); - -$result = $graphServiceClient->users()->post($requestBody)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-riskdetection-delete-group-php-snippets.md b/includes/snippets/php/v1/tutorial-riskdetection-delete-group-php-snippets.md index d0f22039a34..9049e7869ff 100644 --- a/includes/snippets/php/v1/tutorial-riskdetection-delete-group-php-snippets.md +++ b/includes/snippets/php/v1/tutorial-riskdetection-delete-group-php-snippets.md @@ -10,6 +10,6 @@ description: "Automatically generated file. DO NOT MODIFY" $graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes); -$graphServiceClient->groups()->byGroupId('group-id')->delete()->wait(); +$graphServiceClient->identity()->conditionalAccess()->policies()->byConditionalAccessPolicyId('conditionalAccessPolicy-id')->delete()->wait(); ``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-riskdetection-get-riskdetections-filter-php-snippets.md b/includes/snippets/php/v1/tutorial-riskdetection-get-riskdetections-filter-php-snippets.md deleted file mode 100644 index 7f769019a0d..00000000000 --- a/includes/snippets/php/v1/tutorial-riskdetection-get-riskdetections-filter-php-snippets.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -filter = "userDisplayName eq 'MyTestUser1'"; -$requestConfiguration->queryParameters = $queryParameters; - - -$result = $graphServiceClient->identityProtection()->riskDetections()->get($requestConfiguration)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/php/v1/tutorial-riskdetection-riskyuserslist-php-snippets.md b/includes/snippets/php/v1/tutorial-riskdetection-riskyuserslist-php-snippets.md deleted file mode 100644 index bb0cc91a17f..00000000000 --- a/includes/snippets/php/v1/tutorial-riskdetection-riskyuserslist-php-snippets.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```php - -filter = "userDisplayName eq 'MyTestUser1'"; -$requestConfiguration->queryParameters = $queryParameters; - - -$result = $graphServiceClient->identityProtection()->riskyUsers()->get($requestConfiguration)->wait(); - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md b/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md deleted file mode 100644 index 9868e589258..00000000000 --- a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Beta.Identity.Governance - -Get-MgBetaEntitlementManagementAccessPackageCatalog -Filter "(displayName eq 'General')" - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md b/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md deleted file mode 100644 index 3b45fe90080..00000000000 --- a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Beta.Identity.Governance - -Get-MgBetaEntitlementManagementAccessPackageCatalogAccessPackageResourceRole -AccessPackageCatalogId $accessPackageCatalogId -Filter "(originSystem eq 'AadGroup' and accessPackageResource/id eq '4a1e21c5-8a76-4578-acb1-641160e076e8' and displayName eq 'Member')" -ExpandProperty "accessPackageResource" - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-powershell-snippets.md b/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-powershell-snippets.md deleted file mode 100644 index fdb51d4eb61..00000000000 --- a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-powershell-snippets.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Beta.Identity.Governance - -$params = @{ - accessPackageResourceRole = @{ - originId = "Member_e93e24d1-2b65-4a6c-a1dd-654a12225487" - displayName = "Member" - originSystem = "AadGroup" - accessPackageResource = @{ - id = "4a1e21c5-8a76-4578-acb1-641160e076e8" - resourceType = "Security Group" - originId = "e93e24d1-2b65-4a6c-a1dd-654a12225487" - originSystem = "AadGroup" - } - } - accessPackageResourceScope = @{ - originId = "e93e24d1-2b65-4a6c-a1dd-654a12225487" - originSystem = "AadGroup" - } -} - -New-MgBetaEntitlementManagementAccessPackageResourceRoleScope -AccessPackageId $accessPackageId -BodyParameter $params - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md b/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md deleted file mode 100644 index 9abf2f14338..00000000000 --- a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Beta.Identity.Governance - -Get-MgBetaEntitlementManagementAccessPackageCatalogAccessPackageResource -AccessPackageCatalogId $accessPackageCatalogId -Filter "(displayName eq 'Marketing resources')" - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md similarity index 66% rename from includes/snippets/powershell/beta/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md rename to includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md index a35991c4bce..510911b1938 100644 --- a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md +++ b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-accesspackage-powershell-snippets.md @@ -4,7 +4,7 @@ description: "Automatically generated file. DO NOT MODIFY" ```powershell -Import-Module Microsoft.Graph.Beta.Identity.Governance +Import-Module Microsoft.Graph.Identity.Governance $params = @{ catalogId = "cec5d6ab-c75d-47c0-9c1c-92e89f66e384" @@ -12,6 +12,6 @@ $params = @{ description = "Access to resources for the campaign" } -New-MgBetaEntitlementManagementAccessPackage -BodyParameter $params +New-MgEntitlementManagementAccessPackage -BodyParameter $params ``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-group-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-group-powershell-snippets.md deleted file mode 100644 index 66212be713c..00000000000 --- a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-group-powershell-snippets.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Groups - -$params = @{ - description = "Marketing group" - displayName = "Marketing resources" - mailEnabled = $false - mailNickname = "markres" - securityEnabled = $true -} - -New-MgGroup -BodyParameter $params - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-user-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-user-powershell-snippets.md deleted file mode 100644 index 9d42e1b07bd..00000000000 --- a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-create-user-powershell-snippets.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Users - -$params = @{ - accountEnabled = $true - displayName = "Requestor1" - mailNickname = "Requestor1" - userPrincipalName = "Requestor1@contoso.com" - passwordProfile = @{ - forceChangePasswordNextSignIn = $true - password = "Contoso1234" - } -} - -New-MgUser -BodyParameter $params - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-group-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-group-powershell-snippets.md deleted file mode 100644 index b5a0412ce58..00000000000 --- a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-group-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Groups - -Remove-MgGroup -GroupId $groupId - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-user-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-user-powershell-snippets.md deleted file mode 100644 index 3120ab7e643..00000000000 --- a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-delete-user-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Users - -Remove-MgUser -UserId $userId - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md new file mode 100644 index 00000000000..38e0431b81c --- /dev/null +++ b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-powershell-snippets.md @@ -0,0 +1,11 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```powershell + +Import-Module Microsoft.Graph.Identity.Governance + +Get-MgEntitlementManagementCatalog -Filter "(displayName eq 'General')" + +``` \ No newline at end of file diff --git a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-powershell-snippets.md similarity index 61% rename from includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-powershell-snippets.md rename to includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-powershell-snippets.md index af657840ccf..979d5d2d84a 100644 --- a/includes/snippets/powershell/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-powershell-snippets.md +++ b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-powershell-snippets.md @@ -4,21 +4,19 @@ description: "Automatically generated file. DO NOT MODIFY" ```powershell -Import-Module Microsoft.Graph.Beta.Identity.Governance +Import-Module Microsoft.Graph.Identity.Governance $params = @{ catalogId = "cec5d6ab-c75d-47c0-9c1c-92e89f66e384" requestType = "AdminAdd" justification = "" accessPackageResource = @{ - displayName = "Marketing resources" - description = "Marketing group" resourceType = "AadGroup" originId = "e93e24d1-2b65-4a6c-a1dd-654a12225487" originSystem = "AadGroup" } } -New-MgBetaEntitlementManagementAccessPackageResourceRequest -BodyParameter $params +New-MgEntitlementManagementResourceRequest -BodyParameter $params ``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md new file mode 100644 index 00000000000..669bab7925a --- /dev/null +++ b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-powershell-snippets.md @@ -0,0 +1,11 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```powershell + +Import-Module Microsoft.Graph.Identity.Governance + +Get-MgEntitlementManagementCatalogResourceRole -AccessPackageCatalogId $accessPackageCatalogId -Filter "(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')" -ExpandProperty "resource" + +``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md new file mode 100644 index 00000000000..6ff4547f135 --- /dev/null +++ b/includes/snippets/powershell/v1/tutorial-entitlementmanagement-get-accesspackageresources-powershell-snippets.md @@ -0,0 +1,11 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```powershell + +Import-Module Microsoft.Graph.Identity.Governance + +Get-MgEntitlementManagementCatalogResource -AccessPackageCatalogId $accessPackageCatalogId -Filter "originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487'" + +``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-riskdetection-create-user-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-riskdetection-create-user-powershell-snippets.md deleted file mode 100644 index 77844a16d57..00000000000 --- a/includes/snippets/powershell/v1/tutorial-riskdetection-create-user-powershell-snippets.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Users - -$params = @{ - accountEnabled = $true - displayName = "MyTestUser1" - mailNickname = "MyTestUser1" - userPrincipalName = "MyTestUser1@contoso.com" - passwordProfile = @{ - forceChangePasswordNextSignIn = $true - password = "Contoso1234" - } -} - -New-MgUser -BodyParameter $params - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-riskdetection-delete-group-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-riskdetection-delete-group-powershell-snippets.md index b5a0412ce58..3fe5f9173e8 100644 --- a/includes/snippets/powershell/v1/tutorial-riskdetection-delete-group-powershell-snippets.md +++ b/includes/snippets/powershell/v1/tutorial-riskdetection-delete-group-powershell-snippets.md @@ -4,8 +4,8 @@ description: "Automatically generated file. DO NOT MODIFY" ```powershell -Import-Module Microsoft.Graph.Groups +Import-Module Microsoft.Graph.Identity.SignIns -Remove-MgGroup -GroupId $groupId +Remove-MgIdentityConditionalAccessPolicy -ConditionalAccessPolicyId $conditionalAccessPolicyId ``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-riskdetection-delete-user-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-riskdetection-delete-user-powershell-snippets.md deleted file mode 100644 index 3120ab7e643..00000000000 --- a/includes/snippets/powershell/v1/tutorial-riskdetection-delete-user-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Users - -Remove-MgUser -UserId $userId - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-riskdetection-get-riskdetections-filter-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-riskdetection-get-riskdetections-filter-powershell-snippets.md deleted file mode 100644 index 697be4e8fc7..00000000000 --- a/includes/snippets/powershell/v1/tutorial-riskdetection-get-riskdetections-filter-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Identity.SignIns - -Get-MgRiskDetection -Filter "userDisplayName eq 'MyTestUser1'" - -``` \ No newline at end of file diff --git a/includes/snippets/powershell/v1/tutorial-riskdetection-riskyuserslist-powershell-snippets.md b/includes/snippets/powershell/v1/tutorial-riskdetection-riskyuserslist-powershell-snippets.md deleted file mode 100644 index 155ae5373b7..00000000000 --- a/includes/snippets/powershell/v1/tutorial-riskdetection-riskyuserslist-powershell-snippets.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```powershell - -Import-Module Microsoft.Graph.Identity.SignIns - -Get-MgRiskyUser -Filter "userDisplayName eq 'MyTestUser1'" - -``` \ No newline at end of file diff --git a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md b/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md deleted file mode 100644 index 1eeed21f3ce..00000000000 --- a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.identityGovernance.entitlementManagement.accessPackageCatalogs.access_package_catalogs_request_builder import AccessPackageCatalogsRequestBuilder - -graph_client = GraphServiceClient(credentials, scopes) - -query_params = AccessPackageCatalogsRequestBuilder.AccessPackageCatalogsRequestBuilderGetQueryParameters( - filter = "(displayName eq 'General')", -) - -request_configuration = AccessPackageCatalogsRequestBuilder.AccessPackageCatalogsRequestBuilderGetRequestConfiguration( -query_parameters = query_params, -) - -result = await graph_client.identity_governance.entitlement_management.access_package_catalogs.get(request_configuration = request_configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md b/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md deleted file mode 100644 index 07400ed49d7..00000000000 --- a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.models.access_package_resource_request import AccessPackageResourceRequest -from msgraph.generated.models.access_package_resource import AccessPackageResource - -graph_client = GraphServiceClient(credentials, scopes) - -request_body = AccessPackageResourceRequest( - catalog_id = "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", - request_type = "AdminAdd", - justification = "", - access_package_resource = AccessPackageResource( - display_name = "Marketing resources", - description = "Marketing group", - resource_type = "AadGroup", - origin_id = "e93e24d1-2b65-4a6c-a1dd-654a12225487", - origin_system = "AadGroup", - ), -) - -result = await graph_client.identity_governance.entitlement_management.access_package_resource_requests.post(request_body) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md b/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md deleted file mode 100644 index ea5e6e31562..00000000000 --- a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.identityGovernance.entitlementManagement.accessPackageCatalogs.item.accessPackageResourceRoles.access_package_resource_roles_request_builder import AccessPackageResourceRolesRequestBuilder - -graph_client = GraphServiceClient(credentials, scopes) - -query_params = AccessPackageResourceRolesRequestBuilder.AccessPackageResourceRolesRequestBuilderGetQueryParameters( - filter = "(originSystem eq 'AadGroup' and accessPackageResource/id eq '4a1e21c5-8a76-4578-acb1-641160e076e8' and displayName eq 'Member')", - expand = ["accessPackageResource"], -) - -request_configuration = AccessPackageResourceRolesRequestBuilder.AccessPackageResourceRolesRequestBuilderGetRequestConfiguration( -query_parameters = query_params, -) - -result = await graph_client.identity_governance.entitlement_management.access_package_catalogs.by_access_package_catalog_id('accessPackageCatalog-id').access_package_resource_roles.get(request_configuration = request_configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-python-snippets.md b/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-python-snippets.md deleted file mode 100644 index 7de0e40989e..00000000000 --- a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresourcerolescope-python-snippets.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.models.access_package_resource_role_scope import AccessPackageResourceRoleScope -from msgraph.generated.models.access_package_resource_role import AccessPackageResourceRole -from msgraph.generated.models.access_package_resource import AccessPackageResource -from msgraph.generated.models.access_package_resource_scope import AccessPackageResourceScope - -graph_client = GraphServiceClient(credentials, scopes) - -request_body = AccessPackageResourceRoleScope( - access_package_resource_role = AccessPackageResourceRole( - origin_id = "Member_e93e24d1-2b65-4a6c-a1dd-654a12225487", - display_name = "Member", - origin_system = "AadGroup", - access_package_resource = AccessPackageResource( - id = "4a1e21c5-8a76-4578-acb1-641160e076e8", - resource_type = "Security Group", - origin_id = "e93e24d1-2b65-4a6c-a1dd-654a12225487", - origin_system = "AadGroup", - ), - ), - access_package_resource_scope = AccessPackageResourceScope( - origin_id = "e93e24d1-2b65-4a6c-a1dd-654a12225487", - origin_system = "AadGroup", - ), -) - -result = await graph_client.identity_governance.entitlement_management.access_packages.by_access_package_id('accessPackage-id').access_package_resource_role_scopes.post(request_body) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md b/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md deleted file mode 100644 index 6ab7c1b0c65..00000000000 --- a/includes/snippets/python/beta/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.identityGovernance.entitlementManagement.accessPackageCatalogs.item.accessPackageResources.access_package_resources_request_builder import AccessPackageResourcesRequestBuilder - -graph_client = GraphServiceClient(credentials, scopes) - -query_params = AccessPackageResourcesRequestBuilder.AccessPackageResourcesRequestBuilderGetQueryParameters( - filter = "(displayName eq 'Marketing resources')", -) - -request_configuration = AccessPackageResourcesRequestBuilder.AccessPackageResourcesRequestBuilderGetRequestConfiguration( -query_parameters = query_params, -) - -result = await graph_client.identity_governance.entitlement_management.access_package_catalogs.by_access_package_catalog_id('accessPackageCatalog-id').access_package_resources.get(request_configuration = request_configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/beta/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md b/includes/snippets/python/v1/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md similarity index 85% rename from includes/snippets/python/beta/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md rename to includes/snippets/python/v1/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md index 8116c0fe867..009dd641915 100644 --- a/includes/snippets/python/beta/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md +++ b/includes/snippets/python/v1/tutorial-entitlementmanagement-create-accesspackage-python-snippets.md @@ -10,9 +10,11 @@ from msgraph.generated.models.access_package import AccessPackage graph_client = GraphServiceClient(credentials, scopes) request_body = AccessPackage( - catalog_id = "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", display_name = "Marketing Campaign", description = "Access to resources for the campaign", + additional_data = { + "catalog_id" : "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", + } ) result = await graph_client.identity_governance.entitlement_management.access_packages.post(request_body) diff --git a/includes/snippets/python/v1/tutorial-entitlementmanagement-create-group-python-snippets.md b/includes/snippets/python/v1/tutorial-entitlementmanagement-create-group-python-snippets.md deleted file mode 100644 index a6c6d870dad..00000000000 --- a/includes/snippets/python/v1/tutorial-entitlementmanagement-create-group-python-snippets.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.models.group import Group - -graph_client = GraphServiceClient(credentials, scopes) - -request_body = Group( - description = "Marketing group", - display_name = "Marketing resources", - mail_enabled = False, - mail_nickname = "markres", - security_enabled = True, -) - -result = await graph_client.groups.post(request_body) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-entitlementmanagement-create-user-python-snippets.md b/includes/snippets/python/v1/tutorial-entitlementmanagement-create-user-python-snippets.md deleted file mode 100644 index 9149c89a313..00000000000 --- a/includes/snippets/python/v1/tutorial-entitlementmanagement-create-user-python-snippets.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.models.user import User -from msgraph.generated.models.password_profile import PasswordProfile - -graph_client = GraphServiceClient(credentials, scopes) - -request_body = User( - account_enabled = True, - display_name = "Requestor1", - mail_nickname = "Requestor1", - user_principal_name = "Requestor1@contoso.com", - password_profile = PasswordProfile( - force_change_password_next_sign_in = True, - password = "Contoso1234", - ), -) - -result = await graph_client.users.post(request_body) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md new file mode 100644 index 00000000000..f4bd1d63314 --- /dev/null +++ b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackagecatalog-python-snippets.md @@ -0,0 +1,23 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```python + +from msgraph import GraphServiceClient +from msgraph.generated.identityGovernance.entitlementManagement.catalogs.catalogs_request_builder import CatalogsRequestBuilder + +graph_client = GraphServiceClient(credentials, scopes) + +query_params = CatalogsRequestBuilder.CatalogsRequestBuilderGetQueryParameters( + filter = "(displayName eq 'General')", +) + +request_configuration = CatalogsRequestBuilder.CatalogsRequestBuilderGetRequestConfiguration( +query_parameters = query_params, +) + +result = await graph_client.identity_governance.entitlement_management.catalogs.get(request_configuration = request_configuration) + + +``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md new file mode 100644 index 00000000000..b5bf08bf58f --- /dev/null +++ b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourcerequest-python-snippets.md @@ -0,0 +1,28 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```python + +from msgraph import GraphServiceClient +from msgraph.generated.models.access_package_resource_request import AccessPackageResourceRequest + +graph_client = GraphServiceClient(credentials, scopes) + +request_body = AccessPackageResourceRequest( + request_type = AccessPackageRequestType.AdminAdd, + additional_data = { + "catalog_id" : "cec5d6ab-c75d-47c0-9c1c-92e89f66e384", + "justification" : "", + "access_package_resource" : { + "resource_type" : "AadGroup", + "origin_id" : "e93e24d1-2b65-4a6c-a1dd-654a12225487", + "origin_system" : "AadGroup", + }, + } +) + +result = await graph_client.identity_governance.entitlement_management.resource_requests.post(request_body) + + +``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md new file mode 100644 index 00000000000..2e99ce02671 --- /dev/null +++ b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresourceroles-python-snippets.md @@ -0,0 +1,24 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```python + +from msgraph import GraphServiceClient +from msgraph.generated.identityGovernance.entitlementManagement.catalogs.item.resourceRoles.resource_roles_request_builder import ResourceRolesRequestBuilder + +graph_client = GraphServiceClient(credentials, scopes) + +query_params = ResourceRolesRequestBuilder.ResourceRolesRequestBuilderGetQueryParameters( + filter = "(originSystem eq 'AadGroup' and displayName eq 'Member' and resource/id eq '274a1e21c5-8a76-4578-acb1-641160e076e')", + expand = ["resource"], +) + +request_configuration = ResourceRolesRequestBuilder.ResourceRolesRequestBuilderGetRequestConfiguration( +query_parameters = query_params, +) + +result = await graph_client.identity_governance.entitlement_management.catalogs.by_access_package_catalog_id('accessPackageCatalog-id').resource_roles.get(request_configuration = request_configuration) + + +``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md new file mode 100644 index 00000000000..52dcfd39aed --- /dev/null +++ b/includes/snippets/python/v1/tutorial-entitlementmanagement-get-accesspackageresources-python-snippets.md @@ -0,0 +1,23 @@ +--- +description: "Automatically generated file. DO NOT MODIFY" +--- + +```python + +from msgraph import GraphServiceClient +from msgraph.generated.identityGovernance.entitlementManagement.catalogs.item.resources.resources_request_builder import ResourcesRequestBuilder + +graph_client = GraphServiceClient(credentials, scopes) + +query_params = ResourcesRequestBuilder.ResourcesRequestBuilderGetQueryParameters( + filter = "originId eq 'e93e24d1-2b65-4a6c-a1dd-654a12225487'", +) + +request_configuration = ResourcesRequestBuilder.ResourcesRequestBuilderGetRequestConfiguration( +query_parameters = query_params, +) + +result = await graph_client.identity_governance.entitlement_management.catalogs.by_access_package_catalog_id('accessPackageCatalog-id').resources.get(request_configuration = request_configuration) + + +``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-riskdetection-create-user-python-snippets.md b/includes/snippets/python/v1/tutorial-riskdetection-create-user-python-snippets.md deleted file mode 100644 index 1dff78c42f1..00000000000 --- a/includes/snippets/python/v1/tutorial-riskdetection-create-user-python-snippets.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.models.user import User -from msgraph.generated.models.password_profile import PasswordProfile - -graph_client = GraphServiceClient(credentials, scopes) - -request_body = User( - account_enabled = True, - display_name = "MyTestUser1", - mail_nickname = "MyTestUser1", - user_principal_name = "MyTestUser1@contoso.com", - password_profile = PasswordProfile( - force_change_password_next_sign_in = True, - password = "Contoso1234", - ), -) - -result = await graph_client.users.post(request_body) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-riskdetection-delete-group-python-snippets.md b/includes/snippets/python/v1/tutorial-riskdetection-delete-group-python-snippets.md index f62b6aedac3..e541fc972fa 100644 --- a/includes/snippets/python/v1/tutorial-riskdetection-delete-group-python-snippets.md +++ b/includes/snippets/python/v1/tutorial-riskdetection-delete-group-python-snippets.md @@ -9,7 +9,7 @@ from msgraph import GraphServiceClient graph_client = GraphServiceClient(credentials, scopes) -await graph_client.groups.by_group_id('group-id').delete() +await graph_client.identity.conditional_access.policies.by_conditional_access_policy_id('conditionalAccessPolicy-id').delete() ``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-riskdetection-get-riskdetections-filter-python-snippets.md b/includes/snippets/python/v1/tutorial-riskdetection-get-riskdetections-filter-python-snippets.md deleted file mode 100644 index 2f6e4f1b1d1..00000000000 --- a/includes/snippets/python/v1/tutorial-riskdetection-get-riskdetections-filter-python-snippets.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.identityProtection.riskDetections.risk_detections_request_builder import RiskDetectionsRequestBuilder - -graph_client = GraphServiceClient(credentials, scopes) - -query_params = RiskDetectionsRequestBuilder.RiskDetectionsRequestBuilderGetQueryParameters( - filter = "userDisplayName eq 'MyTestUser1'", -) - -request_configuration = RiskDetectionsRequestBuilder.RiskDetectionsRequestBuilderGetRequestConfiguration( -query_parameters = query_params, -) - -result = await graph_client.identity_protection.risk_detections.get(request_configuration = request_configuration) - - -``` \ No newline at end of file diff --git a/includes/snippets/python/v1/tutorial-riskdetection-riskyuserslist-python-snippets.md b/includes/snippets/python/v1/tutorial-riskdetection-riskyuserslist-python-snippets.md deleted file mode 100644 index f9e182d2574..00000000000 --- a/includes/snippets/python/v1/tutorial-riskdetection-riskyuserslist-python-snippets.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: "Automatically generated file. DO NOT MODIFY" ---- - -```python - -from msgraph import GraphServiceClient -from msgraph.generated.identityProtection.riskyUsers.risky_users_request_builder import RiskyUsersRequestBuilder - -graph_client = GraphServiceClient(credentials, scopes) - -query_params = RiskyUsersRequestBuilder.RiskyUsersRequestBuilderGetQueryParameters( - filter = "userDisplayName eq 'MyTestUser1'", -) - -request_configuration = RiskyUsersRequestBuilder.RiskyUsersRequestBuilderGetRequestConfiguration( -query_parameters = query_params, -) - -result = await graph_client.identity_protection.risky_users.get(request_configuration = request_configuration) - - -``` \ No newline at end of file From 89ce6e5f8248218f2eac0810fe9a5aef3c6091a4 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Tue, 2 Apr 2024 17:28:11 -0700 Subject: [PATCH 199/204] Edits; formatting. --- ...security-identitycontainer-list-healthissues.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/api-reference/beta/api/security-identitycontainer-list-healthissues.md b/api-reference/beta/api/security-identitycontainer-list-healthissues.md index 9a7922bbf24..575e03cbbed 100644 --- a/api-reference/beta/api/security-identitycontainer-list-healthissues.md +++ b/api-reference/beta/api/security-identitycontainer-list-healthissues.md @@ -34,11 +34,11 @@ GET /security/identities/healthIssues ## Optional query parameters -This method supports OData query parameters to help customize the response, for example: `$count`, `$filter`, `$skip`, `$top`. +This method supports the following OData query parameters to help customize the response: `$count`, `$filter`, `$skip`, `$top`. For general information, see [OData query parameters](/graph/query-parameters). -The following are examples of their use: +The following examples show how to use optional query parameters. -See all open health alerts. +### Get all open health alerts From bb1732d18e7aa2be110e19e298874205a4977b77 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Tue, 2 Apr 2024 18:00:56 -0700 Subject: [PATCH 201/204] Update channel-post.md --- api-reference/v1.0/api/channel-post.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/api-reference/v1.0/api/channel-post.md b/api-reference/v1.0/api/channel-post.md index 92197215ab2..2bd23359759 100644 --- a/api-reference/v1.0/api/channel-post.md +++ b/api-reference/v1.0/api/channel-post.md @@ -25,8 +25,7 @@ If you're creating a private channel, you can add a maximum of 200 members. One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). -> [!NOTE] -> This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. |Permission type | Permissions (from least to most privileged) | |:--------------------|:---------------------------------------------------------| From 5b9d4efaff7b8ae12cd2225602c796c2ff48628c Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Tue, 2 Apr 2024 18:03:05 -0700 Subject: [PATCH 202/204] Update application-post-calls.md --- api-reference/beta/api/application-post-calls.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/beta/api/application-post-calls.md b/api-reference/beta/api/application-post-calls.md index a4115fd0f6f..b11d8ed6b25 100644 --- a/api-reference/beta/api/application-post-calls.md +++ b/api-reference/beta/api/application-post-calls.md @@ -27,7 +27,7 @@ Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/application-post-calls-permissions.md)] > [!NOTE] -> The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> - The Calls.JoinGroupCalls.Chat permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). > - For a call with app-hosted media, you need the Calls.AccessMedia.All permission in addition to one of the permissions listed in the previous table. Cloud Video Interop solutions that are [Certified for Microsoft Teams](/MicrosoftTeams/cloud-video-interop) have permission to call this API to join meetings for which they have meeting join links, similar to external users joining through a browser. From 3de998ce629eaf315c9eefd567ad92b423638532 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Tue, 2 Apr 2024 19:56:50 -0700 Subject: [PATCH 203/204] Update defaultinvitationredemptionidentityproviderconfiguration.md --- .../defaultinvitationredemptionidentityproviderconfiguration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-reference/v1.0/resources/defaultinvitationredemptionidentityproviderconfiguration.md b/api-reference/v1.0/resources/defaultinvitationredemptionidentityproviderconfiguration.md index 0815dac1490..fa212353c10 100644 --- a/api-reference/v1.0/resources/defaultinvitationredemptionidentityproviderconfiguration.md +++ b/api-reference/v1.0/resources/defaultinvitationredemptionidentityproviderconfiguration.md @@ -28,7 +28,7 @@ None. ## JSON representation -The following is a JSON representation of the resource. +The following JSON representation shows the resource type.