Updates from: 04/06/2022 01:57:22
Service Microsoft Docs article Related commit history on GitHub Change details
v1.0 Accesspackageassignmentpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentpolicy-get.md
If successful, this method returns a `200 OK` response code and the requested [a
## Examples
-### Request
+### Example 1: Retrieve a policy
+
+#### Request
The following is an example of the request.
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/{id}
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/b2eba9a1-b357-42ee-83a8-336522ed6cbf
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-accesspackageassignmentpolicy-csharp-snippets.md)]
GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/ac
-### Response
+#### Response
The following is an example of the response.
Content-type: application/json
} ```
+### Example 2: Retrieve the custom extension handlers for a policy
+
+#### Request
+
+The following is an example of a request to retrieve the collection of custom extension handlers that are defined for a policy and their associated custom workflow extension.
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_accesspackageassignmentpolicy_expand_customextensionhandlers"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197?$expand=customExtensionHandlers($expand=customExtension)
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
++++
+#### Response
+
+The following is an example of the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentPolicy"
+} -->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "id": "4540a08f-8ab5-43f6-a923-015275799197",
+ "displayName": "policy with custom access package workflow extension",
+ "description": "Run specified custom access package workflow extension at different stages.",
+ "canExtend": true,
+ "durationInDays": 0,
+ "expirationDateTime": null,
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "accessReviewSettings": null,
+ "requestorSettings": {
+ "scopeType": "AllExistingDirectorySubjects",
+ "acceptRequests": true,
+ "allowedRequestors": []
+ },
+ "requestApprovalSettings": {
+ "isApprovalRequired": false,
+ "isApprovalRequiredForExtension": false,
+ "isRequestorJustificationRequired": false,
+ "approvalMode": "NoApproval",
+ "approvalStages": []
+ },
+ "customExtensionHandlers": [
+ {
+ "id": "5a38d27a-b702-48d9-ac72-dcf158ba1b0d",
+ "stage": "assignmentRequestCreated",
+ "customExtension": {
+ "id": "219f57b6-7983-45a1-be01-2c228b7a43f8",
+ "displayName": "test_action_1",
+ "description": "Test logic app",
+ "createdDateTime": "2022-01-11T05:19:16.97Z",
+ "lastModifiedDateTime": "2022-01-11T05:19:16.97Z",
+ "endpointConfiguration": {
+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName": "resourcegroup",
+ "logicAppWorkflowName": "customextension_test"
+ },
+ "authenticationConfiguration": {
+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
+ "resourceId": "f604bd15-f785-4309-ad7c-6fad18ddb6cb"
+ }
+ }
+ }
+ ]
+}
+```
+ <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- {
v1.0 Accesspackageassignmentpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentpolicy-update.md
The following table shows the properties that are required when you update an [a
If successful, this method returns a `200 OK` response code and an updated [accessPackageAssignmentPolicy](../resources/accesspackageassignmentpolicy.md) object in the response body. - ## Examples
-### Request
+### Example 1: Update the details of a policy
+
+#### Request
In this policy update, one of the options for the multiple choice question was removed. Future requestors will no longer have the removed option available to them.
Content-Type: application/json
-### Response
+#### Response
> **Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
Content-Type: application/json
} ``` ++
+### Example 2: Remove the customExtensionHandlers from a policy
+
+To remove the collection of **customExtensionHandlers** and their associated custom workflow extension objects from a policy, assign an empty collection to the **customExtensionHandlers** object.
+
+#### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_accesspackageassignmentpolicy_delete_customExtensionHandlers"
+}
+-->
+
+```http
+PUT https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197
+Content-Type: application/json
+
+{
+ "id": "4540a08f-8ab5-43f6-a923-015275799197",
+ "displayName": "policy with custom access package workflow extension",
+ "description": "Run specified custom access package workflow extension at different stages.",
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "expiration": {
+ "type": "afterDuration",
+ "duration": "P365D"
+ },
+ "requestApprovalSettings": null,
+ "requestorSettings": {
+ "acceptRequests": true,
+ "scopeType": "AllExistingDirectorySubjects",
+ "allowedRequestors": []
+ },
+ "accessReviewSettings": null,
+ "customExtensionHandlers": []
+}
+```
+# [JavaScript](#tab/javascript)
++++++
+#### Response
+> **Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentPolicy"
+}
+-->
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "id": "4540a08f-8ab5-43f6-a923-015275799197",
+ "displayName": "policy with custom access package workflow extension",
+ "description": "Run specified custom access package workflow extension at different stages.",
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "expiration": {
+ "type": "afterDuration",
+ "duration": "P365D"
+ },
+ "requestApprovalSettings": null,
+ "requestorSettings": {
+ "acceptRequests": true,
+ "scopeType": "AllExistingDirectorySubjects",
+ "allowedRequestors": []
+ },
+ "accessReviewSettings": null
+}
+```
+ <!-- { "type": "#page.annotation",
v1.0 Accesspackageassignmentrequest Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackageassignmentrequest-get.md
HTTP/1.1 200 OK
Content-type: application/json {
- "id": "433dafca-5047-4614-95f7-a03510b1ded3",
- "requestType": "AdminAdd",
- "requestState": "Delivered",
- "requestStatus": "Fulfilled",
- "isValidationOnly": false,
- "createdDateTime": "2019-10-25T22:55:11.623Z"
+ "id": "c0cfd117-f90e-4f48-8226-e282a2ae752c",
+ "requestType": "UserAdd",
+ "requestState": "delivered",
+ "requestStatus": "Delivered",
+ "createdDateTime": "2022-01-07T00:51:12.817Z",
+ "completedDate": "2022-01-07T00:53:15.127Z",
+ "schedule": {
+ "startDateTime": null,
+ "recurrence": null,
+ "expiration": {
+ "endDateTime": null,
+ "duration": null,
+ "type": "notSpecified"
+ }
+ },
+ "customExtensionHandlerInstances": [
+ {
+ "status": "requestReceived",
+ "externalCorrelationId": "08585600902100964604743022906CU13",
+ "customExtensionId": "e59ef33d-7bc4-4b15-8d3c-01153de8a498",
+ "stage": "assignmentRequestCreated"
+ }
+ ]
} ```
v1.0 Accesspackagecatalog List Customaccesspackageworkflowextensions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackagecatalog-list-customaccesspackageworkflowextensions.md
+
+ Title: "List customAccessPackageWorkflowExtensions"
+description: "Get a list of the customAccessPackageWorkflowExtension objects and their properties."
+
+ms.localizationpriority: medium
++
+# List customAccessPackageWorkflowExtensions
+Namespace: microsoft.graph
++
+Get a list of the [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) objects and their properties. The resulting list includes all the **customAccessPackageWorkflowExtension** objects for the catalog that the caller has access to read.
+
+## 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)|EntitlementManagement.Read.All EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.Read.All, EntitlementManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions
+```
+
+## Optional query parameters
+This method supports the `$select` and `$filter` OData query parameters to help customize the response. For example, to search for access packages with a particular name, include a filter such as `$filter=contains(tolower(displayName),'team')` in the query. 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 [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) objects in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "list_customaccesspackageworkflowextension"
+}
+-->
+``` http
+GET /identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.customAccessPackageWorkflowExtension)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions",
+ "value": [
+ {
+ "id": "98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName": "test_action_0124",
+ "description": "this is for graph testing only",
+ "createdDateTime": "2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime": "2022-01-24T21:55:44.953Z",
+ "clientConfiguration": null,
+ "endpointConfiguration": {
+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName": "test",
+ "logicAppWorkflowName": "elm-extension-email"
+ },
+ "authenticationConfiguration": {
+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
+ "resourceId": "eed6dee9-7ff7-44a5-8980-c11e8886cea2"
+ }
+ }
+ ]
+}
+```
v1.0 Accesspackagecatalog Post Customaccesspackageworkflowextensions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accesspackagecatalog-post-customaccesspackageworkflowextensions.md
+
+ Title: "Create customAccessPackageWorkflowExtensions"
+description: "Create a new customAccessPackageWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Create customAccessPackageWorkflowExtensions
+Namespace: microsoft.graph
++
+Create a new [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object and add it to an existing [accessPackageCatalog](../resources/accesspackagecatalog.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)|EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions
+```
+
+## 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 [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object.
+
+You can specify the following properties when creating a **customAccessPackageWorkflowExtension**.
+
+|Property|Type|Description|
+|:|:|:|
+|description|String|Description for the customAccessPackageWorkflowExtension object.|
+|displayName|String|Display name for the customAccessPackageWorkflowExtension.|
+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The type and details for configuring the endpoint to call the logic app's workflow.|
+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.|
+++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_customaccesspackageworkflowextension_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions
+Content-Type: application/json
+
+{
+ "displayName": "test_action_0124",
+ "description": "this is for graph testing only",
+ "endpointConfiguration": {
+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName": "EMLogicApp",
+ "logicAppWorkflowName": "customextension_test"
+ },
+ "authenticationConfiguration": {
+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
+ "resourceId": "f604bd15-f785-4309-ad7c-6fad18ddb6cb"
+ }
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.customAccessPackageWorkflowExtension"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "id": "98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName": "test_action_0124",
+ "description": "this is for graph testing only",
+ "createdDateTime": "2022-01-24T21:48:57.1483656Z",
+ "lastModifiedDateTime": "2022-01-24T21:48:57.1483656Z",
+ "clientConfiguration": null,
+ "endpointConfiguration": {
+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName": "EMLogicApp",
+ "logicAppWorkflowName": "customextension_test"
+ },
+ "authenticationConfiguration": {
+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
+ "resourceId": "f604bd15-f785-4309-ad7c-6fad18ddb6cb"
+ }
+}
+```
+
v1.0 Accessreviewhistorydefinition List Instances https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewhistorydefinition-list-instances.md
Content-Type: application/json
"value": [ { "id": "61a617dd-238f-4037-8fa5-d800e515f5bc",
- "status": "Done",
+ "status": "done",
"reviewHistoryPeriodStartDate": "2021-02-01T00:00:00Z", "reviewHistoryPeriodEndDate": "2021-03-01T00:00:00Z", "fulfilledDateTime": "2021-03-01T01:38:15.7998393Z",
v1.0 Accessreviewinstance Filterbycurrentuser https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstance-filterbycurrentuser.md
Namespace: microsoft.graph
Returns all [accessReviewInstance](../resources/accessreviewinstance.md) objects on a given [accessReviewScheduleDefinition](../resources/accessreviewscheduledefinition.md) where the calling user is a reviewer on one or more [accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) objects.
->[!NOTE]
->The default page size for this API is 100 accessReviewInstance objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
## 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).
GET /identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinitio
## Optional query parameters This method supports `$select`, `$filter`, `$orderBy`, `$skip` and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewInstance** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers |Name|Description| |:|:|
v1.0 Accessreviewinstance List Contactedreviewers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstance-list-contactedreviewers.md
Namespace: microsoft.graph
Get the reviewers who received notifications for an [access review instance](../resources/accessreviewinstance.md). The reviewers are represented by an [accessReviewReviewer](../resources/accessreviewreviewer.md) object. A list of zero or more objects are returned, including all of their nested properties.
->[!NOTE]
->The default page size for this API is 100 **accessReviewReviewer** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
GET /identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinitio
## Optional query parameters This method supports `$select`, `$filter`, `$orderBy`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewReviewer** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers |Name|Description| |:|:|
v1.0 Accessreviewinstance List Decisions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstance-list-decisions.md
Namespace: microsoft.graph
Retrieve the [accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) objects for a specific [accessReviewInstance](../resources/accessreviewinstance.md). A list of zero or more accessReviewInstanceDecisionItem objects are returned, including all of their nested properties.
->[!NOTE]
->The default page size for this API is 100 accessReviewInstance objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
GET /identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinitio
## Optional query parameters This method supports `$select`, `$filter`, `$orderBy`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewInstance** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers |Name|Description| |:|:|
GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/decisions/
[!INCLUDE [sample-code](../includes/snippets/powershell/list-accessreviewinstancedecisionitem-expand-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
v1.0 Accessreviewinstance List Stages https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstance-list-stages.md
If successful, this method returns a `200 OK` response code and a collection of
## Examples ### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_accessreviewstage"
If successful, this method returns a `200 OK` response code and a collection of
``` http GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/16d424f6-0100-4bf1-9ebc-fe009c5e5006/instances/bb14c722-51b8-4962-9bd2-1d96ba773d80/stages ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response >**Note:** The response object shown here might be shortened for readability.
v1.0 Accessreviewinstance Pendingaccessreviewinstances https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstance-pendingaccessreviewinstances.md
Namespace: microsoft.graph
>[!NOTE] >This method will be deprecated and will stop returning data on May 19, 2023. It has been replaced by [filterByCurrentUser](accessreviewinstance-filterbycurrentuser.md).
->[!NOTE]
->The default page size for this API is 100 accessReviewInstance objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- Retrieve the [accessReviewInstance](../resources/accessreviewinstance.md) objects pending approval by the calling user. A list of zero or more accessReviewInstance objects are returned, of which the calling user is an assigned reviewer. ## Permissions
GET /me/pendingAccessReviewInstances
## Optional query parameters This method supports `$skip` and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewInstance** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers None.
v1.0 Accessreviewinstancedecisionitem Filterbycurrentuser https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstancedecisionitem-filterbycurrentuser.md
Namespace: microsoft.graph
Retrieve all decision items on an instance of an access review or a stage of an instance of a multi-stage access review, for which the calling user is the reviewer. The decision items are presented by a [accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) objects on a given [accessReviewInstance](../resources/accessreviewinstance.md) or [accessReviewStage](../resources/accessReviewStage.md) for which the calling user is the reviewer. -
->[!NOTE]
->The default page size for this API is 100 **accessReviewInstanceDecisionItem** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
The following table shows the query parameters that can be used with this method
## Optional query parameters This method supports the `$select`, `$filter`, `$orderBy`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewInstanceDecisionItem** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers |Name|Description| |:|:|
Content-Type: application/json
#### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "accessreviewinstancedecisionitem_filterbycurrentuser_2"
Content-Type: application/json
``` http GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/0185aab8-9a7e-44b5-ae36-41b923c3bf87/instances/1234aab8-9a7e-5678-ae36-41b923c3bf87/stages/9458f255-dff2-4d86-9a05-69438f49d7f8/decisions/filterByCurrentUser(on='reviewer') ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response >**Note:** The response object shown here might be shortened for readability.
v1.0 Accessreviewinstancedecisionitem Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstancedecisionitem-get.md
Content-Type: application/json
### Example 2: Retrieve a decision from a stage of a multi-stage access review #### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_accessreviewstage_accessreviewinstancedecisionitem"
Content-Type: application/json
``` http GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/5eac5a70-7cd7-4f20-92b0-f9dba70dd7f0/instances/6444d4fd-ab55-4608-8cf9-c6702d172bcc/stages/9458f255-dff2-4d86-9a05-69438f49d7f8/decisions/e6cafba0-cbf0-4748-8868-0810c7f4cc06 ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ #### Response >**Note:** The response object shown here might be shortened for readability.
v1.0 Accessreviewinstancedecisionitem Listpendingapproval https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstancedecisionitem-listpendingapproval.md
Namespace: microsoft.graph
Retrieve the [accessReviewInstanceDecisionItem](../resources/accessreviewinstance.md) objects for a specific [accessReviewInstance](../resources/accessreviewscheduledefinition.md) pending approval by the calling user. A list of zero or more accessReviewInstanceDecisionItem objects are returned, including all of their nested properties.
->[!NOTE]
->The default page size for this API is 100 accessReviewInstanceDecisionItem objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
GET /me/pendingAccessReviewInstances/{instance-id}/decisions
## Optional query parameters This method supports `$skip` and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewInstanceDecisionItem** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers None.
v1.0 Accessreviewscheduledefinition Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewscheduledefinition-delete.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Delete an [accessReviewScheduleDefinition](../resources/accessreviewscheduledefinition.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).
v1.0 Accessreviewscheduledefinition Filterbycurrentuser https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewscheduledefinition-filterbycurrentuser.md
Namespace: microsoft.graph
Returns [accessReviewScheduleDefinition](../resources/accessreviewscheduledefinition.md) objects where the calling user is a reviewer on one or more [accessReviewInstance](../resources/accessreviewinstance.md) objects.
->[!NOTE]
->The default page size for this API is 100 accessReviewScheduleDefinition objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
GET /identityGovernance/accessReviews/definitions/filterByCurrentUser(on='review
## Optional query parameters This method supports `$select`, `$filter`, `$orderBy`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewScheduleDefinition** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers |Name|Description| |:|:|
v1.0 Accessreviewscheduledefinition List Instances https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewscheduledefinition-list-instances.md
Namespace: microsoft.graph
Retrieve the [accessReviewInstance](../resources/accessreviewinstance.md) objects for a specific [accessReviewScheduleDefinition](../resources/accessreviewscheduledefinition.md). A list of zero or more **accessReviewInstance** objects are returned, including all of their nested properties. Returned objects do not include associated accessReviewInstanceDecisionItems. To retrieve the decisions on the instance, use [List accessReviewInstanceDecisionItem](accessreviewinstance-list-decisions.md).
->[!NOTE]
->The default page size for this API is 100 accessReviewInstance objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
GET /identityGovernance/accessReviews/definitions/{definition-id}/instances
## Optional query parameters This method supports `$select`, `$filter`, `$orderBy`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewInstance** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers None.
v1.0 Accessreviewset List Definitions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewset-list-definitions.md
Namespace: microsoft.graph
Retrieve the [accessReviewScheduleDefinition](../resources/accessreviewscheduledefinition.md) objects. A list of zero or more accessReviewScheduleDefinition objects are returned, including all of their nested properties, for each access review series created. This does not include the associated accessReviewInstance objects.
->[!NOTE]
->The default page size for this API is 100 accessReviewScheduleDefinition objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
GET /identityGovernance/accessReviews/definitions
## Optional query parameters This method supports the `$select`, `$top`, `$skip`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewScheduleDefinition** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ### Use the $filter query parameter The `$filter` query parameter with the `contains` operator is supported on the **scope** property of accessReviewScheduleDefinition. Use the following format for the request:
v1.0 Accessreviewset List Historydefinitions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewset-list-historydefinitions.md
Namespace: microsoft.graph
Retrieve the [accessReviewHistoryDefinition](../resources/accessreviewhistorydefinition.md) objects created in the last 30 days, including all nested properties.
->[!NOTE]
->The default page size for this API is 100 **accessReviewHistoryDefinitions** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
->
->If no query parameters are provided and there are more than 100 results, Microsoft Graph will automatically paginate results at 100 results per page.
- ## 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).
GET /identityGovernance/accessReviews/historyDefinitions
This method supports the `$top`, `$filter`, `$expand`, and `$skip` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). Including `?$expand=instances` will return the [accessReviewHistoryDefinitions](../resources/accessreviewhistorydefinition.md) objects along with their associated instances.
+The default page size for this API is 100 **accessReviewHistoryDefinitions** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
+ ## Request headers |Name|Description|
v1.0 Accessreviewset Post Definitions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewset-post-definitions.md
The following example creates an access review with the following settings:
#### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_accessReviewScheduleDefinition_group_multiStage"
Content-type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ #### Response >**Note:** The response object shown here might be shortened for readability.
v1.0 Accessreviewstage Filterbycurrentuser https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewstage-filterbycurrentuser.md
If successful, this function returns a `200 OK` response code and a [accessRevie
## Examples ### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "accessreviewstage_filterbycurrentuser"
If successful, this function returns a `200 OK` response code and a [accessRevie
``` http GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/08531375-eff6-4e21-b1a8-de0eb37ec913/instances/86889534-b102-4226-bfce-0c2aeee845df/stages/filterByCurrentUser(on='reviewer') ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response
v1.0 Accessreviewstage Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewstage-get.md
If successful, this method returns a `200 OK` response code and an [accessReview
## Examples ### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_accessreviewstage"
If successful, this method returns a `200 OK` response code and an [accessReview
``` http GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/6af553ce-104d-4842-ab5f-67d7b556e9dd/instances/9ea56d3c-8746-4cdf-9ccc-c7fe1a267c24/stages/839ecbd4-ba5d-4d32-8249-e734aac47adf ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response
v1.0 Accessreviewstage List Decisions https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewstage-list-decisions.md
Namespace: microsoft.graph
Get the decisions from a stage in a multi-stage access review. The decisions in an [accessReviewStage](../resources/accessReviewStage.md) object are represented by an accessReviewInstanceDecisionItem](../resources/accessreviewinstancedecisionitem.md) object.
->[!NOTE]
->The default page size for this API is 100 accessReviewStage objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
- ## 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).
GET /identityGovernance/accessReviews/definitions/{accessReviewScheduleDefinitio
## Optional query parameters This method supports the `$select`, `$filter`, `$orderBy`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+The default page size for this API is 100 **accessReviewStage** objects. To improve efficiency and avoid timeouts due to large result sets, apply pagination using the `$skip` and `$top` query parameters. For more information, see [Paging Microsoft Graph data in your app](/graph/paging).
++ ## Request headers |Name|Description| |:|:|
If successful, this method returns a `200 OK` response code and a collection of
## Examples ### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_stage_accessreviewinstancedecisionitem"
If successful, this method returns a `200 OK` response code and a collection of
``` http GET https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/16d424f6-0100-4bf1-9ebc-fe009c5e5006/instances/bb14c722-51b8-4962-9bd2-1d96ba773d80/stages/8f0a8999-205b-4c29-a68c-2bee353fd4c5/decisions ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response
v1.0 Accessreviewstage Stop https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewstage-stop.md
If successful, this action returns a `204 No Content` response code.
## Examples ### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "accessreviewstage_stop"
If successful, this action returns a `204 No Content` response code.
``` http POST https://graph.microsoft.com/beta/identityGovernance/accessReviews/definitions/2b83cc42-09db-46f6-8c6e-16fec466a82d/instances/61a617dd-238f-4037-8fa5-d800e515f5bc/stages/5d431f4b-56f2-4a50-938b-fb1e4e2c91b9/stop ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response
v1.0 Accessreviewstage Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewstage-update.md
Attempting to remove existing **fallbackReviewers** returns a `409 Conflict` res
## Examples ### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_accessreviewstage"
Content-Type: application/json
] } ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++ ### Response
v1.0 Administrativeunit Delete Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-delete-members.md
Title: "Remove a member"
-description: "Use this API to remove a member (user or group) from an administrative unit."
+description: "Use this API to remove a member (user, group, or device) from an administrative unit."
ms.localizationpriority: medium ms.prod: "directory-management"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Use this API to remove a member (user or group) from an administrative unit.
+Use this API to remove a member (user, group, or device) from an administrative unit.
## 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).
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AdministrativeUnit.ReadWrite.All |
Do not supply a request body for this method.
If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example
-##### Request
-Here is an example of the request. In the example below, id1 represents the identifier for the target administrative unit, and id2 represents the unique identifier for the member user or group to be removed from the targetted administrative unit.
+### Request
+The following is an example of the request. In the example below, `{id1}` represents the identifier for the target administrative unit, and `{id2}` represents the unique identifier for the member user, group, or device to be removed from the target administrative unit.
-```http
+```msgraph-interactive
DELETE https://graph.microsoft.com/beta/administrativeUnits/{id1}/members/{id2}/$ref ```
-##### Response
-Here is an example of the response.
+### Response
+The following is an example of the response.
```http HTTP/1.1 204 No Content
v1.0 Administrativeunit Delete Scopedrolemembers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-delete-scopedrolemembers.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.ReadWrite.Directory, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.ReadWrite.Directory |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.ReadWrite.Directory |
v1.0 Administrativeunit Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-delete.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AdministrativeUnit.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } --> ```http DELETE /administrativeUnits/{id}- ``` ## Request headers | Name | Description|
Do not supply a request body for this method.
If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example
-##### Request
+### Request
Here is an example of the request. # [HTTP](#tab/http)
DELETE https://graph.microsoft.com/beta/administrativeUnits/{id}
-##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+### Response
+Here is an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true
v1.0 Administrativeunit Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-delta.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |administrativeunit | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
v1.0 Administrativeunit Get Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-get-members.md
Title: "Get a member"
-description: "Use this API to get a specific member (user or group) in an administrative unit."
+description: "Use this API to get a specific member (user, group, or device) in an administrative unit."
ms.localizationpriority: medium ms.prod: "directory-management"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Use this API to get a specific member (user or group) in an administrative unit.
+Use this API to get a specific member (user, group, or device) in an administrative unit.
## 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).
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
Do not supply a request body for this method.
## Response
-If successful, this method returns a `200 OK` response code and a [user](../resources/user.md) or [group](../resources/group.md) object in the response body.
+If successful, this method returns a `200 OK` response code and a [user](../resources/user.md), [group](../resources/group.md), or [device](../resources/device.md) object in the response body.
## Example
-##### Request
-Here is an example of the request.
+### Request
+The following is an example of the request.
-```http
+```msgraph-interactive
GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members/{id} ```
-##### Response
-Here is an example of the respone. Note: The response object shown here might be shortened for readability.
+### 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
v1.0 Administrativeunit Get Scopedrolemembers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-get-scopedrolemembers.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Administrativeunit Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } --> ```http GET /administrativeUnits/{id}
+GET /directory/administrativeUnits/{id}
``` ## Optional query parameters This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response.
Do not supply a request body for this method.
If successful, this method returns a `200 OK` response code and [administrativeUnit](../resources/administrativeunit.md) object in the response body. ## Example
-##### Request
+### Request
Here is an example of the request. # [HTTP](#tab/http)
Here is an example of the request.
"name": "get_administrativeunit" }--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/administrativeUnits/{id}
+GET https://graph.microsoft.com/beta/administrativeUnits/4d7ea995-bc0f-45c0-8c3e-132e93bf95f8
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-administrativeunit-csharp-snippets.md)]
GET https://graph.microsoft.com/beta/administrativeUnits/{id}
-##### Response
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+### Response
+Here is an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
HTTP/1.1 200 OK
Content-type: application/json {
- "displayName": "displayName-value",
- "description": "description-value",
- "visibility": "visibility-value",
- "id": "id-value"
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#administrativeUnits/$entity",
+ "id": "4d7ea995-bc0f-45c0-8c3e-132e93bf95f8",
+ "deletedDateTime": null,
+ "displayName": "Seattle District Technical Schools",
+ "description": "Seattle district technical schools administration",
+ "isMemberManagementRestricted": null,
+ "visibility": "HiddenMembership",
+ "membershipRule": null,
+ "membershipType": null,
+ "membershipRuleProcessingState": null
} ```
v1.0 Administrativeunit List Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-list-members.md
Title: "List members"
-description: "Use this API to get the members list (user and group) in an administrative unit."
+description: "Use this API to get the members list (users, groups, and devices) in an administrative unit."
ms.localizationpriority: medium ms.prod: "directory-management"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Use this API to get the members list (user and group) in an administrative unit.
+Use this API to get the members list (users, groups, and devices) in an administrative unit.
## 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) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
GET /administrativeUnits/{id}/members GET /administrativeUnits/{id}/members/$ref ```
+## Optional query parameters
+This method (when used without `$ref`) supports the [OData query parameters](/graph/query-parameters) to help customize the response, including `$search`, `$count`, and `$filter`. OData cast is also enabled, for example, you can cast to get just the users that are a member of the administrative unit.
+
+`$search` is supported on the **displayName** and **description** properties only. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
+ ## Request headers
-| Name |Description|
+| Header |Value|
|:-|:-| | Authorization | Bearer {token}. Required. |
+| ConsistencyLevel | eventual. This header and `$count` are required when using `$search`, or in specific usage of `$filter`. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). |
## 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 [user](../resources/user.md) and/or [group](../resources/group.md) objects in the response body. Instead, if you put `$ref` at the end of the request, the response will contain a collection of `@odata.id` links/URLs to the members.
+If successful, this method returns a `200 OK` response code and a collection of [user](../resources/user.md), [group](../resources/group.md), or [device](../resources/device.md) objects in the response body. Adding `$ref` at the end of the request returns a collection of only `@odata.id` URLs of the members.
## Examples
-##### List member objects
+### Example 1: List member objects
+
+#### Request
The following request will list the members of the administrative unit, returning a collection of users and/or groups. ```http GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members ```
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+#### 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
} ```
-##### List member references
+### Example 2: List member references
+
+#### Request
+ The following request will list the member references of the administrative unit, returning a collection of `@odata.id` references to the members.+ ``` GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members/$ref ```
-Here is an example of the response. Note: The response object shown here might be shortened for readability.
+
+#### 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
v1.0 Administrativeunit List Scopedrolemembers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-list-scopedrolemembers.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Administrativeunit Post Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-post-members.md
Title: "Add a member"
-description: "Use this API to add a member (user or group) to an administrative unit."
+description: "Use this API to add a member (user, group, or device) to an administrative unit."
ms.localizationpriority: medium ms.prod: "directory-management"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Use this API to add a member (user or group) to an administrative unit or to create a new group within an administrative unit. All [group types](/graph/api/resources/groups-overview) can be created within an administrative unit.
+Use this API to add a member (user, group, or device) to an administrative unit or to create a new group within an administrative unit. All [group types](/graph/api/resources/groups-overview) can be created within an administrative unit.
-**NOTE:** Currently it's only possible to add one member at a time to an administrative unit.`
+**Note:** Currently, it's only possible to add one member at a time to an administrative unit.`
## 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).
One of the following permissions is required to call this API. To learn more, in
### Permissions to add an existing user, group, or device |Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AdministrativeUnit.ReadWrite.All | ### Permissions to create a new group |Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Group.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Group.Create, Group.ReadWrite.All, Directory.ReadWrite.All |
POST /administrativeUnits/{id}/members
| Authorization | Bearer {token}. Required. | | Content-type | application/json. Required. |
-## Request body
### Adding an existing user or group
-In the request body, provide the `id` of a [user](../resources/user.md), [group](../resources/group.md), or [directoryObject](../resources/directoryobject.md) to be added.
+In the request body, provide the `id` of a [user](../resources/user.md), [group](../resources/group.md), [device](../resources/device.md), or [directoryObject](../resources/directoryobject.md) to be added.
### Creating a new group The following table shows the properties of the [group](../resources/group.md) resource to specify when you create a group in the administrative unit.
Content-type: application/json
-In the request body, provide the `id` of the [user](../resources/user.md) or [group](../resources/group.md) object you want to add.
+In the request body, provide the `id` of the [user](../resources/user.md), [group](../resources/group.md), or [device](../resources/device.md) object you want to add.
#### Response+ The following is an example of the response. <!-- {
v1.0 Administrativeunit Post Scopedrolemembers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-post-scopedrolemembers.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.ReadWrite.Directory, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.ReadWrite.Directory |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.ReadWrite.Directory |
v1.0 Administrativeunit Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/administrativeunit-update.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AdministrativeUnit.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AdministrativeUnit.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } --> ```http PATCH /administrativeUnits/{id}
+PATCH /directory/administrativeUnits/{id}
``` ## Request headers
In the request body, supply the values for relevant fields that should be update
| Property | Type |Description| |:|:--|:-|
-|description|string|Description for the administrative unit.|
-|displayName|string|Display name for the administrative unit.|
-|visibility|string|Visibility for the administrative unit. If not set then the default is "public". Can be set to "HiddenMembership", which hides the membership from non-members.|
+|description|String|Description for the administrative unit.|
+|displayName|String|Display name for the administrative unit.|
-Since the **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), you can use the `PATCH` operation to
-add, update, or delete your own app-specific data in custom properties of an extension in an existing **administrativeUnit** instance.
+Since the **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), you can use the `PATCH` operation to add, update, or delete your own app-specific data in custom properties of an extension in an existing **administrativeUnit** instance.
## Response
If successful, this method returns a `204 No Content` response code.
## Example
-##### Request
+### Request
# [HTTP](#tab/http)
If successful, this method returns a `204 No Content` response code.
"name": "update_administrativeunit" }--> ```http
-PATCH https://graph.microsoft.com/beta/administrativeUnits/{id}
+PATCH https://graph.microsoft.com/beta/administrativeUnits/4d7ea995-bc0f-45c0-8c3e-132e93bf95f8
Content-type: application/json {
- "displayName": "displayName-value",
- "description": "description-value",
- "visibility": "visibility-value"
+ "displayName": "Greater Seattle District Technical Schools"
} ``` # [C#](#tab/csharp)
Content-type: application/json
-##### Response
+### Response
<!-- { "blockType": "response"
v1.0 Agreement Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/agreement-delete.md
Do not supply a request body for this method.
## Response
-If successful, this method returns a `204, No Content` response code. It does not return anything in the response body.
+If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.
## Example
-##### Request
+### Request
# [HTTP](#tab/http)
If successful, this method returns a `204, No Content` response code. It does no
"name": "delete_agreement" }--> ```http
-DELETE https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/{id}
+DELETE https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/0ec9f6a6-159d-4dd8-a563-1f0b5935e80b
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/delete-agreement-csharp-snippets.md)]
DELETE https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements
[!INCLUDE [sample-code](../includes/snippets/go/delete-agreement-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+
-##### Response
->**Note:** The response object shown here might be shortened for readability.
+### Response
<!-- { "blockType": "response", "truncated": true
v1.0 Agreement Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/agreement-get.md
When calling on behalf of a user, the user needs to belong to one of the followi
```http GET /identityGovernance/termsOfUse/agreements/{id} ```
-<!--
+ ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
>
+This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response.
## Request headers | Name | Type | Description |
This method supports the [OData Query Parameters](/graph/query-parameters) to he
Do not supply a request body for this method. ## Response If successful, this method returns a `200 OK` response code and [agreement](../resources/agreement.md) object in the response body.
-## Example
-##### Request
+## Examples
+
+### Example 1: Retrieve an agreement
+
+#### Request
# [HTTP](#tab/http) <!-- {
If successful, this method returns a `200 OK` response code and [agreement](../r
"name": "get_agreement" }--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/{id}?$expand=files
+GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/0ec9f6a6-159d-4dd8-a563-1f0b5935e80b
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-agreement-csharp-snippets.md)]
GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/{i
[!INCLUDE [sample-code](../includes/snippets/go/get-agreement-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+
-##### Response
+#### Response
>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response",
HTTP/1.1 200 OK
Content-type: application/json {
- "displayName": "MSGraph Sample",
- "isViewingBeforeAcceptanceRequired": true,
- "id": "id-value",
- "files": [
- {
- "id": "id-value",
- "language": "en",
- "fileName": "TOU.pdf",
- "isDefault": true
- }
- ]
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements/$entity",
+ "id": "0ec9f6a6-159d-4dd8-a563-1f0b5935e80b",
+ "displayName": "All users terms of use",
+ "termsExpiration": null,
+ "userReacceptRequiredFrequency": "P90D",
+ "isViewingBeforeAcceptanceRequired": false,
+ "isPerDeviceAcceptanceRequired": false
+}
+```
++
+### Example 2: Retrieve an agreement and its related files
+
+#### Request
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_agreement_files"
+}-->
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/093b947f-8363-4979-a47d-4c52b33ee1be?$expand=files
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+#### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.agreement"
+} -->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements(files())/$entity",
+ "id": "0ec9f6a6-159d-4dd8-a563-1f0b5935e80b",
+ "displayName": "All users terms of use",
+ "termsExpiration": null,
+ "userReacceptRequiredFrequency": "P90D",
+ "isViewingBeforeAcceptanceRequired": false,
+ "isPerDeviceAcceptanceRequired": false,
+ "files@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/termsOfUse/agreements('0ec9f6a6-159d-4dd8-a563-1f0b5935e80b')/files",
+ "files": [
+ {
+ "id": "681b73a7-e9ae-4f2d-aca5-9e857599cd15",
+ "fileName": "ToU.pdf",
+ "displayName": "Contoso Terms of Use",
+ "language": "en-GB",
+ "isDefault": true,
+ "isMajorVersion": false,
+ "createdDateTime": "2022-03-02T14:11:32.885186Z",
+ "fileData": null
+ }
+ ]
} ```
v1.0 Agreement List Acceptances https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/agreement-list-acceptances.md
+
+ Title: "List acceptances"
+description: "Get the details about the acceptance records for a specific agreement."
+
+ms.localizationpriority: medium
++
+# List acceptances
+Namespace: microsoft.graph
++
+Get the details about the acceptance records for a specific agreement.
+
+## 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) | AgreementAcceptance.Read, AgreementAcceptance.Read.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/termsOfUse/agreements/{agreementsId}/acceptances
+```
+
+## Optional query parameters
+This method the `$select` and `$filter` 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 [agreementAcceptance](../resources/agreementacceptance.md) objects in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "list_agreementacceptance"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/acceptances
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.agreementAcceptance)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreementAcceptances",
+ "value": [
+ {
+ "id": "94410bbf-3d3e-4683-8149-f034e55c39dd_d4bb5206-77bf-4d5c-96b4-cf7b0ed3be98",
+ "agreementId": "94410bbf-3d3e-4683-8149-f034e55c39dd",
+ "userId": "d4bb5206-77bf-4d5c-96b4-cf7b0ed3be98",
+ "deviceId": "00000000-0000-0000-0000-000000000000",
+ "deviceDisplayName": null,
+ "deviceOSType": null,
+ "deviceOSVersion": null,
+ "agreementFileId": "08033369-8972-42a3-8533-90bbd2757a01",
+ "userDisplayName": "Megan Bowen",
+ "userPrincipalName": "MeganB@Contoso.com",
+ "userEmail": "MeganB@Contoso.com",
+ "recordedDateTime": "2022-03-04T14:11:22.6658376Z",
+ "expirationDateTime": null,
+ "state": "accepted"
+ }
+ ]
+}
+```
+
v1.0 Agreement List Files https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/agreement-list-files.md
+
+ Title: "List files (localized agreement files)"
+description: "Retrieve all localized files related to an agreement."
+ms.localizationpriority: medium
+++
+# List files (localized agreement files)
+Namespace: microsoft.graph
++
+Retrieve all localized files related to an agreement.
+
+## 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) | Agreement.Read.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | Not supported. |
++
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /agreements/{agreementsId}?$expand=files
+```
+
+## 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 [agreementFileLocalization](../resources/agreementfilelocalization.md) objects in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "list_agreementfilelocalization"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd?$expand=files
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.agreementFileLocalization"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements(files())/$entity",
+ "id": "94410bbf-3d3e-4683-8149-f034e55c39dd",
+ "displayName": "Contoso ToU for guest users",
+ "termsExpiration": null,
+ "userReacceptRequiredFrequency": null,
+ "isViewingBeforeAcceptanceRequired": true,
+ "isPerDeviceAcceptanceRequired": false,
+ "files@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/termsOfUse/agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/files",
+ "files": [
+ {
+ "id": "08033369-8972-42a3-8533-90bbd2757a01",
+ "fileName": "TOU.pdf",
+ "displayName": "Contoso ToU for guest users",
+ "language": "en",
+ "isDefault": true,
+ "isMajorVersion": false,
+ "createdDateTime": "2022-03-04T13:14:13.9361722Z",
+ "fileData": null
+ },
+ {
+ "id": "90d1723c-52c1-40e3-a51a-da99a82c0327",
+ "fileName": "Contoso ToU for guest users (French)",
+ "displayName": "Contoso ToU for guest users (French)",
+ "language": "fr-FR",
+ "isDefault": false,
+ "isMajorVersion": false,
+ "createdDateTime": "2022-03-04T14:38:22.8292386Z",
+ "fileData": null
+ }
+ ]
+}
+```
+
v1.0 Agreement Post Files https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/agreement-post-files.md
+
+ Title: "Create agreementFileLocalization"
+description: "Create a new localized agreement file."
+
+ms.localizationpriority: medium
++
+# Create agreementFileLocalization
+Namespace: microsoft.graph
++
+Create a new localized agreement file.
+
+## 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) | Agreement.ReadWrite.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /agreements/{agreementsId}/files
+```
+
+## 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 [agreementFileLocalization](../resources/agreementfilelocalization.md) object.
+
+You can specify the following properties when creating an **agreementFileLocalization**.
+
+|Property|Type|Description|
+|:|:|:|
+|displayName|String|Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.|
+|fileData|[agreementFileData](../resources/agreementfiledata.md)|Data that represents the terms of use PDF document.|
+|fileName|String|Name of the agreement file (for example, TOU.pdf). |
+|isDefault|Boolean|If none of the languages matches the client preference, indicates whether this is the default agreement file . If none of the files are marked as default, the first one is treated as the default. Read-only.|
+|isMajorVersion|Boolean|Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.|
+|language|String|The language of the agreement file in the format "languagecode2-country/regioncode2". "languagecode2" is a lowercase two-letter code derived from ISO 639-1, while "country/regioncode2" is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is `en-US`.|
+++
+## Response
+
+If successful, this method returns a `200 OK` response code and an [agreementFileLocalization](../resources/agreementfilelocalization.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "ignored",
+ "name": "create_agreementfilelocalization_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/files
+Content-Type: application/json
+
+{
+ "fileName": "Contoso ToU for guest users (French)",
+ "language": "fr-FR",
+ "isDefault": false,
+ "isMajorVersion": false,
+ "displayName": "Contoso ToU for guest users (French)",
+ "fileData": {
+ "data": "JVBERi0xLjUKJb/3ov4KNCAwIG9iago8PCAvTGluZWFyaX//truncated-binary-data"
+ }
+}
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.agreementFileLocalization"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/termsOfUse/agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/files/$entity",
+ "id": "90d1723c-52c1-40e3-a51a-da99a82c0327",
+ "fileName": "Contoso ToU for guest users (French)",
+ "displayName": "Contoso ToU for guest users (French)",
+ "language": "fr-FR",
+ "isDefault": false,
+ "isMajorVersion": false,
+ "createdDateTime": "2022-03-04T14:38:22.8292386Z",
+ "fileData": {
+ "data": "JVBERi0xLjUKJb/"
+ }
+}
+```
+
v1.0 Agreement Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/agreement-update.md
In the request body, supply the values for relevant fields that should be update
|isViewingBeforeAcceptanceRequired|Boolean|Whether the user has to expand and view the agreement before accepting.| ## Response
-If successful, this method returns a `200 OK` response code and an updated [agreement](../resources/agreement.md) object in the response body.
+If successful, this method returns a `204 No Content` response code.
## Example ##### Request
If successful, this method returns a `200 OK` response code and an updated [agre
"blockType": "request", "name": "update_agreement" }-->
-```http
-PATCH https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/{id}
+```msgraph-interactive
+PATCH https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/0ec9f6a6-159d-4dd8-a563-1f0b5935e80b
Content-type: application/json {
- "displayName": "displayName-value",
- "isViewingBeforeAcceptanceRequired": true
+ "displayName": "All Contoso volunteers - Terms of use",
+ "isViewingBeforeAcceptanceRequired": true
} ``` # [C#](#tab/csharp)
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/go/update-agreement-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [PowerShell](#tab/powershell)
+ ##### Response
->**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.agreement"
+ "truncated": true
} --> ```http
-HTTP/1.1 200 OK
-Content-type: application/json
-
-{
- "displayName": "displayName-value",
- "isViewingBeforeAcceptanceRequired": true,
- "id": "id-value"
-}
+HTTP/1.1 204 No Content
``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
v1.0 Agreementfile Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/agreementfile-get.md
+
+ Title: "Get agreementFile"
+description: "Retrieve the details of the default file for an agreement, including the language and version information. "
+
+ms.localizationpriority: medium
++
+# Get agreementFile
+Namespace: microsoft.graph
++
+Retrieve the details of the default file for an agreement, including the language and version information. The file information is specified through the [agreementFile](../resources/agreementfile.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)|Agreement.Read.All, Agreement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /agreements/{agreementsId}/file
+```
+
+## 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 [agreementFile](../resources/agreementfile.md) objects in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_agreementfile"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements/94410bbf-3d3e-4683-8149-f034e55c39dd/file
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.agreementFile"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/termsOfUse/agreements('94410bbf-3d3e-4683-8149-f034e55c39dd')/file/$entity",
+ "@odata.type": "#microsoft.graph.agreementFileLocalization",
+ "id": "08033369-8972-42a3-8533-90bbd2757a01",
+ "fileName": "TOU.pdf",
+ "displayName": "Contoso ToU for guest users",
+ "language": "en",
+ "isDefault": true,
+ "isMajorVersion": false,
+ "createdDateTime": "2022-03-04T13:14:13.9361722Z",
+ "fileData": null
+}
+```
+
v1.0 Application Addpassword https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-addpassword.md
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |:|:--|
-| Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Application.ReadWrite.All | | Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
v1.0 Application Delete Owners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-delete-owners.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
v1.0 Application Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-delete.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Application.ReadWrite.All | |Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
v1.0 Application Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-delta.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
v1.0 Application Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Application.Read.All, Application.ReadWrite.All | |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
Content-type: application/json
"enableIdTokenIssuance": false, "enableAccessTokenIssuance": false }
- }
+ },
+ "windows": null
} ```
v1.0 Application List Extensionproperty https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-list-extensionproperty.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All|
|Delegated (personal Microsoft account) | Application.Read.All, Application.ReadWrite.All | |Application | Application.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
The following is an example of the request.
}--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/applications/{id}/extensionProperties
+GET https://graph.microsoft.com/beta/applications/fd918e4b-c821-4efb-b50a-5eddd23afc6f/extensionProperties
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-extensionproperties-csharp-snippets.md)]
HTTP/1.1 200 OK
Content-type: application/json {
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('fd918e4b-c821-4efb-b50a-5eddd23afc6f')/extensionProperties",
"value": [ {
- "id": "a2c459db-f5dc-4328-ae9b-118e88d04d19",
+ "id": "da38c7b1-133e-4a79-abcd-e2fd586ce621",
"deletedDateTime": null,
- "appDisplayName": "Display name",
- "name": "extension_b3efaf8f68a44275abcff28ef86b2ee3_extensionName",
+ "appDisplayName": "",
+ "name": "extension_25883231668a43a780b25685c3f874bc_jobGroup",
"dataType": "String", "isSyncedFromOnPremises": false, "targetObjects": [
- "Application"
+ "User"
+ ]
+ },
+ {
+ "id": "1f0f15e3-925d-40f0-8fc8-9d3ad135bce0",
+ "deletedDateTime": null,
+ "appDisplayName": "",
+ "name": "extension_25883231668a43a780b25685c3f874bc_cpiminternal_useAccountEnabledForPhone",
+ "dataType": "String",
+ "isSyncedFromOnPremises": false,
+ "targetObjects": [
+ "User"
] } ]
v1.0 Application List Owners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-list-owners.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Application List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-list.md
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |: |:- |
-| Delegated (work or school account) | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Application.Read.All and User.Read, Application.ReadWrite.All and User.Read | | Application | Application.Read.All, Application.ReadWrite.All, Directory.Read.All |
The following is an example of the request. This request requires the **Consiste
>**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
-# [HTTP](#tab/http)
<!-- { "blockType": "request",
- "name": "get_a_count"
+ "name": "list_applications_startswith"
}--> ```msgraph-interactive GET https://graph.microsoft.com/beta/applications?$filter=startswith(displayName, 'a')&$count=true&$top=1&$orderby=displayName ConsistencyLevel: eventual ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
-- #### Response
v1.0 Application Post Applications https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-applications.md
Namespace: microsoft.graph
Create a new [application](../resources/application.md) object. > [!IMPORTANT]
-> Adding [**passwordCredential**](../resources/passwordcredential.md) when creating applications is not supported. Use the [addPassword](application-addpassword.md) method to add passwords for an application.
+> Adding [**passwordCredential**](../resources/passwordcredential.md) when creating applications is not supported. Use the [addPassword](application-addpassword.md) method to add passwords or secrets for an application.
## 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).
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Application.ReadWrite.All | |Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
Content-type: application/json
"enableIdTokenIssuance": false, "enableAccessTokenIssuance": false }
- }
+ },
+ "windows" : null
} ```
v1.0 Application Post Calls https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-calls.md
Title: "Create call" description: "Create a new call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Application Post Extensionproperty https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-extensionproperty.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Application.ReadWrite.All | |Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
The following is an example of the request.
}--> ```http
-POST https://graph.microsoft.com/beta/applications/{id}/extensionProperties
+POST https://graph.microsoft.com/beta/applications/fd918e4b-c821-4efb-b50a-5eddd23afc6f/extensionProperties
Content-type: application/json {
- "name": "extensionName",
- "dataType": "string",
+ "name": "jobGroup",
+ "dataType": "String",
"targetObjects": [
- "Application"
+ "User"
] } ```
HTTP/1.1 201 Created
Content-type: application/json {
- "id": "a2c459db-f5dc-4328-ae9b-118e88d04d19",
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('fd918e4b-c821-4efb-b50a-5eddd23afc6f')/extensionProperties/$entity",
+ "id": "da38c7b1-133e-4a79-abcd-e2fd586ce621",
"deletedDateTime": null,
- "appDisplayName": "Display name",
- "name": "extension_b3efaf8f68a44275abcff28ef86b2ee3_extensionName",
+ "appDisplayName": "b2c-extensions-app. Do not modify. Used by AADB2C for storing user data.",
"dataType": "String", "isSyncedFromOnPremises": false,
+ "name": "extension_25883231668a43a780b25685c3f874bc_jobGroup",
"targetObjects": [
- "Application"
+ "User"
] } ```
v1.0 Application Post Owners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-owners.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All and Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All and Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.ReadWrite.OwnedBy and Directory.Read.All, Application.ReadWrite.All and Directory.Read.All, Directory.ReadWrite.All |
v1.0 Application Removekey https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-removekey.md
In the request body, provide the following required properties.
| Property | Type | Description| |:-|:--|:--|
-| keyId | GUID | The unique identifier for the password.|
+| keyId | Guid | The unique identifier for the password.|
| proof | String | A self-signed JWT token used as a proof of possession of the existing keys. This JWT token must be signed using the private key of one of the application's existing valid certificates. The token should contain the following claims:<ul><li>`aud` - Audience needs to be `00000002-0000-0000-c000-000000000000`.</li><li>`iss` - Issuer needs to be the __id__ of the application that is making the call.</li><li>`nbf` - Not before time.</li><li>`exp` - Expiration time should be `nbf` + 10 mins.</li></ul><br>For steps to generate this proof of possession token, see [Generating proof of possession tokens for rolling keys](/graph/application-rollkey-prooftoken).| ## Response
v1.0 Application Removepassword https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-removepassword.md
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |:|:--|
-| Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Application.ReadWrite.All | | Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
POST /applications/{id}/removePassword
| Property | Type | Description| |:-|:--|:--|
-| keyId | GUID | The unique identifier for the password. Required. |
+| keyId | Guid | The unique identifier for the password. Required. |
## Response
v1.0 Application Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-update.md
Namespace: microsoft.graph
Update the properties of an [application](../resources/application.md) object. > [!IMPORTANT]
-> Using PATCH to set [**passwordCredential**](../resources/passwordcredential.md) is not supported. Use the [addPassword](./application-addpassword.md) and [removePassword](./application-removepassword.md) methods to update the password for an application.
+> Using PATCH to set [**passwordCredential**](../resources/passwordcredential.md) is not supported. Use the [addPassword](./application-addpassword.md) and [removePassword](./application-removepassword.md) methods to update the password or secret for an application.
## 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).
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Application.ReadWrite.All | |Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
In the request body, supply the values for relevant fields that should be update
| uniqueName | String | The unique identifier that can be assigned to an application as an alternative identifier. Immutable. Read-only. | | web | [webApplication](../resources/webapplication.md) | Specifies settings for a web application. | | spa | [spaApplication](../resources/spaapplication.md) | Specifies settings for a single-page application, including sign out URLs and redirect URIs for authorization codes and access tokens. |
+| windows | [windowsApplication](../resources/windowsapplication.md) | Specifies settings for apps running Microsoft Windows and published in the Microsoft Store or Xbox games store. Includes package SID and redirect URIs for authorization codes and access tokens. |
## Response
v1.0 Attacksimulationroot List Simulationautomations https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attacksimulationroot-list-simulationautomations.md
+
+ Title: "List simulationAutomations"
+description: "Get a list of attack simulation automations for a tenant."
+
+ms.localizationpriority: medium
++
+# List simulationAutomations
+Namespace: microsoft.graph
++
+Get a list of attack simulation automations for a tenant.
+
+## 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) | SecurityEvents.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | SecurityEvents.Read.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/simulationAutomations
+```
+
+## Optional query parameters
+This method supports the `$count`, `$filter`, `$orderby`, `$skip`, `$top`, and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. You can use the `$filter` and `$orderby` query parameters on the **displayName** and **status** properties.
+
+If the result set spans multiple pages, the response body contains an `@odata.nextLink` that you can use to page through the result set.
+
+The following are examples of their use:
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /security/attackSimulation/simulationAutomations?$count=true
+GET /security/attackSimulation/simulationAutomations?$filter={property} eq '{property-value}'
+GET /security/attackSimulation/simulationAutomations?$filter={property} eq '{property-value}'&$top=5
+GET /security/attackSimulation/simulationAutomations?$orderby={property}
+GET /security/attackSimulation/simulationAutomations?$skip={skipCount}
+GET /security/attackSimulation/simulationAutomations?$top=1
+GET /security/attackSimulation/simulationAutomations?$select={property}
+```
+
+## 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 [simulationAutomation](../resources/simulationautomation.md) objects in the response body.
+
+## Examples
+
+The following is an example of a request.
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "list_simulationautomation"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/security/attackSimulation/simulationAutomations
+```
++
+### Response
+
+The following is an example of the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.simulationAutomation)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.simulationAutomation",
+ "id": "fbad62b0-b32d-b6ac-9f48-d84bbea08f96",
+ "displayName": "Reed Flores",
+ "description": "Sample Simulation Automation Description",
+ "status": "running",
+ "createdDateTime": "2022-01-01T01:01:01.01Z",
+ "createdBy": {
+ "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
+ "displayName": "Reed Flores",
+ "email": "reed@contoso.com"
+ },
+ "lastModifiedDateTime": "2022-01-01T01:01:01.01Z",
+ "lastModifiedBy": {
+ "id": "99af58b9-ef1a-412b-a581-cb42fe8c8e21",
+ "displayName": "Reed Flores",
+ "email": "reed@contoso.com"
+ },
+ "lastRunDateTime": "2022-01-01T01:01:01.01Z",
+ "nextRunDateTime": "2022-01-01T01:01:01.01Z"
+ }
+ ]
+}
+```
+
v1.0 Attacksimulationroot List Simulations https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attacksimulationroot-list-simulations.md
Title: "List simulations"
-description: "List attack simulations of a tenant."
+description: "Get a list of attack simulation campaigns for a tenant."
ms.localizationpriority: medium ms.prod: "security"
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-List attack simulations of a tenant.
+Get a list of attack simulation campaigns for a tenant.
## 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).
If successful, this method returns a `200 OK` response code and a collection of
## Examples ### Request-
-# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_simulation"
If successful, this method returns a `200 OK` response code and a collection of
``` http GET https://graph.microsoft.com/beta/security/attackSimulation/simulations ```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
--- ### Response
Content-Type: application/json
}, "launchDateTime": "2021-01-01T02:01:01.01Z", "completionDateTime": "2021-01-07T01:01:01.01Z",
- "includeAllAccountTargets": false,
- "enableRegionTimezoneDelivery": false,
"isAutomated": false,
- "cleanupArtifacts": false,
- "payloadSource": "global",
- "payloadDeliveryPlatform": "email",
- "trainingAssignmentPreference": "manual",
- "trainingContentPreference": "microsoft",
- "trainingDueDateTime": "2021-01-31T01:01:01.01Z"
+ "automationId": "f1b13829-3829-f1b1-2938-b1f12938b1ab",
+ "payloadDeliveryPlatform": "email"
} ] }
v1.0 Attendancerecord List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/attendancerecord-list.md
Content-Type: application/json
"emailAddress": "frederick.cormier@contoso.com", "totalAttendanceInSeconds": 322, "role": "Organizer",
+ "registrantId": null,
"identity": { "id": "dc17674c-81d9-4adb-bfb2-8f6a442e4623", "displayName": "Frederick Cormier",
Content-Type: application/json
"emailAddress": "lisa.adkins@contoso.com", "totalAttendanceInSeconds": 314, "role": "Presenter",
+ "registrantId": null,
"identity": { "id": "57caaef9-5ed0-48d5-8862-e5abfa71b3e9", "displayName": "Lisa Adkins",
v1.0 Authentication List Methods https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/authentication-list-methods.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve a list of [authentication method](../resources/authenticationmethod.md) objects. This API returns only authentication methods supported on this API version. See [Azure AD authentication methods API overview](../resources/authenticationmethods-overview.md) for a list of currently supported methods.
+Retrieve a list of [authenticationMethod](../resources/authenticationmethod.md) objects. This API returns only authentication methods supported on this API version. See [Azure AD authentication methods API overview](../resources/authenticationmethods-overview.md) for a list of currently supported methods.
## Permissions
v1.0 Basetask Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/basetask-get.md
Content-Type: application/json
"createdDateTime": "2021-11-15T13:16:53.0831814Z", "lastModifiedDateTime": "2021-11-15T13:17:24.9876101Z", "id": "AAkALgAAAAAAHYQDEapmEc2byACqAC-EWg0AkOO4xOT--0qFRAqk3TNe0QAAAy35RwAA",
- "body": {
- "content": "",
- "contentType": "text"
- },
+ "textBody": "",
"parentList@odata.context": "https://graph.microsoft.com/betIAAA%3D')/tasks('AAkALgAAAAAAHYQDEapmEc2byACqAC-EWg0AkOO4xOT--0qFRAqk3TNe0QAAAy35RwAA')/microsoft.graph.task/parentList/$entity", "parentList": { "id": "AAMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNiYQAuAAAAAAAboFsPFj7gQpLAt-6oC2JgAQCQ47jE5P--SoVECqTdM17RAAAB4mDIAAA="
v1.0 Basetask Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/basetask-update.md
PATCH /users/{userId|userPrincipalName}/tasks/alltasks/{baseTaskId}
|Property|Type|Description| |:|:|:|
-|body|[itemBody](../resources/itembody.md)|The task body that typically contains information about the task.|
+|textBody|String|The task body in text format that typically contains information about the task.|
|createdDateTime|DateTimeOffset|The date in the specified time zone that the task was finished.| |lastModifiedDateTime|DateTimeOffset|The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header.| |bodyLastModifiedDateTime|DateTimeOffset|The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header.|
PATCH /users/{userId|userPrincipalName}/tasks/alltasks/{baseTaskId}
|recurrence|[patternedRecurrence](../resources/patternedrecurrence.md)|The recurrence pattern for the task.| |displayName|String|A brief description of the task.| |status|taskStatus_v2|Indicates state or progress of the task. The possible values are: `notStarted`, `inProgress`, `completed`, `unknownFutureValue`.|
-|personalProperties|[personalTaskProperties](../resources/personaltaskproperties.md)|Properties that are personal to a user such as reminderDateTime.|
+|viewpoint|[taskViewpoint](../resources/taskviewpoint.md)|Properties that are personal to a user such as reminderDateTime.|
Content-Type: application/json
Content-length: 634 {
- "@odata.type": "#microsoft.graph.baseTask",
- "body": {
- "@odata.type": "microsoft.graph.itemBody"
- },
+ "@odata.type": "#microsoft.graph.task",
+ "textBody": "String",
"bodyLastModifiedDateTime": "String (timestamp)", "completedDateTime": "String (timestamp)", "dueDateTime": {
Content-length: 634
}, "displayName": "String", "status": "String",
- "personalProperties": {
- "@odata.type": "microsoft.graph.personalTaskProperties"
+ "viewpoint": {
+ "@odata.type": "microsoft.graph.taskViewpoint"
} } ```
Content-length: 634
<!-- { "blockType": "response", "truncated": true,
- "@odata.type": "microsoft.graph.baseTask"
+ "@odata.type": "microsoft.graph.task"
} --> ``` http
Content-Type: application/json
"createdDateTime": "2021-11-15T14:38:25.6868632Z", "lastModifiedDateTime": "2021-11-15T15:51:13.3606631Z", "id": "AAkALgAAAAAAHYQDEapmEc2byACqAC-EWg0AkOO4xOT",
- "body": {
- "content": "",
- "contentType": "text"
- },
+ "textBody": "",
"parentList": { "id": "AAMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNiYQAuAAAAAAAboFsPFj7gQpLAt" }
v1.0 Basetasklist List Tasks https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/basetasklist-list-tasks.md
Content-Type: application/json
"createdDateTime": "2021-11-17T06:58:32.4882235Z", "lastModifiedDateTime": "2021-11-17T07:02:49.1697427Z", "id": "AAkALgAAAAAAHYQDEapmEc2byACqAC",
- "body": {
- "content": "",
- "contentType": "text"
- },
+ "textBody": "",
"parentList": { "id": "AQMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNm" }
v1.0 Basetasklist Post Tasks https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/basetasklist-post-tasks.md
You can specify the following properties when creating a **baseTask**.
|Property|Type|Description| |:|:|:|
-|body|[itemBody](../resources/itembody.md)|The task body that typically contains information about the task.|
+|textBody|String|The task body in text format that typically contains information about the task.|
|createdDateTime|DateTimeOffset|The date in the specified time zone that the task was finished.| |lastModifiedDateTime|DateTimeOffset|The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.| |bodyLastModifiedDateTime|DateTimeOffset|The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.|
You can specify the following properties when creating a **baseTask**.
|recurrence|[patternedRecurrence](../resources/patternedrecurrence.md)|The recurrence pattern for the task.| |displayName|String|A brief description of the task.| |status|taskStatus_v2|Indicates the state or progress of the task. The possible values are: `notStarted`, `inProgress`, `completed`, `unknownFutureValue`. Required.|
-|personalProperties|[personalTaskProperties](../resources/personaltaskproperties.md)|Properties that are personal to a user such as reminderDateTime.|
+|viewpoint|[taskViewpoint](../resources/taskviewpoint.md)|Properties that are personal to a user such as reminderDateTime.|
Content-Type: application/json
Content-length: 634 {
- "@odata.type": "#microsoft.graph.baseTask",
- "body": {
- "@odata.type": "microsoft.graph.itemBody"
- },
+ "@odata.type": "#microsoft.graph.task",
+ "textBody": "String",
"bodyLastModifiedDateTime": "String (timestamp)", "completedDateTime": "String (timestamp)", "dueDateTime": {
Content-length: 634
}, "displayName": "String", "status": "String",
- "personalProperties": {
- "@odata.type": "microsoft.graph.personalTaskProperties"
+ "viewpoint": {
+ "@odata.type": "microsoft.graph.taskViewpoint"
} } ```
Content-length: 634
<!-- { "blockType": "response", "truncated": true,
- "@odata.type": "microsoft.graph.baseTask"
+ "@odata.type": "microsoft.graph.task"
} --> ``` http
Content-Type: application/json
"createdDateTime": "2021-11-17T10:11:18.0229364Z", "lastModifiedDateTime": "2021-11-17T10:11:18.19789Z", "id": "AAkALgAAAAAAHYQDEapmEc2byACqAC",
- "body": {
- "content": "",
- "contentType": "text"
- },
+ "textBody": "",
"parentList": { "id": "AQMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNi" }
v1.0 Bitlocker List Recoverykeys https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bitlocker-list-recoverykeys.md
The response might also contain an `odata.nextLink`, which you can use to page t
|Name|Description| |:|:| |Authorization|Bearer {token}. Required.|
+|User-Agent|The identifier for the calling application. This value contains information about the operating system and the browser used. Required.|
|ocp-client-name|The name of the client application performing the API call. This header is used for debugging purposes. Optional.| |ocp-client-version|The version of the client application performing the API call. This header is used for debugging purposes. Optional.|
The following is an example of the request.
--> ``` http GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys
+User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
ocp-client-name: "My Friendly Client" ocp-client-version: "1.2" ```
The following is an example of the request.
--> ``` http GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys?$filter=deviceId eq '1ab40ab2-32a8-4b00-b6b5-ba724e407de9'
+User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
ocp-client-name: "My Friendly Client" ocp-client-version: "1.2" ```
v1.0 Bitlockerrecoverykey Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bitlockerrecoverykey-get.md
To get the specified BitLocker key without returning the **key** property:
} --> ``` http
-GET /informationProtection/bitlocker/recoveryKeys/'{bitlockeryRecoveryKeyId}'
+GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}
``` To get the specified BitLocker key including its **key** property:
To get the specified BitLocker key including its **key** property:
} --> ``` http
-GET /informationProtection/bitlocker/recoveryKeys/'{bitlockeryRecoveryKeyId}'?$select=key
+GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}?$select=key
``` ## Optional query parameters
This method supports the `$select` OData query parameter to return the **key** p
|Name|Description| |:|:| |Authorization|Bearer {token}. Required.|
+|User-Agent|The identifier for the calling application. This value contains information about the operating system and the browser used. Required.|
|ocp-client-name|The name of the client application performing the API call. This header is used for debugging purposes. Optional.| |ocp-client-version|The version of the client application performing the API call. This header is used for debugging purposes. Optional.| + ## Request body Do not supply a request body for this method.
The following is an example of the request.
--> ``` http GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4
+User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
ocp-client-name: "My Friendly Client" ocp-client-version: "1.2" ```
The following is an example of the request.
--> ``` http GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4?$select=key
+User-Agent: "Dsreg/10.0 (Windows 10.0.19043.1466)"
+ocp-client-name: "My Friendly Client"
+ocp-client-version: "1.2"
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-bitlockerrecoverykey-4-csharp-snippets.md)]
v1.0 Bookingappointment Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bookingappointment-delete.md
One of the following permissions is required to call this API. To learn more, in
<!-- { "blockType": "ignored" } --> ```http DELETE /bookingBusinesses/{id}/appointments/{id}- ``` ## Request headers | Name | Description|
Do not supply a request body for this method.
If successful, this method returns `204, No Content` response code. It does not return anything in the response body. ## Example
-##### Request
-The following is an example of the request.
+### Request
+The following is an example of a request.
# [HTTP](#tab/http) <!-- {
DELETE https://graph.microsoft.com/beta/bookingBusinesses/Contosolunchdelivery@c
-##### Response
-The following is an example of the response. Note: The response object shown here might be shortened for readability.
+### Response
+The following is an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true
v1.0 Bookingappointment Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bookingappointment-update.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Update the properties of a [bookingAppointment](../resources/bookingappointment.md) object in the specified [bookingBusiness](../resources/bookingbusiness.md).+ ## 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) |
One of the following permissions is required to call this API. To learn more, in
```http PATCH /bookingBusinesses/{id}/appointments/{id} ```+ ## Optional request headers+ | Name | Description| |:--|:--| | Authorization | Bearer {code}. Required.| ## Request body
-In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
+ | Property | Type |Description| |:|:--|:-|
In the request body, supply the values for relevant fields that should be update
|invoiceUrl|String|The URL of the invoice in Microsoft Bookings.| |filledAttendeesCount|Int32|The current number of customers in the appointment. Required.| |isLocationOnline|Boolean|True indicates that the appointment will be held online. Default value is false.|
-|maximumAttendeesCount|Int32|The maximum number of customers allowed in the appointment. Required.|
+|maximumAttendeesCount|Int32|The maximum number of customers allowed in the appointment. Required. |
|optOutOfCustomerEmail|Boolean|True indicates that the [bookingCustomer](../resources/bookingcustomer.md) for this appointment does not wish to receive a confirmation for this appointment.| |postBuffer|Duration|The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | |preBuffer|Duration|The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.|
In the request body, supply the values for relevant fields that should be update
|staffMemberIds|String collection|The ID of each [bookingStaffMember](../resources/bookingstaffmember.md) who is scheduled in this appointment.| |start|[dateTimeTimeZone](../resources/datetimetimezone.md)|The date, time, and time zone that the appointment begins.|
+> [!NOTE]
+> If the maximum number of customers (**maximumAttedeesCount**) allowed in the [service](../resources/bookingservice.md) is greater than 1:
+> - Make sure that the customers exist in the Booking Calendar. If they donΓÇÖt, create using the [Create bookingCustomer](bookingbusiness-post-customers.md) operation.
+> - Pass valid customer IDs when you create or update the appointment. If the customer ID is not valid, that customer won't be included in the appointment object.
## Response+ If successful, this method returns a `204, No Content` response code. It does not return anything in the response body.+ ## Example+ ### Request+ The following example changes the date of service by a day and updates the invoice date. # [HTTP](#tab/http)
v1.0 Bookingbusiness Post Appointments https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bookingbusiness-post-appointments.md
One of the following permissions is required to call this API. To learn more, in
POST /bookingBusinesses/{id}/appointments ```+ ## Request headers+ | Name | Description| |:|:-| | Authorization | Bearer {code}. Required.| ## Request body+ In the request body, supply a JSON representation of [bookingAppointment](../resources/bookingappointment.md) object.
+If the maximum number of customers (**maximumAttedeesCount**) allowed in the [service](../resources/bookingservice.md) is greater than 1:
+
+- Make sure that the customers exist in the Booking Calendar. If they donΓÇÖt, create using the [Create bookingCustomer](bookingbusiness-post-customers.md) operation.
+- Pass valid customer IDs when you create or update the appointment. If the customer ID is not valid, that customer won't be included in the appointment object.
## Response+ If successful, this method returns a `201 Created` response code and [bookingAppointment](../resources/bookingappointment.md) object in the response body. ## Example+ ### Request The following is an example of the request. This appointment does not involve booking specific staff members.
v1.0 Bundle Additem https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bundle-additem.md
- Title: Add item to a bundle
-description: Add item to a bundle of driveItems
+
+ Title: "Add item to a bundle"
+description: "Add item to a bundle of driveItems."
ms.localizationpriority: medium ms.prod: "sharepoint" doc_type: apiPageType
POST /drive/bundles/{bundle-id}/children
| Name | Description | |:- |: |
-| Authorization | Bearer \{token\}. Required. |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required.|
## Request body
-The request body includes the identifier for an item that should be added to the bundle's children collection.
+In the request body, supply a JSON representation of a [driveItem][] object.
## Response
-If successful, the response is `204 No Content`.
+If successful, this method returns a `204 No Content` response code.
-Read the [Error Responses][error-response] topic for more information about how errors are returned.
+For information about error responses, see [Microsoft Graph error responses and resource types][error-response].
## Example ### Request
-This request will add an existing item to the specified bundle.
+The following is an example of a request that adds an existing item to the specified bundle.
# [HTTP](#tab/http)
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+ ### Response
+The following is an example of the response.
+ <!-- { "blockType": "response" } --> ```http
v1.0 Bundle Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bundle-delete.md
- Title: Delete bundle
-description: Delete a bundle of driveItems
+
+ Title: "Delete bundle"
+description: "Delete a bundle of driveItems."
ms.localizationpriority: medium ms.prod: "sharepoint" doc_type: apiPageType
DELETE /drive/items/{bundle-id}
| Name | Description | |:- |: |
-| Authorization | Bearer \{token\}. Required. |
-| if-match | eTag. Optional. If this request header is included and the eTag (or cTag) provided does not match the current tag on the bundle, a `412 Precondition Failed` response is returned and the bundle will not be deleted.
+| Authorization | Bearer {token}. Required. |
+| if-match | eTag. Optional. If this request header is included and the eTag (or cTag) provided does not match the current tag on the bundle, a `412 Precondition Failed` response is returned and the bundle will not be deleted.|
## Request body
-Do not supply a request body with this method.
+Do not supply a request body for this method.
## Response
-If successful, this call returns a `204 No Content` response to indicate that resource was deleted and there was nothing to return.
+If successful, this method returns a `204 No Content` response code. It does not return anything in the response body.
-Read the [Error Responses][error-response] topic for more info about how errors are returned.
+For information about error responses, see [Microsoft Graph error responses and resource types][error-response].
## Example ### Request
+The following is an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete-bundle" } -->
DELETE https://graph.microsoft.com/beta/drive/items/{bundle-id}
### Response
+The following is an example of the response.
+ <!-- { "blockType": "response" } --> ```http
v1.0 Bundle Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bundle-get.md
- Title: Get bundle
-description: Get a bundle of driveItems
+
+ Title: "Get bundle"
+description: "Get a bundle of driveItems."
ms.localizationpriority: medium ms.prod: "sharepoint" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve the metadata for a [bundle][] based on the bundle's unique ID.
+Retrieve the metadata for a [bundle][] based on the unique ID of the bundle.
## Permissions
GET /drive/items/{bundle-id}
``` Because bundles are items, you can use the **items** collection to return metadata about a bundle.
-You can also use the **bundles** collection as a convenience to ensure you're getting a bundle in response.
+You can also use the **bundles** collection as a convenience to ensure you get a bundle in the response.
## Optional query parameters
You can use the [OData query parameters][odata-parameters] to restrict the shape
## Request headers | Name | Description | |:- |: |
-| Authorization | Bearer \{token\}. Required. |
-| if-none-match | eTag. Optional. If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an `HTTP 304 Not Modified` response is returned.
+| Authorization | Bearer {token}. Required. |
+| if-none-match | eTag. Optional. If this request header is included and the eTag (or cTag) provided matches the current tag on the file, a `304 Not Modified` response is returned.|
## Request body
Do not supply a request body with this method.
## Response
-If successful, this method returns a [driveItem][driveItem] resource with the [bundle][bundle] in the response body.
+If successful, this method returns a `200 OK` response code and a [driveItem][driveItem] object that contains the [bundle][bundle] in the response body.
-Read the [Error Responses][error-response] topic for more info about how errors are returned.
+For information about error responses, see [Microsoft Graph error responses and resource types][error-response].
## Examples
Read the [Error Responses][error-response] topic for more info about how errors
#### Request
+The following is an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-bundle-metadata" } --> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/drive/bundles/{bundle-id}
+GET https://graph.microsoft.com/v1.0/drive/bundles/{bundle-id}
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-bundle-metadata-csharp-snippets.md)]
GET https://graph.microsoft.com/beta/drive/bundles/{bundle-id}
#### Response
+The following is an example of the response.
+
+>**Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "@odata.type": "microsoft.graph.driveItem", "truncated": true } --> ```http
Content-type: application/json
} ```
-The response object shown here might be shortened for readability.
- ### Example 2: Get a bundle and its children in a single call
-You can use the [`expand`](/graph/query-parameters) query string parameter to include the children of a bundle in the same call as retrieving the metadata of a bundle.
+Use the `expand` [query string parameter](/graph/query-parameters) to include the children of a bundle in the same request that retrieves the metadata of a bundle.
#### Request
+The following is an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-bundle-and-children" } --> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/drive/items/{bundle-id}?expand=children
+GET https://graph.microsoft.com/v1.0/drive/items/{bundle-id}?expand=children
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-bundle-and-children-csharp-snippets.md)]
GET https://graph.microsoft.com/beta/drive/items/{bundle-id}?expand=children
#### Response
-This call will return the bundle metadata and a list of children of the bundle.
+The following is an example of the response. This call will return the bundle metadata and a list of children of the bundle.
If the bundle has no children, it will return an empty collection. If the number of children in the bundle is greater than the default page size, the **children@odata.nextLink** property will be returned with a URL that can be used to request the next page of children in the bundle.
+>**Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "@odata.type": "microsoft.graph.driveItem", "truncated": true } --> ```http
Content-Type: application/json
} ```
-The response object shown here might be shortened for readability.
- [bundle]: ../resources/bundle.md [driveItem]: ../resources/driveItem.md
v1.0 Bundle List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bundle-list.md
- Title: List bundles
-description: List the bundles in a user's drive
+
+ Title: "List bundles"
+description: "List the bundles in a user's drive."
ms.localizationpriority: medium ms.prod: "sharepoint" doc_type: apiPageType
GET /drive/bundles
## Optional query parameters
-This method supports the [OData Query Parameters][] to filter and shape the response.
+This method supports the `$filter` [OData query parameters](/graph/query-parameters) to help customize the response.
-You can't use the `expand=children` query parameter when enumerating bundles.
+You can't use the `expand=children` query parameter to list bundles.
## Request headers | Name | Description | |:- |: |
-| Authorization | Bearer \{token\}. Required. |
+| Authorization | Bearer {token}. Required. |
## Request body
-Do not supply a request body with this method.
+Do not supply a request body for this method.
## Response
-If successful, this request returns the list of bundle items defined for the drive.
+If successful, this method returns a `200 OK` response code and a collection of [bundle][bundle] objects in the response body.
-Read the [Error Responses][error-response] topic for more info about how errors are returned.
+For information about error responses, see [Microsoft Graph error responses and resource types][error-response].
## Examples
To request an enumeration of all bundles defined in the drive, you can make a re
#### Request
+The following is an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list-all-bundles", "tags": "service.onedrive" } -->
GET https://graph.microsoft.com/beta/drive/bundles
#### Response
+The following is an example of the response.
+
+> **Note**: The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "@odata.type": "microsoft.graph.driveItem", "truncated": true, "isCollection": true } --> ```http
Content-type: application/json
} ```
-The response object shown here might be shortened for readability.
- ### Example 2: List all photo albums in a drive
-To filter the list of bundles returned from a request to the bundles collection, you can use the `filter` query string parameter to specify the type of bundle to return by checking for the existence of a facet on the bundle:
+To filter the list of bundles returned from a request to the bundles collection, you can use the `filter` query string parameter to specify the type of bundle to return by checking for the existence of a facet on the bundle.
#### Request
+The following is an example of a request.
# [HTTP](#tab/http) <!-- {"blockType": "request", "name": "list-album-bundles", "tags": "service.onedrive" } -->
GET https://graph.microsoft.com/beta/drive/bundles?filter=bundle/album%20ne%20nu
#### Response
-The response to a GET to the bundles endpoint is an array of [driveItem][] resources with the [bundle][].
-Because all bundles are items, you can use use all the standard item operations on them.
+The following is an example of the response. The response to a GET to the bundles endpoint is an array of [driveItem][] resources with the [bundle][].
+Because all bundles are items, you can use all the standard item operations on them.
+
+> **Note**: The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "@odata.type": "microsoft.graph.driveItem", "truncated": true, "isCollection": true } -->
Content-type: application/json
} ```
-The response object shown here might be shortened for readability.
-- [bundle]: ../resources/bundle.md [driveItem]: ../resources/driveItem.md [error-response]: /graph/errors
v1.0 Bundle Removeitem https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bundle-removeitem.md
- Title: Remove item from bundle
-description: Remove item from a bundle of driveItems
+
+ Title: "Remove item from bundle"
+description: "Remove item from a bundle of driveItems."
ms.localizationpriority: medium ms.prod: "sharepoint" doc_type: apiPageType
DELETE /drive/bundles/{bundle-id}/children/{item-id}
| Name | Description | |:- |: |
-| Authorization | Bearer \{token\}. Required. |
+| Authorization | Bearer {token}. Required. |
## Request body
-Do not supply a request body with this method.
+Do not supply a request body for this method.
## Response
-If successful, the response is `204 No Content`.
+If successful, this method returns a `204 No Content` response code.
-Read the [Error Responses][error-response] topic for more info about how errors are returned.
+For information about error responses, see [Microsoft Graph error responses and resource types][error-response].
## Example ### Request
+The following is an example of a request.
# [HTTP](#tab/http) <!-- {"blockType": "request", "name": "remove-from-bundle" } -->
DELETE https://graph.microsoft.com/beta/drive/bundles/{bundle-id}/children/{item
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+ ### Response
+The following is an example of the response.
+ <!-- { "blockType": "response" } --> ```http
v1.0 Calendar List Calendarview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/calendar-list-calendarview.md
Do not supply a request body for this method.
If successful, this method returns a `200 OK` response code and collection of [event](../resources/event.md) objects in the response body.
-If the result set spans multiple pages, **calendarView** returns an **@odata.nextLink** property in the response that contains a URL to the next page of results. See [paging](/graph/concepts/paging.md) for details.
+If the result set spans multiple pages, **calendarView** returns an **@odata.nextLink** property in the response that contains a URL to the next page of results. See [paging](/graph/paging) for details.
## Example ### Request
v1.0 Call Answer https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-answer.md
Title: "call: answer" description: "Answer an incoming call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
You do not need any permissions to answer a peer-to-peer call. You need one of t
| Permission type | Permissions (from least to most privileged) | | :-- | :--|
-| Delegated (work or school account) | Not Supported |
-| Delegated (personal Microsoft account) | Not Supported |
-| Application | Calls.JoinGroupCalls.All or Calls.JoinGroupCallsasGuest.All |
+| Delegated (work or school account) | Not supported. |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Calls.JoinGroupCall.All, Calls.JoinGroupCallAsGuest.All |
> **Note:** For a call that uses application-hosted media, you also need the Calls.AccessMedia.All permission. You must have at least one of the following permissions to ensure that the `source` in the incoming call notification is decrypted: Calls.AccessMedia.All, Calls.Initiate.All, Calls.InitiateGroupCall.All, Calls.JoinGroupCall.All, Calls.JoinGroupCallAsGuest.All. The `source` is the caller info in the incoming call notification. Without at least one of these permissions, the `source` will remain encrypted.
v1.0 Call Cancelmediaprocessing https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-cancelmediaprocessing.md
Title: "call: cancelMediaProcessing" description: "Cancels media processing for any in-progress playPrompt or recordResponse operations."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|:|:--| | Delegated (work or school account) | Not Supported. | | Delegated (personal Microsoft account) | Not Supported. |
-| Application | None. |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Call Changescreensharingrole https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-changescreensharingrole.md
Title: "call: changeScreenSharingRole" description: "Allow applications to share screen content with the participants of a group call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-delete.md
Title: "Delete call" description: "Delete or hang up an active call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
Delete or hang up an active call. For group calls, this will only delete your ca
| :-- | :-- | | Delegated (work or school account) | Not Supported. | | Delegated (personal Microsoft account) | Not Supported. |
-| Application | None. |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request <!-- { "blockType": "ignored" } -->
If successful, this method returns `204 No Content` response code. It does not r
## Example
-##### Request
+### Request
The following example shows the request.
DELETE https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-
-##### Response
+### Response
> **Note:** The response object shown here might be shortened for readability.
DELETE https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-
HTTP/1.1 204 No Content ```
-##### Notification - terminating
+### Notification - terminating
```http POST https://bot.contoso.com/api/calls
Content-Type: application/json
```
-##### Notification - terminated
+### Notification - terminated
```http POST https://bot.contoso.com/api/calls
Content-Type: application/json
"state": "terminated", "resultInfo": { "@odata.type": "#microsoft.graph.resultInfo",
- "code": "0"
+ "code": "200",
+ "subcode": "5001",
+ "message": "The conversation has ended."
} } }
Content-Type: application/json
} ```
+#### Call end reason codes
+
+These are some of the common error codes received via notification when call is terminated.
+
+| Code | Sub-code | Termination reason |
+| : | : | : |
+| 200 | 4097 | Call ended by the other participant in the call. |
+| 200 | 4521 | Call ended by the other participant in peer-to-peer call. |
+| 200 | 5000 | Removed from the conversation by another participant. |
+| 200 | 5001 | The conversation has ended. |
+| 200 | 5002 | The conversation has ended as all other participants have left the call. |
+| 200 | 5003 | The conversation has ended. |
+| 200 | 5007 | The conversation has ended as the initiator of the group call left the conversation. |
+| 200 | 5010 | The conversation has ended as only one participant remained in the conversation. |
+| 200 | 5012 | The conversation has ended as there are no participants in the incoming roster. |
+| 200 | 5013 | The conversation has ended as no one else has joined the group call. |
+| 200 | 5014 | The conversation has ended because we were unable to determine a potential host for the group call. |
+| 200 | 5020 | The conversation has ended as there are no non-hidden participants in the incoming roster. |
+| 200 | 5030 | The conversation has ended as the breakout room duration has elapsed. |
+| 200 | 5300 | Participant was removed from the conversation by another participant. |
+| 200 | 5855 | Participant waiting in lobby was removed from the conversation after lobby inactivity timeout. |
+| 200 | 7000 | The conversation has ended by bot. |
+| 200 | 7015 | Call ended as the transfer completed successfully. |
+| 200 | 10550 | The conversation has ended by bot. |
+| 200 | 18503 | The other participant in the peer-to-peer call left the conversation. |
+| 200 | 540000/560000 | Call ended by the PSTN User. |
+| 408 | 8537 | Keep Alive timeout, cleaned up inactive call. |
+| 408 | 1106 | An acknowledgement was not received for the call acceptance in the allotted time. |
+| 408 | 10057 | Call timed out due to no signaling from callee endpoints. |
+| 410 | 301005 | Media connectivity failure. |
+| 480 | 10037 | No callee endpoints were found. |
+| 480 | 10076 | Callee could not be reached. |
+| 480 | 10134 | Call rejected due to inability to route the call. |
+| 480 | 10199 | Call rejected as private calling is disabled for the user. |
+| 500 | 1005 | Server encountered connectivity error with Bot's media. Please check media connectivity between Bot and Microsoft. |
++ <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
v1.0 Call Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-get.md
Title: "Get call" description: "Retrieve the properties and relationships of a call object."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
| :-- | :-- | | Delegated (work or school account) | Not Supported. | | Delegated (personal Microsoft account) | Not Supported. |
-| Application | None. |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Call Keepalive https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-keepalive.md
Title: "call: keepAlive" description: "Make a request to this API every 15 to 45 minutes to ensure that an ongoing call remains active."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
One of the following permissions may be required to call this API. To learn more
| :-- | : | | Delegated (work or school account) | Not Supported | | Delegated (personal Microsoft account) | Not Supported |
-| Application | None |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Call List Audioroutinggroups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-list-audioroutinggroups.md
Title: "List audio routing groups" description: "Retrieve a list of **audioRoutingGroup** objects."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call List Participants https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-list-participants.md
Title: "List participants" description: "Retrieve a list of participant objects in the call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
Retrieve a list of participant objects in the call.
| :-- | : | | Delegated (work or school account) | Not Supported | | Delegated (personal Microsoft account) | Not Supported |
-| Application | None |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request
v1.0 Call Mute https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-mute.md
Title: "call: mute" description: "Allows the application to mute itself."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|:|:--| | Delegated (work or school account) | Not Supported. | | Delegated (personal Microsoft account) | Not Supported. |
-| Application | None. |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Call Playprompt https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-playprompt.md
Title: "call: playPrompt" description: "Play a prompt in the call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
One of the following permissions is required to call this API. To learn more, in
|:|:--| | Delegated (work or school account) | Not Supported. | | Delegated (personal Microsoft account) | Not Supported. |
-| Application | None. |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request
v1.0 Call Post Audioroutinggroups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-post-audioroutinggroups.md
Title: "Create audio routing group" description: "Create a new **audioRoutingGroup**."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call Record https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-record.md
Title: "call: recordResponse" description: "Record a short audio response from the caller. This is useful if the bot wants to capture a voice response from the caller following a prompt."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call Redirect https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-redirect.md
Title: "call: redirect" description: "Redirect an incoming call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call Reject https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-reject.md
Title: "call: reject" description: "Enable a bot to reject an incoming call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call Subscribetotone https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-subscribetotone.md
Title: "call: subscribeToTone" description: "Subscribe to DTMF (dual-tone multi-frequency signaling). This allows you to be notified when the user presses keys on a 'Dialpad'."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call Transfer https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-transfer.md
Title: "call: transfer" description: "Transfer an active peer-to-peer call or group call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Call Unmute https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-unmute.md
Title: "call: unmute" description: "Allow the application to unmute itself."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
For more information about how to handle unmute operations, see [unmuteParticipa
|:|:--| | Delegated (work or school account) | Not supported. | | Delegated (personal Microsoft account) | Not supported. |
-| Application | None. |
+| Application | Calls.Initiate.All, Calls.AccessMedia.All |
+
+> **Note:** Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
## HTTP request <!-- { "blockType": "ignored" } -->
v1.0 Call Updaterecordingstatus https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/call-updaterecordingstatus.md
Title: "call: updateRecordingStatus" description: "Update the application's recording status associated with a call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType
v1.0 Certificatebasedauthconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-delete.md
DELETE https://graph.microsoft.com/beta/organization/{id}/certificateBasedAuthCo
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Certificatebasedauthconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-get.md
GET https://graph.microsoft.com/beta/organization/{id}/certificateBasedAuthConfi
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Channel List Tabs https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/channel-list-tabs.md
Namespace: microsoft.graph
Retrieve the list of [tabs](../resources/teamstab.md) in the specified [channel](../resources/channel.md) within a [team](../resources/team.md).
+> **Note**: The Files tab is native to a channel or chat and is not returned by this API.
+ ## 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).
v1.0 Chat List Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-list-members.md
Title: "List members of a chat" description: "Retrieve members of a chat."-+ ms.localizationpriority: high ms.prod: "microsoft-teams" doc_type: apiPageType
GET https://graph.microsoft.com/beta/me/chats/19:8b081ef6-4792-4def-b2c9-c363a1b
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Chat List Messages https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-list-messages.md
This method supports the following [OData query parameters](/graph/query-paramet
| Name | Description | |:-|:| | [$top](/graph/query-parameters#top-parameter)| Controls the number of items per response. Maximum allowed `$top` value is 50. |
-| [$orderBy](/graph/query-parameters#orderBy) | Currently supports **LastModifiedDateTime (default)** and **CreatedDateTime**. |
+| [$orderBy](/graph/query-parameters#orderBy) | Currently supports **lastModifiedDateTime** (default) and **createdDateTime** in **descending** order. Ascending order is currently not supported.|
The other [OData query parameters](/graph/query-parameters) are not currently supported.
If successful, this method returns a `200 OK` response code and a collection of
### Request
-The following is an example of the request. `$top=2` is passed to retrieve two messages and `$orderBy=createdDateTime` is passed to sort messages by createdDateTime.
+The following is an example of the request. `$top=2` is passed to retrieve two messages and `$orderBy=createdDateTime` is passed to sort messages by **createdDateTime**.
# [HTTP](#tab/http)
The following is an example of the request. `$top=2` is passed to retrieve two m
"name": "get_allchatmessages_1" }--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages?$top=2&$orderBy=createdDateTime
+GET https://graph.microsoft.com/beta/chats/19:2da4c29f6d7041eca70b638b43d45437@thread.v2/messages?$top=2&$orderBy=createdDateTime desc
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/get-allchatmessages-1-csharp-snippets.md)]
v1.0 Chat Patch https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-patch.md
Title: "Update chat" description: "Update the properties of a chat object."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType
v1.0 Chat Post Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-post-members.md
Title: "Add member to a chat" description: "Add a conversationMember to a chat."-+ doc_type: "apiPageType" ms.localizationpriority: medium ms.prod: "microsoft-teams"
v1.0 Chat Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chat-post.md
The following table lists the properties that are required to create a chat obje
|:|:|:| |topic|(Optional) String|The title of the chat. The chat title can be provided only if the chat is of `group` type.| |chatType|[chatType](../resources/chat.md#chattype-values)| Specifies the type of chat. Possible values are: `group` and `oneOnOne`. |
-|members|[conversationMember](../resources/conversationmember.md) collection|List of conversation members that should be added. Every single user, including the user initiating the create request, who will participate in the chat must be specified in this list.|
+|members|[conversationMember](../resources/conversationmember.md) collection|List of conversation members that should be added. Every user who will participate in the chat, including the user who initiates the create request, must be specified in this list. Each member must be assigned a role of `owner` or `guest`. Guest tenant users must be assigned the `guest` role.|
|installedApps| [teamsApp](../resources/teamsapp.md) collection|List of apps that should be installed in the chat.| > **Note:** Currently, only one app installation is supported. If multiple app installations are listed in the request, the response will be a `Bad Request` error.
Content-Type: application/json
} ```
+### Example 5: Create a group chat with tenant guest user
+
+#### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_chat_group"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/chats
+Content-Type: application/json
+
+{
+ "chatType": "group",
+ "topic": "Group chat title",
+ "members": [
+ {
+ "@odata.type": "#microsoft.graph.aadUserConversationMember",
+ "roles": ["owner"],
+ "user@odata.bind": "https://graph.microsoft.com/beta/users('8c0a1a67-50ce-4114-bb6c-da9c5dbcf6ca')"
+ },
+ {
+ "@odata.type": "#microsoft.graph.aadUserConversationMember",
+ "roles": ["owner"],
+ "user@odata.bind": "https://graph.microsoft.com/beta/users('82fe7758-5bb3-4f0d-a43f-e555fd399c6f')"
+ },
+ {
+ "@odata.type": "#microsoft.graph.aadUserConversationMember",
+ "roles": ["guest"],
+ "user@odata.bind": "https://graph.microsoft.com/beta/users('8ba98gf6-7fc2-4eb2-c7f2-aef9f21fd98g')"
+ }
+ ]
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
++++++
+#### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.chat"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#chats/$entity",
+ "id": "19:1c5b01696d2e4a179c292bc9cf04e63b@thread.v2",
+ "topic": "Group chat title",
+ "createdDateTime": "2020-12-04T23:11:16.175Z",
+ "lastUpdatedDateTime": "2020-12-04T23:11:16.175Z",
+ "chatType": "group",
+ "webUrl": "https://teams.microsoft.com/l/chat/19%3A1c5b01696d2e4a179c292bc9cf04e63b@thread.v2/0?tenantId=b33cbe9f-8ebe-4f2a-912b-7e2a427f477f"
+}
+```
+ ## See also - [Get teamsAsyncOperation](teamsasyncoperation-get.md)
v1.0 Chatmessage List Hostedcontents https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/chatmessage-list-hostedcontents.md
GET https://graph.microsoft.com/beta/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Cloudpc Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpc-get.md
Content-Type: application/json
"managedDeviceName": "A00002GI001", "provisioningPolicyId": "13fa0778-ba00-438a-96d3-488c8602ffff", "provisioningPolicyName": "Marketing provisioning policy",
- "onPremisesConnectionName": "on-Premises connection for Marketing",
+ "onPremisesConnectionName": "Azure network connection for Marketing",
"servicePlanId": "da5615b4-a484-4742-a019-2d52c91cffff", "servicePlanName": "standard", "servicePlanType": "enterprise",
v1.0 Cloudpcdeviceimage Getsourceimages https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcdeviceimage-getsourceimages.md
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.cloudPcSourceDeviceImage", "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG/providers/Microsoft.Compute/images/ExampleImage",
- "displayName": "Display Name value"
+ "displayName": "Display Name value",
+ "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
+ "subscriptionDisplayName": "Subscription Display Name value"
} ] }
v1.0 Cloudpconpremisesconnection Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpconpremisesconnection-delete.md
Namespace: microsoft.graph
Delete a specific [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md) object. + When you delete a connection, permissions to the service are removed from the specified Azure resources.
-You cannot delete an on-premises connection once it passes health check, which is indicated by the `healthCheckStatus` property.
+You cannot delete an Azure network connection once it passes health check, which is indicated by the `healthCheckStatus` property.
You cannot delete a connection when it's in use either, as indicated by the `inUse` property.
v1.0 Cloudpconpremisesconnection Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpconpremisesconnection-get.md
Namespace: microsoft.graph
Read the properties and relationships of the [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.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).
If successful, this method returns a `200 OK` response code and a [cloudPcOnPrem
## Examples
-### Example 1: Get the default properties of an on-premises connection
+### Example 1: Get the default properties of an Azure network connection
#### Request
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection", "id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdccffff",
+ "managedBy": "windows365",
"type": "hybridAzureADJoin", "displayName": "Display Name value", "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
Content-Type: application/json
} ```
-### Example 2: Get the selected properties of an on-premises connection, including healthCheckStatusDetails
+### Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails
#### Request
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection", "id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdccffff",
+ "managedBy": "windows365",
"displayName": "Display Name value", "healthCheckStatus": "failed", "healthCheckStatusDetails": {
v1.0 Cloudpconpremisesconnection Runhealthcheck https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpconpremisesconnection-runhealthcheck.md
Title: "CloudPcOnPremisesConnection: runHealthChecks"
-description: "Run health checks on the Cloud PC on-premises connection."
+description: "Run health checks on the Cloud PC Azure network connection."
ms.localizationpriority: medium ms.prod: "cloud-pc"
Namespace: microsoft.graph
Run health checks on the [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md) object. + This will trigger a new health check for this [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md) object and change the healthCheckStatus and [healthCheckStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md) properties when check finished.
v1.0 Cloudpconpremisesconnection Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpconpremisesconnection-update.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Update the properties of a [cloudPcOnPremisesConnection](../resources/cloudpconpremisesconnection.md) object.
-Once the on-premises connection passes health check, which is indicated by the `healthCheckStatus` property, you cannot update it.
## Permissions
The following table shows the properties that are required when you create the [
|Property|Type|Description| |:|:|:|
-|displayName|String|The display name for the on-premises connection.|
+|displayName|String|The display name for the Azure network connection.|
|type|cloudPcOnPremisesConnectionType|Specifies how the provisioned Cloud PC will be joined to Azure Active Directory. Default value is `hybridAzureADJoin`. Possible values are: `azureADJoin`, `hybridAzureADJoin`, `unknownFutureValue`.| |subscriptionId|String|The ID of the target Azure subscription thatΓÇÖs associated with your tenant.| |adDomainName|String|The fully qualified domain name (FQDN) of the Active Directory domain you want to join.|
Content-Type: application/json
{ "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection", "id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff",
+ "managedBy": "windows365",
"type": "hybridAzureADJoin", "displayName": "Display Name value", "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
v1.0 Cloudpconpremisesconnection Updateaddomainpassword https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpconpremisesconnection-updateaddomainpassword.md
Title: "cloudPcOnPremisesConnection: updateAdDomainPassword"
-description: "Update the Active Directory domain password for a successful on-premises connection. This API is supported when the onPremisesConnection's type is hybridAzureADJoin."
+description: "Update the Active Directory domain password for a successful Azure network connection. This API is supported when the onPremisesConnection's type is hybridAzureADJoin."
ms.localizationpriority: medium ms.prod: "cloud-pc"
Namespace: microsoft.graph
Update the Active Directory domain password for an [onPremisesConnection](../resources/cloudpconpremisesconnection.md). This API is supported when the type of the **onPremisesConnection** is `hybridAzureADJoin`. ## 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).
v1.0 Cloudpcorganizationsettings Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcorganizationsettings-get.md
If successful, this method returns a `200 OK` response code and a [cloudPcOrgani
## Examples ### Request+
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_cloudpcorganizationsettings"
If successful, this method returns a `200 OK` response code and a [cloudPcOrgani
``` http GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/organizationSettings ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Cloudpcprovisioningpolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-get.md
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioni
#### Response
-**Note:** The response object shown here might be shortened for readability.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-Type: application/json
"id": "1d164206-bf41-4fd2-8424-a3192d39ffff", "imageDisplayName": "Image Display Name value", "imageId": "Image ID value",
- "imageType":"custom",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff"
+ "imageType": "custom",
+ "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
+ "windowsSettings": {
+ "language": "en-US"
+ }
} ```
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioni
#### Response
-**Note:** The response object shown here might be shortened for readability.
+>**Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true,
Content-Type: application/json
"id": "1d164206-bf41-4fd2-8424-a3192d39ffff", "imageDisplayName": "Image Display Name value", "imageId": "Image ID value",
- "imageType":"custom",
+ "imageType": "custom",
"onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
+ "windowsSettings": {
+ "language": "en-US"
+ },
"assignments": [ { "@odata.type": "microsoft.graph.cloudPcProvisioningPolicyAssignment",
v1.0 Cloudpcprovisioningpolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-update.md
The following table shows the properties that can be updated for the [cloudPcPro
|imageId|String|The ID of the OS image you want to provision on Cloud PCs. The format for a gallery type image is: {publisher_offer_sku}. Supported values for each of the parameters are as follows: <ul><li>publisher: Microsoftwindowsdesktop.</li> <li>offer: windows-ent-cpc.</li> <li>sku: 21h1-ent-cpc-m365, 21h1-ent-cpc-os, 20h2-ent-cpc-m365, 20h2-ent-cpc-os, 20h1-ent-cpc-m365, 20h1-ent-cpc-os, 19h2-ent-cpc-m365 and 19h2-ent-cpc-os.</li></ul>| |imageDisplayName|String|The display name for the OS image youΓÇÖre provisioning.| |imageType|cloudPcProvisioningPolicyImageType|The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: `gallery`, `custom`.|
+|windowsSettings|[cloudPcWindowsSettings](../resources/cloudpcwindowssettings.md)|The Windows operation system settings for the provisioned Cloud PCs with this provisioning policy, such as operation system language setting.|
## Response
PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisio
Content-Type: application/json {
+ "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy",
"displayName": "HR provisioning policy", "description": "Provisioning policy for India HR employees",
- "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701b553"
+ "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
+ "imageId": "Image ID value",
+ "imageDisplayName": "Image Display Name value",
+ "imageType": "custom",
+ "windowsSettings": {
+ "language": "en-US"
+ }
} ``` # [C#](#tab/csharp)
v1.0 Cloudpcsnapshot Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcsnapshot-get.md
+
+ Title: "Get cloudPcSnapshot"
+description: "Read the properties and relationships of a cloudPcSnapshot object."
+
+ms.localizationpriority: medium
++
+# Get cloudPcSnapshot
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [cloudPcSnapshot](../resources/cloudpcsnapshot.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)|CloudPC.Read.All, CloudPC.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|CloudPC.Read.All, CloudPC.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /deviceManagement/virtualEndpoint/snapshots/{cloudPcSnapshotId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter 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 [cloudPcSnapshot](../resources/cloudpcsnapshot.md) object in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of a request.
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_cloudpcsnapshot"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/snapshots/A00009UV000_93aff428-61f2-467f-a879-1102af6fd4a8
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.cloudPcSnapshot"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "value": {
+ "@odata.type": "#microsoft.graph.cloudPcSnapshot",
+ "cloudPcId": "662009bc-7732-4f6f-8726-25883518b33e",
+ "createdDateTime": "2021-08-23T09:28:32.8260335Z",
+ "id": "A00009UV000_93aff428-61f2-467f-a879-1102af6fd4a8",
+ "lastRestoredDateTime": "2021-09-01T09:28:32.8260338Z",
+ "status": "ready"
+ }
+}
+```
+
v1.0 Cloudpcusersetting Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcusersetting-get.md
Content-Type: application/json
"displayName": "String", "selfServiceEnabled": true, "localAdminEnabled": false,
+ "restorePointSetting": {
+ "frequencyInHours": 16,
+ "userRestoreEnabled": true
+ },
"lastModifiedDateTime": "2021-02-01T10:29:57Z", "createdDateTime": "2021-02-01T10:29:57Z" }
Content-Type: application/json
"displayName": "Display Name value", "selfServiceEnabled": true, "localAdminEnabled": false,
+ "restorePointSetting": {
+ "frequencyInHours": 16,
+ "userRestoreEnabled": true
+ },
"lastModifiedDateTime": "2021-02-01T10:29:57Z", "createdDateTime": "2021-02-01T10:29:57Z", "assignments": [
v1.0 Cloudpcusersetting Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/cloudpcusersetting-update.md
The following table shows the properties that are required when you update the [
|displayName|String|The setting name displayed in the user interface.| |localAdminEnabled|Boolean|To turn on the local admin option, change this setting to `True`.ΓÇ» | |selfServiceEnabled|Boolean|To turn on the self-service option, change this setting to `True`.ΓÇ»|
+|restorePointSetting|[cloudPcRestorePointSetting](../resources/cloudpcrestorepointsetting.md)|Defines how frequently a restore point is created (that is, a snapshot is taken) for users' provisioned Cloud PCs (default is 12 hours), and whether the user is allowed to restore their own Cloud PCs to a backup made at a specific point in time.|
|lastModifiedDateTime|DateTimeOffset|The last date and time the setting was modified. The Timestamp type represents the date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like this:ΓÇ»'2014-01-01T00:00:00Z'.ΓÇ»|
Content-Type: application/json
"@odata.type": "#microsoft.graph.cloudPcUserSetting", "displayName": "Example", "selfServiceEnabled": true,
+ "restorePointSetting": {
+ "frequencyInHours": 16,
+ "userRestoreEnabled": true
+ },
"localAdminEnabled": false } ```
v1.0 Columndefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/columndefinition-get.md
ms.prod: "sites-and-lists"
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]+ Retrieve the metadata for a [site][], [list][] or [contentType][] [column][columnDefinition]. ## 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) | Sites.Read.All, Sites.ReadWrite.All, Sites.Manage.All, Sites.FullControl.All |
GET /sites/{site-id}/lists/{list-id}/contentTypes/{contentType-id}/columns/{colu
## Request body
-
+Do not supply a request body for this method.
-Do not supply a request body with this method.
+## Response
+If successful, this method returns a `200 OK` response code and a [columnDefinition][columnDefinition] object in the response body.
- ## Example
-
- ### Request
-
-
+The following is an example of a request.
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_column_from_contenttype" } -->
GET /sites/{site-id}/contentTypes/{contentType-id}/columns/{column-id}
-
- ### Response
-
+The following is an example of the response.
<!-- { "blockType": "response", "@type": "microsoft.graph.columnDefinition", "truncated": true } -->
v1.0 Connector Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connector-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connector List Memberof https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connector-list-memberof.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connector List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connector-list.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connector Post Memberof https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connector-post-memberof.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-delete.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup List Applications https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-list-applications.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup List Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-list-members.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-list.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup Post Applications https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-post-applications.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup Post Connectorgroups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-post-connectorgroups.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.ReadWrite.All |
v1.0 Connectorgroup Post Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-post-members.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-post.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Connectorgroup Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/connectorgroup-update.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Contactmergesuggestions Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/contactmergesuggestions-get.md
+
+ Title: "Get contactMergeSuggestions"
+description: "Read the properties and relationships of a contactMergeSuggestions object."
+
+ms.localizationpriority: medium
++
+# Get contactMergeSuggestions
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [contactMergeSuggestions](../resources/contactmergesuggestions.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)|User.Read, User.ReadWrite|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /me/settings/contactMergeSuggestions
+```
+
+## 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 [contactMergeSuggestions](../resources/contactmergesuggestions.md) object in the response body.
+
+## Examples
+
+The following is an example of the request to get **contactMergeSuggestions** settings for the user.
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_contactmergesuggestions"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/me/settings/contactMergeSuggestions
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.contactMergeSuggestions",
+ "name": "get_contactmergesuggestions"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "isEnabled": true
+}
+```
+
v1.0 Contactmergesuggestions Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/contactmergesuggestions-update.md
+
+ Title: "Update contactMergeSuggestions"
+description: "Update the properties of a contactMergeSuggestions object."
+
+ms.localizationpriority: medium
++
+# Update contactMergeSuggestions
+Namespace: microsoft.graph
++
+Update the properties of a [contactMergeSuggestions](../resources/contactmergesuggestions.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)|User.ReadWrite|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /me/settings/contactMergeSuggestions
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|isEnabled|Boolean|`true` if the duplicate contact merge suggestions feature is enabled for user; `false` if the feature is disabled. Default is `true`.|
+++
+## Response
+
+If successful, this method returns a `204 No Content` response code and the value is updated on the backend.
+
+## Examples
+
+The following example updates the **isEnabled** privacy setting to disable the duplicate contacts merge suggestions feature.
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_contactmergesuggestions"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/me/settings/contactMergeSuggestions
+Content-Type: application/json
+
+{
+ "isEnabled": false
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "name": "update_contactmergesuggestions"
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Contract Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/contract-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
v1.0 Contract List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/contract-list.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
v1.0 Crosstenantaccesspolicy Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicy-get.md
If successful, this method returns a `200 OK` response code and a [crossTenantAc
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_crosstenantaccesspolicy"
If successful, this method returns a `200 OK` response code and a [crossTenantAc
``` http GET https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicy List Partners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicy-list-partners.md
If successful, this method returns a `200 OK` response code and a collection of
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "list_crosstenantaccesspolicyconfigurationpartner"
If successful, this method returns a `200 OK` response code and a collection of
``` http GET https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/partners ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicy Post Partners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicy-post-partners.md
If successful, this method returns a `201 Created` response code and a [crossTen
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_crosstenantaccesspolicyconfigurationpartner_from_"
Content-Type: application/json
} } ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicy Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicy-update.md
The [crossTenantAccessPolicy](../resources/crosstenantaccesspolicy.md) object si
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_crosstenantaccesspolicy"
Content-Type: application/json
"displayName": "CrossTenantAccessPolicy", } ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicyconfigurationdefault Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationdefault-get.md
If successful, this method returns a `200 OK` response code and a [crossTenantAc
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_crosstenantaccesspolicyconfigurationdefault"
If successful, this method returns a `200 OK` response code and a [crossTenantAc
``` http GET https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicyconfigurationdefault Resettosystemdefault https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationdefault-resettosystemdefault.md
If successful, this action returns a `204 No Content` response code. To confirm
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "crosstenantaccesspolicyconfigurationdefault_resettosystemdefault"
If successful, this action returns a `204 No Content` response code. To confirm
``` http POST https://graph.microsoft.com/betefault ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicyconfigurationdefault Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationdefault-update.md
If successful, this method returns a `204 No Content` response code.
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_crosstenantaccesspolicyconfigurationdefault"
Content-Type: application/json
} } ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicyconfigurationpartner Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationpartner-delete.md
If successful, this method returns a `204 No Content` response code.
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "delete_crosstenantaccesspolicyconfigurationpartner"
If successful, this method returns a `204 No Content` response code.
``` http DELETE https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/partners/9c5d131d-b1c3-4fc4-9e3f-c6557947d551 ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicyconfigurationpartner Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationpartner-get.md
If successful, this method returns a `200 OK` response code and a [crossTenantAc
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "get_crosstenantaccesspolicyconfigurationpartner"
If successful, this method returns a `200 OK` response code and a [crossTenantAc
``` http GET https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/partners/9c5d131d-b1c3-4fc4-9e3f-c6557947d551 ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Crosstenantaccesspolicyconfigurationpartner Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationpartner-update.md
If successful, this method returns a `204 No Content` response code.
### Request +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "update_crosstenantaccesspolicyconfigurationpartner"
Content-Type: application/json
} } ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ ### Response
v1.0 Customaccesspackageworkflowextension Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/customaccesspackageworkflowextension-delete.md
+
+ Title: "Delete customAccessPackageWorkflowExtension"
+description: "Delete a customAccessPackageWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Delete customAccessPackageWorkflowExtension
+Namespace: microsoft.graph
++
+Delete a [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object. The custom workflow extension must first be removed from any associated [policies](../resources/accesspackageassignmentpolicy.md) before it can be deleted. Follow these steps to remove the custom workflow extension from any associated policies:
+1. First retrieve the accessPackageCatalogId by calling the [Get accessPackageAssignmentPolicies](accesspackageassignmentpolicy-get.md) operation and appending `?$expand=accessPackage($expand=accessPackageCatalog)` to the query. For example, `https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies?$expand=accessPackage($expand=accessPackageCatalog)`.
+2. Use the access package catalog ID and retrieve the ID of the **customAccessPackageWorkflowExtension** object that you want to delete by running the [LIST customAccessPackageWorkflowExtensions](accesspackagecatalog-list-customaccesspackageworkflowextensions.md) operation.
+3. Call the [Update accessPackageAssignmentPolicy](accesspackageassignmentpolicy-update.md) operation to remove the custom workflow extension object from the policy. For an example, see [Example 2: Remove the customExtensionHandlers from a policy](accesspackageassignmentpolicy-update.md#example-2-remove-the-customextensionhandlers-from-a-policy).
+
+## 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)|EntitlementManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions/{customAccessPackageWorkflowExtensionId}
+```
+
+## 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](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_customaccesspackageworkflowextension"
+}
+-->
+``` http
+DELETE /identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions/98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Response
+```
v1.0 Customaccesspackageworkflowextension Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/customaccesspackageworkflowextension-get.md
+
+ Title: "Get customAccessPackageWorkflowExtension"
+description: "Read the properties and relationships of a customAccessPackageWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Get customAccessPackageWorkflowExtension
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object for an [accessPackageCatalog](../resources/accesspackagecatalog.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)|EntitlementManagement.Read.All EntitlementManagement.ReadWrite.All |
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.Read.All EntitlementManagement.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions/{customAccessPackageWorkflowExtensionId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to retrieve specific properties. 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 [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_customaccesspackageworkflowextension"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions/98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.customAccessPackageWorkflowExtension"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions/98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "id": "98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0",
+ "displayName": "test_action_0124_email",
+ "description": "this is for graph testing only",
+ "createdDateTime": "2022-01-24T21:48:57.15Z",
+ "lastModifiedDateTime": "2022-01-24T21:55:44.953Z",
+ "clientConfiguration": null,
+ "endpointConfiguration": {
+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName": "test",
+ "logicAppWorkflowName": "elm-extension-email"
+ },
+ "authenticationConfiguration": {
+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
+ "resourceId": "eed6dee9-7ff7-44a5-8980-c11e8886cea2"
+ }
+}
+```
+
v1.0 Customaccesspackageworkflowextension Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/customaccesspackageworkflowextension-update.md
+
+ Title: "Update customAccessPackageWorkflowExtension"
+description: "Update the properties of a customAccessPackageWorkflowExtension object."
+
+ms.localizationpriority: medium
++
+# Update customAccessPackageWorkflowExtension
+Namespace: microsoft.graph
++
+Update the properties of an existing [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.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)|EntitlementManagement.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|EntitlementManagement.ReadWrite.All|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PUT /identityGovernance/entitlementManagement/accessPackageCatalogs/{catalogId}/customAccessPackageWorkflowExtensions/{customAccessPackageWorkflowExtensionId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|description|String|Description for the customAccessPackageWorkflowExtension object.|
+|displayName|String|Display name for the customAccessPackageWorkflowExtension.|
+|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|The type and details for configuring the endpoint to call the logic app's workflow.|
+|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow.|
++
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "update_customaccesspackageworkflowextension"
+}
+-->
+``` http
+PUT https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageCatalogs/32efb28c-9a7a-446c-986b-ca6528c6669d/customAccessPackageWorkflowExtensions/98ffaec5-ae8e-4902-a434-5ffc5d3d3cd0
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.customAccessPackageWorkflowExtension",
+ "displayName": "test_action_0124_email",
+ "description": "this is for graph testing only"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.customAccessPackageWorkflowExtension"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "displayName": "test_action_0124_email",
+ "description": "this is for graph testing only",
+ "endpointConfiguration": {
+ "@odata.type": "#microsoft.graph.logicAppTriggerEndpointConfiguration",
+ "subscriptionId": "38ab2ccc-3747-4567-b36b-9478f5602f0d",
+ "resourceGroupName": "EMLogicApp",
+ "logicAppWorkflowName": "elm-extension-email"
+ },
+ "authenticationConfiguration": {
+ "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
+ "resourceId": "eed6dee9-7ff7-44a5-8980-c11e8886cea2"
+ }
+}
+```
+
v1.0 Delegatedadminaccessassignment Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminaccessassignment-delete.md
+
+ Title: "Delete delegatedAdminAccessAssignment"
+description: "Delete a delegatedAdminAccessAssignment object."
+
+ms.localizationpriority: medium
++
+# Delete delegatedAdminAccessAssignment
+Namespace: microsoft.graph
++
+Delete a [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.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)| DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/accessAssignments/{delegatedAdminAccessAssignmentId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|If-Match|If-match: {etag}. Last known ETag value for the **delegatedAdminAccessAssignment** to be deleted. Required. Retrieve the ETag value from a LIST or GET operation.|
+
+## 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
+<!-- {
+ "blockType": "request",
+ "name": "delete_delegatedadminaccessassignment"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/72a7ae7e-4887-4e34-9755-2e1e9b26b943-63f017cb-9e0d-4f14-94bd-4871902b3409/accessAssignments/a9d6cf90-083a-47dc-ace2-1da98be3f344
+If-Match: W/"JyI0NzAwNjg0NS0wMDAwLTE5MDAtMDAwMC02MGY0Yjg4MzAwMDAiJw=="
+```
++
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Delegatedadminaccessassignment Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminaccessassignment-get.md
+
+ Title: "Get delegatedAdminAccessAssignment"
+description: "Read the properties of a delegatedAdminAccessAssignment object."
+
+ms.localizationpriority: medium
++
+# Get delegatedAdminAccessAssignment
+Namespace: microsoft.graph
++
+Read the properties of a [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/accessAssignments/{delegatedAdminAccessAssignmentId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to retrieve specific user properties, including those that are not returned by default.
+
+## 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 [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_delegatedadminaccessassignment"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/72a7ae7e-4887-4e34-9755-2e1e9b26b943-63f017cb-9e0d-4f14-94bd-4871902b3409/accessAssignments/da9d6cf90-083a-47dc-ace2-1da98be3f344
+```
+
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminAccessAssignment"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.delegatedAdminAccessAssignment",
+ "@odata.etag": "W/\"JYsD02WrMDI5OC0wMDAwLTAyMDAtMDAwMC02MjJiZTA0YjAwMDAiJw==\"",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#accessAssignments/$entity",
+ "id": "da9d6cf90-083a-47dc-ace2-1da98be3f344",
+ "status": "active",
+ "createdDateTime": "2022-03-09T13:20:35.2772433Z",
+ "lastModifiedDateTime": "2022-03-11T23:50:35.8970153Z",
+ "accessContainer": {
+ "accessContainerId": "227a2f44-2682-4831-a021-f8d69a34bcba",
+ "accessContainerType": "securityGroup"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
+ },
+ {
+ "roleDefinitionId": "44367163-eba1-44c3-98af-f5787879f96a"
+ },
+ {
+ "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de"
+ },
+ {
+ "roleDefinitionId": "62e90394-69f5-4237-9190-012177145e10"
+ }
+ ]
+ }
+}
+```
+
v1.0 Delegatedadminaccessassignment Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminaccessassignment-update.md
+
+ Title: "Update delegatedAdminAccessAssignment"
+description: "Update the properties of a delegatedAdminAccessAssignment object."
+
+ms.localizationpriority: medium
++
+# Update delegatedAdminAccessAssignment
+Namespace: microsoft.graph
++
+Update the properties of a [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.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)| DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/accessAssignments/{delegatedAdminAccessAssignmentId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|If-Match|If-match: etag}. Last known ETag value for the **delegatedAdminAccessAssignment** to be updated. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
+
+|Property|Type|Description|
+|:|:|:|
+|accessDetails|[delegatedAdminAccessDetails](../resources/delegatedadminaccessdetails.md)|The identifiers of the administrative roles that the partner is assigned in the customer tenant|
++
+## Response
+
+If successful, this method returns a `200 OK` or a `202 Accepted` response code.
+
+## Response headers
+|Name|Description|
+|:|:|
+|Content-Type|application/json.|
+|Location|The location of the long-running operation.|
+|Retry-After|The time after which a subsequent API call can be made to the Location URL to check the status of the long-running operation.|
+
+This method typically returns a `202 Accepted` response code with a URL to a long-running operation in the **Location** response header that can be monitored for completion. If the values specified in the call are identical to the values in the existing object, the API returns a `200 OK` response code with the original [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "update_delegatedadminaccessassignment",
+ "@odata.type": "microsoft.graph.delegatedAdminAccessAssignment"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5e5594d3-6f82-458b-b567-77db4811f0cd-00000000-0000-0000-0000-000000001234/accessAssignments/da9d6cf90-083a-47dc-ace2-1da98be3f344
+If-Match: W/"JyI0NzAwNjg0NS0wMDAwLTE5MDAtMDAwMC02MGY0Yjg4MzAwMDAiJw=="
+Content-Type: application/json
+
+{
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
+ },
+ {
+ "roleDefinitionId": "44367163-eba1-44c3-98af-f5787879f96a"
+ },
+ {
+ "roleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8"
+ }
+ ]
+ }
+}
+```
+
+### Response
+The following is an example response that returns a `202 Accepted` response code along with **Location** and **Retry-After** headers.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminAccessAssignment"
+}
+-->
+``` http
+HTTP/1.1 202 Accepted
+Location: https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5e5594d3-6f82-458b-b567-77db4811f0cd-00000000-0000-0000-0000-000000001234/operations/d8dbb27b-7fe7-4523-a3df-f766355fe0f2
+Retry-After: 10
+Content-Type: application/json
+
+{
+}
+```
v1.0 Delegatedadmincustomer Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadmincustomer-get.md
+
+ Title: "Get delegatedAdminCustomer"
+description: "Read the properties of a delegatedAdminCustomer object."
+
+ms.localizationpriority: medium
++
+# Get delegatedAdminCustomer
+Namespace: microsoft.graph
++
+Read the properties of a [delegatedAdminCustomer](../resources/delegatedadmincustomer.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminCustomers/{delegatedAdminCustomerId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to retrieve specific user properties, including those that are not returned by default.
+
+## 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 [delegatedAdminCustomer](../resources/delegatedadmincustomer.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_delegatedadmincustomer"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminCustomers/4fdbff88-9d6b-42e0-9713-45c922ba8001
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminCustomer"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.delegatedAdminCustomer",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#delegatedAdminCustomers/$entity",
+ "@odata.etag": "W/\"JyIxODAwZTY4My0wMDAwLTAyMDAtMDAwMC02MTU0OWFmMDAwMDAiJw==\"",
+ "id": "4fdbff88-9d6b-42e0-9713-45c922ba8001",
+ "tenantId": "4fdbff88-9d6b-42e0-9713-45c922ba8001",
+ "displayName": "Contoso Inc"
+}
+```
+
v1.0 Delegatedadmincustomer List Servicemanagementdetails https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadmincustomer-list-servicemanagementdetails.md
+
+ Title: "List serviceManagementDetails"
+description: "Get a list of the delegatedAdminServiceManagementDetail objects and their properties."
+
+ms.localizationpriority: medium
++
+# List serviceManagementDetails
+Namespace: microsoft.graph
++
+Get a list of the [delegatedAdminServiceManagementDetail](../resources/delegatedAdminServiceManagementDetail.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminCustomers/{delegatedAdminCustomerId}/serviceManagementDetails
+```
+
+## Optional query parameters
+This method does not support 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 [delegatedAdminServiceManagementDetail](../resources/delegatedAdminServiceManagementDetail.md) objects in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "list_delegatedAdminServiceManagementDetails"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminCustomers/4fdbff88-9d6b-42e0-9713-45c922ba8001/serviceManagementDetails
+```
+
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.delegatedAdminServiceManagementDetail)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#delegatedAdminCustomers/4fdbff88-9d6b-42e0-9713-45c922ba8001/serviceManagementDetails",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminServiceManagementDetail",
+ "id": "fa5fa04e-13df-4b7c-9e99-92573ba1fa55",
+ "serviceManagementUrl": "https://aad.portal.azure.com/contoso.onmicrosoft.com",
+ "serviceName": "Azure Active Directory"
+ },
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminServiceManagementDetail",
+ "id": "5d0273c3-0f0e-4e00-90e8-e792c8860fb5",
+ "serviceManagementUrl": "https://lighthouse.microsoft.com",
+ "serviceName": "Microsoft 365 Lighthouse"
+ },
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminServiceManagementDetail",
+ "id": "2b565abc-b0de-4974-97c0-bed0abb14a0f",
+ "serviceManagementUrl": "https://businesscentral.dynamics.com/55beae45-27a6-4e7a-8c7c-2eae70816cfa/admin",
+ "serviceName": "Dynamics 365 Business Central"
+ },
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminServiceManagementDetail",
+ "id": "ce0b42f4-bfde-4abe-a5f7-add83f104b23",
+ "serviceManagementUrl": "https://admin.teams.microsoft.com/?delegatedOrg=contoso.onmicrosoft.com",
+ "serviceName": "Teams"
+ }
+ ]
+}
+```
+
v1.0 Delegatedadminrelationship Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-delete.md
+
+ Title: "Delete delegatedAdminRelationship"
+description: "Deletes a delegatedAdminRelationship object."
+
+ms.localizationpriority: medium
++
+# Delete delegatedAdminRelationship
+Namespace: microsoft.graph
++
+Delete a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object. A relationship can only be deleted if it's in the "created" status.
+
+## 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)| DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+DELETE /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|If-Match|If-match: {etag}. Last known ETag value for the **delegatedAdminRelationship** to be deleted. Retrieve the ETag value from a LIST or GET operation. 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
+<!-- {
+ "blockType": "request",
+ "name": "delete_delegatedadminrelationship"
+}
+-->
+``` http
+DELETE https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836
+If-Match: W/"JyI0NzAwNjg0NS0wMDAwLTE5MDAtMDAwMC02MGY0Yjg4MzAwMDAiJw=="
+```
++
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 204 No Content
+```
+
v1.0 Delegatedadminrelationship Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-get.md
+
+ Title: "Get delegatedAdminRelationship"
+description: "Read the properties of a delegatedAdminRelationship object."
+
+ms.localizationpriority: medium
++
+# Get delegatedAdminRelationship
+Namespace: microsoft.graph
++
+Read the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to retrieve specific user properties, including those that are not returned by default.
+
+## 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 [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object in the response body.
+
+The **delegatedAdminRelationship** object also contains an **@odata.etag** property as per RFC2616.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_delegatedadminrelationship"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminRelationship"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationship",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#delegatedAdminRelationships/$entity",
+ "@odata.etag": "W/\"JyIxODAwZTY4My0wMDAwLTAyMDAtMDAwMC02MTU0OWFmMDAwMDAiJw==\"",
+ "id": "5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836",
+ "displayName": "Contoso admin relationship",
+ "duration": "P730D",
+ "customer": {
+ "tenantId": "4fdbff88-9d6b-42e0-9713-45c922ba8001",
+ "displayName": "Contoso Inc"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8"
+ },
+ {
+ "roleDefinitionId": "fe930be7-5e62-47db-91af-98c3a49a38b1"
+ },
+ {
+ "roleDefinitionId": "e6d1a23a-da11-4be4-9570-befc86d067a7"
+ }
+ ]
+ },
+ "status": "active",
+ "createdDateTime": "2022-02-10T11:24:42.3148266Z",
+ "lastModifiedDateTime": "2022-02-10T11:26:44.9941884Z",
+ "activatedDateTime": "2022-02-10T11:26:44.9941884Z",
+ "endDateTime": "2024-02-10T11:24:42.3148266Z"
+}
+```
+
v1.0 Delegatedadminrelationship List Accessassignments https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-list-accessassignments.md
+
+ Title: "List accessAssignments"
+description: "Get a list of the delegatedAdminAccessAssignment objects and their properties."
+
+ms.localizationpriority: medium
++
+# List accessAssignments
+Namespace: microsoft.graph
++
+Get a list of the [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/accessAssignments
+```
+
+## Optional query parameters
+This method supports the `$select`, `$filter`, `$top`, `$orderBy`, `$count`, and `$skipToken` [OData query parameters](/graph/query-parameters) to help customize the response.
+
+`$top` supports up to 300 objects.
+
+## 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 [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.md) objects in the response body.
+
+Each **delegatedAdminAccessAssignment** object contains an **@odata.etag** property as per RFC2616.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "list_delegatedadminaccessassignment"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/72a7ae7e-4887-4e34-9755-2e1e9b26b943-63f017cb-9e0d-4f14-94bd-4871902b3409/accessAssignments
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.delegatedAdminAccessAssignment)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#accessAssignments",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminAccessAssignment",
+ "@odata.etag": "W/\"JyIwMDAwMDI5OC0wMDAwLTAyMDAtMDAwMC02MjJiZTA0YjAwMDAiJw==\"",
+ "id": "84c586df-0943-416e-b95f-7289cb8d3bd5",
+ "status": "active",
+ "createdDateTime": "2022-03-07T22:55:18.6780449Z",
+ "lastModifiedDateTime": "2022-03-11T23:50:35.8970153Z",
+ "accessContainer": {
+ "accessContainerId": "227a2f44-2682-4831-a021-f8d69a34bcba",
+ "accessContainerType": "securityGroup"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
+ },
+ {
+ "roleDefinitionId": "44367163-eba1-44c3-98af-f5787879f96a"
+ },
+ {
+ "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de"
+ },
+ {
+ "roleDefinitionId": "62e90394-69f5-4237-9190-012177145e10"
+ }
+ ]
+ }
+ },
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminAccessAssignment",
+ "@odata.etag": "W/\"JyIwMDAwMjAwOC0wMDAwLTAyMDAtMDAwMC02MjJhYWQzYjAwMDAiJw==\"",
+ "id": "8d56bce3-440f-4b4f-b5c2-cc0bcbd0199c",
+ "status": "active",
+ "createdDateTime": "2022-03-10T23:50:35.8970153Z",
+ "lastModifiedDateTime": "2022-03-11T02:00:27.7912161Z",
+ "accessContainer": {
+ "accessContainerId": "869713c9-0b28-4d08-8949-ae07ae1bf528",
+ "accessContainerType": "securityGroup"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de"
+ },
+ {
+ "roleDefinitionId": "f2ef992c-3afb-46b9-b7cf-a126ee74c451"
+ },
+ {
+ "roleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8"
+ },
+ {
+ "roleDefinitionId": "3a2c62db-5318-420d-8d74-23affee5d9d5"
+ }
+ ]
+ }
+ }
+ ]
+}
+```
+
v1.0 Delegatedadminrelationship List Operations https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-list-operations.md
+
+ Title: "List operations"
+description: "Get a list of the delegatedAdminRelationshipOperation objects and their properties."
+
+ms.localizationpriority: medium
++
+# List operations
+Namespace: microsoft.graph
++
+Get a list of the [delegatedAdminRelationshipOperation](../resources/delegatedadminrelationshipoperation.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/operations
+```
+
+## Optional query parameters
+This method supports the `$expand`, `$select`, `$filter`, `$top`, `$count`, and `$skipToken` [OData query parameters](/graph/query-parameters) to help customize the response.
+
+`$top` supports up to 300 objects.
+
+## 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 [delegatedAdminRelationshipOperation](../resources/delegatedadminrelationshipoperation.md) objects in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "list_delegatedadminrelationshipoperation"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836/operations
+```
+
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.delegatedAdminRelationshipOperation)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#operations",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationshipOperation",
+ "@odata.etag": "W/\"JyIwMzAwZTM0ZS0wMDAwLTAyMDAtMDAwMC02MTRjZjI1YzAwMDAiJw==\"",
+ "id": "e7de9158-df46-478e-820c-d6eff099d27b",
+ "operationType": "delegatedAdminAccessAssignmentUpdate",
+ "data": "{\"id\":\"a97a9b4c-f43e-4c47-bbd6-50d8d3c88d94\",\"accessContainer\":{\"accessContainerId\":\"11cc3849-c298-455f-9a11-b7be350ef352\",\"accessContainerType\":\"securityGroup\"},\"accessDetails\":{\"unifiedRoles\":[{\"roleDefinitionId\":\"f2ef992c-3afb-46b9-b7cf-a126ee74c451\"},{\"roleDefinitionId\":\"62e90394-69f5-4237-9190-012177145e10\"}]},\"status\":\"active\"}",
+ "status": "complete",
+ "createdDateTime": "2022-02-09T22:17:43.9821847Z",
+ "lastModifiedDateTime": "2022-02-09T22:17:43.9821847Z"
+ },
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationshipOperation",
+ "@odata.etag": "W/\"JyIwMzAwZTM0ZS0wMKMh5TAyMDAtMDAwMC02MTRjZjI1YzAwMDAiJw==\"",
+ "id": "f7a7dad4-8cc4-40d7-be44-dd3501b1f4e0",
+ "operationType": "delegatedAdminAccessAssignmentUpdate",
+ "data": "{\"id\":\"a97a9b4c-f43e-4c47-bbd6-50d8d3c88d94\",\"accessContainer\":{\"accessContainerId\":\"8d56bce3-440f-4b4f-b5c2-cc0bcbd0199c\",\"accessContainerType\":\"securityGroup\"},\"accessDetails\":{\"unifiedRoles\":[{\"roleDefinitionId\":\"29232cdf-9323-42fd-ade2-1d097af3e4de\"},{\"roleDefinitionId\":\"88d8e3e3-8f55-4a1e-953a-9b9898b8876b\"}]},\"status\":\"active\"}",
+ "status": "complete",
+ "createdDateTime": "2022-02-11T20:32:05.4659288Z",
+ "lastModifiedDateTime": "2022-02-11T20:34:42.9202474Z"
+ }
+ ]
+}
+```
+
v1.0 Delegatedadminrelationship List Requests https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-list-requests.md
+
+ Title: "List requests"
+description: "Get a list of the delegatedAdminRelationshipRequest objects and their properties."
+
+ms.localizationpriority: medium
++
+# List requests
+Namespace: microsoft.graph
++
+Get a list of the [delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/requests
+```
+
+## Optional query parameters
+This method supports the `$expand`, `$select`, `$filter`, `$top`, `$count`, and `$skipToken` [OData query parameters](/graph/query-parameters) to help customize the response.
+
+## 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 [delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.md) objects in the response body.
+
+Each **delegatedAdminRelationshipRequest** object contains an **@odata.etag** property as per RFC2616.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "list_delegatedadminrelationshiprequest"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836/requests
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "Collection(microsoft.graph.delegatedAdminRelationshipRequest)"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#requests",
+ "value": [
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationshipRequest",
+ "@odata.etag": "W/\"JyIxODAwZTY4My0wMDAwLTAyMDAtMDAwMC02MTU0OWFmMDAwMDAiJw==\"",
+ "id": "ae5a6b9e-6355-43dd-b708-48486b69c3ff",
+ "action": "lockForApproval",
+ "status": "complete",
+ "createdDateTime": "2022-02-01T06:14:55.5398865Z",
+ "lastModifiedDateTime": "2022-02-01T06:14:55.5398865Z"
+ },
+ {
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationshipRequest",
+ "@odata.etag": "W/\"JyIxODAwZTY4My0wMDAwLTAyMDAtMDAwMC02MTU0OWFmMDAwMDAiJw==\"",
+ "id": "8a1b6676-5c12-47ba-8d3a-1d38387b0909",
+ "action": "terminate",
+ "status": "running",
+ "createdDateTime": "2022-03-02T06:11:55.5398865Z",
+ "lastModifiedDateTime": "2022-03-02T06:11:55.5398865Z"
+ }
+ ]
+}
+```
+
v1.0 Delegatedadminrelationship Post Accessassignments https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-post-accessassignments.md
+
+ Title: "Create accessAssignments"
+description: "Create a new delegatedAdminAccessAssignment object."
+
+ms.localizationpriority: medium
++
+# Create accessAssignments
+Namespace: microsoft.graph
++
+Create a new [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.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)| DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/accessAssignments
+```
+
+## 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 [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.md) object.
+
+You can specify the following properties when creating a **delegatedAdminAccessAssignment**.
+
+|Property|Type|Description|
+|:|:|:|
+|accessContainer|[delegatedAdminAccessContainer](../resources/delegatedadminaccesscontainer.md)|The access container through which members are assigned access. For example, a security group.|
+|accessDetails|[delegatedAdminAccessDetails](../resources/delegatedadminaccessdetails.md)|The identifiers of the administrative roles that the partner is assigned in the customer tenant.|
++
+## Response
+
+If successful, this method returns a `201 Created` response code and a [delegatedAdminAccessAssignment](../resources/delegatedadminaccessassignment.md) object in the response body. A **Location** header in the response points to the created **delegatedAdminAccessAssignment** object.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "create_delegatedadminaccessassignment_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/72a7ae7e-4887-4e34-9755-2e1e9b26b943-63f017cb-9e0d-4f14-94bd-4871902b3409/accessAssignments
+Content-Type: application/json
+
+{
+ "accessContainer": {
+ "accessContainerId": "869713c9-0b28-4d08-8949-ae07ae1bf528",
+ "accessContainerType": "securityGroup"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de"
+ },
+ {
+ "roleDefinitionId": "f2ef992c-3afb-46b9-b7cf-a126ee74c451"
+ },
+ {
+ "roleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8"
+ },
+ {
+ "roleDefinitionId": "3a2c62db-5318-420d-8d74-23affee5d9d5"
+ }
+ ]
+ }
+}
+```
++
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminAccessAssignment"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+Location: https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/72a7ae7e-4887-4e34-9755-2e1e9b26b943-63f017cb-9e0d-4f14-94bd-4871902b3409/accessAssignments/a9d6cf90-083a-47dc-ace2-1da98be3f344
+
+{
+
+ "@odata.type": "#microsoft.graph.delegatedAdminAccessAssignment",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#accessAssignments",
+ "@odata.etag": "W/\"JyIxODAwZTY4My0wMDAwLTAyMDAtMDAwMC02MTU0OWFmMDAwMDAiJw==\"",
+ "id": "a9d6cf90-083a-47dc-ace2-1da98be3f344",
+ "status": "pending",
+ "createdDateTime": "2022-02-13T10:33:52.3182097Z",
+ "lastModifiedDateTime": "2022-02-13T10:33:52.3182097Z",
+ "accessContainer": {
+ "accessContainerId": "869713c9-0b28-4d08-8949-ae07ae1bf528",
+ "accessContainerType": "securityGroup"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de"
+ },
+ {
+ "roleDefinitionId": "f2ef992c-3afb-46b9-b7cf-a126ee74c451"
+ },
+ {
+ "roleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8"
+ },
+ {
+ "roleDefinitionId": "3a2c62db-5318-420d-8d74-23affee5d9d5"
+ }
+ ]
+ }
+}
+```
+
v1.0 Delegatedadminrelationship Post Requests https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-post-requests.md
+
+ Title: "Create requests"
+description: "Create a new delegatedAdminRelationshipRequest object."
+
+ms.localizationpriority: medium
++
+# Create requests
+Namespace: microsoft.graph
++
+Create a new [delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.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)| DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/requests
+```
+
+## 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 [delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.md) object.
+
+You can specify the following properties when creating a **delegatedAdminRelationshipRequest**.
+
+|Property|Type|Description|
+|:|:|:|
+|action|delegatedAdminRelationshipRequestAction|The action to be performed on the delegated admin relationship. Required. The possible values are: `lockForApproval`, `terminate`.|
+
+## Response
+
+If successful, this method returns a `201 Created` response code and a [delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.md) object in the response body. The response contains a **Location** header which contains a URL to the created delegated admin relationship request.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "create_delegatedadminrelationshiprequest_from_"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836/requests
+Content-Type: application/json
+
+{
+ "action": "lockForApproval"
+}
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminRelationshipRequest"
+}
+-->
+``` http
+HTTP/1.1 201 Created
+Content-Type: application/json
+Location: https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/c45e5ffb-3de2-4938-a214-b7eed802db66-4be56058-bb48-4a8e-8282-6cf0e98e6c9d/requests/5a6666c9-7282-0a41-67aa-25a5a3fbf339
+
+{
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationshipRequest",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#requests",
+ "id": "5a6666c9-7282-0a41-67aa-25a5a3fbf339",
+ "action": "lockForApproval",
+ "status": "created",
+ "createdDateTime": "2022-02-10T10:55:47.1180588Z",
+ "lastModifiedDateTime": "2022-02-10T10:55:47.1180588Z"
+}
+```
+
v1.0 Delegatedadminrelationship Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationship-update.md
+
+ Title: "Update delegatedAdminRelationship"
+description: "Update the properties of a delegatedAdminRelationship object."
+
+ms.localizationpriority: medium
++
+# Update delegatedAdminRelationship
+Namespace: microsoft.graph
++
+Update the properties of a [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object. A relationship can only be updated if it's in the `created` **status**.
+
+## 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)| DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+PATCH /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}
+```
+
+## Request headers
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+|If-Match|If-match: {etag}. Last known ETag value for the **delegatedAdminRelationship** to be updated. Retrieve the ETag value from a LIST or GET operation. Required.|
+|Content-Type|application/json. Required.|
+
+## Request body
++
+|Property|Type|Description|
+|:|:|:|
+|accessDetails|[microsoft.graph.delegatedAdminAccessDetails](../resources/delegatedadminaccessdetails.md)|The identifiers of the administrative roles that the partner requests or has access to in the customer tenant.|
+|customer|[microsoft.graph.delegatedAdminRelationshipCustomerParticipant](../resources/delegatedadminrelationshipcustomerparticipant.md)|The display name and unique identifier of the customer of the relationship.|
+|displayName|String|The display name of the relationship used for ease of identification. Must be unique across *all* delegated admin relationships of the partner.|
+|duration|Duration|The duration of the relationship in ISO 8601 format. Must be a value between `P1D` and `P2Y` inclusive.|
++
+## Response
+
+If successful, this method returns a `200 OK` response code and an updated [delegatedAdminRelationship](../resources/delegatedadminrelationship.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "update_delegatedadminrelationship"
+}
+-->
+``` http
+PATCH https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836
+If-Match: W/"JyI0NzAwNjg0NS0wMDAwLTE5MDAtMDAwMC02MGY0Yjg4MzAwMDAiJw=="
+Content-Type: application/json
+
+{
+ "displayName": "Updated Contoso admin relationship",
+ "duration": "P31D",
+ "customer": {
+ "tenantId": "52eaad04-13a2-4a2f-9ce8-93a294fadf36"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "44367163-eba1-44c3-98af-f5787879f96a"
+ },
+ {
+ "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de"
+ },
+ {
+ "roleDefinitionId": "69091246-20e8-4a56-aa4d-066075b2a7a8"
+ },
+ {
+ "roleDefinitionId": "3a2c62db-5318-420d-8d74-23affee5d9d5"
+ }
+ ]
+ }
+}
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminRelationship"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationship",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#delegatedAdminRelationships/$entity",
+ "@odata.etag": "W/\"JyIwMzAwZTM0ZS0wMDAwLTAyMDAtMDAwMC02MTRjZjI1YzAwMDAiJw==\"",
+ "id": "5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836",
+ "displayName": "Updated Contoso admin relationship",
+ "duration": "P31D",
+ "status": "created",
+ "createdDateTime": "2022-02-10T11:24:42.3148266Z",
+ "lastModifiedDateTime": "2022-02-10T11:26:44.9941884Z",
+ "customer": {
+ "tenantId": "52eaad04-13a2-4a2f-9ce8-93a294fadf36"
+ },
+ "accessDetails": {
+ "unifiedRoles": [
+ {
+ "roleDefinitionId": "44367163-eba1-44c3-98af-f5787879f96a"
+ },
+ {
+ "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de"
+ },
+ {
+ "roleDefinitionId": "69091246-20e8-4a56-aa4d-066075b2a7a8"
+ },
+ {
+ "roleDefinitionId": "3a2c62db-5318-420d-8d74-23affee5d9d5"
+ }
+ ]
+ }
+}
+```
+
v1.0 Delegatedadminrelationshipoperation Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationshipoperation-get.md
+
+ Title: "Get delegatedAdminRelationshipOperation"
+description: "Read the properties of a delegatedAdminRelationshipOperation object."
+
+ms.localizationpriority: medium
++
+# Get delegatedAdminRelationshipOperation
+Namespace: microsoft.graph
++
+Read the properties of a [delegatedAdminRelationshipOperation](../resources/delegatedadminrelationshipoperation.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/operations/{delegatedAdminRelationshipOperationId}
+```
+
+## Optional query parameters
+This method supports the $select OData query parameter to retrieve specific user properties, including those that are not returned by default.
+
+## 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 [delegatedAdminRelationshipOperation](../resources/delegatedadminrelationshipoperation.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_delegatedadminrelationshipoperation"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836/operations/57e4479a-aafb-4d00-ab0f-8ce6027466cf
+```
++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminRelationshipOperation"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationshipOperation",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#operations/$entity",
+ "@odata.etag": "W/\"JyIwMzAwZTM0ZS0wMDAwLTAyMDAtMDAwMC02MTRjZjI1YzAwMDAiJw==\"",
+ "id": "57e4479a-aafb-4d00-ab0f-8ce6027466cf",
+ "operationType": "delegatedAdminAccessAssignmentUpdate",
+ "data": "{\"id\":\"a97a9b4c-f43e-4c47-bbd6-50d8d3c88d94\",\"accessContainer\":{\"accessContainerId\":\"869713c9-0b28-4d08-8949-ae07ae1bf528\",\"accessContainerType\":\"securityGroup\"},\"accessDetails\":{\"unifiedRoles\":[{\"roleDefinitionId\":\"e3973bdf-4987-49ae-837a-ba8e231c7286\"}]},\"status\":\"active\"}",
+ "status": "complete",
+ "createdDateTime": "2022-02-11T19:27:31.4047395Z",
+ "lastModifiedDateTime": "2022-02-11T19:27:31.4047395Z"
+}
+```
+
v1.0 Delegatedadminrelationshiprequest Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/delegatedadminrelationshiprequest-get.md
+
+ Title: "Get delegatedAdminRelationshipRequest"
+description: "Read the properties and relationships of a delegatedAdminRelationshipRequest object."
+
+ms.localizationpriority: medium
++
+# Get delegatedAdminRelationshipRequest
+Namespace: microsoft.graph
++
+Read the properties and relationships of a [delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.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)| DelegatedAdminRelationship.Read.All, DelegatedAdminRelationship.ReadWrite.All |
+|Delegated (personal Microsoft account)| Not supported. |
+|Application| Not supported. |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /tenantRelationships/delegatedAdminRelationships/{delegatedAdminRelationshipId}/requests/{delegatedAdminRelationshipRequestId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter to retrieve specific user properties, including those that are not returned by default.
+
+## 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 [delegatedAdminRelationshipRequest](../resources/delegatedadminrelationshiprequest.md) object in the response body.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "get_delegatedadminrelationshiprequest"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/tenantRelationships/delegatedAdminRelationships/5d027261-d21f-4aa9-b7db-7fa1f56fb163-8777b240-c6f0-4469-9e98-a3205431b836/requests/cf4a23c7-070c-4d1c-8be8-1e86085ac9d1
+```
+
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.delegatedAdminRelationshipRequest"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.type": "#microsoft.graph.delegatedAdminRelationshipRequest",
+ "@odata.context": "https://graph.microsoft.com/beta/tenantRelationships/$metadata#requests/$entity",
+ "@odata.etag": "W/\"JyIxODAwZTY4My0wMDAwLTAyMDAtMDAwMC02MTU0OWFmMDAwMDAiJw==\"",
+ "id": "cf4a23c7-070c-4d1c-8be8-1e86085ac9d1",
+ "action": "lockForApproval",
+ "status": "created",
+ "createdDateTime": "2022-02-10T10:55:47.1180588Z",
+ "lastModifiedDateTime": "2022-02-10T11:26:44.9941884Z"
+}
+```
+
v1.0 Device Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Device List Memberof https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-list-memberof.md
Title: "List device groups"
-description: "Get groups that this device is a direct member of. This operation is not transitive."
+ Title: "List memberOf"
+description: "Get groups or administrative units that this device is a direct member of. This operation is not transitive."
ms.localizationpriority: medium ms.prod: "directory-management" doc_type: apiPageType
-# List device groups
+# List memberOf
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get groups that this device is a direct member of. This operation is not transitive.
+Get [groups](../resources/group.md) and [administrative units](../resources/administrativeunit.md) that the device is a direct member of. This operation is not transitive.
## Permissions
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
This method supports the `$search`, `$count`, and `$filter` [OData query paramet
Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
-When items are added or updated for this resource, they are specially indexed for use with the `$count` and `$search` query parameters. There can be a slight delay between when an item is added or updated and when it is available in the index.
- ## Request headers | Header | Value | |:|:--|
Content-type: application/json
The following is an example of the request. <!-- {
- "blockType": "ignored",
- "name": "get_a_count"
+ "blockType": "request",
+ "name": "list_devices_memberof_startswith"
}--> ```msgraph-interactive GET https://graph.microsoft.com/beta/devices/{id}/memberOf/microsoft.graph.group?$count=true&$orderBy=displayName&$filter=startswith(displayName, 'A')
v1.0 Device List Registeredowners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-list-registeredowners.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Device List Registeredusers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-list-registeredusers.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Device List Transitivememberof https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-list-transitivememberof.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Content-type: application/json
The following is an example of the request. <!-- {
- "blockType": "ignored",
- "name": "get_a_count"
+ "blockType": "request",
+ "name": "list_devices_transitivememberof_startswith"
}--> ```msgraph-interactive GET https://graph.microsoft.com/beta/devices/{id}/transitiveMemberOf/microsoft.graph.group?$count=true&$orderBy=displayName&$filter=startswith(displayName, 'a')
v1.0 Device List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-list.md
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |: |:- |
-| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
GET https://graph.microsoft.com/beta/devices?$select=id,extensionAttributes
#### Response The following is an example of the response.-
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.device"
+} -->
```http HTTP/1.1 200 OK Content-type: application/json
The following is an example of the request. This request requires the **Consiste
>**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants. <!-- {
- "blockType": "ignored",
- "name": "get_a_count"
+ "blockType": "request",
+ "name": "list_devices_startswith"
}--> ```msgraph-interactive GET https://graph.microsoft.com/beta/devices?$filter=startswith(displayName, 'a')&$count=true&$top=1&$orderby=displayName
v1.0 Device Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/device-update.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Device.ReadWrite.All, Directory.ReadWrite.All |
v1.0 Directory Deleteditems Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directory-deleteditems-delete.md
For applications:
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All |
For users:
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | User.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | User.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
For groups:
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Group.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Group.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Not supported. |
v1.0 Directory Deleteditems Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directory-deleteditems-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.Read.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All, Directory.Read.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Group.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Directory Deleteditems List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directory-deleteditems-list.md
Title: "List deleted items"
+ Title: "List deletedItems (directory objects)"
description: "Retrieve a list of recently deleted items from deleted items." ms.localizationpriority: medium
ms.prod: "directory-management"
doc_type: apiPageType
-# List deleted items
+# List deletedItems (directory objects)
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve a list of recently deleted items from [deleted items](../resources/directory.md).
-
-Currently, deleted items functionality is only supported for the [application](../resources/application.md), [group](../resources/group.md), and [user](../resources/user.md) resources.
+Retrieve a list of recently deleted directory objects. Currently, this functionality is only supported for the [application](../resources/application.md), [group](../resources/group.md), and [user](../resources/user.md) resources.
>**Note:** Deleted security groups are deleted permanently and can't be retrieved through this API.
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Application.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Application.ReadWrite.All, Directory.Read.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All, Directory.Read.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Group.Read.All, Group.ReadWrite.All, Directory.Read.All |
v1.0 Directory Deleteditems Restore https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directory-deleteditems-restore.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.ReadWrite.All, Application.ReadWrite.OwnedBy |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | User.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | User.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | User.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Group.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Group.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Group.ReadWrite.All |
v1.0 Directory List Administrativeunits https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directory-list-administrativeunits.md
+
+ Title: "List administrativeUnits"
+description: "Retrieve a list of administrativeUnit objects."
+
+ms.localizationpriority: medium
++
+# List administrativeUnits
+
+Namespace: microsoft.graph
++
+Retrieve a list of [administrativeUnit](../resources/administrativeunit.md) objects.
+## 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) | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | AdministrativeUnit.Read.All, Directory.Read.All, AdministrativeUnit.ReadWrite.All, Directory.ReadWrite.All |
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+GET /administrativeUnits
+GET /directory/administrativeUnits
+```
+## Optional query parameters
+This method supports the `$count`, `$select`, `$search`, `$filter`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response.
++
+## 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 collection of [administrativeUnit](../resources/administrativeunit.md) objects in the response body.
+## Example
+### Request
+Here is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_administrativeunits"
+}-->
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/administrativeUnits
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++
+### Response
+Here is an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.administrativeUnit",
+ "isCollection": true
+} -->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#administrativeUnits",
+ "value": [
+ {
+ "id": "4d7ea995-bc0f-45c0-8c3e-132e93bf95f8",
+ "deletedDateTime": null,
+ "displayName": "Seattle District Technical Schools",
+ "description": "Seattle district technical schools administration",
+ "isMemberManagementRestricted": null,
+ "visibility": "HiddenMembership",
+ "membershipRule": null,
+ "membershipType": null,
+ "membershipRuleProcessingState": null
+ }
+ ]
+}
+```
+
+<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "List administrativeUnits",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ ]
+}
+-->
v1.0 Directory Post Administrativeunits https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directory-post-administrativeunits.md
+
+ Title: "Create administrativeUnit"
+description: "Use this API to create a new administrativeUnit."
+
+ms.localizationpriority: medium
++
+# Create administrativeUnit
+
+Namespace: microsoft.graph
++
+Use this API to create a new [administrativeUnit](../resources/administrativeunit.md).
+## 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) | AdministrativeUnit.ReadWrite.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | AdministrativeUnit.ReadWrite.All |
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+```http
+POST /administrativeUnits
+POST /directory/administrativeUnits
+```
+## Request headers
+| Name |Description|
+|:-|:-|
+| Authorization | Bearer {token}. Required. |
+| Content-type | application/json. Required. |
+
+## Request body
+In the request body, supply a JSON representation of an [administrativeUnit](../resources/administrativeunit.md) object.
+
+Because the **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), you can use the `POST` operation and add custom properties with your own data to the administrative unit while creating it.
+
+## Response
+
+If successful, this method returns a `201 Created` response code and an [administrativeUnit](../resources/administrativeunit.md) object in the response body.
+
+## Example
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_administrativeunit_from_administrativeunits"
+}-->
+```http
+POST https://graph.microsoft.com/beta/administrativeUnits
+Content-type: application/json
+
+{
+ "displayName": "Seattle District Technical Schools",
+ "description": "Seattle district technical schools administration",
+ "visibility": "HiddenMembership"
+}
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++
+In the request body, supply a JSON representation of an [administrativeUnit](../resources/administrativeunit.md) object.
+
+### Response
+
+The following is an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.administrativeUnit"
+} -->
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#administrativeUnits/$entity",
+ "id": "7a3dc8f3-b3a0-4164-9a99-ed36f3af039f",
+ "deletedDateTime": null,
+ "displayName": "Seattle District Technical Schools",
+ "description": "Seattle district technical schools administration",
+ "visibility": "HiddenMembership"
+}
+```
+
+## See also
+
+- [Add custom data to resources using extensions](/graph/extensibility-overview)
+- [Add custom data to users using open extensions (preview)](/graph/extensibility-open-users)
+<!--
+- [Add custom data to groups using schema extensions (preview)](/graph/extensibility-schema-groups)
+-->
++
+<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "Create administrativeUnit",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ ]
+}
+-->
++
v1.0 Directoryobject Checkmembergroups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-checkmembergroups.md
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |:-|:-|
-| Delegated (work or school account) | User.ReadBasic.All, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | User.ReadBasic.All, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |:-|:-|
-| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
v1.0 Directoryobject Checkmemberobjects https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-checkmemberobjects.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | User.Read, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | User.Read, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | | :- | : |
-| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |:|:--|
-| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Directoryobject Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-delete.md
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Delete directoryObject.
+Delete a directory object, for example, a group, user, application, or service principal.
+ ## 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).
+### Delete a user
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.AccessAsUser.All |
+|Delegated (work or school account) | User.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+|Application | User.ReadWrite.All |
+
+### Delete a group
+
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.ReadWrite.All |
+
+### Delete an application or service principal
-**NOTE:** Users, groups, and contacts are types of directory object. As a result,if you need to delete users, the following permission can and should be used: User.ReadWrite.All
+|Permission type | Permissions (from least to most privileged) |
+|:--|:|
+|Delegated (work or school account) | Application.ReadWrite.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | Application.ReadWrite.All |
## HTTP request
v1.0 Directoryobject Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All |
v1.0 Directoryobject Getmembergroups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-getmembergroups.md
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | | :- | : |
-| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |:|:--|
-| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Directoryobject Getmemberobjects https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-getmemberobjects.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | User.Read, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | User.Read, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | | :- | : |
-| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
One of the following permissions is required to call this API. To learn more, in
| Permission type | Permissions (from least to most privileged) | |:|:--|
-| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+| Delegated (work or school account) | Device.Read.All, Directory.Read.All, Directory.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | | Application | Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Directoryobject Validateproperties https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryobject-validateproperties.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Group.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Group.Read.All, Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Group.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
v1.0 Directoryrole Delete Member https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-delete-member.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.ReadWrite.Directory, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.ReadWrite.Directory |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.ReadWrite.Directory |
v1.0 Directoryrole Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-delta.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Directoryrole Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Directoryrole List Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-list-members.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Directoryrole List Scopedmembers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-list-scopedmembers.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Directoryrole List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-list.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Directoryrole Post Directoryroles https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-post-directoryroles.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.ReadWrite.Directory, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.ReadWrite.Directory |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.ReadWrite.Directory |
v1.0 Directoryrole Post Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryrole-post-members.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.ReadWrite.Directory, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.ReadWrite.Directory |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.ReadWrite.Directory |
v1.0 Directoryroletemplate Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryroletemplate-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Directoryroletemplate List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directoryroletemplate-list.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All |
v1.0 Directorysetting Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directorysetting-delete.md
Title: "Delete a directory setting"
+ Title: "Delete directorySetting"
description: "Delete a directory setting." ms.localizationpriority: medium
ms.prod: "directory-management"
doc_type: apiPageType
-# Delete a directory setting
+# Delete directorySetting
Namespace: microsoft.graph
Namespace: microsoft.graph
Delete a directory setting.
-> **Note**: The /beta version of this API only applies to groups. The /v1.0 version of this API has been renamed to *Delete groupSettings*.
- ## 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) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.ReadWrite.All | ## HTTP request <!-- { "blockType": "ignored" } -->
-Delete a specific tenant-wide or group setting
+Delete a tenant-wide setting.
```http
-DELETE /settings/{id}
-DELETE /groups/{id}/settings/{id}
+DELETE /settings/{directorySettingId}
+```
+<!-- { "blockType": "ignored" } -->
+Delete a group-specific setting.
+```http
+DELETE /groups/{groupId}/settings/{directorySettingId}
```+ ## Request headers | Name | Description| |:|:-|
Do not supply a request body for this method.
If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example
-##### Request
+### Request
Here is an example of the request. # [HTTP](#tab/http)
Here is an example of the request.
"blockType": "request", "name": "delete_directorysetting" }-->
-```http
-DELETE https://graph.microsoft.com/beta/settings/{id}
+```msgraph-interactive
+DELETE https://graph.microsoft.com/beta/settings/3c105fc3-2254-4861-9e2d-d59e2126f3ef
``` # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/delete-directorysetting-csharp-snippets.md)]
DELETE https://graph.microsoft.com/beta/settings/{id}
-##### Response
+### Response
<!-- { "blockType": "response", "truncated": true
v1.0 Directorysetting Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directorysetting-get.md
Title: "Get a directory setting"
+ Title: "Get directorySetting"
description: "Retrieve the properties of a specific directory setting object." ms.localizationpriority: medium
ms.prod: "directory-management"
doc_type: apiPageType
-# Get a directory setting
+# Get directorySetting
Namespace: microsoft.graph
Namespace: microsoft.graph
Retrieve the properties of a specific directory setting object.
-> **Note**: The /beta version of this API only applies to groups. The /v1.0 version of this API has been renamed to *Get groupSettings*.
- ## 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). +
+### List tenant-wide settings
+ |Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
+### List group-specific settings
+
+|Permission type | Permissions (from least to most privileged) |
+|:--|:|
+|Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | Group.Read.All, Group.ReadWrite.All |
++ ## HTTP request+
+<!-- { "blockType": "ignored" } -->
+
+Get a tenant-wide setting.
+
+```http
+GET /settings/{directorySettingId}
+```
+ <!-- { "blockType": "ignored" } -->
-Get a specific tenant-wide or group setting
+Get a group-specific setting.
```http
-GET /settings/{id}
-GET /groups/{id}/settings/{id}
+GET /groups/{groupId}/settings/{directorySettingId}
```+ ## Optional query parameters
-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
+This method supports the `$select` [OData query parameters](/graph/query-parameters) to help customize the response.
## Request headers | Name |Description|
GET https://graph.microsoft.com/beta/settings/f0b2d6f5-097d-4177-91af-a24e530b53
-##### Response
+### Response
The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- {
v1.0 Directorysetting Post Settings https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directorysetting-post-settings.md
- Title: "Create a directory setting"
-description: "Use this API to create a new setting, based on the templates available in directorySettingTemplates."
-
-doc_type: apiPageType
--
-# Create a directory setting
-
-Namespace: microsoft.graph
--
-Use this API to create a new setting, based on the templates available in directorySettingTemplates. These settings can be at the tenant-level or at an object level (currently only for groups). The creation request must provide settingValues for all the settings defined in the template. For group-specific settings, only the setting governing whether members of a group can invite guest users can be set. This will govern this behavior once the ability to add guest users to a group is generally available.
-
-> **Note**: The /beta version of this API only applies to groups. The /v1.0 version of this API has been renamed to *Create groupSettings*.
-
-For a list of templates and the properties they support in beta, use a [directorySettingTemplate query](https://developer.microsoft.com/graph/graph-explorer?request=directorySettingTemplates&version=beta). (For v1.0 endpoints, call [groupSettingTemplates](https://developer.microsoft.com/graph/graph-explorer?request=groupSettingTemplates&version=v1.0).)
--
-## 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) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Directory.ReadWrite.All |
-
-## HTTP request
-<!-- { "blockType": "ignored" } -->
-```http
-POST /settings
-POST /groups/{id}/settings
-```
-## Request headers
-| Name | Description|
-|:|:-|
-| Authorization | Bearer {token}. Required.|
-
-## Request body
-In the request body, supply a JSON representation of [directorySetting](../resources/directorysetting.md) object. However, the display name for the setting will be set based on the referenced settings template name.
-
-## Response
-
-If successful, this method returns `201 Created` response code and [directorySetting](../resources/directorysetting.md) object in the response body.
-
-## Example 1: Create a new setting for all Microsoft 365 groups in the tenant
-
-### Request
-The following is an example of the request.
--
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "create_directorysetting_from_settings"
-}-->
-```http
-POST https://graph.microsoft.com/beta/settings
-Content-type: application/json
-
-{
- "displayName": "Group.Unified",
- "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
- "values": [
- {
- "name": "GuestUsageGuidelinesUrl",
- "value": "https://privacy.contoso.com/privacystatement"
- },
- {
- "name": "EnableMSStandardBlockedWords",
- "value": "true"
- },
- {
- "name": "EnableMIPLabels",
- "value": "true"
- },
- {
- "name": "PrefixSuffixNamingRequirement",
- "value": "[Contoso-][GroupName]"
- }
- ]
-}
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
-
-# [PowerShell](#tab/powershell)
----
-In the request body, supply a JSON representation of [directorySetting](../resources/directorysetting.md) object.
-
-### Response
-The following is an example of the response.
-
->**Note:** The response object shown here has been shortened for readability.
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.directorySetting"
-} -->
-```http
-HTTP/1.1 201 Created
-Content-type: application/json
-
-{
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#settings/$entity",
- "id": "f0b2d6f5-097d-4177-91af-a24e530b53cc",
- "displayName": "Group.Unified",
- "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
- "values": [
- {
- "name": "GuestUsageGuidelinesUrl",
- "value": "https://privacy.contoso.com/privacystatement"
- },
- {
- "name": "EnableMSStandardBlockedWords",
- "value": "true"
- },
- {
- "name": "EnableMIPLabels",
- "value": "true"
- },
- {
- "name": "PrefixSuffixNamingRequirement",
- "value": "[Contoso-][GroupName]"
- }
- ]
-}
-```
-
-## Example 2: Create a setting to block guests for a specific Microsoft 365 group
-
-### Request
--
-# [HTTP](#tab/http)
-<!-- {
- "blockType": "request",
- "name": "create_directorysetting_from_settings_for_guests"
-}-->
-```http
-POST https://graph.microsoft.com/v1.0/groups/055a5d18-a3a9-4338-b9c5-de92559b7ebf/settings
-Content-type: application/json
-
-{
- "displayName": "Group.Unified.Guest",
- "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
- "values": [
- {
- "name": "AllowToAddGuests",
- "value": "false"
- }
- ]
-}
-```
-# [C#](#tab/csharp)
-
-# [JavaScript](#tab/javascript)
-
-# [Objective-C](#tab/objc)
-
-# [Java](#tab/java)
-
-# [Go](#tab/go)
----
-In the request body, supply a JSON representation of [directorySetting](../resources/directorysetting.md) object.
-
-### Response
-
-Note: The response object shown here may be shortened for readability.
-
-<!-- {
- "blockType": "response",
- "truncated": true,
- "@odata.type": "microsoft.graph.directorySetting"
-} -->
-```http
-HTTP/1.1 201 Created
-Content-type: application/json
-
-{
- "@odata.context": "https://graph.microsoft.com/beta/$metadata#settings/$entity",
- "id": "a77ad44e-aa2a-4976-91b5-b947787b9577",
- "displayName": "Group.Unified.Guest",
- "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
- "values": [
- {
- "name": "AllowToAddGuests",
- "value": "false"
- }
- ]
-}
-```
-
-<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
-2015-10-25 14:57:30 UTC -->
-<!--
-{
- "type": "#page.annotation",
- "description": "Create directorySetting",
- "keywords": "",
- "section": "documentation",
- "tocPath": "",
- "suppressions": [
- ]
-}
>
v1.0 Directorysetting Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directorysetting-update.md
Title: "Update a directory setting"
+ Title: "Update directorySetting"
description: "Update the properties of a specific directory setting object." ms.localizationpriority: medium
ms.prod: "directory-management"
doc_type: apiPageType
-# Update a directory setting
+# Update directorySetting
Namespace: microsoft.graph
Namespace: microsoft.graph
Update the properties of a specific directory setting object.
-> **Note**: The /beta version of this API only applies to groups. The /v1.0 version of this API has been renamed to *Update groupSettings*.
## 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) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.ReadWrite.All | + ## HTTP request <!-- { "blockType": "ignored" } -->
-Update a tenant-wide or group specific setting.
+Update a tenant-wide setting.
+```http
+PATCH /settings/{directorySettingId}
+```
+
+<!-- { "blockType": "ignored" } -->
+Update a group-specific setting.
```http
-PATCH /settings/{id}
-PATCH /groups/{id}/settings/{id}
+PATCH /groups/{groupId}/settings/{directorySettingId}
```+ ## Optional request headers | Name | Description| |:--|:--|
In the request body, supply the values for relevant fields that should be update
If successful, this method returns a `204 OK` response code. ## Example
-##### Request
+### Request
Here is an example of the request. # [HTTP](#tab/http)
Here is an example of the request.
"blockType": "request", "name": "update_directorysetting" }-->
-```http
-PATCH https://graph.microsoft.com/beta/settings/{id}
+```msgraph-interactive
+PATCH https://graph.microsoft.com/beta/settings/3c105fc3-2254-4861-9e2d-d59e2126f3ef
Content-type: application/json {
- "values": [
- {
- "name": "name-value",
- "value": "value-value"
- }
- ]
+ "values": [
+ {
+ "name": "CustomBlockedWordsList",
+ "value": "Contoso"
+ }
+ ]
} ``` # [C#](#tab/csharp)
Content-type: application/json
-##### Response
+### Response
<!-- { "blockType": "response" } -->
v1.0 Directorysettingtemplate Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directorysettingtemplate-get.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
v1.0 Directorysettingtemplate List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/directorysettingtemplate-list.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, Directory.ReadWrite.All |
v1.0 Driveitem Get Content Format https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/driveitem-get-content-format.md
Not all files can be converted into all formats.
To download the item in its original format, see [download an item's contents](driveitem-get-content.md).
-## Prerequisites
+## Permissions
-To call this API, the user must have granted the application read access to the file the app wishes to convert.
+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) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
+| Delegated (personal Microsoft account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All |
+| Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
## HTTP request
GET /drive/root:/{path and filename}:/content?format={format}
|:-|:-|:| | _format_ | string | Specify the format the item's content should be downloaded as. | - The following values are valid for the **format** parameter: | Value | Description | Supported source extensions
The following values are valid for the **format** parameter:
## Example - # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "convert-item-content", "scopes": "files.read" } -->
v1.0 Driveitem Get Content https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/driveitem-get-content.md
-description: "Download the contents of the primary stream (file) of a DriveItem. Only driveItems with the file property can be downloaded."
Previously updated : 09/10/2017
+description: "Download the contents of the primary stream (file) of a driveItem. Only driveItems with the file property can be downloaded."
Title: Download a file ms.localizationpriority: medium ms.prod: "sharepoint" doc_type: apiPageType
-# Download the contents of a DriveItem
+# Download the contents of a driveItem
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] [!INCLUDE [tls-1.2-required](../../includes/tls-1.2-required.md)]
-Download the contents of the primary stream (file) of a DriveItem. Only driveItems with the **file** property can be downloaded.
+Download the contents of the primary stream (file) of a [driveItem](../resources/driveitem.md). Only **driveItems** with the **file** property can be downloaded.
## Permissions
GET /users/{userId}/drive/items/{item-id}/content
Here is an example to download a complete file. -
+### Request
# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "download-item-content", "scopes": "files.read" } -->
HTTP/1.1 302 Found
Location: https://b0mpua-by3301.files.1drv.com/y23vmagahszhxzlcvhasdhasghasodfi ```
+## Downloading files in JavaScript apps
+To download files in a JavaScript app, you cannot use the `/content` API, because this responds with a `302` redirect.
+A `302` redirect is explicitly prohibited when a [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) _preflight_ is required, such as when providing the **Authorization** header.
+
+Instead, your app needs to select the `@microsoft.graph.downloadUrl` property, which returns the same URL that `/content` directs to.
+This URL can then be requested directly using XMLHttpRequest.
+Because these URLs are pre-authenticated, they can be retrieved without a CORS preflight request.
+
+### Example
+
+To retrieve the download URL for a file, first make a request that includes the `@microsoft.graph.downloadUrl` property:
+
+```http
+GET /drive/items/{item-ID}?select=id,@microsoft.graph.downloadUrl
+```
+
+This returns the ID and download URL for a file:
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "id": "12319191!11919",
+ "@microsoft.graph.downloadUrl": "https://..."
+}
+```
+
+You can then make an XMLHttpRequest for the URL provided in `@microsoft.graph.downloadUrl` to retrieve the file.
+ ## Partial range downloads To download a partial range of bytes from the file, your app can use the `Range` header as specified in [RFC 2616](https://www.ietf.org/rfc/rfc2616.txt).
v1.0 Driveitem List Children https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/driveitem-list-children.md
GET /drives/{drive-id}/items/{item-id}/children
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Driveitemversion Restore https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/driveitemversion-restore.md
POST /drives/{drive-id}/items/{item-id}/versions/{version-id}/restoreVersion
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Ediscovery Sourcecollection Purgedata https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/ediscovery-sourcecollection-purgedata.md
+
+ Title: "sourceCollection: purgeData"
+description: "Use the purge data method to delete sensitive misplaced Microsoft Teams messages in a sourceCollection."
+
+ms.localizationpriority: medium
++
+# sourceCollection: purgeData
+
+Namespace: microsoft.graph.ediscovery
++
+Permanently delete Microsoft Teams messages contained in a [sourceCollection](../resources//ediscovery-sourcecollection.md).
+
+>**Note:** This request purges Teams data only. It does not purge other types of data such as mailbox items.
+
+You can collect and purge the following categories of Teams content:
+- **Teams 1:1 chats** - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called *conversations*.
+- **Teams group chats** - Chat messages, posts, and attachments shared in a Teams conversation between three or more people. Also called *1:N* chats or *group conversations*.
+- **Teams channels** - Chat messages, posts, replies, and attachments shared in a standard Teams channel.
+- **Private channels** - Message posts, replies, and attachments shared in a private Teams channel.
+- **Shared channels** - Message posts, replies, and attachments shared in a shared Teams channel.
+
+For more information about purging Teams messages, see:
+- [eDiscovery solution series: Data spillage scenario - Search and purge](/microsoft-365/compliance/data-spillage-scenariosearch-and-purge)
+- [Advanced eDiscovery workflow for content in Microsoft Teams](/microsoft-365/compliance/teams-workflow-in-advanced-ediscovery)
+
+## 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)|eDiscovery.ReadWrite.All|
+|Delegated (personal Microsoft account)|Not supported.|
+|Application|Not supported.|
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+POST /compliance/ediscovery/cases/{caseId}/sourceCollections/{sourceCollectionId}/purgeData
+```
+
+## Request headers
+
+|Name|Description|
+|:|:|
+|Authorization|Bearer {token}. Required.|
+
+## Request body
+
+Do not supply a request body for this method.
+
+## Response
+
+If successful, this action returns a `202 Accepted` response code.
+
+If the purge data operation is started successfully, this action returns a `202 Accepted` response code. The response will also contain a `Location` header, which contains the location of the [Purge data operation](../resources/ediscovery-purgedataoperation.md) that was created to commit the purge.
+To check the status of the purge data operation, make a GET request to the location URL. When the request successfully completes, the [status](../resources/ediscovery-caseoperation.md#caseoperationstatus-values) will change to `succeeded`.
+
+## Examples
+
+### Request
+<!-- {
+ "blockType": "request",
+ "name": "sourcecollectionthis.purgedata"
+}
+-->
+``` http
+POST https://graph.microsoft.com/beta/compliance/ediscovery/cases/{caseId}/sourceCollections/{sourceCollectionId}/purgeData
+```
+
+### Response
+<!-- {
+ "blockType": "response",
+ "truncated": true
+}
+-->
+``` http
+HTTP/1.1 202 Accepted
+```
v1.0 Educationclass Delete Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationclass-delete-members.md
DELETE https://graph.microsoft.com/beta/education/classes/11003/members/14008
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Educationclass Delete Teachers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationclass-delete-teachers.md
DELETE https://graph.microsoft.com/beta/education/classes/{id}/teachers/14012
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Educationschool Delete Classes https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationschool-delete-classes.md
DELETE https://graph.microsoft.com/beta/education/schools/10001/classes/11001
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Educationschool Delete Users https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/educationschool-delete-users.md
DELETE https://graph.microsoft.com/beta/education/schools/10001/users/13006
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Emailauthenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-delete.md
DELETE https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/aut
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Emailauthenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-get.md
GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/ema
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Emailauthenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/emailauthenticationmethodconfiguration-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Endpoint Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/endpoint-get.md
description: "Retrieve the properties and relationships of a specific endpoint o
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "groups"-+ # Get endpoint
Namespace: microsoft.graph
Retrieve the properties and relationships of a specific [endpoint](../resources/endpoint.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).
+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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.Read.All, Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.Read.All, Group.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/endpoints/{id} ```+ ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Name |Description|
-|:-|:-|
-| Authorization | Bearer {token}. Required.|
+
+| 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 an [Endpoint](../resources/endpoint.md) object in the response body.+ ## Example
-### Request
+### Request
# [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_endpoint" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/endpoints/{id} ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-endpoint-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-endpoint-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-endpoint-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-endpoint-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-endpoint-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] ### Response+ Here is an example of the response.
->Note: The response object shown here might be shortened for readability.
+
+> Note: The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.endpoint" } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
v1.0 Entitlementmanagement Post Accesspackageassignmentpolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackageassignmentpolicies.md
Content-type: application/json
``` +
+### Example 4: Create a policy and specify the stages to trigger pre-defined custom workflow extensions
+
+#### Request
+
+In the following example, the pre-defined **customAccessPackageWorkflowExtension** object is triggered when an access package assigned request is created and when it's granted.
++
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "create_accesspackageassignmentpolicy_customaccesspackageworkflowextension"
+}-->
+```msgraph-interactive
+POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies
+Content-type: application/json
+
+{
+ "displayName": "extension-policy",
+ "description": "test",
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "expiration": {
+ "type": "afterDuration",
+ "duration": "P365D"
+ },
+ "canExtend": false,
+ "requestApprovalSettings": null,
+ "requestorSettings": {
+ "acceptRequests": true,
+ "scopeType": "AllExistingDirectorySubjects",
+ "allowedRequestors": [],
+ "isOnBehalfAllowed": false
+ },
+ "accessReviewSettings": null,
+ "questions": [],
+ "customExtensionHandlers": [
+ {
+ "stage": "assignmentRequestCreated",
+ "customExtension": {
+ "id": "219f57b6-7983-45a1-be01-2c228b7a43f8" //customAccessPackageWorkflowExtension.id
+ }
+ },
+ {
+ "stage": "assignmentRequestGranted",
+ "customExtension": {
+ "id": "219f57b6-7983-45a1-be01-2c228b7a43f8"
+ }
+ }
+ ]
+}
+```
+# [JavaScript](#tab/javascript)
+
+# [Go](#tab/go)
+++++
+#### Response
+
+The following is an example of the response. The **customExtensionHandlers** object isn't returned by default. To retrieve this object, use the **GET** method with `$expand`. For more information, see [Retrieve the custom extension handlers for a policy](accesspackageassignmentpolicy-get.md#example-2-retrieve-the-custom-extension-handlers-for-a-policy)
+
+> **Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.accessPackageAssignmentPolicy"
+} -->
+
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "id": "d0324cbb-24a2-4edb-acca-fee5384c6a5e",
+ "displayName": "extension-policy",
+ "description": "test",
+ "canExtend": false,
+ "durationInDays": 0,
+ "expirationDateTime": null,
+ "accessPackageId": "ba5807c7-2aa9-4c8a-907e-4a17ee587500",
+ "accessReviewSettings": null,
+ "questions": [],
+ "requestorSettings": {
+ "scopeType": "AllExistingDirectorySubjects",
+ "acceptRequests": true,
+ "allowedRequestors": []
+ },
+ "requestApprovalSettings": {
+ "isApprovalRequired": false,
+ "isApprovalRequiredForExtension": false,
+ "isRequestorJustificationRequired": false,
+ "approvalMode": "NoApproval",
+ "approvalStages": []
+ }
+}
+```
+ <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- {
v1.0 Entitlementmanagement Post Accesspackageresourcerequests https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackageresourcerequests.md
POST /identityGovernance/entitlementManagement/accessPackageResourceRequests
In the request body, supply a JSON representation of an [accessPackageResourceRequest](../resources/accesspackageresourcerequest.md) object. Include the `accessPackageResource` relationship with an [accessPackageResource](../resources/accesspackageresource.md) object as part of the request.
-To add an Azure AD group as a resource to a catalog, set the **catalogId** to be of the ID of the catalog, **requestType** to be `AdminAdd`, and an `accessPackageResource` representing the resource. The value of the **originSystem** property within the `accessPackageResource` should be `AadGroup` and the value of the **originId** is the identifier of the group.
+To add an Azure AD group as a resource to a catalog, set the **catalogId** to be of the ID of the catalog, **requestType** to be `AdminAdd`, and an `accessPackageResource` representing the resource. The value of the **originSystem** property within the `accessPackageResource` should be `AadGroup` and the value of the **originId** is the identifier of the group. If using delegated permissions, the user requesting to add a group should be an owner of the group or in a directory role which allows them to modify groups. If using application permissions, the application requesting to add the group should also be assigned the `Group.ReadWrite.All` permission.
-To remove an Azure AD app from a catalog, set the **catalogId** to be of the ID of the catalog, **requestType** to be `AdminRemove`, and the `accessPackageResource` the resource object to be removed. The resource object can be retrieved using [list accessPackageResources](accesspackagecatalog-list-accesspackageresources.md).
+To add an Azure AD application as a resource to a catalog, set the **catalogId** to be of the ID of the catalog, **requestType** to be `AdminAdd`, and an `accessPackageResource` representing the resource. The value of the **originSystem** property within the `accessPackageResource` should be `AadApplication` and the value of the **originId** is the identifier of the [servicePrincipal](../resources/serviceprincipal.md). If using delegated permissions, the user requesting to add an application should be an owner of the application or in a directory role which allows them to modify application role assignments.
-To assign the geolocation environment for a multi-geolocation Sharepoint Online resource, include the **accessPackageResourceEnvironment** relationship in the `accessPackageResource` object. This can be done in two ways:
+To add a SharePoint Online site as a resource to a catalog, set the **catalogId** to be of the ID of the catalog, **requestType** to be `AdminAdd`, and an `accessPackageResource` representing the resource. The value of the **originSystem** property within the `accessPackageResource` should be `SharePointOnline` and the value of the **originId** is the URI of the [site](../resources/site.md). If using delegated permissions, the user should be in the the SharePoint Administrator role. If using application permissions, the application requesting to add the site should also be assigned the `Sites.FullControl.All` permission. To assign the geolocation environment for a multi-geolocation Sharepoint Online resource, include the **accessPackageResourceEnvironment** relationship in the `accessPackageResource` object. This can be done in two ways:
+ Use `@odata.bind` annotation to assign the `id` of the `accessPackageResourceEnvironment` to an `accessPackageResourceEnvironment` object. + Specify the `originId` parameter of the `accessPackageResourceEnvironment` in an `accessPackageResourceEnvironment` object.
+To remove a resource from a catalog, set the **catalogId** to be of the ID of the catalog, **requestType** to be `AdminRemove`, and the `accessPackageResource` the resource object to be removed. The resource object can be retrieved using [list accessPackageResources](accesspackagecatalog-list-accesspackageresources.md).
## Response
Content-type: application/json
The following is an example of the request for adding an application to a catalog, including specifying a required attribute of that application. +
+# [HTTP](#tab/http)
<!-- { "blockType": "request", "name": "create_accesspackageresourcerequest_from_accesspackageresourcerequests6"
Content-type: application/json
} ```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++ #### Response
v1.0 Event Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/event-get.md
The following example shows expanding a series master event of a recurring serie
"name": "get_event_seriesMaster_expansion" }--> ```msgraph-interactive
-GET https://graph.microsoft.com/beta/me/events/AAMkADAGAADDdm4NAAA=/?$select=subject,start,end,occurrenceId,exceptionOccurrences,cancelledOccurrences$expand=exceptionOccurrences
+GET https://graph.microsoft.com/beta/me/events/AAMkADAGAADDdm4NAAA=/?$select=subject,start,end,occurrenceId,exceptionOccurrences,cancelledOccurrences&$expand=exceptionOccurrences
``` # [Go](#tab/go) [!INCLUDE [sample-code](../includes/snippets/go/get-event-seriesmaster-expansion-go-snippets.md)]
GET https://graph.microsoft.com/beta/me/events/AAMkADAGAADDdm4NAAA=/?$select=sub
[!INCLUDE [sample-code](../includes/snippets/powershell/get-event-seriesmaster-expansion-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+ #### Response
v1.0 Extensionproperty Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/extensionproperty-delete.md
+
+ Title: "Delete extensionProperty"
+description: "Delete an extensionProperty."
+ms.localizationpriority: medium
+++
+# Delete extensionProperty
+
+Namespace: microsoft.graph
++
+Delete an [extensionProperty](../resources/extensionproperty.md).
+
+## 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) | Application.ReadWrite.All, Directory.ReadWrite.All |
+|Delegated (personal Microsoft account) | Application.ReadWrite.All |
+|Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All |
+
+## HTTP request
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+DELETE /applications/{id}/extensionProperties/{id}
+```
+
+## 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 `204 No Content` response code. It does not return anything in the response body.
+
+## Examples
+
+### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "delete_extensionproperty"
+}-->
+
+```http
+DELETE https://graph.microsoft.com/beta/applications/fd918e4b-c821-4efb-b50a-5eddd23afc6f/extensionProperties/1f0f15e3-925d-40f0-8fc8-9d3ad135bce0
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
++++
+### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true
+} -->
+
+```http
+HTTP/1.1 204 No Content
+```
+
+<!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98
+2019-02-04 14:57:30 UTC -->
+<!-- {
+ "type": "#page.annotation",
+ "description": "Delete extensionProperty",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": ""
+}-->
+++
v1.0 Extensionproperty Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/extensionproperty-get.md
+
+ Title: "Get extensionProperty"
+description: "Read an extensionProperty object."
+
+ms.localizationpriority: medium
++
+# Get extensionProperty
+Namespace: microsoft.graph
++
+Read an [extensionProperty](../resources/extensionproperty.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) | Application.Read.All, Directory.Read.All, Application.ReadWrite.All |
+|Delegated (personal Microsoft account) | Application.Read.All, Application.ReadWrite.All |
+|Application | Application.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All |
+
+## HTTP request
+
+<!-- {
+ "blockType": "ignored"
+}
+-->
+``` http
+GET /applications/{applicationsId}/extensionProperties/{extensionPropertyId}
+```
+
+## Optional query parameters
+This method supports the `$select` OData query parameter 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 an [extensionProperty](../resources/extensionproperty.md) object in the response body.
+
+## Examples
+
+### Request
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_extensionproperty"
+}
+-->
+``` http
+GET https://graph.microsoft.com/beta/applications/fd918e4b-c821-4efb-b50a-5eddd23afc6f/extensionProperties/1f0f15e3-925d-40f0-8fc8-9d3ad135bce0
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++++
+### Response
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.extensionProperty"
+}
+-->
+``` http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('fd918e4b-c821-4efb-b50a-5eddd23afc6f')/extensionProperties/$entity",
+ "id": "1f0f15e3-925d-40f0-8fc8-9d3ad135bce0",
+ "deletedDateTime": null,
+ "appDisplayName": "b2c-extensions-app. Do not modify. Used by AADB2C for storing user data.",
+ "name": "extension_25883231668a43a780b25685c3f874bc_cpiminternal_useAccountEnabledForPhone",
+ "dataType": "String",
+ "isSyncedFromOnPremises": false,
+ "targetObjects": [
+ "User"
+ ]
+}
+```
+
v1.0 Externalconnectors Connectionoperation Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-connectionoperation-get.md
GET https://graph.microsoft.com/beta/external/connections/contosohr/operations/3
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Externalconnection Post Groups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalconnection-post-groups.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Externalconnection Post Schema https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalconnection-post-schema.md
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+ <!-- markdownlint-disable MD024 -->
v1.0 Externalconnectors Externalconnection Put Items https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalconnection-put-items.md
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/objc/create-externalitem-from-connections-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Externalgroup Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalgroup-delete.md
DELETE https://graph.microsoft.com/beta/external/connections/contosohr/groups/31
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Externalgroup Post Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalgroup-post-members.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Externalgroupmember Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalgroupmember-delete.md
DELETE https://graph.microsoft.com/beta/external/connections/contosohr/groups/31
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+ <!-- markdownlint-disable MD024 -->
v1.0 Externalconnectors Externalitem Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalitem-delete.md
DELETE https://graph.microsoft.com/beta/external/connections/contosohr/items/TSP
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Externalitem Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-externalitem-update.md
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Schema Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-schema-get.md
GET https://graph.microsoft.com/beta/external/connections/contosohr/schema
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Externalconnectors Schema Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/externalconnectors-schema-update.md
Content-type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Fido2authenticationmethodconfiguration Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-delete.md
DELETE https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/aut
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Fido2authenticationmethodconfiguration Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-get.md
GET https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authen
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Fido2authenticationmethodconfiguration Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/fido2authenticationmethodconfiguration-update.md
Content-Type: application/json
[!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
+# [Go](#tab/go)
+
v1.0 Governanceresource Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceresource-get.md
description: "Retrieve the properties and relationships of a governanceResource
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Get governanceResource
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of a [governanceResource](../resources/governanceresource.md) object.
v1.0 Governanceresource List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceresource-list.md
description: "Retrieve a collection of governanceResource that the requestor has
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # List governanceResources
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a collection of [governanceResource](../resources/governanceresource.md) that the requestor has access to.
v1.0 Governanceresource Register https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceresource-register.md
description: "Register a governanceResource object in PIM."
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # governanceResource: register
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Register a [governanceResource](../resources/governanceresource.md) object in Privileged Identity Management.
v1.0 Governanceroleassignment Export https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignment-export.md
description: "Retrieve a collection of governanceRoleAssignmentRequests in the f
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Export governanceRoleAssignmentRequests
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a collection of [governanceRoleAssignmentRequests](../resources/governanceroleassignmentrequest.md) in the format `application/octet-stream`, which can be parsed as a .csv file in the browser.
v1.0 Governanceroleassignment Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignment-get.md
description: "Retrieve the properties and relationships of a governanceRoleAssig
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Get governanceRoleAssignment
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of a [governanceRoleAssignment](../resources/governanceroleassignment.md).
v1.0 Governanceroleassignment List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignment-list.md
description: "Retrieve a collection of governanceRoleAssignments."
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # List governanceRoleAssignments
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a collection of [governanceRoleAssignments](../resources/governanceroleassignment.md).
v1.0 Governanceroleassignmentrequest Cancel https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignmentrequest-cancel.md
description: "Cancel a governanceRoleAssignmentRequest."
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Cancel governanceRoleAssignmentRequest
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Cancel a [governanceRoleAssignmentRequest](../resources/governanceroleassignmentrequest.md).
v1.0 Governanceroleassignmentrequest Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignmentrequest-get.md
description: "Get a governanceRoleAssignmentRequest. "
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Get governanceRoleAssignmentRequest
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Get a [governanceRoleAssignmentRequest](../resources/governanceroleassignmentrequest.md).
v1.0 Governanceroleassignmentrequest List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignmentrequest-list.md
description: "Retrieve a collection of governanceRoleAssignmentRequests. "
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # List governanceRoleAssignmentRequests
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a collection of [governanceRoleAssignmentRequests](../resources/governanceroleassignmentrequest.md).
v1.0 Governanceroleassignmentrequest Post https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignmentrequest-post.md
description: "Create a role assignment request to represent the operation you wa
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Create governanceRoleAssignmentRequest
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Create a role assignment request to represent the operation you want on a role assignment. The following table lists the operations.
v1.0 Governanceroleassignmentrequest Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignmentrequest-update.md
description: "Enable administrators to update their decisions (`AdminApproved` o
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Update governanceRoleAssignmentRequests
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Enable administrators to update their decisions (`AdminApproved` or `AdminDenied`) on [governanceRoleAssignmentRequests](../resources/governanceroleassignmentrequest.md) that are in status of `PendingAdminDecision`.
v1.0 Governanceroledefinition Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroledefinition-get.md
description: "Retrieve the properties and relationships of a governanceRoleDefin
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Get governanceRoleDefinition
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of a [governanceRoleDefinition](../resources/governanceroledefinition.md).
v1.0 Governanceroledefinition List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroledefinition-list.md
description: "Get a collection of governanceRoleDefinitions on a resource."
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # List governanceRoleDefinitions
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Get a collection of [governanceRoleDefinitions](../resources/governanceroledefinition.md) on a resource.
v1.0 Governancerolesetting Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governancerolesetting-get.md
description: "Retrieve the properties and relationships of a governanceRoleSetti
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Get governanceRoleSetting
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of a [governanceRoleSetting](../resources/governancerolesetting.md).
v1.0 Governancerolesetting List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governancerolesetting-list.md
description: "Retrieve a collection of governanceRoleSettings on a resource."
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # List governanceRoleSettings
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a collection of [governanceRoleSettings](../resources/governancerolesetting.md) on a resource.
v1.0 Governancerolesetting Update https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governancerolesetting-update.md
description: "Update the properties of governanceRoleSetting."
ms.localizationpriority: medium doc_type: apiPageType ms.prod: "governance"-+ # Update governanceRoleSetting
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Update the properties of [governanceRoleSetting](../resources/governancerolesetting.md).
v1.0 Group Addfavorite https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-addfavorite.md
Title: "group: addFavorite" description: "Add the group to the list of the current user's favorite groups. Supported for Microsoft 365 groups only." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Add the group to the list of the current user's favorite groups. Supported for Microsoft 365 groups only. ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/addFavorite ``` ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `200 OK` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_addfavorite" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/addFavorite ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-addfavorite-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-addfavorite-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-addfavorite-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-addfavorite-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-addfavorite-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.+ <!-- { "blockType": "response", "truncated": false } -->+ ```http HTTP/1.1 200 OK ```
HTTP/1.1 200 OK
] } -->--
v1.0 Group Assignlicense https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-assignlicense.md
Title: "group: assignLicense" description: "Add or remove licenses on the group. Licenses assigned to the group will be assigned to all users in the group." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: "apiPageType"
Add or remove licenses on the group. Licenses assigned to the group will be assi
To get the subscriptions available in the directory, perform a [GET subscribedSkus request](subscribedsku-list.md). ## 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) | Group.ReadWrite.All, Directory.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.ReadWrite.All, Directory.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/assignLicense ```+ ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Content-Type | application/json. Required. |
+
+| Header | Value |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json. Required. |
## Request body+ In the request body, provide a JSON object with the following parameters.
-| Parameter | Type |Description|
-|:|:--|:-|
-|addLicenses|[assignedLicense](../resources/assignedlicense.md) collection|A collection of [assignedLicense](../resources/assignedlicense.md) objects that specify the licenses to add. You can disable servicePlans associated with a license by setting the **disabledPlans** property on an [assignedLicense](../resources/assignedlicense.md) object.|
-|removeLicenses|GUID collection|A collection of skuIds that identify the licenses to remove.|
+| Parameter | Type | Description |
+| :- | : | :-- |
+| addLicenses | [assignedLicense](../resources/assignedlicense.md) collection | A collection of [assignedLicense](../resources/assignedlicense.md) objects that specify the licenses to add. You can disable servicePlans associated with a license by setting the **disabledPlans** property on an [assignedLicense](../resources/assignedlicense.md) object. |
+| removeLicenses | Guid collection | A collection of skuIds that identify the licenses to remove. |
## Response
If successful, this method returns a `202 Accepted` response code and a target [
## Examples ### Example 1: Add licenses to the group+ The following example adds licenses to the group.
-#### Request
+#### Request
# [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_assignlicense" }-->+ ```http POST https://graph.microsoft.com/beta/groups/1132b215-826f-42a9-8cfe-1643d19d17fd/assignLicense Content-type: application/json
Content-type: application/json
"removeLicenses": [] } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-assignlicense-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-assignlicense-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-assignlicense-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-assignlicense-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-assignlicense-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The response is the updated group object.
->**Note:** The response object shown here might be shortened for readability.
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.group" } -->+ ```http HTTP/1.1 202 Accepted Content-type: application/json
location: https://graph.microsoft.com/v2/e8e96c2a-d787-4eb1-98d7-9e57c965f1de/di
``` ### Example 2: Remove licenses from the group+ The following example removes licenses from the group. #### Request - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_removelicense"
Content-type: application/json
] } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-removelicense-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-removelicense-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-removelicense-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-removelicense-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-removelicense-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The response is the updated group object.
->**Note:** The response object shown here might be shortened for readability..
+> **Note:** The response object shown here might be shortened for readability..
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.group" } -->+ ```http HTTP/1.1 202 Accepted Content-type: application/json
v1.0 Group Delete Acceptedsenders https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-acceptedsenders.md
Title: "Remove acceptedSender" description: "Remove a user or group from the accepted-senders list. "-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Remove a user or group from the accepted-senders list of the specified group.
+Remove a user or group from the accepted-senders list of the specified group.
## 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) | Group.ReadWrite.All |
-| Delegated (personal Microsoft account) | Not supported.|
-| Application | Not supported.|
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id}/acceptedSenders/$ref?$id={id} ``` ## Request headers
-| Header | Value |
-|:|:|
-| Authorization | Bearer {token}. Required.
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Examples+ ### Example 1: Remove a user from the accepted-senders list for the group.+ #### Request <!-- { "blockType": "request", "name": "remove_user_from_acceptedsenderslist_of_group" }-->+ ```http DELETE https://graph/microsoft.com/beta/groups/{id}/acceptedSenders/$ref?$id=https://graph.microsoft.com/beta/users/{user-id} ``` #### Response
-The following is an example of the response.
+
+The following is an example of the response.
<!-- { "blockType": "response", "name": "remove_user_from_acceptedsenderslist_of_group", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ``` ### Example 2: Remove a group from the accepted-senders list for the group.+ #### Request <!-- { "blockType": "request", "name": "remove_group_from_acceptedsenderslist_of_group" }-->+ ```http DELETE https://graph/microsoft.com/beta/groups/{id}/acceptedSenders/$ref?$id=https://graph.microsoft.com/beta/groups/{other-group-id} ``` #### Response
-The following is an example of the response.
+
+The following is an example of the response.
<!-- { "blockType": "response", "name": "remove_group_from_acceptedsenderslist_of_group", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
"suppressions": [] } -->--
v1.0 Group Delete Approleassignments https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-approleassignments.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AppRoleAssignment.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AppRoleAssignment.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AppRoleAssignment.ReadWrite.All |
v1.0 Group Delete Conversation https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-conversation.md
Title: "Delete conversation" description: "Delete a conversation object."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Delete a [conversation](../resources/conversation.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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id}/conversations/{id} ``` ## Request headers
-| Name | Description|
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "delete_group_conversation" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/conversations/AAQkAGI5MWY5ZmUyLTJiNzYtNDE0ZC04OWEwLWM3M2FjYmM3NzNlZgAQABuXO3guDWBMpyKF7LsVwfU= ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/delete-group-conversation-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/delete-group-conversation-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/delete-group-conversation-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/delete-group-conversation-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/delete-group-conversation-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response
-The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+The following is an example of the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Delete Event https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-event.md
Title: "Delete event" description: "Delete an event object."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Delete an [event](../resources/event.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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id}/events/{id} DELETE /groups/{id}/calendar/events/{id} ``` ## Request headers
-| Name | Description|
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "delete_group_event" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/events/AQMkAGI5MWY5ZmUyLTJiNzYtNDE0ZC04OWEwLWM3M2FjYmM3NwAzZWYARgAAA_b2VnUAiWNLj0xeSOs499YHAMT2RdsuOqRIlQZ4vOzp66YAAAIBDQAAAMT2RdsuOqRIlQZ4vOzp66YAAAIJOgAAAA== ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/delete-group-event-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/delete-group-event-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/delete-group-event-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/delete-group-event-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/delete-group-event-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response
-The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+The following is an example of the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Delete Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-members.md
Title: "Remove member" description: "Remove a member from a Microsoft 365 group or a security group through the members navigation property." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Remove a member from a group via the **members** navigation property. You can't remove a member from groups with dynamic memberships. ## 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) | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+
+> [!IMPORTANT]
+> To remove members from a role-assignable group, the calling user or app must also be assigned the _RoleManagement.ReadWrite.Directory_ permission.
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id}/members/{id}/$ref ``` ## Request headers
-| Name | Description|
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "delete_member_from_group" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/{group-id}/members/{directory-object-id}/$ref ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/delete-member-from-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/delete-member-from-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/delete-member-from-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
DELETE https://graph.microsoft.com/beta/groups/{group-id}/members/{directory-obj
In the request, specify the identifier of the group and the identifier of the directory object you want to remove. #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response" } -->+ ```http HTTP/1.1 204 No Content ``` ## See also+ - [Add member to team](team-post-members.md) - [Update member's role in team](team-update-members.md) - [Remove member from team](team-delete-members.md)
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Delete Owners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-owners.md
Title: "Remove group owner" description: "Use this API to remove an owner from a Microsoft 365 group or a security group through the owners navigation property." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Use this API to remove an owner from a Microsoft 365 group or a security group t
> **Note:** For issues encountered when removing owner of a group associated with a [team](/graph/api/resources/team.md), see [Known Issues](/graph/known-issues#removing-a-group-owner-also-removes-the-user-as-a-group-member). ## 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) | Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.ReadWrite.All, Directory.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id}/owners/{id}/$ref ``` ## Request headers
-| Name | Description|
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example+ ### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "delete_owner_from_group" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/{id}/owners/{id}/$ref ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/delete-owner-from-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/delete-owner-from-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/delete-owner-from-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
DELETE https://graph.microsoft.com/beta/groups/{id}/owners/{id}/$ref
In the request, specify the `id` of the directory object you want to remove after the $ref segment. ### Response+ The following is an example of the response. <!-- { "blockType": "response" } -->+ ```http HTTP/1.1 204 No Content ``` ## See also+ - [Add member to team](team-post-members.md) - [Update member's role in team](team-update-members.md) - [Remove member from team](team-delete-members.md)
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Delete Rejectedsenders https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-rejectedsenders.md
Title: "Remove rejectedSender" description: "Remove a user or group from the rejected-senders list."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Remove a user or group from the rejected-senders list of the specified group. ## 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) | Group.ReadWrite.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id}/rejectedSenders/$ref?$id={id} ``` ## Request headers
-| Header | Value |
-|:|:|
-| Authorization | Bearer {token}. Required.
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Examples+ ### Example 1: Remove a user from the rejected-senders list of the group.
-#### Request
+#### Request
# [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "remove_user_from_rejectedsenderslist_of_group" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/{id}/rejectedSenders/$ref?$id=https://graph.microsoft.com/beta/users/{id} ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/remove-user-from-rejectedsenderslist-of-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/remove-user-from-rejectedsenderslist-of-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/remove-user-from-rejectedsenderslist-of-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/remove-user-from-rejectedsenderslist-of-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] #### Response
-The following is an example of the response.
+
+The following is an example of the response.
+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ``` ### Example 2: Remove a group from the rejected-senders list of the group.+ #### Request # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "remove_group_from_rejectedsenderslist_of_group" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/{id}/rejectedSenders/$ref?$id=https://graph.microsoft.com/beta/groups/{other-group-id} ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/remove-group-from-rejectedsenderslist-of-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/remove-group-from-rejectedsenderslist-of-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/remove-group-from-rejectedsenderslist-of-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/remove-group-from-rejectedsenderslist-of-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response
-The following is an example of the response.
+
+The following is an example of the response.
+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Delete Thread https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-thread.md
Title: "Delete conversation thread" description: "Delete a thread object."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Delete a [thread](../resources/conversationthread.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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id}/threads/{id} ``` ## Request headers
-| Name | Description|
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `204 No Content` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "delete_group_thread" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/threads/AAQkAGI5MWY5ZmUyLTJiNzYtNDE0ZC04OWEwLWM3M2FjYmM3NzNlZgMkABAAG5c7eC4NYEynIoXsuxXB9RAAG5c7eC4NYEynIoXsuxXB9Q== ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/delete-group-thread-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/delete-group-thread-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/delete-group-thread-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/delete-group-thread-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/delete-group-thread-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response
-The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+The following is an example of the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Delete https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete.md
Title: "Delete group - Microsoft Graph API" description: "Delete a group resource."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Deletes a group.
+Deletes a group.
-When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This isn't applicable to Security groups and Distribution groups which are permanently deleted immediately. To learn more, see [deletedItems](../resources/directory.md).
+When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This isn't applicable to Security groups and Distribution groups which are permanently deleted immediately. To learn more, see [deletedItems](../resources/directory.md).
## 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) | Group.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.ReadWrite.All |
## HTTP request <!-- { "blockType": "ignored" } -->+ ```http DELETE /groups/{id} ``` ## Request headers
-| Name | Description|
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body
If successful, this method returns `204 No Content` response code. It does not r
The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "delete_group" }-->+ ```http DELETE https://graph.microsoft.com/beta/groups/{id} ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/delete-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/delete-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/delete-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/delete-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/delete-group-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - ### Response
-The following is an example of the response.
+The following is an example of the response.
+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Delta https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delta.md
Title: "group: delta" description: "Get newly created, updated, or deleted groups, including group membership changes, without having to perform a full read of the entire group collection. See Using Delta Query for details." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Get newly created, updated, or deleted groups, including group membership change
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) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
## HTTP request
You only need to specify any desired query parameters once upfront.
In subsequent requests, copy and apply the `nextLink` or `deltaLink` URL from the previous response, as that URL already includes the encoded, desired parameters.
-| Query parameter | Type |Description|
-|:|:--|:-|
-| $deltatoken | string | A [state token](/graph/delta-query-overview) returned in the `deltaLink` URL of the previous **delta** function call for the same group collection, indicating the completion of that round of change tracking. Save and apply the entire `deltaLink` URL including this token in the first request of the next round of change tracking for that collection.|
-| $skiptoken | string | A [state token](/graph/delta-query-overview) returned in the `nextLink` URL of the previous **delta** function call, indicating there are further changes to be tracked in the same group collection. |
+| Query parameter | Type | Description |
+| :-- | :-- | : |
+| $deltatoken | string | A [state token](/graph/delta-query-overview) returned in the `deltaLink` URL of the previous **delta** function call for the same group collection, indicating the completion of that round of change tracking. Save and apply the entire `deltaLink` URL including this token in the first request of the next round of change tracking for that collection. |
+| $skiptoken | string | A [state token](/graph/delta-query-overview) returned in the `nextLink` URL of the previous **delta** function call, indicating there are further changes to be tracked in the same group collection. |
### OData query parameters This method supports optional OData query parameters to help customize the response. -- You can use a `$select` query parameter as in any GET request to specify only the properties your need for best performance. The *id* property is always returned.
+- You can use a `$select` query parameter as in any GET request to specify only the properties your need for best performance. The _id_ property is always returned.
- You can use `$select=members` to get membership changes. You can additionally track other changes like ownership and more by selecting any [group relationship](../resources/group.md#relationships) of type **directoryObject collection**. - There is limited support for `$filter`: - The only supported `$filter` expression is for tracking changes on a specific object: `$filter=id+eq+{value}`. You can filter multiple objects. For example, `https://graph.microsoft.com/beta/groups/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'`. There is a limit of 50 filtered objects. ## Request headers
-| Name | Description|
-|:|:-|
-| Authorization | Bearer &lt;token&gt;|
-| Content-Type | application/json |
-| Prefer | return=minimal <br><br>Specifying this header with a request that uses a `deltaLink` would return only the object properties that have changed since the last round. Optional. |
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer &lt;token&gt; |
+| Content-Type | application/json |
+| Prefer | return=minimal <br><br>Specifying this header with a request that uses a `deltaLink` would return only the object properties that have changed since the last round. Optional. |
## Request body
Do not supply a request body for this method.
If successful, this method returns `200 OK` response code and [group](../resources/group.md) collection object in the response body. The response also includes a state token which is either a `nextLink` URL or a `deltaLink` URL. - If a `nextLink` URL is returned:+ - This indicates there are additional pages of data to be retrieved in the session. The application continues making requests using the `nextLink` URL until a `deltaLink` URL is included in the response. - The response includes the same set of properties as in the initial delta query request. This allows you to capture the full current state of the objects when initiating the delta cycle.
By default, requests using a `deltaLink` or `nextLink` return the same propertie
- If the property has not changed, the old value is included in the response. - If the property has never been set before it will not be included in the response at all. -
-> **Note:** With this behavior, by looking at the response it is not possible to tell whether a property is changing or not. Also, the delta responses tend to be large because they contain all property values - as shown in the [second example](#request-2) below.
+> **Note:** With this behavior, by looking at the response it is not possible to tell whether a property is changing or not. Also, the delta responses tend to be large because they contain all property values - as shown in the [second example](#request-2) below.
#### Alternative: return only the changed properties
Adding an optional request header - `prefer:return=minimal` - results in the fol
The following is an example of the request. There is no `$select` parameter, so a default set of properties is tracked and returned. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_delta"
The following is an example of the request. There is no `$select` parameter, so
```msgraph-interactive GET https://graph.microsoft.com/beta/groups/delta ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-delta-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-delta-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-delta-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-delta-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-delta-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response 1 The following is an example of the response when using `deltaLink` obtained from the query initialization.
->**Note:** The response object shown here might be shortened for readability.
+> **Note:** The response object shown here might be shortened for readability.
>
-> Note the presence of the *members@delta* property which includes the ids of member objects in the group.
+> Note the presence of the _members@delta_ property which includes the ids of member objects in the group.
<!-- { "blockType": "response",
Content-type: application/json
The next example shows the initial request selecting 3 properties for change tracking, with default response behavior: # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_delta_with_selelct"
The next example shows the initial request selecting 3 properties for change tra
```msgraph-interactive GET https://graph.microsoft.com/beta/groups/delta?$select=displayName,description,mailNickname ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-delta-with-selelct-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-delta-with-selelct-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-delta-with-selelct-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-delta-with-selelct-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-delta-with-selelct-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response 2 The following is an example of the response when using `deltaLink` obtained from the query initialization. Note that all 3 properties are included in the response and it is not known which ones have changed since the `deltaLink` was obtained.
Content-type: application/json
The next example shows the initial request selecting 3 properties for change tracking, with alternative minimal response behavior: # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_delta_minimal"
The next example shows the initial request selecting 3 properties for change tra
GET https://graph.microsoft.com/beta/groups/delta?$select=displayName,description,mailNickname Prefer: return=minimal ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-delta-minimal-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-delta-minimal-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-delta-minimal-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-delta-minimal-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-delta-minimal-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response 3 The following is an example of the response when using `deltaLink` obtained from the query initialization. Note that the `mailNickname` property is not included, which means it has not changed since the last delta query; `displayName` and `description` are included which means their values have changed.
Content-type: application/json
] } -->--
v1.0 Group Evaluatedynamicmembership https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-evaluatedynamicmembership.md
Title: "group: evaluateDynamicMembership" description: "Evaluate if a user or device is or would be a member of a dynamic group."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Evaluate whether a user or device is or would be a member of a dynamic group. The membership rule is returned along with other details that were used in the evaluation. You can complete this operation in the following ways:
+Evaluate whether a user or device is or would be a member of a dynamic group. The membership rule is returned along with other details that were used in the evaluation. You can complete this operation in the following ways:
-- Evaluate whether a user or device is a member of a specified dynamic group.
+- Evaluate whether a user or device is a member of a specified dynamic group.
- Evaluate whether a user or device would be a member of a dynamic group based on the ID of the user or device and a membership rule. ## Permissions
One of the following permissions is required to call this API. To learn more, in
### Evaluate dynamic membership with member ID and group ID
-| Permission type | Permissions (from least to most privileged) |
-| :-- | : |
-| Delegated (work or school account) | For user: Group.Read.All and User.Read.All, Directory.Read.All<br>For device: Group.Read.All and Device.Read.All, Directory.Read.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
+| Delegated (work or school account) | For user: Group.Read.All and User.Read.All, Directory.Read.All<br>For device: Group.Read.All and Device.Read.All, Directory.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
### Evaluate dynamic membership with member ID and membership rule
-| Permission type | Permissions (from least to most privileged) |
-| :-- | : |
-| Delegated (work or school account) | For user: User.Read.All, Directory.Read.All<br>For device: Device.Read.All, Directory.Read.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | For user: User.Read.All, Directory.Read.All<br>For device: Device.Read.All, Directory.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request
POST /groups/evaluateDynamicMembership
## Request headers
-| Name | Description |
-| : | :- |
-| Authorization | Bearer {token} |
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token} |
| Content-type | application/json | ## Request body
In the request body, supply the required properties.
The following table lists the properties that are required when you evaluate group membership.
-| Parameter | Type | Description |
-| :-- | : | :- |
-| memberId | String collection | memberId is the object Id of the user or device to be evaluated. |
-| membershipRule | String collection | The rule that is used for membership evaluation. If this property is not provided, the rule for the existing group is evaluated. If this property is provided, the user or device is evaluated for possible membership in a group with the same rule. For more information, see [Dynamic membership rules for groups in Azure Active Directory](/azure/active-directory/users-groups-roles/groups-dynamic-membership).|
+| Parameter | Type | Description |
+| :- | :- | : |
+| memberId | String collection | memberId is the object Id of the user or device to be evaluated. |
+| membershipRule | String collection | The rule that is used for membership evaluation. If this property is not provided, the rule for the existing group is evaluated. If this property is provided, the user or device is evaluated for possible membership in a group with the same rule. For more information, see [Dynamic membership rules for groups in Azure Active Directory](/azure/active-directory/users-groups-roles/groups-dynamic-membership). |
## Response
If successful, this method returns a `200 OK` response code and an [evaluateDyna
The following is an example of the request. - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_evaluatedynamicmembership_1" }--> ```http
-POST https://graph.microsoft.com/beta/groups/{id}/evaluateDynamicMembership
+POST https://graph.microsoft.com/beta/groups/{id}/evaluateDynamicMembership
Content-type: application/json
-{
+{
"memberId": "319b41e8-d9e4-42f8-bdc9-741113f48b33" } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-evaluatedynamicmembership-1-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-evaluatedynamicmembership-1-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-evaluatedynamicmembership-1-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-evaluatedynamicmembership-1-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-evaluatedynamicmembership-1-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response
-The following is an example of the response.
+The following is an example of the response.
<!-- { "blockType": "response",
Content-type: application/json
The following is an example of the request. - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_evaluatedynamicmembership_2" }--> ```http
-POST https://graph.microsoft.com/beta/groups/evaluateDynamicMembership
+POST https://graph.microsoft.com/beta/groups/evaluateDynamicMembership
Content-type: application/json
-{
+{
"memberId": "319b41e8-d9e4-42f8-bdc9-741113f48b33", "membershipRule": "(user.displayName -startsWith \"EndTestUser\")" } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-evaluatedynamicmembership-2-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-evaluatedynamicmembership-2-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-evaluatedynamicmembership-2-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-evaluatedynamicmembership-2-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response
-The following is an example of the response.
+The following is an example of the response.
<!-- { "blockType": "response",
v1.0 Group Get Conversation https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-get-conversation.md
Title: "Get conversation" description: "Get a conversation object."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Get a [conversation](../resources/conversation.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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.Read.All, Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.Read.All, Group.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/conversations/{id} ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| 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 [conversation](../resources/conversation.md) object in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_conversation" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/conversations/AAQkAGI5MWY5ZmUyLTJiNzYtNDE0ZC04OWEwLWM3M2FjYmM3NzNlZgAQABuXO3guDWBMpyKF7LsVwfU= ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-conversation-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-conversation-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-conversation-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-conversation-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-conversation-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.conversation" } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group Get Event https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-get-event.md
Title: "Get event" description: "Get an event object."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Get an [event](../resources/event.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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/events/{id} GET /groups/{id}/calendar/events/{id} ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Name | Type | Description |
-|:|:--|:--|
-| Authorization | string | Bearer {token}. Required. |
-| Prefer: outlook.timezone | string | Use this to specify the time zone for start and end times in the response. If not specified, those time values are returned in UTC. Optional. |
+
+| Name | Type | Description |
+| :-- | :-- | : |
+| Authorization | string | Bearer {token}. Required. |
+| Prefer: outlook.timezone | string | Use this to specify the time zone for start and end times in the response. If not specified, those time values are returned in UTC. Optional. |
| Prefer: outlook.body-content-type | string | The format of the **body** property to be returned in. Values can be "text" or "html". A `Preference-Applied` header is returned as confirmation if this `Prefer` header is specified. If the header is not specified, the **body** property is returned in HTML format. Optional. | ## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns a `200 OK` response code and an [event](../resources/event.md) object in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_event" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/events/AQMkAGI5MWY5ZmUyLTJiNzYtNDE0ZC04OWEwLWM3M2FjYmM3NwAzZWYARgAAA_b2VnUAiWNLj0xeSOs499YHAMT2RdsuOqRIlQZ4vOzp66YAAAIBDQAAAMT2RdsuOqRIlQZ4vOzp66YAAAIJOgAAAA== ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-event-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-event-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-event-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-event-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-event-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.event" } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group Get Thread https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-get-thread.md
Title: "Get conversation thread" description: "Get a thread object."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Get a [thread](../resources/conversationthread.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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.Read.All, Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.Read.All, Group.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/threads/{id} ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| 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 [thread](../resources/conversationthread.md) object in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_thread" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/threads/AAQkAGI5MWY5ZmUyLTJiNzYtNDE0ZC04OWEwLWM3M2FjYmM3NzNlZgMkABAAG5c7eC4NYEynIoXsuxXB9RAAG5c7eC4NYEynIoXsuxXB9Q== ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-thread-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-thread-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-thread-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-thread-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-thread-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.conversationThread" } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group Get https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-get.md
Title: "Get group" description: "Get the properties and relationships of a group object."-+ ms.localizationpriority: high ms.prod: "groups" doc_type: apiPageType
Get the properties and relationships of a [group](../resources/group.md) object.
This operation returns by default only a subset of all the available properties, as noted in the [Properties](../resources/group.md#properties) section. To get properties that are _not_ returned by default, specify them in a `$select` OData query option. The **hasMembersWithLicenseErrors** property is an exception and is not returned in the `$select` query. Because the **group** resource supports [extensions](/graph/extensibility-overview), you can also use the `GET` operation to get custom properties and extension data in a **group** instance. ## 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) | GroupMember.Read.All, Group.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
->**Note:** Depending on the group features you're trying to access, permissions might be limited. For more information, see the [Groups](/graph/known-issues#groups) section in [Known issues with Microsoft Graph](/graph/known-issues).
+> **Note:** Depending on the group features you're trying to access, permissions might be limited. For more information, see the [Groups](/graph/known-issues#groups) section in [Known issues with Microsoft Graph](/graph/known-issues).
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id} ```+ ## Optional query parameters+ You can use `$select` to get specific group properties, including those that are not returned by default. For more information on OData query options, see [OData Query Parameters](/graph/query-parameters). ## Request headers
-| Name | Type | Description|
-|:--|:|:-|
-| Authorization | string | Bearer {token}. Required. |
+
+| Name | Type | Description |
+| : | :-- | : |
+| Authorization | string | 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 [group](../resources/group.md) object in the response body. It returns the default properties unless you use `$select` to specify specific properties. ## Example
If successful, this method returns a `200 OK` response code and [group](../resou
The following is an example of a GET request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "sampleKeys": ["45b7d2e7-b882-4a80-ba97-10b7a63b8fa4"], "name": "get_group_1" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/45b7d2e7-b882-4a80-ba97-10b7a63b8fa4 ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-1-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-1-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-1-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-1-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-1-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response. It includes only the default properties.
->**Note:** The response object shown here might be shortened for readability. All the default properties are returned in an actual call.
+> **Note:** The response object shown here might be shortened for readability. All the default properties are returned in an actual call.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.group", "name": "get_group_1" } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
} ``` - ### Example 2: Return additional properties by using $select #### Request The following is an example of a GET request. - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "sampleKeys": ["b320ee12-b1cd-4cca-b648-a437be61c5cd"], "name": "get_group_non_default" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-non-default-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-non-default-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-non-default-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-non-default-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-non-default-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response The following is an example of the response which includes the requested non-default properties.
The following is an example of the response which includes the requested non-def
"@odata.type": "microsoft.graph.group", "name": "get_group_non_default" } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
"unseenCount": 0 } ```+ ### Example 3: Read a specific dynamic group #### Request
The following is an example of the request.
"sampleKeys": ["1cdf9c18-a7dc-46b1-b47f-094d5656376d"], "name": "get_dynamic_group" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/1cdf9c18-a7dc-46b1-b47f-094d5656376d?$select=id,membershipRule,membershipRuleProcessingState,membershipRuleProcessingStatus ```
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
- [Add custom data to users using open extensions](/graph/extensibility-open-users) - [Add custom data to groups using schema extensions](/graph/extensibility-schema-groups) - <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
Content-type: application/json
] } -->--
v1.0 Group List Acceptedsenders https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-acceptedsenders.md
Title: "List acceptedSenders" description: "Get a list of users or groups that are in the accepted-senders list for this group."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Get a list of users or groups that are in the accepted-senders list for this gro
Users in the accepted senders list can post to conversations of the group (identified in the GET request URL). Make sure you do not specify the same user or group in the accepted senders and rejected senders lists, otherwise you will get an error. ## 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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
[!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/acceptedSenders ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| 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 collection of [directoryObject](../resources/directoryobject.md) objects in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_acceptedsenders" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/acceptedSenders ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-acceptedsenders-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-acceptedsenders-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-acceptedsenders-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-acceptedsenders-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-acceptedsenders-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group List Approleassignments https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-approleassignments.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All |
v1.0 Group List Calendarview https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-calendarview.md
Title: "List calendarView" description: "Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the default calendar of a group." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the default calendar of a group. ## 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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime} ``` ## Query parameters+ In the request URL, provide the following required query parameters with values.
-| Parameter | Type | Description |
-|:--|:-|:--|
+| Parameter | Type | Description |
+| : | :-- | :- |
| startDateTime | String | The start date and time of the time range, represented in ISO 8601 format. For example, "2019-11-08T19:00:00-08:00". | | endDateTime | String | The end date and time of the time range, represented in ISO 8601 format. For example, "2019-11-08T20:00:00-08:00". |
This method also supports some of the [OData Query Parameters](/graph/query-para
> The **createdDateTime** and **lastModifiedDateTime** properties of [event](../resources/event.md) do not support `$select`. To get their values, simply query on **calendarView** without applying `$select`. ## Request headers
-| Name | Type | Description |
-|:|:--|:--|
-| Authorization | string | Bearer {token}. Required. |
-| Prefer: outlook.timezone | string | Use this to specify the time zone for start and end times in the response. If not specified, those time values are returned in UTC. Optional. |
+
+| Name | Type | Description |
+| :-- | :-- | : |
+| Authorization | string | Bearer {token}. Required. |
+| Prefer: outlook.timezone | string | Use this to specify the time zone for start and end times in the response. If not specified, those time values are returned in UTC. Optional. |
| Prefer: outlook.body-content-type | string | The format of the **body** property to be returned in. Values can be "text" or "html". A `Preference-Applied` header is returned as confirmation if this `Prefer` header is specified. If the header is not specified, the **body** property is returned in HTML format. Optional. | ## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns a `200 OK` response code and collection of [event](../resources/event.md) objects in the response body. ## Example+ #### Request+ The following example requests event bodies to be returned in text format. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_get_calendarviews" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/02bd9fd6-8f93-4758-87c3-1fb73740a315/calendarView?startDateTime=2017-01-01T19:00:00-08:00&endDateTime=2017-10-01T19:00:00.00-08:00 Prefer: outlook.body-content-type="text" ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-get-calendarviews-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-get-calendarviews-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-get-calendarviews-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-get-calendarviews-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.event", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
v1.0 Group List Conversations https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-conversations.md
Title: "List conversations" description: "Retrieve the list of conversations in this group."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Retrieve the list of [conversations](../resources/conversation.md) in this group. ## 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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.Read.All, Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.Read.All, Group.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/conversations ``` ## Optional query parameters+ This method supports the `$select` and `$filter` [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| 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 collection of [conversation](../resources/conversation.md) objects in the response body. ## Example+ ### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_conversations" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/conversations ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-conversations-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-conversations-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-conversations-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-conversations-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-conversations-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - ### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.conversation", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group List Endpoints https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-endpoints.md
Title: "List endpoints" description: "Retrieve a list of endpoint objects."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Retrieve a list of [endpoint](../resources/endpoint.md) objects. ## 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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.Read.All, Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.Read.All, Group.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/endpoints ```+ ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Name |Description|
-|:-|:-|
-| Authorization | Bearer {token}. Required.|
-| Content-Type | Application/Json |
+
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | Application/Json |
## 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 [Endpoint](../resources/endpoint.md) objects in the response body.+ ## Example
-### Request
+### Request
# [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_endpoints_1" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/endpoints ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-endpoints-1-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-endpoints-1-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-endpoints-1-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-endpoints-1-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-endpoints-1-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] ### Response+ Here is an example of the response.
->Note: The response object shown here might be shortened for readability.
+
+> Note: The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.endpoint", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
v1.0 Group List Grouplifecyclepolicies https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-grouplifecyclepolicies.md
Title: "List groupLifecyclePolicies" description: "Retrieves a list of groupLifecyclePolicy objects to which a group belongs."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Retrieves a list of [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md)
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) | Directory.Read.All, Directory.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Directory.Read.All, Directory.ReadWrite.All|
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Directory.Read.All, Directory.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/groupLifecyclePolicies ```+ ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Name | Description |
-|:-|:-|
+
+| 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 collection of [groupLifecyclePolicy](../resources/grouplifecyclepolicy.md) objects in the response body.+ ## Example ##### Request - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_grouplifecyclepolicies" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/groupLifecyclePolicies ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-grouplifecyclepolicies-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-grouplifecyclepolicies-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-grouplifecyclepolicies-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-grouplifecyclepolicies-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/groups/{id}/groupLifecyclePolicies
##### Response Note: The response object shown here might be shortened for readability.+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.groupLifecyclePolicy", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
v1.0 Group List Memberof https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-memberof.md
Title: "List group memberOf" description: "Get groups and administrative units that the group is a direct member of."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Get groups and administrative units that the group is a direct member of.
-This operation is not transitive. Unlike getting a user's Microsoft 365 groups, this returns all types of groups, not just Microsoft 365 groups.
+This operation is not transitive. Unlike getting a user's Microsoft 365 groups, this returns all types of groups, not just Microsoft 365 groups.
## 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) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Directory.ReadWrite.All |
## HTTP request <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/memberOf ```
This method supports the [OData query parameters](/graph/query-parameters) to he
## Request headers
-| Name | Description |
-|:- |:-- |
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | :- |
+| Authorization | Bearer {token}. Required. |
| ConsistencyLevel | eventual. This header and `$count` are required when using the `$search`, `$filter`, `$orderby`, or OData cast query parameters. It uses an index that might not be up-to-date with recent changes to the object. | ## Request body
If successful, this method returns a `200 OK` response code and collection of [d
The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_get_memberof" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/memberOf ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-get-memberof-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-get-memberof-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-get-memberof-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-get-memberof-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-get-memberof-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/groups/{id}/memberOf
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
The following is an example of the request.
"blockType": "ignored", "name": "get_count_only" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/memberOf/$count ConsistencyLevel: eventual
The following is an example of the response.
"blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
394 ``` --- ### Example 3: Use OData cast to get only a count of group membership #### Request
The following is an example of the request.
"blockType": "ignored", "name": "get_count_group_only" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/devices/{id}/memberOf/microsoft.graph.group/$count ConsistencyLevel: eventual
The following is an example of the response.
"blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
394 ``` -- ### Example 4: Use OData cast and $search to get membership with display names that contain the letters 'Video' including a count of returned objects #### Request
The following is an example of the request.
"blockType": "ignored", "name": "get_video_count" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:Video" ConsistencyLevel: eventual
ConsistencyLevel: eventual
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. <!-- {
- "blockType": "ignored",
- "name": "get_a_count"
+ "blockType": "request",
+ "name": "list_groups_memberof_startswith"
}-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/memberOf/microsoft.graph.group?$count=true&$orderby=displayName&$filter=startswith(displayName, 'A') ConsistencyLevel: eventual
ConsistencyLevel: eventual
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } ```+ <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
Content-type: application/json
] } -->--
v1.0 Group List Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-members.md
Title: "List group members" description: "Get a list of the group's direct members." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
When a group contains more than 100 members, Microsoft Graph returns a `@odata.n
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) | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
> **Note:** To list the members of a hidden membership group, the Member.Read.Hidden permission is required. [!INCLUDE [limited-info](../../includes/limited-info.md)]
-
+ ## HTTP request <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/members ```
This method supports the [OData query parameters](/graph/query-parameters) to he
## Request headers
-| Name | Description |
-|:- |:-- |
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | :- |
+| Authorization | Bearer {token}. Required. |
| ConsistencyLevel | eventual. This header and `$count` are required when using the `$search`, `$filter`, `$orderby`, or OData cast query parameters. It uses an index that might not be up-to-date with recent changes to the object. | ## Request body
If successful, this method returns a `200 OK` response code and collection of [d
The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_members" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/members ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-members-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-members-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-members-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-members-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-members-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/groups/{id}/members
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
The following is an example of the request.
"blockType": "ignored", "name": "get_count_only" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/members/$count ConsistencyLevel: eventual
The following is an example of the response.
"blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
893 ``` -- ### Example 3: Use OData cast to get only a count of user membership #### Request
The following is an example of the request.
"blockType": "ignored", "name": "get_count_user_only" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/members/microsoft.graph.user/$count ConsistencyLevel: eventual
The following is an example of the response.
"blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
893 ``` -- ### Example 4: Use $search and OData cast to get user membership in groups with display names that contain the letters 'Pr' including a count of returned objects #### Request
The following is an example of the request.
"blockType": "request", "name": "get_pr_count" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/members/microsoft.graph.user?$count=true&$orderby=displayName&$search="displayName:Pr"&$select=displayName,id ConsistencyLevel: eventual ``` - #### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.user", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. - # [HTTP](#tab/http)+ <!-- { "blockType": "request",
- "name": "get_a_count"
+ "name": "list_groups_members_startswith"
}-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/members?$count=true&$filter=startswith(displayName, 'a') ConsistencyLevel: eventual ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-a-count-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-a-count-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-a-count-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-a-count-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-a-count-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
} -->
+### Example 6: Use OData cast to retrieve service principals added as group members
+
+#### Request
+
+The following is an example of the request.
+
+# [HTTP](#tab/http)
+
+<!-- {
+ "blockType": "request",
+ "name": "get_members_serviceprincipals"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/groups/3802e9bb-0951-4e18-b9eb-f934b4241194/members/microsoft.graph.servicePrincipal
+```
+
+# [C#](#tab/csharp)
++
+# [JavaScript](#tab/javascript)
++
+# [Objective-C](#tab/objc)
++
+# [Java](#tab/java)
++
+# [Go](#tab/go)
++++
+#### Response
+
+The following is an example of the response.
+
+> **Note:** The response object shown here might be shortened for readability.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.servicePrincipal",
+ "isCollection": true
+} -->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#servicePrincipals",
+ "value": [
+ {
+ "id": "11111111-2222-3333-4444-555555555555",
+ "deletedDateTime": null,
+ "accountEnabled": true,
+ "appDisplayName": "Contoso Azure App",
+ "appId": "11111111-2222-3333-4444-555555555555",
+ }
+ ]
+}
+```
v1.0 Group List Owners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-owners.md
Title: "List owners" description: "Retrieve a list of the group's owners." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Retrieve a list of the group's owners. The owners are a set of users who are allowed to modify the group object. Owners are currently not available in Microsoft Graph for groups that were created in Exchange or groups that are synchronized from an on-premises environment.
+Retrieve a list of the group's owners. The owners are a set of users who are allowed to modify the group object. Owners are currently not available in Microsoft Graph for groups that were created in Exchange or groups that are synchronized from an on-premises environment.
## 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) | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
[!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/owners ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Name | Type | Description|
-|:--|:|:-|
-| Authorization | string | Bearer {token}. Required. |
+
+| Name | Type | Description |
+| : | :-- | : |
+| Authorization | string | 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 collection of [directoryObject](../resources/directoryobject.md) objects in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_get_owners" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/owners ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-get-owners-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-get-owners-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-get-owners-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-get-owners-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-get-owners-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group List Photos https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-photos.md
Title: "List photos" description: "Retrieve a list of profilePhoto objects."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Retrieve a list of [profilePhoto](../resources/profilephoto.md) objects. ## 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) | Group.ReadBasic.All, Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.ReadBasic.All, Group.Read.All, Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | Group.ReadBasic.All, Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.ReadBasic.All, Group.Read.All, Group.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/photos GET /users/{id | userPrincipalName}/joinedGroups/{id}/photos ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Name | Type | Description|
-|:--|:|:-|
-| Authorization | string | Bearer {token}. Required. |
+
+| Name | Type | Description |
+| : | :-- | : |
+| Authorization | string | 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 collection of [profilePhoto](../resources/profilephoto.md) objects in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_photos" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/photos ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-photos-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-photos-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-photos-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-photos-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-photos-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.profilePhoto", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group List Rejectedsenders https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-rejectedsenders.md
Title: "List rejectedSenders" description: "Get a list of users or groups that are in the rejected-senders list for this group. "-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get a list of users or groups that are in the rejected-senders list for this group.
+Get a list of users or groups that are in the rejected-senders list for this group.
Users in the rejected senders list cannot post to conversations of the group (identified in the GET request URL). Make sure you do not specify the same user or group in the rejected senders and accepted senders lists, otherwise you will get an error. ## 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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
[!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/rejectedSenders ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| 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 collection of [directoryObject](../resources/directoryobject.md) objects in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_rejectedsenders" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/rejectedSenders ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-rejectedsenders-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-rejectedsenders-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-rejectedsenders-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-rejectedsenders-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-rejectedsenders-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group List Settings https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-settings.md
+
+ Title: "List settings"
+description: "Retrieve a list of directory setting objects."
+
+ms.localizationpriority: medium
++
+# List settings
+
+Namespace: microsoft.graph
++
+Retrieve a list of tenant-level or group-specific group settings objects.
+
+## 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).
+
+### List tenant-wide settings
+
+|Permission type | Permissions (from least to most privileged) |
+|:--|:|
+|Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | Directory.Read.All, Directory.ReadWrite.All |
+
+### List group-specific settings
+
+|Permission type | Permissions (from least to most privileged) |
+|:--|:|
+|Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+|Delegated (personal Microsoft account) | Not supported. |
+|Application | Group.Read.All, Group.ReadWrite.All |
+
+## HTTP request
+<!-- { "blockType": "ignored" } -->
+List tenant-wide or group settings
+```http
+GET /settings
+```
+
+<!-- { "blockType": "ignored" } -->
+List group-specific settings
+```http
+GET /groups/{groupId}/settings
+```
+
+## Optional query parameters
+This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response.
+
+## 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 collection of [directorySetting](../resources/directorysetting.md) objects in the response body.
+
+## Example
+
+### Request
+Here is an example of the request.
+
+# [HTTP](#tab/http)
+<!-- {
+ "blockType": "request",
+ "name": "get_settings_1"
+}-->
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/settings
+```
+# [C#](#tab/csharp)
+
+# [JavaScript](#tab/javascript)
+
+# [Objective-C](#tab/objc)
+
+# [Java](#tab/java)
+
+# [Go](#tab/go)
+
+# [PowerShell](#tab/powershell)
+++
+### Response
+The following is an example of the response.
+>**Note:** The response object shown here might be shortened for readability.
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.directorySetting",
+ "isCollection": true
+} -->
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#settings",
+ "value": [
+ {
+ "id": "f0b2d6f5-097d-4177-91af-a24e530b53cc",
+ "displayName": "Group.Unified",
+ "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
+ "values": [
+ {
+ "name": "EnableMIPLabels",
+ "value": "true"
+ },
+ {
+ "name": "CustomBlockedWordsList",
+ "value": ""
+ },
+ {
+ "name": "EnableMSStandardBlockedWords",
+ "value": "true"
+ },
+ {
+ "name": "ClassificationDescriptions",
+ "value": ""
+ },
+ {
+ "name": "DefaultClassification",
+ "value": ""
+ },
+ {
+ "name": "PrefixSuffixNamingRequirement",
+ "value": "[Contoso-][GroupName]"
+ },
+ {
+ "name": "AllowGuestsToBeGroupOwner",
+ "value": "false"
+ },
+ {
+ "name": "AllowGuestsToAccessGroups",
+ "value": "true"
+ },
+ {
+ "name": "GuestUsageGuidelinesUrl",
+ "value": "https://privacy.contoso.com/privacystatement"
+ },
+ {
+ "name": "GroupCreationAllowedGroupId",
+ "value": ""
+ },
+ {
+ "name": "AllowToAddGuests",
+ "value": "true"
+ },
+ {
+ "name": "UsageGuidelinesUrl",
+ "value": ""
+ },
+ {
+ "name": "ClassificationList",
+ "value": ""
+ },
+ {
+ "name": "EnableGroupCreation",
+ "value": "true"
+ }
+ ]
+ }
+ ]
+}
+```
+
+<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79
+2015-10-25 14:57:30 UTC -->
+<!--
+{
+ "type": "#page.annotation",
+ "description": "List settings",
+ "keywords": "",
+ "section": "documentation",
+ "tocPath": "",
+ "suppressions": [
+ ]
+}
+-->
v1.0 Group List Threads https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-threads.md
Title: "List threads" description: "Get all the threads of a group."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Get all the threads of a group.
Note: You can also [get all the threads of a conversation](conversation-list-threads.md). ## 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) | Group.Read.All, Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.Read.All, Group.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.Read.All, Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.Read.All, Group.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/threads ``` ## Optional query parameters+ This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| 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 collection of [conversationThread](../resources/conversationthread.md) objects in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_threads" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/threads ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-threads-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-threads-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-threads-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-threads-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-threads-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.conversationThread", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group List Transitivememberof https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-transitivememberof.md
Title: "List group transitive memberOf" description: "Get groups and administrative units that the group is a member of." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Get groups and administrative units that the group is a member of. This operation is transitive and will also include all groups that this groups is a nested member of. Unlike getting a user's Microsoft 365 groups, this returns all types of groups, not just Microsoft 365 groups.
+Get groups and administrative units that the group is a member of. This operation is transitive and will also include all groups that this groups is a nested member of. Unlike getting a user's Microsoft 365 groups, this returns all types of groups, not just Microsoft 365 groups.
## 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) | Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | Directory.Read.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Directory.Read.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Directory.Read.All, Directory.ReadWrite.All |
[!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request <!-- { "blockType": "ignored" } -->+ ```http GET /groups/{id}/transitiveMemberOf ```
This method supports the [OData query parameters](/graph/query-parameters) to he
## Request headers
-| Name | Description |
-|:- |:-- |
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | :- |
+| Authorization | Bearer {token}. Required. |
| ConsistencyLevel | eventual. This header and `$count` are required when using the `$search`, `$filter`, `$orderby`, or OData cast query parameters. It uses an index that might not be up-to-date with recent changes to the object. | ## Request body
If successful, this method returns a `200 OK` response code and collection of [d
The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_transitivememberof"
The following is an example of the request.
```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMemberOf ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-transitivememberof-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-transitivememberof-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-transitivememberof-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-transitivememberof-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-transitivememberof-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/groups/{id}/transitiveMemberOf
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
The following is an example of the request.
"blockType": "ignored", "name": "get_count_only" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMemberOf/$count ConsistencyLevel: eventual
The following is an example of the response.
"blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
294 ``` -- ### Example 3: Use OData cast to get only a count of transitive membership in groups #### Request
The following is an example of the request.
"blockType": "ignored", "name": "get_count_only" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMemberOf/microsoft.graph.group/$count ConsistencyLevel: eventual
The following is an example of the response.
"blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
294 ``` --- ### Example 4: Use OData cast and $search to get membership in groups with display names that contain the letters 'tier' including a count of returned objects #### Request
The following is an example of the request.
"blockType": "ignored", "name": "get_tier_count" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMemberOf/microsoft.graph.group?$count=true&$orderby=displayName&$search="displayName:tier"&$select=displayName,id ConsistencyLevel: eventual
ConsistencyLevel: eventual
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
The following is an example of the request.
<!-- { "blockType": "ignored",
- "name": "get_a_count"
+ "name": "list_groups_transitivememberof_startswith"
}-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMemberOf/microsoft.graph.group?$count=true&$orderby=displayName&$filter=startswith(displayName, 'a') ConsistencyLevel: eventual
ConsistencyLevel: eventual
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
} ```+ <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
Content-type: application/json
] } -->--
v1.0 Group List Transitivemembers https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-transitivemembers.md
Title: "List group transitive members" description: "Get a list of the group's members." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Get a list of the group's members. A group can have users, contacts, devices, se
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) | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All, Directory.AccessAsUser.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All |
-> **Note:** To list the members of a hidden membership group, the *Member.Read.Hidden* permission is required.
+> **Note:** To list the members of a hidden membership group, the _Member.Read.Hidden_ permission is required.
[!INCLUDE [limited-info](../../includes/limited-info.md)]
To filter the results on the OData type, such as `microsoft.graph.user` or `micr
## Request headers
-| Name | Description |
-|:- |:-- |
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | :- |
+| Authorization | Bearer {token}. Required. |
| ConsistencyLevel | eventual. This header and `$count` are required when using the `$search`, `$filter`, `$orderby`, or OData cast query parameters. It uses an index that might not be up-to-date with recent changes to the object. | ## Request body
If successful, this method returns a `200 OK` response code and collection of [d
The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_transitivemembers"
The following is an example of the request.
```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMembers ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-transitivemembers-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-transitivemembers-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-transitivemembers-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-group-transitivemembers-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-group-transitivemembers-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/groups/{id}/transitiveMembers
The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.directoryObject", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. - # [HTTP](#tab/http)+ <!-- { "blockType": "ignored", "name": "get_group_transitivemembers_count"
The following is an example of the request.
GET https://graph.microsoft.com/beta/groups/{id}/transitiveMembers/$count ConsistencyLevel: eventual ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-transitivemembers-count-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-transitivemembers-count-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-transitivemembers-count-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response The following is an example of the response.
The following is an example of the response.
<!-- { "blockType": "response", } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
893 ``` - ### Example 3: Use the microsoft.graph.group OData cast to get only members that are groups #### Request The following is an example of the request. - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_group_transitivemembers_odataCast" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitivemembers/microsoft.graph.group?$count=true ConsistencyLevel: eventual ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-group-transitivemembers-odatacast-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-group-transitivemembers-odatacast-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-group-transitivemembers-odatacast-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -
+# [Go](#tab/go)
+ + #### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_tier_count" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMembers/microsoft.graph.user?$count=true&$orderBy=displayName&$search="displayName:tier"&$select=displayName,id ConsistencyLevel: eventual ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-tier-count-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-tier-count-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-tier-count-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -
+# [Go](#tab/go)
+ + #### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. - # [HTTP](#tab/http)+ <!-- { "blockType": "request",
- "name": "get_a_count"
+ "name": "list_groups_transitivemembers_startswith"
}--> ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/{id}/transitiveMembers/microsoft.graph.user?$count=true&$orderBy=displayName&$filter=startswith(displayName, 'a') ConsistencyLevel: eventual ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-a-count-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-a-count-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-a-count-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-a-count-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-a-count-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } ```+ <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
Content-type: application/json
] } -->--
v1.0 Group List https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list.md
Title: "List groups" description: "List all the groups available in an organization, including but not limited to Microsoft 365 groups." ms.localizationpriority: high-+ ms.prod: "groups" doc_type: apiPageType
This operation returns by default only a subset of the more commonly used proper
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) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-| Delegated (personal Microsoft account) | Not supported. |
-| Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :-- |
+| Delegated (work or school account) | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.Read.All, Group.Read.All, Directory.Read.All, Group.ReadWrite.All, Directory.ReadWrite.All |
## HTTP request <!-- { "blockType": "ignored" } -->+ ```http GET /groups ```
GET /groups
This method supports the `$count`, `$expand`, `$filter`, `$orderBy`, `$search`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. The default and maximum page sizes are 100 and 999 group objects respectively. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). To list only Microsoft 365 groups (aka unified groups), apply a filter on **groupTypes**:+ <!-- { "blockType": "ignored" } -->+ ```http GET https://graph.microsoft.com/beta/groups?$filter=groupTypes/any(c:c+eq+'Unified') ```
For more information on OData query options, see [OData query parameters](/graph
## Request headers
-| Name | Description |
-|:- |:-- |
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
| ConsistencyLevel | eventual. This header and `$count` are required when using `$search`, or in specific usage of `$filter`. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). | ## Request body
If successful, this method returns a `200 OK` response code and collection of [g
The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_groups" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-groups-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-groups-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-groups-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-groups-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-groups-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
GET https://graph.microsoft.com/beta/groups
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability. All the default properties are returned for each group in an actual call.
+
+> **Note:** The response object shown here might be shortened for readability. All the default properties are returned for each group in an actual call.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` because `$count` is in the request. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
->**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
+> **Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
<!-- { "blockType": "request", "name": "get_groups_withlicenseerrors_count" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups?$count=true&$filter=hasMembersWithLicenseErrors+eq+true&$select=id,displayName ConsistencyLevel: eventual
The following is an example of the response which includes only the requested pr
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` because `$count` is in the request. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
->**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
+> **Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
<!-- { "blockType": "ignored", "name": "get_count_only" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups/$count ConsistencyLevel: eventual
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: text/plain
Content-type: text/plain
893 ``` - ### Example 4: Use $filter and $top to get one group with a display name that starts with 'a' including a count of returned objects #### Request The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` and the `$count=true` query string because the request has both the `$orderBy` and `$filter` query parameters. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
->**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
+> **Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
<!-- { "blockType": "request",
- "name": "get_a_count"
+ "name": "get_groups_startswith"
}-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups?$filter=startswith(displayName, 'a')&$count=true&$top=1&$orderby=displayName ConsistencyLevel: eventual
ConsistencyLevel: eventual
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` because `$search` is in the request. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
->**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
+> **Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
<!-- { "blockType": "request", "name": "get_video_count" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups?$search="displayName:Video"&$count=true ConsistencyLevel: eventual
ConsistencyLevel: eventual
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` because `$search` is in the request. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
->**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
+> **Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
<!-- { "blockType": "request", "name": "get_video_count" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups?$search="displayName:Video" OR "description:prod"&$orderby=displayName&$count=true ConsistencyLevel: eventual
ConsistencyLevel: eventual
#### Response The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
The following is an example of the request that filters by the **membershipRuleProcessingState** to retrieve dynamic groups. You may also filter by the **groupTypes** properties (that is, `$filter=groupTypes/any(s:s eq 'DynamicMembership')`). This request requires the **ConsistencyLevel** header set to `eventual` and the `$count=true` query string because the request uses the `not` operator of the `$filter` query parameter. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries).
->**Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
+> **Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants.
# [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "get_enabled_dynamic_groups" }-->+ ```msgraph-interactive GET https://graph.microsoft.com/beta/groups?$filter=mailEnabled eq false and securityEnabled eq true and NOT(groupTypes/any(s:s eq 'Unified')) and membershipRuleProcessingState eq 'On'&$count=true&$select=id,membershipRule,membershipRuleProcessingState ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/get-enabled-dynamic-groups-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/get-enabled-dynamic-groups-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/get-enabled-dynamic-groups-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/get-enabled-dynamic-groups-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/get-enabled-dynamic-groups-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response The following is an example of the response.
The following is an example of the response.
"@odata.type": "microsoft.graph.group", "isCollection": true } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
} ```
+### Example 8: List any groups with any licenses
+
+#### Request
+
+# [HTTP](#tab/http)
+
+<!-- {
+ "blockType": "request",
+ "name": "get_groups_with_licenses"
+}-->
+
+```msgraph-interactive
+GET https://graph.microsoft.com/beta/groups?$select=id,assignedLicenses&$filter=assignedLicenses/any()
+```
+
+# [C#](#tab/csharp)
++
+# [JavaScript](#tab/javascript)
++
+# [Objective-C](#tab/objc)
++
+# [Java](#tab/java)
++
+# [Go](#tab/go)
++
+# [PowerShell](#tab/powershell)
++++
+#### Response
+
+The following is an example of the response.
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.group",
+ "isCollection": true
+} -->
+
+```http
+HTTP/1.1 200 OK
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#groups(id,assignedLicenses)",
+ "value": [
+ {
+ "id": "5caf712c-8483-4b3d-8384-d8da988c0ca4",
+ "assignedLicenses": [
+ {
+ "disabledPlans": [],
+ "skuId": "6fd2c87f-b296-42f0-b197-1e91e994b900"
+ }
+ ]
+ },
+ {
+ "id": "aae8ec2a-5a08-4013-ae70-fafbb5c20de1",
+ "assignedLicenses": [
+ {
+ "disabledPlans": [
+ "7547a3fe-08ee-4ccb-b430-5077c5041653"
+ ],
+ "skuId": "18181a46-0d4e-45cd-891e-60aabd171b4e"
+ }
+ ]
+ },
+ {
+ "id": "e55bdaa0-e104-479a-979e-b0457fff6380",
+ "assignedLicenses": [
+ {
+ "disabledPlans": [
+ "7547a3fe-08ee-4ccb-b430-5077c5041653"
+ ],
+ "skuId": "6fd2c87f-b296-42f0-b197-1e91e994b900"
+ }
+ ]
+ }
+ ]
+}
+```
+ <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
Content-type: application/json
] } -->--
v1.0 Group Post Acceptedsenders https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-acceptedsenders.md
Title: "Create acceptedSender" description: "Add a new user or group to the acceptedSender list."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Add a new user or group to the acceptedSender list.
Specify the user or group in `@odata.id` in the request body. Users in the accepted senders list can post to conversations of the group . Make sure you do not specify the same user or group in the accepted senders and rejected senders lists, otherwise you will get an error. ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/acceptedSenders/$ref ```+ ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ In the request body, supply the id of a user or group object. ## Response+ This method returns `204 No Content` response code and no response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "create_acceptedsender" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/acceptedSenders/$ref Content-type: application/json
Content-type: application/json
"@odata.id":"https://graph.microsoft.com/beta/users/alexd@contoso.com" } ```+ # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-acceptedsender-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-acceptedsender-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-acceptedsender-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-acceptedsender-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-acceptedsender-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Post Approleassignments https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-approleassignments.md
One of the following permissions is required to call this API. To learn more, in
|Permission type | Permissions (from least to most privileged) | |:--|:|
-|Delegated (work or school account) | AppRoleAssignment.ReadWrite.All, Directory.AccessAsUser.All |
+|Delegated (work or school account) | AppRoleAssignment.ReadWrite.All |
|Delegated (personal Microsoft account) | Not supported. | |Application | AppRoleAssignment.ReadWrite.All |
v1.0 Group Post Conversations https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-conversations.md
Title: "Create conversation" description: "Create a new conversation by including a thread and a post. "-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Create a new [conversation](../resources/conversation.md) by including a thread and a post.
+Create a new [conversation](../resources/conversation.md) by including a thread and a post.
Use [reply thread](conversationthread-reply.md) or [reply post](post-reply.md) to further post to that conversation. ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/conversations ``` ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Content-Type | application/json |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json |
## Request body+ In the request body, supply a JSON representation of [conversation](../resources/conversation.md) object containing a [conversationThread](../resources/conversationthread.md) and a [post](../resources/post.md). ## Response
-If successful, this method returns `201 Created` response code and [conversation](../resources/conversation.md) object in the response body.
-The response includes the IDs for the new conversation and thread, which you can use in the
+If successful, this method returns `201 Created` response code and [conversation](../resources/conversation.md) object in the response body.
+
+The response includes the IDs for the new conversation and thread, which you can use in the
[list posts](conversationthread-list-posts.md) operation to get the new post as well. ## Example+ ### Request
-The following is an example of the request.
+The following is an example of the request.
# [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "create_conversation_from_group" }-->+ ```http POST https://graph.microsoft.com/beta/groups/29981b6a-0e57-42dc-94c9-cd24f5306196/conversations Content-type: application/json
Content-type: application/json
] } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-conversation-from-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-conversation-from-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-conversation-from-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-conversation-from-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-conversation-from-group-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - ### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.conversation" } -->+ ```http HTTP/1.1 200 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group Post Events https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-events.md
Title: "Create event" description: "Use this API to create a new event."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Use this API to create a new [event](../resources/event.md). ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/events POST /groups/{id}/calendar/events ``` ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ In the request body, supply a JSON representation of an [event](../resources/event.md) object. ## Response+ If successful, this method returns a `201 Created` response code and an [event](../resources/event.md) object in the response body. ## Example+ ### Request+ The following is an example of a request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "sampleKeys": ["01d4ee64-15ce-491e-bad1-b91aa3223df4"], "name": "create_event_from_group" }-->+ ```http POST https://graph.microsoft.com/beta/groups/01d4ee64-15ce-491e-bad1-b91aa3223df4/events Content-type: application/json
Content-type: application/json
] } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-event-from-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-event-from-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-event-from-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-event-from-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-event-from-group-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] ### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.event" } -->+ ```http HTTP/1.1 201 Created Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group Post Groups https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-groups.md
Title: "Create group" description: "Create a new Microsoft 365 group or security group."-+ ms.localizationpriority: high ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Create a new [group](../resources/group.md) as specified in the request body. You can create one of the following groups:
-* Microsoft 365 group (unified group)
-* Security group
+- Microsoft 365 group (unified group)
+- Security group
This operation returns by default only a subset of the properties for each group. These default properties are noted in the [Properties](../resources/group.md#properties) section. To get properties that are _not_ returned by default, do a [GET operation](group-get.md) and specify the properties in a `$select` OData query option. **Note**: To create a [team](../resources/team.md), first create a group then add a team to it, see [create team](../api/team-put-teams.md). ## 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) | Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.Create, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.Create, Group.ReadWrite.All, Directory.ReadWrite.All |
## HTTP request <!-- { "blockType": "ignored" } -->+ ```http POST /groups ``` ## Request headers
-| Name | Description|
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body
In the request body, supply a JSON representation of the [group](../resources/gr
The following table shows the properties that are required when you create the [group](../resources/group.md). Specify other writable properties as necessary for your group.
-| Property | Type | Description|
-|:|:--|:-|
-| displayName | string | The name to display in the address book for the group. Maximum length is 256 characters. Required. |
-| mailEnabled | boolean | Set to `true` for mail-enabled groups. Required. |
-| mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : . <> , SPACE`. Required. |
-| securityEnabled | boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Azure portal always have **securityEnabled** initially set to `true`.|
+| Property | Type | Description |
+| :-- | : | :-- |
+| displayName | string | The name to display in the address book for the group. Maximum length is 256 characters. Required. |
+| mailEnabled | boolean | Set to `true` for mail-enabled groups. Required. |
+| mailNickname | string | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the [ASCII character set 0 - 127](/office/vba/language/reference/user-interface-help/character-set-0127) except the following: ` @ () \ [] " ; : . <> , SPACE`. Required. |
+| securityEnabled | boolean | Set to `true` for security-enabled groups, including Microsoft 365 groups. Required. **Note:** Groups created using the Microsoft Azure portal always have **securityEnabled** initially set to `true`. |
> [!IMPORTANT]
-> + Creating a group using the **Group.Create** application permission without specifying owners will create the group anonymously and the group will not be modifiable. Add owners to the group while creating it to specify owners who can modify the group.
>
->+ Creating a Microsoft 365 group programmatically with an app-only context and without specifying owners will create the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken.
+> - Creating a group using the **Group.Create** application permission without specifying owners will create the group anonymously and the group will not be modifiable. Add owners to the group while creating it to specify owners who can modify the group.
+>
+> - Creating a Microsoft 365 group programmatically with an app-only context and without specifying owners will create the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken.
>
->+ To following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**.
+> - To following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**.
Because the **group** resource supports [extensions](/graph/extensibility-overview), you can add custom properties with your own data to the group while creating it.
Because the **group** resource supports [extensions](/graph/extensibility-overvi
Use the **groupTypes** property to control the type of group and its membership, as shown.
-| Type of group | Assigned membership | Dynamic membership |
-|:--|:|:|
-| Microsoft 365 (aka unified group)| `["Unified"]` | `["Unified","DynamicMembership"]`
-| Dynamic | `[]` (_null_) | `["DynamicMembership"]`|
+| Type of group | Assigned membership | Dynamic membership |
+| :-- | : | :-- |
+| Microsoft 365 (aka unified group) | `["Unified"]` | `["Unified","DynamicMembership"]` |
+| Dynamic | `[]` (_null_) | `["DynamicMembership"]` |
## Response
If successful, this method returns a `201 Created` response code and a [group](.
The following example creates a Microsoft 365 group. Because the owners have not been specified, the calling user is automatically added as the owner of the group. - #### Request The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "create_group" }-->
-``` http
+
+```http
POST https://graph.microsoft.com/beta/groups Content-type: application/json
Content-type: application/json
"securityEnabled": false } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-group-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response The following is an example of the response. The value of the **preferredDataLocation** property is inherited from the group creator's preferred data location.
->**Note:** The response object shown here might be shortened for readability.
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of the response. The value of the **preferredDataLoc
"@odata.type": "microsoft.graph.group", "name": "create_group" } -->
-``` http
+
+```http
HTTP/1.1 201 Created Content-type: application/json
The following is an example of the request.
"blockType": "request", "name": "create_prepopulated_group" }-->
-``` http
+
+```http
POST https://graph.microsoft.com/beta/groups Content-Type: application/json
Content-Type: application/json
The following is an example of a successful response. It includes only default properties. You can subsequently get the **owners** or **members** navigation properties of the group to verify the owner or members. The value of the **preferredDataLocation** property is inherited from the group creator's preferred data location.
->**Note:** The response object shown here might be shortened for readability.
+> **Note:** The response object shown here might be shortened for readability.
<!-- { "blockType": "response",
The following is an example of a successful response. It includes only default p
"@odata.type": "microsoft.graph.group", "name": "create_prepopulated_group" } -->
-``` http
+
+```http
HTTP/1.1 201 Created Content-type: application/json
Content-type: application/json
#### Request
-The following is an example of the request. The calling user or app must be assigned the *RoleManagement.ReadWrite.Directory* permission to set the **isAssignableToRole** property or update the membership of such groups.
+The following is an example of the request. The calling user or app must be assigned the _RoleManagement.ReadWrite.Directory_ permission to set the **isAssignableToRole** property or update the membership of such groups.
**NOTE:** A group with **isAssignableToRole** property set to `true` cannot be of dynamic membership type. For more information, see [Using a group to manage Azure AD role assignments](https://go.microsoft.com/fwlink/?linkid=2103037). - # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "create_role_enabled_group" }-->
-``` http
+
+```http
POST https://graph.microsoft.com/beta/groups Content-Type: application/json
Content-Type: application/json
] } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-role-enabled-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-role-enabled-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-role-enabled-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-role-enabled-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-role-enabled-group-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
The following is an example of the response. The value of the **preferredDataLoc
"@odata.type": "microsoft.graph.group", "name": "create_role_enabled_group" } -->
-``` http
+
+```http
HTTP/1.1 201 Created Content-type: application/json
Content-type: application/json
- [Add custom data to users using open extensions (preview)](/graph/extensibility-open-users) - [Add custom data to groups using schema extensions (preview)](/graph/extensibility-schema-groups) - <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!--
Content-type: application/json
] } -->--
v1.0 Group Post Members https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-members.md
Title: "Add members" description: "Add a member to a Microsoft 365 or security group through the members navigation property." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Add a member to a security or Microsoft 365 group through the **members** navigation property.
-You can add users, devices, service principals, or other groups.
+You can add users, devices, service principals, or other groups.
> [!IMPORTANT]
-> + You can add members to security and Microsoft 365 groups only. For more information, see [Group types in Azure AD and Microsoft Graph only](/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph).
-> + You cannot add security groups to Microsoft 365 groups.
-> + You cannot add Microsoft 365 groups to security groups or other Microsoft 365 groups.
-> + A security group can have users, devices, groups, or service principals as its members, while a Microsoft 365 group can have only users as its members.
-
+>
+> - You can add members to security and Microsoft 365 groups only. For more information, see [Group types in Azure AD and Microsoft Graph only](/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph).
+> - You cannot add security groups to Microsoft 365 groups.
+> - You cannot add Microsoft 365 groups to security groups or other Microsoft 365 groups.
+> - A security group can have users, devices, groups, or service principals as its members, while a Microsoft 365 group can have only users as its members.
## 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) | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All |
+
+> [!IMPORTANT]
+> To add members to a role-assignable group, the calling user or app must also be assigned the _RoleManagement.ReadWrite.Directory_ permission.
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{group-id}/members/$ref ``` ## Request headers
-| Name | Description|
-|:- |:--|
+
+| Name | Description |
+| : | : |
| Authorization | Bearer {token}. Required. | ## Request body+ In the request body, supply a JSON representation of a [directoryObject](../resources/directoryobject.md), [user](../resources/user.md) or [group](../resources/group.md) object to be added. ## Response
-If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. This method returns a `400 Bad Request` response code when the object is already a member of the group. This method returns a `404 Not Found` response code when the object being added doesn't exist.
+
+If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. This method returns a `400 Bad Request` response code when the object is already a member of the group. This method returns a `404 Not Found` response code when the object being added doesn't exist.
## Example+ ### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "add_group_member" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{group-id}/members/$ref Content-type: application/json
Content-type: application/json
"@odata.id": "https://graph.microsoft.com/beta/directoryObjects/{id}" } ```+ # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/add-group-member-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/add-group-member-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/add-group-member-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/add-group-member-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/add-group-member-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
In the request body, supply a JSON representation of the `id` of the [directoryObject](../resources/directoryobject.md), [user](../resources/user.md), or [group](../resources/group.md) object you want to add. ### Response+ The following is an example of the response. <!-- { "blockType": "response" } -->+ ```http HTTP/1.1 204 No Content ``` ## See also+ - [Add member to team](team-post-members.md) - [Update member's role in team](team-update-members.md) - [Remove member from team](team-delete-members.md)
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Post Owners https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-owners.md
Title: "Add owners" description: "Add a user or service principal to a Microsoft 365 or security group's owners. The owners are a set of users or service principals who are allowed to modify the group object." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Add a user or service principal to a Microsoft 365 or security group's owners. The owners are a set of users or service principals who are allowed to modify the group object.
->**Important:** If you update the group owners and you created a team for the group, it can take up to 2 hours for the owners to be synchronized with Microsoft Teams. Also, if you want the owner to be able to make changes in a team - for example, by creating a Planner plan - the owner also needs to be added as a group/team member.
+> **Important:** If you update the group owners and you created a team for the group, it can take up to 2 hours for the owners to be synchronized with Microsoft Teams. Also, if you want the owner to be able to make changes in a team - for example, by creating a Planner plan - the owner also needs to be added as a group/team member.
## 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) | Group.ReadWrite.All, Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Group.ReadWrite.All, Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | :- |
+| Delegated (work or school account) | Group.ReadWrite.All, Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Group.ReadWrite.All, Directory.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/owners/$ref ```+ ## Request headers
-| Name | Description|
-|:|:-|
-| Authorization | Bearer {token}. Required. |
-| Content-type | application/json. Required. |
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required. |
+| Content-type | application/json. Required. |
## Request body
-In the request body, supply a JSON representation with the **@odata.id** of a [user](../resources/user.md) or [servicePrincipal](../resources/user.md) object to be added.
+
+In the request body, supply a JSON representation with the **@odata.id** of a [user](../resources/user.md) or [servicePrincipal](../resources/serviceprincipal.md) object to be added.
## Response+ If successful, this method returns a `204 No Content` response code. It does not return anything in the response body. This method returns a `400 Bad Request` response code when the object is already a member of the group. This method returns a `404 Not Found` response code when the object being added doesn't exist. ## Example+ ### Request+ The following is an example of the request that adds a user as a group owner. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "create_owner_from_group" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/owners/$ref Content-type: application/json
Content-type: application/json
"@odata.id": "https://graph.microsoft.com/beta/users/{id}" } ```+ # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-owner-from-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-owner-from-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-owner-from-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-owner-from-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-owner-from-group-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
Content-type: application/json
In the request body, supply a JSON representation with the **@odata.id** of a [user](../resources/user.md) or [servicePrincipal](../resources/user.md) object to be added. ### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response" } -->+ ```http HTTP/1.1 204 No Content ``` ## See also+ - [Add member to team](team-post-members.md) - [Update member's role in team](team-update-members.md) - [Remove member from team](team-delete-members.md)
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Post Rejectedsenders https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-rejectedsenders.md
Title: "Create rejectedSender" description: "Add a new user or group to the rejectedSender list."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Add a new user or group to the rejectedSender list.
Specify the user or group in `@odata.id` in the request body. Users in the rejected senders list cannot post to conversations of the group (identified in the POST request URL). Make sure you do not specify the same user or group in the rejected senders and accepted senders lists, otherwise you will get an error. ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/rejectedSenders/$ref ``` ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body+ In the request body, supply the id of a user or group object. ## Response+ This method returns `204 No Content` response code and no response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "create_rejectedsender" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/rejectedSenders/$ref Content-type: application/json
Content-type: application/json
"@odata.id":"https://graph.microsoft.com/beta/users/alexd@contoso.com" } ```+ # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-rejectedsender-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-rejectedsender-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-rejectedsender-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-rejectedsender-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-rejectedsender-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 204 No Content ```
HTTP/1.1 204 No Content
] } -->--
v1.0 Group Post Settings https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-settings.md
Title: "Create a directory setting on groups"
+ Title: "Create settings"
description: "Use this API to create a new directory setting for the group."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
-# Create a directory setting on groups
+# Create settings
Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Use this API to create a new directory setting for the group.
+Create a new setting based on the templates available in [directorySettingTemplates](../resources/directorysettingtemplate.md). These settings can be at the tenant-level or at the group level.
+
+Group settings apply to only Microsoft 365 groups. The template named `Group.Unified` can be used to configure tenant-wide Microsoft 365 group settings, while the template named `Group.Unified.Guest` can be used to configure group-specific settings.
+ ## 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) | Directory.ReadWrite.All, Directory.AccessAsUser.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Directory.ReadWrite.All |
## HTTP request+
+Create a tenant-wide setting.
+
+<!-- { "blockType": "ignored" } -->
+
+```http
+POST /settings
+```
+
+Create a group-specific setting.
+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/settings ```+ ## Request headers
-| Name | Description|
-|:|:-|
-| Authorization | Bearer {token}. Required|
+
+| Name | Description |
+| : | :-- |
+| Authorization | Bearer {token}. Required |
## Request body+ In the request body, supply a JSON representation of [directorySetting](../resources/directorysetting.md) object. ## Response If successful, this method returns `201 Created` response code and [directorySetting](../resources/directorysetting.md) object in the response body.
-## Example
-### Request
-The following is an example of the request.
+## Examples
+
+### Example 1: Create a setting to block guests for a specific Microsoft 365 group
+
+#### Request
+The following is an example of the request.
# [HTTP](#tab/http)+ <!-- { "blockType": "request",
- "name": "create_directorysetting_from_group"
+ "name": "create_groupsetting_from_groupsettings_for_guests"
}-->+ ```http
-POST https://graph.microsoft.com/beta/groups/{id}/settings
+POST https://graph.microsoft.com/beta/groups/05aa6a98-956a-45c0-b13b-88076a23f2cd/settings
Content-type: application/json {
- "directorySetting": {
- "displayName": "displayName-value",
- "templateId": "templateId-value",
+ "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
"values": [
- {
- "name": "name-value",
- "value": "value-value"
- }
+ {
+ "name": "AllowToAddGuests",
+ "value": "false"
+ }
]
- }
} ```+ # [C#](#tab/csharp)+ [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -
+# [Objective-C](#tab/objc)
++
+# [Java](#tab/java)
++
+#### Response
-### Response
The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.directorySetting" } -->+ ```http HTTP/1.1 201 Created Content-type: application/json {
- "directorySetting": {
- "id": "id-value",
- "displayName": "displayName-value",
- "templateId": "templateId-value",
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#settings/$entity",
+ "id": "a06fa228-3042-4662-bd09-33e298da1afe",
+ "displayName": null,
+ "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
"values": [
- {
- "name": "name-value",
- "value": "value-value"
- }
+ {
+ "name": "AllowToAddGuests",
+ "value": "false"
+ }
+ ]
+}
+```
+
+### Example 2: Create a directory or tenant-level setting
+
+#### Request
+
+# [HTTP](#tab/http)
+
+<!-- {
+ "blockType": "request",
+ "name": "create_directorysettings"
+}-->
+
+```msgraph-interactive
+POST https://graph.microsoft.com/beta/settings
+Content-type: application/json
+
+{
+ "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
+ "values": [
+ {
+ "name": "GuestUsageGuidelinesUrl",
+ "value": "https://privacy.contoso.com/privacystatement"
+ },
+ {
+ "name": "EnableMSStandardBlockedWords",
+ "value": "true"
+ },
+ {
+ "name": "EnableMIPLabels",
+ "value": "true"
+ },
+ {
+ "name": "PrefixSuffixNamingRequirement",
+ "value": "[Contoso-][GroupName]"
+ }
+ ]
+}
+```
+
+# [C#](#tab/csharp)
++
+# [JavaScript](#tab/javascript)
++
+# [Objective-C](#tab/objc)
++
+# [Java](#tab/java)
++
+# [Go](#tab/go)
++
+# [PowerShell](#tab/powershell)
++++
+#### Response
+
+<!-- {
+ "blockType": "response",
+ "truncated": true,
+ "@odata.type": "microsoft.graph.directorySetting"
+} -->
+
+```http
+HTTP/1.1 201 Created
+Content-type: application/json
+
+{
+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#settings/$entity",
+ "id": "844d252c-4de2-43eb-a784-96df77231aae",
+ "displayName": null,
+ "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
+ "values": [
+ {
+ "name": "GuestUsageGuidelinesUrl",
+ "value": "https://privacy.contoso.com/privacystatement"
+ },
+ {
+ "name": "EnableMSStandardBlockedWords",
+ "value": "true"
+ },
+ {
+ "name": "EnableMIPLabels",
+ "value": "true"
+ },
+ {
+ "name": "PrefixSuffixNamingRequirement",
+ "value": "[Contoso-][GroupName]"
+ }
]
- }
} ```
Content-type: application/json
] } -->--
v1.0 Group Post Threads https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-threads.md
Title: "Create conversation thread" description: "Start a new group conversation by first creating a thread. "-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
-Start a new group conversation by first creating a thread.
+Start a new group conversation by first creating a thread.
A new conversation, conversation thread, and post are created in the group. Use [reply thread](conversationthread-reply.md) or [reply post](post-reply.md) to further post to that thread.
-Note: You can also [start a new thread in an existing conversation](conversation-post-threads.md).
+Note: You can also [start a new thread in an existing conversation](conversation-post-threads.md).
## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/threads ```+ ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Content-Type | application/json |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Content-Type | application/json |
## Request body+ In the request body, supply a JSON representation of [conversationThread](../resources/conversationthread.md) object containing a [post](../resources/post.md). ## Response+ If successful, this method returns `201 Created` response code and [conversationThread](../resources/conversationthread.md) object in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "create_conversationthread_from_group" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/threads Content-type: application/json
Content-type: application/json
}] } ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/create-conversationthread-from-group-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/create-conversationthread-from-group-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/create-conversationthread-from-group-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/create-conversationthread-from-group-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/create-conversationthread-from-group-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.
->**Note:** The response object shown here might be shortened for readability.
+
+> **Note:** The response object shown here might be shortened for readability.
+ <!-- { "blockType": "response", "truncated": true, "@odata.type": "microsoft.graph.conversationThread" } -->+ ```http HTTP/1.1 201 OK Content-type: application/json
Content-type: application/json
] } -->--
v1.0 Group Removefavorite https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-removefavorite.md
Title: "group: removeFavorite" description: "Remove the group from the list of the current user's favorite groups. Supported for Microsoft 365 groups only." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Remove the group from the list of the current user's favorite groups. Supported for Microsoft 365 groups only. ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/removeFavorite ``` ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `200 OK` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_removefavorite" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/removeFavorite ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-removefavorite-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-removefavorite-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-removefavorite-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-removefavorite-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-removefavorite-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response+ The following is an example of the response.+ <!-- { "blockType": "response", "truncated": false } -->+ ```http HTTP/1.1 200 OK ```
HTTP/1.1 200 OK
] } -->--
v1.0 Group Renew https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-renew.md
Title: "group: renew" description: "Renews a group's expiration. When a group is renewed, the group expiration is extended by the number of days defined in the policy." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Renews a group's expiration. When a group is renewed, the group expiration is ex
## 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) | Group.ReadWrite.All or Directory.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported |
-|Application | Group.ReadWrite.All or Directory.ReadWrite.All |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All or Directory.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported |
+| Application | Group.ReadWrite.All or Directory.ReadWrite.All |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/renew ``` ## Request headers
-| Name | Description|
-|:|:-|
-| Authorization | Bearer {token}. Required. |
+| Name | Description |
+| : | : |
+| Authorization | Bearer {token}. Required. |
## Request body
If successful, this method returns `204 No Content` response code. It does not r
### Request -- # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_renew" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/renew ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-renew-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-renew-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-renew-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-renew-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-renew-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -- ### Response+ <!-- { "blockType": "response" } -->+ ```http HTTP/1.1 204 No Content ```
v1.0 Group Resetunseencount https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-resetunseencount.md
Title: "group: resetUnseenCount" description: "Reset the unseenCount of all the posts that the current user has not seen since their last visit."-+ ms.localizationpriority: medium ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Reset the unseenCount of all the posts that the current user has not seen since their last visit. Supported for Microsoft 365 groups only. ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/resetUnseenCount ```+ ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
## Request body+ Do not supply a request body for this method. ## Response+ If successful, this method returns `200 OK` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_resetunseencount" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/resetUnseenCount ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-resetunseencount-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-resetunseencount-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-resetunseencount-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go)+ [!INCLUDE [sample-code](../includes/snippets/go/group-resetunseencount-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell)+ [!INCLUDE [sample-code](../includes/snippets/powershell/group-resetunseencount-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - #### Response
-The following is an example of the response.
+
+The following is an example of the response.
+ <!-- { "blockType": "response", "truncated": true } -->+ ```http HTTP/1.1 200 OK ```
HTTP/1.1 200 OK
] } -->--
v1.0 Group Subscribebymail https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-subscribebymail.md
Title: "group: subscribeByMail" description: "Calling this method will enable the current user to receive email notifications for this group, about new posts, events, and files in that group." ms.localizationpriority: medium-+ ms.prod: "groups" doc_type: apiPageType
Namespace: microsoft.graph
Calling this method will enable the current user to receive email notifications for this group, about new posts, events, and files in that group. Supported for Microsoft 365 groups only. ## 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) | Group.ReadWrite.All |
-|Delegated (personal Microsoft account) | Not supported. |
-|Application | Not supported. |
+| Permission type | Permissions (from least to most privileged) |
+| :- | : |
+| Delegated (work or school account) | Group.ReadWrite.All |
+| Delegated (personal Microsoft account) | Not supported. |
+| Application | Not supported. |
## HTTP request+ <!-- { "blockType": "ignored" } -->+ ```http POST /groups/{id}/subscribeByMail ```+ ## Request headers
-| Header | Value |
-|:|:--|
-| Authorization | Bearer {token}. Required. |
-| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
+
+| Header | Value |
+| : | : |
+| Authorization | Bearer {token}. Required. |
+| Prefer | return=minimal. If minimal response header is included in the request header, then a successful response returns `204 No Content` code. Optional. |
## Request body ## Response+ If successful, this method returns `200 OK` response code. It does not return anything in the response body. ## Example+ #### Request+ The following is an example of the request. # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "group_subscribebymail" }-->+ ```http POST https://graph.microsoft.com/beta/groups/{id}/subscribeByMail ```+ # [C#](#tab/csharp)+ [!INCLUDE [sample-code](../includes/snippets/csharp/group-subscribebymail-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript)+ [!INCLUDE [sample-code](../includes/snippets/javascript/group-subscribebymail-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc)+ [!INCLUDE [sample-code](../includes/snippets/objc/group-subscribebymail-objc-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)+ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-docum