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 List Decisions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstance-list-decisions.md | 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 | Accessreviewinstancedecisionitem Filterbycurrentuser | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/accessreviewinstancedecisionitem-filterbycurrentuser.md | 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 | 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 | 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). 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 | 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 <!-- { "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 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). 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 | 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 <!-- { "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). 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 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). 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 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 <!-- { "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 Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-get.md | 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 Post Applications | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-applications.md | Content-type: application/json "enableIdTokenIssuance": false, "enableAccessTokenIssuance": false }- } + }, + "windows" : null } ``` |
v1.0 | Application Post Extensionproperty | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/application-post-extensionproperty.md | 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 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 | 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 | 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 | 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 | 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 | Bundle Removeitem | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/bundle-removeitem.md | 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) + |
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 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 | 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 | 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 | 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 | 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 | 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 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 | |:|:--| |
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, Directory.AccessAsUser.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, Directory.AccessAsUser.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 | 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). One of the following permissions is required to call this API. To learn more, in ## 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 (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). One of the following permissions is required to call this API. To learn more, in |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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | |
v1.0 | Governanceroleassignmentrequest Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governanceroleassignmentrequest-update.md | 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 | 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 | |
v1.0 | Governancerolesetting Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/governancerolesetting-get.md | 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 | 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 | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Update the properties of [governanceRoleSetting](../resources/governancerolesetting.md). |
v1.0 | Group Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-assignlicense.md | 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.| +|removeLicenses|Guid collection|A collection of skuIds that identify the licenses to remove.| ## Response |
v1.0 | Group Delete Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-delete-members.md | One of the following permissions is required to call this API. To learn more, in |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 |
v1.0 | Group List Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-members.md | 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 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, Directory.AccessAsUser.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 Transitivemembers | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list-transitivemembers.md | ConsistencyLevel: eventual [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ConsistencyLevel: eventual [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Group List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-list.md | 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 --> <!-- |
v1.0 | Group Post Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/group-post-members.md | One of the following permissions is required to call this API. To learn more, in |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 |
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). One of the following permissions is required to call this API. To learn more, in |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| |:|:-| In the request body, supply a JSON representation of [directorySetting](../resou If successful, this method returns `201 Created` response code and [directorySetting](../resources/directorysetting.md) object in the response body. -## Example -### 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)++# [Objective-C](#tab/objc) ++# [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -### Response +#### Response The following is an example of the response. >**Note:** The response object shown here might be shortened for readability. <!-- { HTTP/1.1 201 Created Content-type: application/json {- "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": "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": "name-value", - "value": "value-value" - } + { + "name": "GuestUsageGuidelinesUrl", + "value": "https://privacy.contoso.com/privacystatement" + }, + { + "name": "EnableMSStandardBlockedWords", + "value": "true" + }, + { + "name": "EnableMIPLabels", + "value": "true" + }, + { + "name": "PrefixSuffixNamingRequirement", + "value": "[Contoso-][GroupName]" + } ]- } } ``` |
v1.0 | Identityapiconnector Create | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identityapiconnector-create.md | Content-Type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/apiConnectors/$entity",- "id":"guid", + "id":"GUID", "displayName": "Test API", "targetUrl": "https://someapi.com/api", "authenticationConfiguration": { Content-Type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/apiConnectors/$entity",- "id":"guid", + "id":"GUID", "displayName": "Test API", "targetUrl": "https://someotherapi.com/api", "authenticationConfiguration": { |
v1.0 | Identityapiconnector Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identityapiconnector-get.md | Content-Type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/apiConnectors/$entity",- "id":"guid", + "id":"GUID", "displayName": "Test API", "targetUrl": "https://someapi.com/api", "authenticationConfiguration": { |
v1.0 | Identityapiconnector Uploadclientcertificate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identityapiconnector-uploadclientcertificate.md | Content-type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/apiConnectors/$entity",- "id": "guid", + "id": "45715bb8-13f9-4bf6-927f-ef96c102d394", "displayName": "My API connector", "targetUrl": "https://api.contoso.com/endpoint", "authenticationConfiguration": { |
v1.0 | Identityprotectionroot List Riskyserviceprincipals | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identityprotectionroot-list-riskyserviceprincipals.md | If successful, this method returns a `200 OK` response code and a collection of ## Examples ### Request++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_riskyserviceprincipal" If successful, this method returns a `200 OK` response code and a collection of ``` http GET https://graph.microsoft.com/beta/identityProtection/riskyServicePrincipals ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ ### Response |
v1.0 | Identityprotectionroot List Serviceprincipalriskdetections | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/identityprotectionroot-list-serviceprincipalriskdetections.md | If successful, this method returns a `200 OK` response code and a collection of #### Request The following is an example of the request.++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_serviceprincipalriskdetection" The following is an example of the request. ``` http GET https://graph.microsoft.com/beta/identityProtection/servicePrincipalRiskDetections ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ #### Response Content-Type: application/json #### Request The following example shows how to use `$filter` to get the collection of service principal risk detections where the risk level is `medium` or the risk event type is `investigationsThreatIntelligence`. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_filter_serviceprincipalriskdetection" The following example shows how to use `$filter` to get the collection of servic ``` http GET https://graph.microsoft.com/beta/identityProtection/servicePrincipalRiskDetections?$filter=riskEventType eq 'investigationsThreatIntelligence' or riskLevel eq 'medium' ```+# [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. |
v1.0 | Informationprotectionlabel Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/informationprotectionlabel-get.md | GET https://graph.microsoft.com/beta/me/informationprotection/policy/labels/{id} [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Informationprotectionpolicy List Labels | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/informationprotectionpolicy-list-labels.md | GET https://graph.microsoft.com/beta/me/informationProtection/policy/labels [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Intune Deviceconfig Aospdeviceownercertificateprofilebase Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownercertificateprofilebase-get.md | + + Title: "Get aospDeviceOwnerCertificateProfileBase" +description: "Read properties and relationships of the aospDeviceOwnerCertificateProfileBase object." ++localization_priority: Normal +++# Get aospDeviceOwnerCertificateProfileBase ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Read properties and relationships of the [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md) object. ++## Prerequisites +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)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId} +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId} +``` ++## 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.| +|Accept|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 [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1295 ++{ + "value": { + "@odata.type": "#microsoft.graph.aospDeviceOwnerCertificateProfileBase", + "id": "0a3f3f7e-3f7e-0a3f-7e3f-3f0a7e3f3f0a", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7 + } +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownercertificateprofilebase List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownercertificateprofilebase-list.md | + + Title: "List aospDeviceOwnerCertificateProfileBases" +description: "List properties and relationships of the aospDeviceOwnerCertificateProfileBase objects." ++localization_priority: Normal +++# List aospDeviceOwnerCertificateProfileBases ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++List properties and relationships of the [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md) objects. ++## Prerequisites +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)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/deviceConfigurations +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|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 [aospDeviceOwnerCertificateProfileBase](../resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md) objects in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1373 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.aospDeviceOwnerCertificateProfileBase", + "id": "0a3f3f7e-3f7e-0a3f-7e3f-3f0a7e3f3f0a", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7 + } + ] +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerpkcscertificateprofile-create.md | + + Title: "Create aospDeviceOwnerPkcsCertificateProfile" +description: "Create a new aospDeviceOwnerPkcsCertificateProfile object." ++localization_priority: Normal +++# Create aospDeviceOwnerPkcsCertificateProfile ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Create a new [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) object. ++## Prerequisites +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)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/deviceConfigurations +POST /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the aospDeviceOwnerPkcsCertificateProfile object. ++The following table shows the properties that are required when you create the aospDeviceOwnerPkcsCertificateProfile. ++|Property|Type|Description| +|:|:|:| +|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|certificationAuthority|String|PKCS Certification Authority| +|certificationAuthorityName|String|PKCS Certification Authority Name| +|certificationAuthorityType|[deviceManagementCertificationAuthority](../resources/intune-deviceconfig-devicemanagementcertificationauthority.md)|Certification authority type. Possible values are: `notConfigured`, `microsoft`, `digiCert`.| +|certificateTemplateName|String|PKCS Certificate Template Name| +|subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| +|subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| +|certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| +|customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| ++++## Response +If successful, this method returns a `201 Created` response code and a [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations +Content-type: application/json +Content-length: 1663 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerPkcsCertificateProfile", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "certificationAuthority": "Certification Authority value", + "certificationAuthorityName": "Certification Authority Name value", + "certificationAuthorityType": "microsoft", + "certificateTemplateName": "Certificate Template Name value", + "subjectAlternativeNameFormatString": "Subject Alternative Name Format String value", + "subjectNameFormatString": "Subject Name Format String value", + "certificateStore": "machine", + "customSubjectAlternativeNames": [ + { + "@odata.type": "microsoft.graph.customSubjectAlternativeName", + "sanType": "emailAddress", + "name": "Name value" + } + ] +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 1835 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerPkcsCertificateProfile", + "id": "9e0cbf94-bf94-9e0c-94bf-0c9e94bf0c9e", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "certificationAuthority": "Certification Authority value", + "certificationAuthorityName": "Certification Authority Name value", + "certificationAuthorityType": "microsoft", + "certificateTemplateName": "Certificate Template Name value", + "subjectAlternativeNameFormatString": "Subject Alternative Name Format String value", + "subjectNameFormatString": "Subject Name Format String value", + "certificateStore": "machine", + "customSubjectAlternativeNames": [ + { + "@odata.type": "microsoft.graph.customSubjectAlternativeName", + "sanType": "emailAddress", + "name": "Name value" + } + ] +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerpkcscertificateprofile-delete.md | + + Title: "Delete aospDeviceOwnerPkcsCertificateProfile" +description: "Deletes a aospDeviceOwnerPkcsCertificateProfile." ++localization_priority: Normal +++# Delete aospDeviceOwnerPkcsCertificateProfile ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Deletes a [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md). ++## Prerequisites +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)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /deviceManagement/deviceConfigurations/{deviceConfigurationId} +DELETE /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration +DELETE /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `204 No Content` response code. ++## Example ++### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerpkcscertificateprofile-get.md | + + Title: "Get aospDeviceOwnerPkcsCertificateProfile" +description: "Read properties and relationships of the aospDeviceOwnerPkcsCertificateProfile object." ++localization_priority: Normal +++# Get aospDeviceOwnerPkcsCertificateProfile ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Read properties and relationships of the [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) object. ++## Prerequisites +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)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId} +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId} +``` ++## 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.| +|Accept|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 [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1946 ++{ + "value": { + "@odata.type": "#microsoft.graph.aospDeviceOwnerPkcsCertificateProfile", + "id": "9e0cbf94-bf94-9e0c-94bf-0c9e94bf0c9e", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "certificationAuthority": "Certification Authority value", + "certificationAuthorityName": "Certification Authority Name value", + "certificationAuthorityType": "microsoft", + "certificateTemplateName": "Certificate Template Name value", + "subjectAlternativeNameFormatString": "Subject Alternative Name Format String value", + "subjectNameFormatString": "Subject Name Format String value", + "certificateStore": "machine", + "customSubjectAlternativeNames": [ + { + "@odata.type": "microsoft.graph.customSubjectAlternativeName", + "sanType": "emailAddress", + "name": "Name value" + } + ] + } +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerpkcscertificateprofile-list.md | + + Title: "List aospDeviceOwnerPkcsCertificateProfiles" +description: "List properties and relationships of the aospDeviceOwnerPkcsCertificateProfile objects." ++localization_priority: Normal +++# List aospDeviceOwnerPkcsCertificateProfiles ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++List properties and relationships of the [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) objects. ++## Prerequisites +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)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/deviceConfigurations +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|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 [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) objects in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2052 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.aospDeviceOwnerPkcsCertificateProfile", + "id": "9e0cbf94-bf94-9e0c-94bf-0c9e94bf0c9e", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "certificationAuthority": "Certification Authority value", + "certificationAuthorityName": "Certification Authority Name value", + "certificationAuthorityType": "microsoft", + "certificateTemplateName": "Certificate Template Name value", + "subjectAlternativeNameFormatString": "Subject Alternative Name Format String value", + "subjectNameFormatString": "Subject Name Format String value", + "certificateStore": "machine", + "customSubjectAlternativeNames": [ + { + "@odata.type": "microsoft.graph.customSubjectAlternativeName", + "sanType": "emailAddress", + "name": "Name value" + } + ] + } + ] +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownerpkcscertificateprofile-update.md | + + Title: "Update aospDeviceOwnerPkcsCertificateProfile" +description: "Update the properties of a aospDeviceOwnerPkcsCertificateProfile object." ++localization_priority: Normal +++# Update aospDeviceOwnerPkcsCertificateProfile ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Update the properties of a [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) object. ++## Prerequisites +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)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId} +PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration +PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) object. ++The following table shows the properties that are required when you create the [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md). ++|Property|Type|Description| +|:|:|:| +|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|certificationAuthority|String|PKCS Certification Authority| +|certificationAuthorityName|String|PKCS Certification Authority Name| +|certificationAuthorityType|[deviceManagementCertificationAuthority](../resources/intune-deviceconfig-devicemanagementcertificationauthority.md)|Certification authority type. Possible values are: `notConfigured`, `microsoft`, `digiCert`.| +|certificateTemplateName|String|PKCS Certificate Template Name| +|subjectAlternativeNameFormatString|String|Custom String that defines the AAD Attribute.| +|subjectNameFormatString|String|Custom format to use with SubjectNameFormat = Custom. Example: CN={{EmailAddress}},E={{EmailAddress}},OU=Enterprise Users,O=Contoso Corporation,L=Redmond,ST=WA,C=US| +|certificateStore|[certificateStore](../resources/intune-shared-certificatestore.md)|Target store certificate. Possible values are: `user`, `machine`.| +|customSubjectAlternativeNames|[customSubjectAlternativeName](../resources/intune-deviceconfig-customsubjectalternativename.md) collection|Custom Subject Alternative Name Settings. This collection can contain a maximum of 500 elements.| ++++## Response +If successful, this method returns a `200 OK` response code and an updated [aospDeviceOwnerPkcsCertificateProfile](../resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} +Content-type: application/json +Content-length: 1663 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerPkcsCertificateProfile", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "certificationAuthority": "Certification Authority value", + "certificationAuthorityName": "Certification Authority Name value", + "certificationAuthorityType": "microsoft", + "certificateTemplateName": "Certificate Template Name value", + "subjectAlternativeNameFormatString": "Subject Alternative Name Format String value", + "subjectNameFormatString": "Subject Name Format String value", + "certificateStore": "machine", + "customSubjectAlternativeNames": [ + { + "@odata.type": "microsoft.graph.customSubjectAlternativeName", + "sanType": "emailAddress", + "name": "Name value" + } + ] +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1835 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerPkcsCertificateProfile", + "id": "9e0cbf94-bf94-9e0c-94bf-0c9e94bf0c9e", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "certificationAuthority": "Certification Authority value", + "certificationAuthorityName": "Certification Authority Name value", + "certificationAuthorityType": "microsoft", + "certificateTemplateName": "Certificate Template Name value", + "subjectAlternativeNameFormatString": "Subject Alternative Name Format String value", + "subjectNameFormatString": "Subject Name Format String value", + "certificateStore": "machine", + "customSubjectAlternativeNames": [ + { + "@odata.type": "microsoft.graph.customSubjectAlternativeName", + "sanType": "emailAddress", + "name": "Name value" + } + ] +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-create.md | + + Title: "Create aospDeviceOwnerTrustedRootCertificate" +description: "Create a new aospDeviceOwnerTrustedRootCertificate object." ++localization_priority: Normal +++# Create aospDeviceOwnerTrustedRootCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Create a new [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) object. ++## Prerequisites +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)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/deviceConfigurations +POST /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the aospDeviceOwnerTrustedRootCertificate object. ++The following table shows the properties that are required when you create the aospDeviceOwnerTrustedRootCertificate. ++|Property|Type|Description| +|:|:|:| +|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|trustedRootCertificate|Binary|Trusted Root Certificate| +|certFileName|String|File name to display in UI.| ++++## Response +If successful, this method returns a `201 Created` response code and a [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations +Content-type: application/json +Content-length: 1148 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerTrustedRootCertificate", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", + "certFileName": "Cert File Name value" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 1320 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerTrustedRootCertificate", + "id": "fa03dc2b-dc2b-fa03-2bdc-03fa2bdc03fa", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", + "certFileName": "Cert File Name value" +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-delete.md | + + Title: "Delete aospDeviceOwnerTrustedRootCertificate" +description: "Deletes a aospDeviceOwnerTrustedRootCertificate." ++localization_priority: Normal +++# Delete aospDeviceOwnerTrustedRootCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Deletes a [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md). ++## Prerequisites +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)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /deviceManagement/deviceConfigurations/{deviceConfigurationId} +DELETE /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration +DELETE /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `204 No Content` response code. ++## Example ++### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-get.md | + + Title: "Get aospDeviceOwnerTrustedRootCertificate" +description: "Read properties and relationships of the aospDeviceOwnerTrustedRootCertificate object." ++localization_priority: Normal +++# Get aospDeviceOwnerTrustedRootCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Read properties and relationships of the [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) object. ++## Prerequisites +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)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId} +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId} +``` ++## 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.| +|Accept|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 [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1407 ++{ + "value": { + "@odata.type": "#microsoft.graph.aospDeviceOwnerTrustedRootCertificate", + "id": "fa03dc2b-dc2b-fa03-2bdc-03fa2bdc03fa", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", + "certFileName": "Cert File Name value" + } +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-list.md | + + Title: "List aospDeviceOwnerTrustedRootCertificates" +description: "List properties and relationships of the aospDeviceOwnerTrustedRootCertificate objects." ++localization_priority: Normal +++# List aospDeviceOwnerTrustedRootCertificates ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++List properties and relationships of the [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) objects. ++## Prerequisites +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)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/deviceConfigurations +GET /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|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 [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) objects in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1489 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.aospDeviceOwnerTrustedRootCertificate", + "id": "fa03dc2b-dc2b-fa03-2bdc-03fa2bdc03fa", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", + "certFileName": "Cert File Name value" + } + ] +} +``` ++++ |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-deviceconfig-aospdeviceownertrustedrootcertificate-update.md | + + Title: "Update aospDeviceOwnerTrustedRootCertificate" +description: "Update the properties of a aospDeviceOwnerTrustedRootCertificate object." ++localization_priority: Normal +++# Update aospDeviceOwnerTrustedRootCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Update the properties of a [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) object. ++## Prerequisites +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)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId} +PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration +PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer <token> Required.| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) object. ++The following table shows the properties that are required when you create the [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md). ++|Property|Type|Description| +|:|:|:| +|id|String|Key of the entity. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|lastModifiedDateTime|DateTimeOffset|DateTime the object was last modified. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|supportsScopeTags|Boolean|Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsEdition|[deviceManagementApplicabilityRuleOsEdition](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md)|The OS edition applicability for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleOsVersion|[deviceManagementApplicabilityRuleOsVersion](../resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md)|The OS version applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|deviceManagementApplicabilityRuleDeviceMode|[deviceManagementApplicabilityRuleDeviceMode](../resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md)|The device mode applicability rule for this Policy. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|createdDateTime|DateTimeOffset|DateTime the object was created. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| +|trustedRootCertificate|Binary|Trusted Root Certificate| +|certFileName|String|File name to display in UI.| ++++## Response +If successful, this method returns a `200 OK` response code and an updated [aospDeviceOwnerTrustedRootCertificate](../resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} +Content-type: application/json +Content-length: 1148 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerTrustedRootCertificate", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", + "certFileName": "Cert File Name value" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1320 ++{ + "@odata.type": "#microsoft.graph.aospDeviceOwnerTrustedRootCertificate", + "id": "fa03dc2b-dc2b-fa03-2bdc-03fa2bdc03fa", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "supportsScopeTags": true, + "deviceManagementApplicabilityRuleOsEdition": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition", + "osEditionTypes": [ + "windows10EnterpriseN" + ], + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleOsVersion": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion", + "minOSVersion": "Min OSVersion value", + "maxOSVersion": "Max OSVersion value", + "name": "Name value", + "ruleType": "exclude" + }, + "deviceManagementApplicabilityRuleDeviceMode": { + "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode", + "deviceMode": "sModeConfiguration", + "name": "Name value", + "ruleType": "exclude" + }, + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "description": "Description value", + "displayName": "Display Name value", + "version": 7, + "trustedRootCertificate": "dHJ1c3RlZFJvb3RDZXJ0aWZpY2F0ZQ==", + "certFileName": "Cert File Name value" +} +``` ++++ |
v1.0 | Intune Shared Devicemanagementscript Create | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-shared-devicemanagementscript-create.md | Content-Length: 615 "id": "59ea4525-4525-59ea-2545-ea592545ea59", "displayName": "Display Name value", "description": "Description value",- "runSchedule": { - "@odata.type": "microsoft.graph.runSchedule" - }, "scriptContent": "c2NyaXB0Q29udGVudA==", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", |
v1.0 | Intune Shared Devicemanagementscript Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/intune-shared-devicemanagementscript-update.md | Content-Length: 615 "id": "59ea4525-4525-59ea-2545-ea592545ea59", "displayName": "Display Name value", "description": "Description value",- "runSchedule": { - "@odata.type": "microsoft.graph.runSchedule" - }, "scriptContent": "c2NyaXB0Q29udGVudA==", "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", |
v1.0 | Itemactivity Getbyinterval | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/itemactivity-getbyinterval.md | description: "Get itemActivityStats for the activities that took place under this resource within the specified time interval." Previously updated : 10/06/2017 Title: Get item activity stats by interval ms.localizationpriority: medium doc_type: apiPageType # Get item activity stats by interval Get [itemActivityStats][] for the activities that took place under this resource Analytics aggregates might not be available for all action types. -[itemActivityStats]: ../resources/itemactivitystat.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) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All -|Delegated (personal Microsoft account) | Not supported. -|Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All +|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) | Not supported.| +|Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All| ## HTTP request GET /sites/{site-id}/lists/{list-id}/items/{item-id}/getActivitiesByInterval(sta | endDateTime | string (timestamp) | The end time over which to aggregate activities. | interval | string | The aggregation interval. +## 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 [itemActivityStats][] object in the response body. + ## Example -#### Request +### Request +The following is an example of a request. # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-activities-by-interval" } --> GET /drives/{drive-id}/items/{item-id}/getActivitiesByInterval(startDateTime='20 -#### Response +### Response ++The following is an example of the response. <!-- { "blockType": "response", "@type": "Collection(microsoft.graph.itemActivityStat)", "truncated": true } --> Content-type: application/json } ``` +[itemActivityStats]: ../resources/itemactivitystat.md + <!-- { "type": "#page.annotation", |
v1.0 | Itemanalytics Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/itemanalytics-get.md | description: "Get itemAnalytics about the views that took place under this resource." Previously updated : 10/06/2017 Title: Get analytics ms.localizationpriority: medium doc_type: apiPageType # Get analytics For a custom time range or interval, use the [getActivitiesByInterval][] API. 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) | Not supported. -|Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All +|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) | Not supported.| +|Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All| ## HTTP request GET /sites/{site-id}/analytics GET /sites/{site-id}/lists/{list-id}/items/{item-id}/analytics ``` +## 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. | ++## 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 [itemAnalytics][] objects in the response body. + ## Example -#### Request +### Request +The following is an example of a request. # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-analytics" } --> GET /drives/{drive-id}/items/{item-id}/analytics [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + -#### Response +### Response ++The following is an example of the response. <!-- { "blockType": "response", "@type": "microsoft.graph.itemAnalytics", "truncated": true } --> |
v1.0 | List Create | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/list-create.md | description: "Create a new list in a site." Previously updated : 09/11/2017 Title: Create a SharePoint List ms.localizationpriority: medium ms.prod: "sharepoint" One of the following permissions is required to call this API. To learn more, in POST https://graph.microsoft.com/beta/sites/{site-id}/lists ``` +## 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 [list][] resource to create. +In the request body, supply a JSON representation of a [list][] object. ++## Response -## Example +If successful, this method returns a `201 Created` response code and a [list][] object in the response body. -Here is an example of how to create a new generic list. +## Examples ++### Request ++The following is an example of how to create a new generic list. ++> **Note:** Custom columns are optional. ++In addition to any columns specified here, new lists are created with columns defined in the referenced **template**. +If the **list** facet or **template** is not specified, the list defaults to the `genericList` template, which includes a _Title_ column. # [HTTP](#tab/http) Content-Type: application/json -**Note:** Custom columns are optional. --In addition to any columns specified here, new lists are created with columns defined in the referenced **template**. -If the **list** facet or **template** is unspecified, the list defaults to the `genericList` template, which includes a _Title_ column. +### Response -## Response +The following is an example of the response. -If successful, this method returns a [list][] in the response body for the created list. +> **Note:** The response object is truncated for clarity. Default properties will be returned from the actual call. <!-- { "blockType": "response", "@odata.type": "microsoft.graph.list", "truncated": true } --> Content-type: application/json } ``` -**Note:** The response object is truncated for clarity. -Default properties will be returned from the actual call. - [list]: ../resources/list.md [site]: ../resources/site.md |
v1.0 | List List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/list-list.md | Get the collection of [lists][] for a [site][]. Lists with the [system][] facet are hidden by default. To list them, include `system` in your `$select` statement. -[lists]: ../resources/list.md -[site]: ../resources/site.md -[system]: ../resources/systemfacet.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). One of the following permissions is required to call this API. To learn more, in GET /sites/{site-id}/lists ``` +## 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 [list][] objects in the response body. + ## Example ### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "enum-lists", "scopes": "sites.read.all service.sharepoint" } --> GET https://graph.microsoft.com/beta/sites/{site-id}/lists ### Response +The following is an example of the response. + <!-- { "blockType": "response", "@type": "microsoft.graph.list", "isCollection": true, "truncated": true } --> ```http Content-type: application/json } ``` +[lists]: ../resources/list.md +[list]: ../resources/list.md +[site]: ../resources/site.md +[system]: ../resources/systemfacet.md + <!-- { "type": "#page.annotation", |
v1.0 | Listitem List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/listitem-list.md | description: "Get the collection of items in a list." Previously updated : 09/11/2017 Title: Retrieve items from a SharePoint list ms.localizationpriority: medium ms.prod: "sharepoint" GET /sites/{site-id}/lists/{list-id}/items?expand=fields GET /sites/{site-id}/lists/{list-id}/items?expand=fields(select=Column1,Column2) ``` +## Request headers ++| Name |Description| +|:-|:-| +| Authorization | Bearer {code}. 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 [listItem][item] objects in the response body. + ## Example -#### Request +### Request +The following is an example of a request. # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get-list-items" } --> GET https://graph.microsoft.com/beta/sites/{site-id}/lists/{list-id}/items?expan -#### Response +### Response ++The following is an example of the response. <!-- { "blockType": "response", "@odata.type": "Collection(microsoft.graph.listItem)", "truncated": true } --> |
v1.0 | Manageddevice Bulkrestorecloudpc | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/manageddevice-bulkrestorecloudpc.md | + + Title: "managedDevice: bulkRestoreCloudPc" +description: "Restore multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices and a restore point date and time." ++ms.localizationpriority: medium +++# managedDevice: bulkRestoreCloudPc +Namespace: microsoft.graph +++Restore multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices and a restore point date and time. ++## 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.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|CloudPC.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/managedDevices/bulkRestoreCloudPc +``` ++## 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 parameters. ++The following table shows the parameters that can be used with this action. ++|Parameter|Type|Description| +|:|:|:| +|managedDeviceIds|String collection|The IDs of the Cloud PC devices.| +|restorePointDateTime|DateTimeOffset|The UTC time point for the selected Cloud PC devices to restore to a previous state. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is '2014-01-01T00:00:00Z'.| +|timeRange|[restoreTimeRange](#restoretimerange-values)|The time range of the restore point. Possible values are: `before`, `after`, `beforeOrAfter`, `unknownFutureValue`.| ++### restoreTimeRange values ++|Member|Description| +|:|:| +|before|Choose the closest snapshot before the selected time point.| +|after|Choose the closest snapshot after the selected time point.| +|beforeOrAfter|Choose the closest snapshot around the selected time point.| +|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| ++## Response ++If successful, this action returns a `200 OK` response code and a [cloudPcBulkRemoteActionResult](../resources/cloudpcbulkremoteactionresult.md) in the response body. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "manageddevicethis.bulkrestorecloudpc" +} +--> +``` http +POST https://graph.microsoft.com/beta/deviceManagement/managedDevices/bulkRestoreCloudPc +Content-Type: application/json +Content-length: 123 ++{ + "managedDeviceIds": [ + "30d0e128-de93-41dc-89ec-33d84bb662a0", + "7c82a3e3-9459-44e4-94d9-b92f93bf78dd" + ], + "restorePointDateTime": "2021-09-23T04:00:00.0000000", + "timeRange": "before" +} +``` +# [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.cloudPcBulkRemoteActionResult" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "microsoft.graph.cloudPcBulkRemoteActionResult", + "successfulDeviceIds": [ + "30d0e128-de93-41dc-89ec-33d84bb662a0" + ], + "failedDeviceIds": [ + "7c82a3e3-9459-44e4-94d9-b92f93bf78dd" + ], + "notFoundDeviceIds": [ + ], + "notSupportedDeviceIds": [ + ] + } +} +``` |
v1.0 | Manageddevice Restorecloudpc | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/manageddevice-restorecloudpc.md | + + Title: "managedDevice: restoreCloudPc" +description: "Restore a Cloud PC device to a previous state from a snapshot." ++ms.localizationpriority: medium +++# managedDevice: restoreCloudPc +Namespace: microsoft.graph +++Restore a Cloud PC device to a previous state from a snapshot. ++## 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.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|CloudPC.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/managedDevices/{managedDeviceId}/restoreCloudPc +``` ++## 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 parameters. ++The following table shows the parameters that can be used with this action. ++|Parameter|Type|Description| +|:|:|:| +|cloudPcSnapshotId|String|The unique identifier for the snapshot of the Cloud PC device at a specific point in time.| ++++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Request +The following is an example of a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "manageddevicethis.restorecloudpc" +} +--> +``` http +POST https://graph.microsoft.com/beta/deviceManagement/managedDevices/5e1387aa-d960-4916-ae7c-293b977e49bf/restoreCloudPc +Content-Type: application/json +Content-length: 37 ++{ + "cloudPcSnapshotId": "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 +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Managedtenants Auditevent Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-auditevent-get.md | + + Title: "Get auditEvent" +description: "Read the properties and relationships of an auditEvent object." ++ms.localizationpriority: medium +++# Get auditEvent +Namespace: microsoft.graph.managedTenants +++Read the properties and relationships of an [auditEvent](../resources/managedtenants-auditevent.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)|ManagedTenant.Read.All, ManagedTenant.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Not supported.| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /auditEvent +GET /managedTenant/auditEvents/{auditEventId} +``` ++## 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 an [auditEvent](../resources/managedtenants-auditevent.md) object in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_auditevent" +} +--> +``` http +GET https://graph.microsoft.com/beta/tenantRelationships/managedTenants/auditEvent +``` +# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++++++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.managedTenants.auditEvent" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "c3b0d319-9913-bd52-7376-1125f0594129", + "activityDateTime": "2021-12-21T16:48:23.0330765Z", + "activityId": "64be6675-3cb8-4b14-95f3-6d5ce9eecd79", + "initiatedByAppId": "00000003-0000-0000-c000-000000000000", + "initiatedByUpn": "meganb@contoso.onmicrosoft.com", + "category": "Baselines", + "activity": "/managementActionTenantDeploymentStatuses/microsoft.graph.managedTenants.changeDeploymentStatus", + "httpVerb": "POST", + "path": "/managementActionTenantDeploymentStatuses/microsoft.graph.managedTenants.changeDeploymentStatus", + "url": "https://graph.microsoft.com/managementActionTenantDeploymentStatuses/microsoft.graph.managedTenants.changeDeploymentStatus", + "requestBody": "" +} +``` + |
v1.0 | Managedtenants Managedtenant List Auditevents | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/managedtenants-managedtenant-list-auditevents.md | + + Title: "List auditEvents" +description: "Get a list of the auditEvent objects and their properties." ++ms.localizationpriority: medium +++# List auditEvents +Namespace: microsoft.graph.managedTenants +++Get a list of the [auditEvent](../resources/managedtenants-auditevent.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)|ManagedTenant.Read.All, ManagedTenant.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|Not supported.| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /managedTenant/auditEvents +``` ++## 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 [auditEvent](../resources/managedTenants-auditevent.md) objects in the response body. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "list_auditevent" +} +--> +``` http +GET https://graph.microsoft.com/beta/managedTenant/auditEvents +``` +++### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.managedTenants.auditEvent)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "id": "c3b0d319-9913-bd52-7376-1125f0594129", + "activityDateTime": "2021-12-21T16:48:23.0330765Z", + "activityId": "64be6675-3cb8-4b14-95f3-6d5ce9eecd79", + "initiatedByAppId": "00000003-0000-0000-c000-000000000000", + "initiatedByUpn": "meganb@contoso.onmicrosoft.com", + "category": "Baselines", + "activity": "/managementActionTenantDeploymentStatuses/microsoft.graph.managedTenants.changeDeploymentStatus", + "httpVerb": "POST", + "path": "/managementActionTenantDeploymentStatuses/microsoft.graph.managedTenants.changeDeploymentStatus", + "url": "https://graph.microsoft.com/managementActionTenantDeploymentStatuses/microsoft.graph.managedTenants.changeDeploymentStatus", + "requestBody": "" + } + ] +} +``` + |
v1.0 | Microsoftauthenticatorauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-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 | Microsoftauthenticatorauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-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 | Microsoftauthenticatorauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/microsoftauthenticatorauthenticationmethodconfiguration-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 | Mobileappmanagementpolicies List Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/mobileappmanagementpolicies-list-includedgroups.md | GET https://graph.microsoft.com/beta/policies/mobileAppManagementPolicies/ab90ba [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Mobileappmanagementpolicies Post Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/mobileappmanagementpolicies-post-includedgroups.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 | Mobiledevicemanagementpolicies List Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-list-includedgroups.md | GET https://graph.microsoft.com/beta/policies/mobileDeviceManagementPolicies/ab9 [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Mobiledevicemanagementpolicies Post Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-post-includedgroups.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 | Organizationalbranding Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbranding-get.md | The following example returns the **bannerLogo** object which hadn't been set fo The following is an example of the request. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_organizationalbranding_frlocale_bannerLogo" The following is an example of the request. ```msgraph-interactive GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f2efb1d/branding/localizations/default/bannerLogo ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ #### Response |
v1.0 | Organizationalbranding List Localizations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbranding-list-localizations.md | GET https://graph.microsoft.com/beta/organization/84841066-274d-4ec0-a5c1-276be6 [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Organizationalbranding Post Localizations | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbranding-post-localizations.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 | Organizationalbranding Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbranding-update.md | The following is an example of the request. ++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_organizationalbrandinglocaliation_2" Content-Type: image/jpeg <Image> ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) +++ |
v1.0 | Organizationalbrandinglocalization Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbrandinglocalization-delete.md | DELETE https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249 [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Organizationalbrandinglocalization Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbrandinglocalization-get.md | GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + GET https://graph.microsoft.com/beta/organization/d69179bf-f4a4-41a9-a9de-249c0f [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Organizationalbrandinglocalization Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/organizationalbrandinglocalization-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) + 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 | Orgcontact Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/orgcontact-delete.md | - Title: "Delete orgContact" -description: "Delete orgContact." --doc_type: apiPageType ---# Delete orgContact --Namespace: microsoft.graph ---Delete orgContact. -## 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.AccessAsUser.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Not supported. | --## HTTP request -<!-- { "blockType": "ignored" } --> -```http -DELETE /contacts/{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. --## Example -##### Request -Here is an example of the request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "delete_orgcontact" -}--> -```http -DELETE https://graph.microsoft.com/beta/contacts/{id} -``` -# [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. -<!-- { - "blockType": "response", - "truncated": true -} --> -```http -HTTP/1.1 204 No Content -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- -{ - "type": "#page.annotation", - "description": "Delete orgContact", - "keywords": "", - "section": "documentation", - "tocPath": "", - "suppressions": [ - ] -} >-- |
v1.0 | Orgcontact Get Transitivereports | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/orgcontact-get-transitivereports.md | GET https://graph.microsoft.com/beta/contacts/45b7d2e7-b882-4a80-ba97-10b7a63b8f [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Orgcontact Post Directreports | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/orgcontact-post-directreports.md | - Title: "Create directReport" -description: "Use this API to create a new directReport." --doc_type: apiPageType ---# Create directReport --Namespace: microsoft.graph ---Use this API to create a new directReport. -## 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) | Not supported. | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Not supported. | --## HTTP request -<!-- { "blockType": "ignored" } --> -```http -POST /contacts/{id}/directReports --``` -## Request headers -| Name | Description| -|:|:--| -| Authorization | Bearer {token}. Required. | --## Request body -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. --## Response --If successful, this method returns `201 Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. --## Example -##### Request -Here is an example of the request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "create_directoryobject_from_orgcontact_1" -}--> -```http -POST https://graph.microsoft.com/beta/contacts/{id}/directReports -Content-type: application/json --{ - "directoryObject": { - } -} -``` -# [JavaScript](#tab/javascript) --# [C#](#tab/csharp) --# [Go](#tab/go) ----In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -##### 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.directoryObject" -} --> -```http -HTTP/1.1 200 OK -Content-type: application/json --{ - "directoryObject": { - "id": "id-value" - } -} -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- -{ - "type": "#page.annotation", - "description": "Create directReport", - "keywords": "", - "section": "documentation", - "tocPath": "", - "suppressions": [ - ] -} >-- |
v1.0 | Orgcontact Post Memberof | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/orgcontact-post-memberof.md | - Title: "Create memberOf" -description: "Use this API to create a new memberOf." --doc_type: apiPageType ---# Create memberOf --Namespace: microsoft.graph ---Use this API to create a new memberOf. -## 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) | Not supported. | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Not supported. | --## HTTP request -<!-- { "blockType": "ignored" } --> -```http -POST /contacts/{id}/memberOf --``` -## Request headers -| Name | Description| -|:|:--| -| Authorization | Bearer {token}. Required. | --## Request body -In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. --## Response --If successful, this method returns `201 Created` response code and [directoryObject](../resources/directoryobject.md) object in the response body. --## Example -##### Request -Here is an example of the request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "create_directoryobject_from_orgcontact_2" -}--> -```http -POST https://graph.microsoft.com/beta/contacts/{id}/memberOf -Content-type: application/json --{ - "directoryObject": { - } -} -``` -# [JavaScript](#tab/javascript) --# [C#](#tab/csharp) --# [Go](#tab/go) ----In the request body, supply a JSON representation of [directoryObject](../resources/directoryobject.md) object. -##### 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.directoryObject" -} --> -```http -HTTP/1.1 200 OK -Content-type: application/json --{ - "directoryObject": { - "id": "id-value" - } -} -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- -{ - "type": "#page.annotation", - "description": "Create memberOf", - "keywords": "", - "section": "documentation", - "tocPath": "", - "suppressions": [ - ] -} >-- |
v1.0 | Orgcontact Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/orgcontact-update.md | - Title: "Update orgcontact" -description: "Update the properties of orgcontact object." --doc_type: apiPageType ---# Update orgcontact --Namespace: microsoft.graph ---Update the properties of orgcontact 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) | Not supported. | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Not supported. | --## HTTP request -<!-- { "blockType": "ignored" } --> -```http -PATCH /contacts/{id} -``` -## Request headers -| Name | Type | Description| -|:--|:|:-| -| Authorization | string | Bearer {token}. 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 you shouldn't include existing values that haven't changed. --| Property | Type |Description| -|:|:--|:-| -|city|String|| -|country|String|| -|department|String|| -|onPremisesSyncEnabled|Boolean|| -|displayName|String|| -|givenName|String|| -|jobTitle|String|| -|onPremisesLastSyncDateTime|DateTimeOffset|| -|mail|String|| -|mailNickname|String|| -|mobilePhone|String|| -|officeLocation|String|| -|postalCode|String|| -|proxyAddresses|String|| -|state|String|| -|streetAddress|String|| -|surname|String|| -|businessPhones|String collection|| --## Response --If successful, this method returns a `204 No Content` response code. --## Example -##### Request -The following is an example of the request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "update_orgcontact" -}--> -```http -PATCH https://graph.microsoft.com/beta/contacts/{id} -Content-type: application/json --{ - "businessPhones": [ - "businessPhones-value" - ], - "city": "city-value", - "companyName": "companyName-value", - "country": "country-value", - "department": "department-value", - "displayName": "displayName-value" -} -``` -# [C#](#tab/csharp) --# [JavaScript](#tab/javascript) --# [Objective-C](#tab/objc) --# [Go](#tab/go) --# [PowerShell](#tab/powershell) ----### Response -The following is an example of the response. -<!-- { - "blockType": "response" -} --> -```http -HTTP/1.1 204 No Content -``` --<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> -<!-- -{ - "type": "#page.annotation", - "description": "Update orgcontact", - "keywords": "", - "section": "documentation", - "tocPath": "", - "suppressions": [ - ] -} >-- |
v1.0 | Outlookuser Post Mastercategories | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/outlookuser-post-mastercategories.md | POST /users/{id|userPrincipalName}/outlook/masterCategories | Name | Description| |:|:-| | Authorization | Bearer {token}. Required. |-+|Content-Type|application/json. Required.| ## Request body-In the request body, supply a JSON representation of [outlookCategory](../resources/outlookcategory.md) object. +In the request body, supply a JSON representation of an [outlookCategory](../resources/outlookcategory.md) object. ## Response -If successful, this method returns `201 Created` response code and [outlookCategory](../resources/outlookcategory.md) object in the response body. +If successful, this method returns a `201 Created` response code and an [outlookCategory](../resources/outlookcategory.md) object in the response body. ## Example-##### Request -Here is an example of the request. +### Request +The following is an example of a request. # [HTTP](#tab/http) <!-- { Content-type: application/json Content-Length: 70 {- "displayName":"Project expenses", - "color":"preset9" + "displayName": "Project expenses", + "color": "preset9" } ``` # [C#](#tab/csharp) Content-Length: 70 -In the request body, supply a JSON representation of [outlookCategory](../resources/outlookcategory.md) object. -##### Response -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. <!-- { "blockType": "response", "truncated": true, HTTP/1.1 201 Created Content-type: application/json {- "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('8ae6f565-0d7f-4ead-853e-7db94c912a1f')/outlook/masterCategories/$entity", - "id":"bac262b7-485d-4739-b436-e31467d64fac", - "displayName":"Project expenses", - "color":"preset9" + "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('8ae6f565-0d7f-4ead-853e-7db94c912a1f')/outlook/masterCategories/$entity", + "id": "bac262b7-485d-4739-b436-e31467d64fac", + "displayName": "Project expenses", + "color": "preset9" } ``` |
v1.0 | Participant Invite | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/participant-invite.md | Title: "participant: invite" description: "Invite participants to the active call."-+ ms.localizationpriority: medium ms.prod: "cloud-communications" doc_type: apiPageType Invite participants to the active call. For more information about how to handle operations, see [commsoperation](../resources/commsoperation.md). ->**Note:** This API is only supported for group calls. +>**Note:** Inviting multiple participants in one request is only supported for group calls. ## 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). In the request body, provide a JSON object with the following parameters. |clientContext|String|Unique Client Context string. Max limit is 256 chars.| ## Response-If succsessful, this method returns a `200 OK` response code and a Location header with a URI to the [inviteParticipantsOperation](../resources/inviteparticipantsoperation.md) created for this request. The body of the response contains the [inviteParticipantsOperation](../resources/inviteparticipantsoperation.md) created. +If successful, this method returns a `200 OK` response code and a Location header with a URI to the [inviteParticipantsOperation](../resources/inviteparticipantsoperation.md) created for this request. The body of the response contains the [inviteParticipantsOperation](../resources/inviteparticipantsoperation.md) created. >**Note:** When this API returns a successful response, all participants will receive a roster update. The following examples show how to call this API. > **Note:** The response objects might be shortened for readability. All the properties will be returned from an actual call. -### Example 1: Invite one participant to an existing group call +### Example 1: Invite one participant to an existing call #### Request |
v1.0 | Participant Stopholdmusic | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/participant-stopholdmusic.md | Location: https://graph.microsoft.com/beta/communications/calls/e141b67c-90fd-45 { "@odata.type": "#microsoft.graph.stopHoldMusicOperation", "id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",- "status": "running", - "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c" -} -``` --### Notification sent to the application after the stopHoldMusicOperation finishes --```http -POST https://bot.contoso.com/api/calls -Content-Type: application/json -``` --<!-- { - "blockType": "example", - "@odata.type": "microsoft.graph.commsNotifications" -}--> -```json -{ - "@odata.type": "#microsoft.graph.commsNotifications", - "value": [ - { - "@odata.type": "#microsoft.graph.commsNotification", - "changeType": "deleted", - "resourceUrl": "communications/calls/e141b67c-90fd-455d-858b-b48a40b9cc8d/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5", - "resourceData": { - "@odata.type": "#microsoft.graph.stopHoldMusicOperation", - "@odata.id": "communications/calls/e141b67c-90fd-455d-858b-b48a40b9cc8d/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5", - "@odata.etag": "W/\"54451\"", - "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c", - "status": "completed" - } - } - ] + "status": "completed", + "clientContext": "d45324c1-fcb5-430a-902c-f20af696537c", + "resultInfo": null } ``` |
v1.0 | Passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration-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 | Passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration-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 | Passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/passwordlessmicrosoftauthenticatorauthenticationmethodconfiguration-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 | Printusagebyprinter Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/printusagebyprinter-get.md | GET https://graph.microsoft.com/beta/print/reports/dailyPrintUsageByPrinter/016b [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Printusagebyuser Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/printusagebyuser-get.md | GET https://graph.microsoft.com/beta/print/reports/dailyPrintUsageByUser/016b556 [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Privilegedapproval Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedapproval-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of privilegedapproval object. ## Permissions |
v1.0 | Privilegedapproval List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedapproval-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a list of privilegedapproval objects. |
v1.0 | Privilegedapproval Myrequests | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedapproval-myrequests.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Get the requestor's approval requests. |
v1.0 | Privilegedapproval Post Privilegedapproval | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedapproval-post-privilegedapproval.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Use this API to create a new privilegedApproval. ## Permissions |
v1.0 | Privilegedapproval Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedapproval-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Update the properties of privilegedapproval object. ## Permissions |
v1.0 | Privilegedoperationevent List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedoperationevent-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a list of [privilegedOperationEvent](../resources/privilegedoperationevent.md) objects, which represent the audit events that are generated by Privileged Identity Management for the role operations. For the details about the audit event, refer [privilegedOperationEvent](../resources/privilegedoperationevent.md). To filter the query results, use the standard OData ``$filter`` expression. |
v1.0 | Privilegedrole Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedrole-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of [privilegedRole](../resources/privilegedrole.md) object. |
v1.0 | Privilegedrole List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedrole-list-assignments.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a list of [privilegedRoleAssignment](../resources/privilegedroleassignment.md) objects that are associated with the role. Each [privilegedRoleAssignment](../resources/privilegedroleassignment.md) represents a role assignment to a user. ## Permissions |
v1.0 | Privilegedrole List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedrole-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a list of [privilegedRole](../resources/privilegedrole.md) objects. |
v1.0 | Privilegedrole Selfactivate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedrole-selfactivate.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Activate the role that is assigned to the requester. |
v1.0 | Privilegedrole Selfdeactivate | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedrole-selfdeactivate.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Deactivate the role that is assigned to the requestor. ## Permissions |
v1.0 | Privilegedroleassignment Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignment-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Delete [privilegedRoleAssignment](../resources/privilegedroleassignment.md). ## Permissions |
v1.0 | Privilegedroleassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignment-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of privilegedRoleAssignment object. ## Permissions |
v1.0 | Privilegedroleassignment List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignment-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a list of [privilegedRoleAssignment](../resources/privilegedroleassignment.md) objects, which correspond to all role assignments for the organization. ## Permissions |
v1.0 | Privilegedroleassignment Makeeligible | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignment-makeeligible.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Make the role assignment eligible. If the role assignment is already eligible before the call, it does nothing. If the role assignment is permanent and the requestor is different from the target user, the role assignment will become eligible and the role will be deactivated for the target user. If the requestor is the target user and the role is Security Administrator or Privileged Role Administrator, the role will be activated with the default expiration. |
v1.0 | Privilegedroleassignment Makepermanent | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignment-makepermanent.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Make the role assignment permanent. |
v1.0 | Privilegedroleassignment My | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignment-my.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Get the requestor's privileged role assignments. |
v1.0 | Privilegedroleassignment Post Privilegedroleassignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignment-post-privilegedroleassignments.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Use this API to create a new [privilegedRoleAssignment](../resources/privilegedroleassignment.md). ## Permissions |
v1.0 | Privilegedroleassignmentrequest Cancel | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignmentrequest-cancel.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Cancel a [privilegedRoleAssignmentRequest](../resources/privilegedroleassignmentrequest.md). |
v1.0 | Privilegedroleassignmentrequest List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignmentrequest-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve a collection of [privilegedRoleAssignmentRequest](../resources/privilegedroleassignmentrequest.md). |
v1.0 | Privilegedroleassignmentrequest My | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignmentrequest-my.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Get the requester's privileged role assignment requests. |
v1.0 | Privilegedroleassignmentrequest Post | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedroleassignmentrequest-post.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Create a [privilegedroleassignmentrequest](../resources/privilegedroleassignmentrequest.md) object. |
v1.0 | Privilegedrolesettings Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedrolesettings-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the role settings for the given role. A [privilegedRoleSettings](../resources/privilegedrolesettings.md) object will be returned. ## Permissions |
v1.0 | Privilegedrolesummary Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/privilegedrolesummary-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of [privilegedRoleSummary](../resources/privilegedrolesummary.md) object. ## Permissions |
v1.0 | Rbacapplication List Roleassignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/rbacapplication-list-roleassignments.md | GET /roleManagement/entitlementManagement/roleAssignments?$filter=principalId eq GET /roleManagement/entitlementManagement/roleAssignments?$filter=roleDefinitionId eq '{roleDefinition id}' -GET /roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/accessPackageCatalog/{catalog id}' +GET /roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}' ``` ## Query parameters -This operation requires the `$filter` query parameter. You can filter on the `roleDefinitionId` or `principalId` properties. The `roleDefinitionId` property can be either a role object ID or a role template object ID. The `$expand` query parameter is also supported on **principal**. For general information, see [OData query parameters](/graph/query-parameters). +This operation requires the `$filter` query parameter. You can filter on the `roleDefinitionId`, `principalId` or `appScopeId` properties. The `roleDefinitionId` property can be either a role object ID or a role template object ID. The `$expand` query parameter is also supported on **principal**. For general information, see [OData query parameters](/graph/query-parameters). ## Request headers Content-type: application/json } ``` +### Example 3: Request using $filter for role assignments on an access package catalog and expand principal ++#### Request ++The following is an example of the request. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_roleAssignments_3" +}--> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/4cee616b-fdf9-4890-9d10-955e0ccb12bc'&$expand=principal +``` +# [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.unifiedRoleAssignment", + "isCollection": true +} --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/roleAssignments", + "value": [ + { + "id": "900633fe-2508-4b13-a561-a15e320ad35f", + "principalId": "39228473-522e-4533-88cc-a9553180cb99", + "roleDefinitionId": "ae79f266-94d4-4dab-b730-feca7e132178", + "appScopeId": "/AccessPackageCatalog/4cee616b-fdf9-4890-9d10-955e0ccb12bc", + "principal": { + "@odata.type": "#microsoft.graph.user", + "id": "39228473-522e-4533-88cc-a9553180cb99" + } + } + ] +} +``` +++ <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 2019-02-04 14:57:30 UTC --> <!-- { |
v1.0 | Rbacapplication List Roledefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/rbacapplication-list-roledefinitions.md | Depending on the RBAC provider and the permission type (delegated or application |Permission type | Permissions (from least to most privileged) | |:--|:|-|Delegated (work or school account) | CloudPC.Read.All, CloudPC.ReadWrite.All, RoleManagement.Read.All | +|Delegated (work or school account) | RoleManagement.Read.CloudPC, CloudPC.Read.All, RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All, RoleManagement.Read.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | CloudPC.Read.All, CloudPC.ReadWrite.All, RoleManagement.Read.All | +|Application | RoleManagement.Read.CloudPC, CloudPC.Read.All, RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All, RoleManagement.Read.All | ### For a device management (Intune) provider |
v1.0 | Rbacapplication List Transitiveroleassignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/rbacapplication-list-transitiveroleassignments.md | + + Title: "List transitiveRoleAssignment" +description: "List direct and transitive role assignments for a specific principal." +ms.localizationpriority: medium ++++# List transitiveRoleAssignment ++Namespace: microsoft.graph +++Get the list of direct and transitive [unifiedRoleAssignment](../resources/unifiedroleassignment.md) objects for a specific principal. For example, if a user is assigned an Azure AD role through group membership, the role assignment is transitive, and this request will list the group's ID as the **principalId**. Results can also be filtered by the **roleDefinitionId** and **directoryScopeId**. Supported only for directory (Azure AD) provider. ++For more information, see [Use Azure AD groups to manage role assignments](/azure/active-directory/roles/groups-concept). ++> [!NOTE] +> This request might have replication delays for role assignments that were recently created, updated, or deleted. ++## 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) | 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 | ++## HTTP request ++To list transitive role assignments for a directory provider: ++<!-- { + "blockType": "ignored" +} +--> +```http +GET /roleManagement/directory/transitiveRoleAssignments?$filter=principalId eq '{principalId}' +``` ++## Optional query parameters ++This method supports the `$count`, `$filter` (`eq`), and `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). You can filter by the **principalId**, **roleDefinitionId** and **directoryScopeId** to retrieve both direct and transitive role assignments for a principal. ++## Request headers ++| Name |Description| +|:-|:-| +| Authorization | Bearer {token} Required. | +| ConsistencyLevel | eventual. This header, `$count`, and `$filter` are required. For more information about the use of **ConsistencyLevel**, `$count`, and `$filter`, 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 [unifiedRoleAssignment](../resources/unifiedroleassignment.md) objects in the response body. ++## Examples +For the examples in this section, consider the following role assignment scenario. A user named Alice has both direct and transitive role assignments as follows: ++| User | Group | Role | Scope | Role assignment ID | +| :: | :: | :: | :: | :: | +| Alice<br/>`2c7936bc-3517-40f3-8eda-4806637b6516` | | User Administrator<br/>`fe930be7-5e62-47db-91af-98c3a49a38b1` | Tenant | RA1<br/>`857708a7-b5e0-44f9-bfd7-53531d72a739` | +| | G1<br/>`ae2fc327-4c71-48ed-b6ca-f48632186510`<br/>(Alice is a member) | User Administrator<br/>`fe930be7-5e62-47db-91af-98c3a49a38b1` | Tenant | RA2<br/>`8a021d5f-7351-4713-aab4-b088504d476e` | +| | G2<br/>`6ffb34b8-5e6d-4727-a7f9-93245e7f6ea8`<br/>(Alice is a member) | Helpdesk Administrator<br/>`729827e3-9c14-49f7-bb1b-9608f156bbb8` | Administrative unit (AU1)<br/>`26e79164-0c5c-4281-8c5b-be7bc7809fb2` | RA3<br/>`6cc86637-13c8-473f-afdc-e0e65c9734d2` | +++ Alice is assigned the User Administrator role directly at tenant scope with role assignment RA1. ++ Alice is member of a group G1 and G1 is assigned the User Administrator role at tenant scope with role assignment RA2.++ Alice is also a member of group G2 and G2 is assigned the Helpdesk Administrator role at an administrative unit AU1 scope with role assignment RA3.++### Example 1 : Get direct and transitive role assignments of a principal ++#### Request ++The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` and the `$count=true` and `$filter` query parameters. For more information about the use of **ConsistencyLevel**, `$count`, and `$filter`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_unifiedroleassignment_all" +} +--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/roleManagement/directory/transitiveRoleAssignments?$count=true&$filter=principalId eq '2c7936bc-3517-40f3-8eda-4806637b6516' +ConsistencyLevel: eventual +``` +# [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. All the properties will be returned from an actual call. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.unifiedRoleAssignment", + "isCollection": true +} +--> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/transitiveRoleAssignments", + "value": [ + { + "id": "857708a7-b5e0-44f9-bfd7-53531d72a739", + "principalId": "2c7936bc-3517-40f3-8eda-4806637b6516", + "directoryScopeId": "/", + "roleDefinitionId": "fe930be7-5e62-47db-91af-98c3a49a38b1" + }, + { + "id": "8a021d5f-7351-4713-aab4-b088504d476e", + "principalId": "ae2fc327-4c71-48ed-b6ca-f48632186510", + "directoryScopeId": "/", + "roleDefinitionId": "fe930be7-5e62-47db-91af-98c3a49a38b1" + }, + { + "id": "6cc86637-13c8-473f-afdc-e0e65c9734d2", + "principalId": "6ffb34b8-5e6d-4727-a7f9-93245e7f6ea8", + "directoryScopeId": "/administrativeUnits/26e79164-0c5c-4281-8c5b-be7bc7809fb2", + "roleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8" + } + ] +} +``` ++### Example 2: Get direct and transitive assignments of a principal, but only specific role definitions ++#### Request ++The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` and the `$count=true` and `$filter` query parameters. For more information about the use of **ConsistencyLevel**, `$count`, and `$filter`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_unifiedroleassignment_transitive" +} +--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/roleManagement/directory/transitiveRoleAssignments?$count=true&$filter=principalId eq '2c7936bc-3517-40f3-8eda-4806637b6516' and roleDefinitionId eq 'fe930be7-5e62-47db-91af-98c3a49a38b1' +ConsistencyLevel: eventual +``` +# [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. All the properties will be returned from an actual call. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.unifiedRoleAssignment", + "isCollection": true +} +--> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/transitiveRoleAssignments", + "value": [ + { + "id": "857708a7-b5e0-44f9-bfd7-53531d72a739", + "principalId": "2c7936bc-3517-40f3-8eda-4806637b6516", + "directoryScopeId": "/", + "roleDefinitionId": "fe930be7-5e62-47db-91af-98c3a49a38b1" + }, + { + "id": "8a021d5f-7351-4713-aab4-b088504d476e", + "principalId": "6ffb34b8-5e6d-4727-a7f9-93245e7f6ea8", + "directoryScopeId": "/", + "roleDefinitionId": "fe930be7-5e62-47db-91af-98c3a49a38b1" + } + ] +} +``` ++### Example 3: Get direct and transitive role assignments of a principal, but only administrative unit scoped ++#### Request ++The following is an example of the request. This request requires the **ConsistencyLevel** header set to `eventual` and the `$count=true` and `$filter` query parameters. For more information about the use of **ConsistencyLevel**, `$count`, and `$filter`, see [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries). +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_unifiedroleassignment_tenantscoped" +} +--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/roleManagement/directory/transitiveRoleAssignments?$count=true&$filter=principalId eq '2c7936bc-3517-40f3-8eda-4806637b6516' and directoryScopeId eq '/administrativeUnits/26e79164-0c5c-4281-8c5b-be7bc7809fb2' +ConsistencyLevel: eventual +``` +# [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. All the properties will be returned from an actual call. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.unifiedRoleAssignment", + "isCollection": true +} +--> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/transitiveRoleAssignments", + "value": [ + { + "id": "6cc86637-13c8-473f-afdc-e0e65c9734d2", + "principalId": "6ffb34b8-5e6d-4727-a7f9-93245e7f6ea8", + "directoryScopeId": "/administrativeUnits/26e79164-0c5c-4281-8c5b-be7bc7809fb2", + "roleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8" + } + ] +} +``` |
v1.0 | Rbacapplication Post Roledefinitions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/rbacapplication-post-roledefinitions.md | Depending on the RBAC provider and the permission type (delegated or application |Permission type | Permissions (from least to most privileged) | |:--|:|-|Delegated (work or school account) | CloudPC.ReadWrite.All | +|Delegated (work or school account) | RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | CloudPC.ReadWrite.All | +|Application | RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All | ### For a device management (Intune) provider |
v1.0 | Rbacapplicationmultiple List Resourcenamespaces | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/rbacapplicationmultiple-list-resourcenamespaces.md | + + Title: "List resourceNamespaces" +description: "Get a list of the unifiedRbacResourceNamespace objects and their properties." ++ms.localizationpriority: medium +++# List resourceNamespaces +Namespace: microsoft.graph +++Get a list of the [unifiedRbacResourceNamespace](../resources/unifiedrbacresourcenamespace.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)|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /roleManagement/directory/resourceNamespaces +``` ++## Optional query parameters +This method supports the `$filter` and `$select` OData query parameters to help customize the response. This method supports `$filter` for **id** and **name**. 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 [unifiedRbacResourceNamespace](../resources/unifiedrbacresourcenamespace.md) objects in the response body. ++## Examples ++The following example gets all resource namespaces. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_unifiedrbacresourcenamespace" +} +--> +``` http +GET https://graph.microsoft.com/beta/roleManagement/directory/resourceNamespaces +``` +# [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 has been shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.unifiedRbacResourceNamespace)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/resourceNamespaces", + "value": [ + { + "id": "microsoft.aad.b2c", + "name": "microsoft.aad.b2c" + }, + { + "id": "microsoft.aad.cloudAppSecurity", + "name": "microsoft.aad.cloudAppSecurity" + }, + { + "id": "microsoft.directory", + "name": "microsoft.directory" + } + ] +} +``` |
v1.0 | Reportroot List Dailyprintusagebyprinter | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-list-dailyprintusagebyprinter.md | GET https://graph.microsoft.com/beta/print/reports/dailyPrintUsageByPrinter [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Reportroot List Dailyprintusagebyuser | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-list-dailyprintusagebyuser.md | GET https://graph.microsoft.com/beta/print/reports/dailyPrintUsageByUser [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Reportroot List Monthlyprintusagebyprinter | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-list-monthlyprintusagebyprinter.md | GET https://graph.microsoft.com/beta/print/reports/monthlyPrintUsageByPrinter [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Reportroot List Monthlyprintusagebyuser | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/reportroot-list-monthlyprintusagebyuser.md | GET https://graph.microsoft.com/beta/print/reports/monthlyPrintUsageByUser [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Riskyserviceprincipal Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyserviceprincipal-confirmcompromised.md | If successful, this action returns a `204 No Content` response code. It does not ## Example ### Request++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "riskyserviceprincipal_confirmcompromised" Content-Type: application/json ] } ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ ### Response |
v1.0 | Riskyserviceprincipal Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyserviceprincipal-dismiss.md | If successful, this action returns a `204 No Content` response code. It does not ## Example ### Request++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "riskyserviceprincipal_dismiss" Content-Type: application/json ] } ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ ### Response |
v1.0 | Riskyserviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyserviceprincipal-get.md | If successful, this method returns a `200 OK` response code and a [riskyServiceP ## Examples ### Request++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_riskyserviceprincipal" If successful, this method returns a `200 OK` response code and a [riskyServiceP ``` http GET https://graph.microsoft.com/beta/identityProtection/riskyServicePrincipals/9089a539-a539-9089-39a5-899039a58990 ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ ### Response |
v1.0 | Riskyserviceprincipal List History | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyserviceprincipal-list-history.md | If successful, this method returns a `200 OK` response code and a collection of ## Example ### Request++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_riskyserviceprincipalhistoryitem" If successful, this method returns a `200 OK` response code and a collection of ``` http GET https://graph.microsoft.com/beta/identityProtection/riskyServicePrincipals/{riskyServicePrincipalId}/history ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ ### Response |
v1.0 | Riskyuser List History | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyuser-list-history.md | GET https://graph.microsoft.com/beta/identityProtection/riskyUsers/41a31b00-3b3b [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + #### Response |
v1.0 | Riskyuserhistoryitem Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/riskyuserhistoryitem-get.md | GET https://graph.microsoft.com/beta/identityProtection/riskyUsers/41a31b00-3b3b [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + #### Response |
v1.0 | Schedule Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-get.md | Title: "Get schedule" description: "Retrieve the properties and relationships of a **schedule** object."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule List Schedulinggroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-list-schedulinggroups.md | Title: "List schedulingGroups" description: "Get the list of schedulingGroup in this schedule."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule List Shifts | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-list-shifts.md | Title: "List shifts" description: "Get the list of shifts in a schedule."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType GET /teams/{teamId}/schedule/shifts ``` ## Optional query parameters+ This method supports the `$filter` [OData query parameter](/graph/query-parameters) to help customize the response. +> [!NOTE] +> The `$filter` parameter doesn't support the use of the same property more than once in a query. For example, the following query will not work: `sharedShift/startDateTime ge 2019-05-09T00:00:00Z and sharedShift/startDateTime le 2019-05-09T23:59:59Z`. + ## Request headers | Header | Value | |
v1.0 | Schedule List Timeoffreasons | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-list-timeoffreasons.md | Title: "List timeOffReasons" description: "Get the list of timeOffReasons in a schedule."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule List Timesoff | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-list-timesoff.md | Title: "List timesOff" description: "Get the list of timesOff in this schedule."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule Post Schedulinggroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-post-schedulinggroups.md | Title: "Create schedulingGroup" description: "Create a new schedulingGroup."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule Post Shifts | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-post-shifts.md | Title: "Create shift" description: "Create a new shift."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule Post Timeoffreasons | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-post-timeoffreasons.md | Title: "Create timeOffReason" description: "Create a new timeOffReason."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule Post Timesoff | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-post-timesoff.md | Title: "Create timeOff" description: "Create a new timeOff."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedule Share | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedule-share.md | Title: "schedule: share" description: "Share a schedule time range with schedule members."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedulinggroup Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedulinggroup-delete.md | Title: "Delete schedulingGroup" description: "Mark a schedulingGroup as inactive by setting its isActive property"-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedulinggroup Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedulinggroup-get.md | Title: "Get schedulingGroup" description: "Retrieve the properties and relationships of a [schedulingGroup](../resources/schedulinggroup.md) by ID."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Schedulinggroup Put | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/schedulinggroup-put.md | Title: "Replace schedulingGroup" description: "Replace an existing schedulingGroup."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Search Acronym Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-acronym-delete.md | + + Title: "Delete acronym" +description: "Deletes an acronym object." ++ms.localizationpriority: medium +++# Delete acronym +Namespace: microsoft.graph.search +++Deletes an [acronym](../resources/search-acronym.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /search/acronyms/{acronymsId} +``` ++## 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_acronym" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/search/acronyms/{acronymsId} +``` +# [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 Content +``` + |
v1.0 | Search Acronym Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-acronym-get.md | + + Title: "Get acronym" +description: "Read the properties and relationships of an acronym object." ++ms.localizationpriority: medium +++# Get acronym +Namespace: microsoft.graph.search +++Read the properties and relationships of an [acronym](../resources/search-acronym.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /search/acronyms/{acronymsId} +``` ++## Optional query parameters +This method supports the `select`, `expand`, `filter`, `orderBy`, `maxTop`, and `count` [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 an [acronym](../resources/search-acronym.md) object in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_acronym" +} +--> +``` http +GET https://graph.microsoft.com/beta/search/acronyms/{acronymsId} +``` +# [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.search.acronym" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897", + "displayName": "DNN", + "standsFor": ["Deep Neural Network"], + "description": "A deep neural network is a neural network with a certain level of complexity, a neural network with more than two layers.", + "webUrl": "http://microsoft.com/deep-neural-network", + "state": "published", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "lastModifiedBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Amalie Larsen" + } + } +} +``` + |
v1.0 | Search Acronym Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-acronym-update.md | + + Title: "Update acronym" +description: "Update the properties of an acronym object." ++ms.localizationpriority: medium +++# Update acronym +Namespace: microsoft.graph.search +++Update the properties of an [acronym](../resources/search-acronym.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /search/acronyms/{acronymsId} +``` ++## 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 [acronym](../resources/search-acronym.md) object. Supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. ++|Property|Type|Description| +|:|:|:| +|description|String|A brief description of the acronym that gives users more info about the acronym and what it stands for. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|displayName|String|The actual short form or acronym. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|standsFor|String collection|What the acronym stands for.| +|state|microsoft.graph.search.answerState|State of the acronym. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| +|webUrl|String|The URL of the page or website where users can go for more information about the acronym. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| ++++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_acronym" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/search/acronyms/{acronymsId} +Content-Type: application/json ++{ + "description": "A deep neural network is a neural network with a certain level of complexity, a neural network with more than two layers." +} +``` +# [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 Content +``` + |
v1.0 | Search Bookmark Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-bookmark-delete.md | + + Title: "Delete bookmark" +description: "Delete a bookmark object." ++ms.localizationpriority: medium +++# Delete bookmark +Namespace: microsoft.graph.search +++Delete a [bookmark](../resources/search-bookmark.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /search/bookmarks/{bookmarksId} +``` ++## 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_bookmark" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/search/bookmarks/{bookmarkId} +``` +# [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 Content +``` + |
v1.0 | Search Bookmark Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-bookmark-get.md | + + Title: "Get bookmark" +description: "Read the properties and relationships of a bookmark object." ++ms.localizationpriority: medium +++# Get bookmark +Namespace: microsoft.graph.search +++Read the properties and relationships of a [bookmark](../resources/search-bookmark.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /search/bookmarks/{bookmarksId} +``` ++## Optional query parameters +This method supports the `select`, `expand`, `filter`, `orderBy`, `maxTop`, and `count` [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 [bookmark](../resources/search-bookmark.md) object in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_bookmark" +} +--> +``` http +GET https://graph.microsoft.com/beta/search/bookmarks/{bookmarksId} +``` +# [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.search.bookmark" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897", + "displayName": "Italy Holiday", + "webUrl": "http://www.margiestravel.com/", + "description": "Book a fancy vacation in Tuscany or browse museums in Florence.", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "lastModifiedBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Amalie Larsen" + } + }, + "keywords": { + "keywords": ["Vacation in Europe", "Holiday in Europe"], + "reservedKeywords": ["Vacation in Italy"], + "matchSimilarKeywords": true + }, + "categories": ["HR"], + "availabilityStartDateTime": "2020-09-21T20:01:37Z", + "availabilityEndDateTime": "2020-11-21T20:01:37Z", + "languageTags": ["en-US"], + "platforms": ["ios"], + "groupIds": ["groupId"], + "targetedVariations": null, + "powerAppIds": ["powerAppId"], + "state": "published", + "isSuggested": false +} +``` + |
v1.0 | Search Bookmark Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-bookmark-update.md | + + Title: "Update bookmark" +description: "Update the properties of a bookmark object." ++ms.localizationpriority: medium +++# Update bookmark +Namespace: microsoft.graph.search +++Update the properties of a [bookmark](../resources/search-bookmark.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /search/bookmarks/{bookmarksId} +``` ++## 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 [bookmark](../resources/search-bookmark.md) object. Supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +>**Note:** Updates to collection properties will update the entire collection. Any updates to a collection, such as keywords or categories, will replace the collection entirely. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Bookmark name displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|description|String|Bookmark description shown on search results page. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|webUrl|String|Bookmark URL link. When users click this bookmark in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|categories|String collection|Categories commonly used to describe this bookmark. For example, IT and HR.| +|availabilityStartDateTime|DateTimeOffset|Timestamp of when the bookmark will start to appear as a search result. Set as `null` for always available.| +|availabilityEndDateTime|DateTimeOffset|Timestamp of when the bookmark will stop to appear as a search result. Set as `null` for always available.| +|languageTags|String collection|List of countries or regions able to view this bookmark.| +|platforms|microsoft.graph.devicePlatformType collection|List of devices and operating systems able to view this bookmark. Possible values are: `unknown`, `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `androidASOP`.| +|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a bookmark for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.| +|powerAppIds|String collection|List of Power Apps associated with this bookmark. If users add existing Power Apps to a bookmark, they can complete tasks, such as to enter vacation time or to report expenses on the search results page.| +|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerKeyword.md)|Keywords that trigger this bookmark to appear in search results.| +|state|microsoft.graph.search.answerState|State of the bookmark. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| +|groupIds|String collection|List of security groups able to view this bookmark.| ++++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_bookmark" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/search/bookmarks/{bookmarksId} +Content-Type: application/json ++{ + "description": "Book a fancy vacation in Tuscany or browse museums in Florence." +} ++``` +# [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 Content +``` + |
v1.0 | Search Qna Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-qna-delete.md | + + Title: "Delete qna" +description: "Delete a qna object." ++ms.localizationpriority: medium +++# Delete qna +Namespace: microsoft.graph.search +++Delete a [qna](../resources/search-qna.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /search/qnas/{qnaId} +``` ++## 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_qna" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/search/qnas/{qnaId} +``` +# [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 Content +``` + |
v1.0 | Search Qna Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-qna-get.md | + + Title: "Get qna" +description: "Read the properties and relationships of a qna object." ++ms.localizationpriority: medium +++# Get qna +Namespace: microsoft.graph.search +++Read the properties and relationships of a [qna](../resources/search-qna.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /search/qnas/{qnaId} +``` ++## Optional query parameters +This method supports the `select`, `expand`, `filter`, `orderBy`, `maxTop`, and `count` [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 [qna](../resources/search-qna.md) object in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_qna" +} +--> +``` http +GET https://graph.microsoft.com/beta/search/qnas/{qnaId} +``` +# [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.search.qna" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897", + "displayName": "Global Country Holidays", + "webUrl": "http://www.contoso.com/", + "description": "The dates that Contoso offices will be closed to observe holidays. These dates may differ from the actual date of the holiday in cases where the holiday falls on a weeΓÇïkend.", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "lastModifiedBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Amalie Larsen" + } + }, + "keywords": { + "keywords": ["new years day", "martin luther king day", "presidents day", "memorial day", "independence day", "labor day", "thanksgiving", "christmas"], + "reservedKeywords": ["holidays", "paid days off"], + "matchSimilarKeywords": true + }, + "availabilityStartDateTime": "2020-09-21T20:01:37Z", + "availabilityEndDateTime": "2021-12-31T20:01:37Z", + "languageTags": ["en-US"], + "platforms": ["ios"], + "groupIds": ["groupId"], + "targetedVariations": null, + "state": "published" +} +``` + |
v1.0 | Search Qna Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-qna-update.md | + + Title: "Update qna" +description: "Update the properties of a qna object." ++ms.localizationpriority: medium +++# Update qna +Namespace: microsoft.graph.search +++Update the properties of a [qna](../resources/search-qna.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /search/qna/{qnaId} +``` ++## 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 [qna](../resources/search-qna.md) object. Supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. +>**Note:** Updates to collection properties will update the entire collection. Any updates to a collection, such as keywords or categories, will replace the collection entirely. ++|Property|Type|Description| +|:|:|:| +|displayName|String|Question displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|description|String|Answer displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|webUrl|String|Qna URL link. When users click this qna in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna will start to appear as a search result. Set as `null` for always available.| +|availabilityEndDateTime|DateTimeOffset|Timestamp of when the qna will stop to appear as a search result. Set as `null` for always available.| +|languageTags|String collection|List of countries or regions able to view this qna.| +|platforms|microsoft.graph.devicePlatformType collection|List of devices and operating systems able to view this qna. Possible values are: `unknown`, `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `androidASOP`.| +|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.| +|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerKeyword.md)|Keywords that trigger this qna to appear in search results.| +|state|microsoft.graph.search.answerState|State of the qna. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| +|groupIds|String collection|List of security groups able to view this qna.| ++++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request +<!-- { + "blockType": "request", + "name": "update_qna" +}--> +``` http +PATCH https://graph.microsoft.com/beta/search/qna/{qnaId} +Content-Type: application/json ++{ + "description": "The dates that Contoso offices will be closed to observe holidays. These dates may differ from the actual date of the holiday in cases where the holiday falls on a weeΓÇïkend." +} +``` +++### Response +<!-- { + "blockType": "response", + "truncated": true +}--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Search Searchentity List Acronyms | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-searchentity-list-acronyms.md | + + Title: "List acronyms" +description: "Get a list of the acronym objects and their properties." ++ms.localizationpriority: medium +++# List acronyms +Namespace: microsoft.graph.search +++Get a list of the [acronym](../resources/search-acronym.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /search/acronyms +``` ++## Optional query parameters +This method supports the `select`, `expand`, `filter`, `orderBy`, `maxTop`, and `count` [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 [acronym](../resources/search-acronym.md) objects in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_acronym" +} +--> +``` http +GET https://graph.microsoft.com/beta/search/acronyms +``` +# [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.search.acronym", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++[ + { + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897", + "displayName": "DNN", + "standsFor": ["Deep Neural Network"], + "description": "A deep neural network is a neural network with a certain level of complexity, a neural network with more than two layers.", + "webUrl": "http://microsoft.com/deep-neural-network", + "state": "published", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "lastModifiedBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Amalie Larsen" + } + } + } +] +``` + |
v1.0 | Search Searchentity List Bookmarks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-searchentity-list-bookmarks.md | + + Title: "List bookmarks" +description: "Get a list of bookmark objects and their properties." ++ms.localizationpriority: medium +++# List bookmarks +Namespace: microsoft.graph.search +++Get a list of [bookmark](../resources/search-bookmark.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /search/bookmarks +``` ++## Optional query parameters +This method supports the `select`, `expand`, `filter`, `orderBy`, `maxTop`, and `count` [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 [bookmark](../resources/search-bookmark.md) objects in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_bookmark" +} +--> +``` http +GET https://graph.microsoft.com/beta/search/bookmarks +``` +# [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.search.bookmark", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++[ + { + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897", + "displayName": "Italy Holiday", + "webUrl": "http://www.margiestravel.com/", + "description": "Book a fancy vacation in Tuscany or browse museums in Florence.", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "lastModifiedBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Amalie Larsen" + } + }, + "keywords": { + "keywords": ["Vacation in Europe", "Holiday in Europe"], + "reservedKeywords": ["Vacation in Italy"], + "matchSimilarKeywords": true + }, + "categories": ["HR"], + "availabilityStartDateTime": "2020-09-21T20:01:37Z", + "availabilityEndDateTime": "2020-11-21T20:01:37Z", + "languageTags": ["en-US"], + "platforms": ["ios"], + "groupIds": ["groupId"], + "targetedVariations": null, + "powerAppIds": ["powerAppId"], + "state": "published", + "isSuggested": false + } +] +``` + |
v1.0 | Search Searchentity List Qnas | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-searchentity-list-qnas.md | + + Title: "List qnas" +description: "Get a list of the qna objects and their properties." ++ms.localizationpriority: medium +++# List qnas +Namespace: microsoft.graph.search +++Get a list of the [qna](../resources/search-qna.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /search/qnas +``` ++## Optional query parameters +This method supports the `select`, `expand`, `filter`, `orderBy`, `maxTop`, and `count` [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 [qna](../resources/search-qna.md) objects in the response body. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_qna" +} +--> +``` http +GET https://graph.microsoft.com/beta/search/qnas +``` +# [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.search.qna", + "isCollection": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++[ + { + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897", + "displayName": "Global Country Holidays", + "webUrl": "http://www.contoso.com/", + "description": "The dates that Contoso offices will be closed to observe holidays. These dates may differ from the actual date of the holiday in cases where the holiday falls on a weeΓÇïkend. <table> <thead> <tr> <td><strong>2021 Dates</strong></td> <td><strong>Holiday</strong></td> </tr> </thead> <tbody> <tr> <td>January 1, 2021</td> <td>New Year's Day</td> </tr> <tr> <td>January 18, 2021</td> <td>Martin Luther King Day</td> </tr> <tr> <td>February 15, 2021</td> <td>Presidents Day</td> </tr> <tr> <td>May 31, 2021</td> <td>Memorial Day</td> </tr> <tr> <td>July 5, 2021</td> <td>Independence Day</td> </tr> <tr> <td>September 6, 2021</td> <td>Labor Day</td> </tr> <tr> <td>November 25, 2021 - November 26, 2021</td> <td>Thanksgiving Day and Day after Thanksgiving</td> </tr> <tr> <td>December 23, 2021 - December 24, 2021</td> <td>Christmas Eve and Christmas Day</td> </tr> </tbody> </table>", + "lastModifiedDateTime": "2016-03-21T20:01:37Z", + "lastModifiedBy": { + "user": { + "id": "efee1b77-fb3b-4f65-99d6-274c11914d12", + "displayName": "Amalie Larsen" + } + }, + "keywords": { + "keywords": ["new years day", "martin luther king day", "presidents day", "memorial day", "independence day", "labor day", "thanksgiving", "christmas"], + "reservedKeywords": ["holidays", "paid days off"], + "matchSimilarKeywords": true + }, + "availabilityStartDateTime": "2020-09-21T20:01:37Z", + "availabilityEndDateTime": "2021-12-31T20:01:37Z", + "languageTags": ["en-US"], + "platforms": ["ios"], + "groupIds": ["groupId"], + "targetedVariations": null, + "state": "published" + } +] +``` + |
v1.0 | Search Searchentity Post Acronyms | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-searchentity-post-acronyms.md | + + Title: "Create acronym" +description: "Create a new acronym object." ++ms.localizationpriority: medium +++# Create acronym +Namespace: microsoft.graph.search +++Create a new [acronym](../resources/search-acronym.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /search/acronyms +``` ++## 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 [acronym](../resources/search-acronym.md) object. ++The following table shows the properties that are available when you create an [acronym](../resources/search-acronym.md). ++|Property|Type|Description| +|:|:|:| +|description|String|A brief description of the acronym that gives users more info about the acronym and what it stands for. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|displayName|String|The actual short form or acronym. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|standsFor|String collection|What the acronym stands for.| +|state|microsoft.graph.search.answerState|State of the acronym. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| +|webUrl|String|The URL of the page or website where users can go for more information about the acronym. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| ++++## Response ++If successful, this method returns a `200 Ok` response code. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_acronym_from_acronyms" +}--> +```http +POST https://graph.microsoft.com/beta/search/acronyms +Content-Type: application/json ++{ + "displayName": "DNN", + "standsFor": "Deep Neural Network", + "description": "A deep neural network is a neural network with a certain level of complexity, a neural network with more than two layers.", + "webUrl": "http://microsoft.com/deep-neural-network", + "state": "draft" +} +``` +# [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. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.search.acronym" +}--> +```http +HTTP/1.1 200 Ok +Content-Type: application/json ++{ + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897" +} +``` + |
v1.0 | Search Searchentity Post Bookmarks | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-searchentity-post-bookmarks.md | + + Title: "Create bookmark" +description: "Create a new bookmark object." ++ms.localizationpriority: medium +++# Create bookmark +Namespace: microsoft.graph.search +++Create a new [bookmark](../resources/search-bookmark.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +}--> +```http +POST /search/bookmarks +``` ++## 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 [bookmark](../resources/search-bookmark.md) object. ++The following table shows the properties that are available when you create a [bookmark](../resources/search-bookmark.md). ++|Property|Type|Description| +|:|:|:| +|displayName|String|Bookmark name displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|description|String|Bookmark description shown on search results page. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|webUrl|String|Bookmark URL link. When users click this bookmark in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|categories|String collection|Categories commonly used to describe this bookmark. For example, IT and HR.| +|availabilityStartDateTime|DateTimeOffset|Timestamp of when the bookmark will start to appear as a search result. Set as `null` for always available.| +|availabilityEndDateTime|DateTimeOffset|Timestamp of when the bookmark will stop to appear as a search result. Set as `null` for always available.| +|languageTags|String collection|List of countries or regions able to view this bookmark.| +|platforms|microsoft.graph.devicePlatformType collection|List of devices and operating systems able to view this bookmark. Possible values are: `unknown`, `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `androidASOP`.| +|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a bookmark for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.| +|powerAppIds|String collection|List of Power Apps associated with this bookmark. If users add existing Power Apps to a bookmark, they can complete tasks, such as to enter vacation time or to report expenses on the search results page.| +|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerKeyword.md)|Keywords that trigger this bookmark to appear in search results.| +|state|microsoft.graph.search.answerState|State of the bookmark. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| +|groupIds|String collection|List of security groups able to view this bookmark.| ++++## Response ++If successful, this method returns a `201 Created` response code with the ID of the bookmark created. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_bookmark_from_bookmarks" +}--> +```http +POST https://graph.microsoft.com/beta/search/bookmarks +Content-Type: application/json ++{ + "displayName": "Contoso Install Site", + "webUrl": "http://www.contoso.com/", + "description": "Try or buy Contoso for Home or Business and view product information", + "keywords": { + "keywords": ["Contoso", "install"], + "reservedKeywords": ["Contoso"], + "matchSimilarKeywords": true + }, + "availabilityStartDateTime": null, + "availabilityEndDateTime": null, + "platforms": ["windows"], + "targetedVariations": [ + { + "languageTag": "es-ES", + "displayName": "Sitio de instalaci├│n Contoso", + "description": "Pruebe o compre Contoso hogar o negocios y vea la informaci├│n del producto" + } + ], + "groupIds": ["groupId"], + "powerAppIds": ["powerAppId"], + "state": "published" +} +``` +# [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. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.search.bookmark" +}--> +```http +HTTP/1.1 201 CREATED +Location: /733b26d5-af76-4eea-ac69-1a0ce8716897 +Content-Type: application/json ++{ + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897" +} +``` + |
v1.0 | Search Searchentity Post Qnas | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/search-searchentity-post-qnas.md | + + Title: "Create qna" +description: "Create a new qna object." ++ms.localizationpriority: medium +++# Create qna +Namespace: microsoft.graph.search +++Create a new [qna](../resources/search-qna.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)| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | +|Delegated (personal Microsoft account)| Not supported. | +|Application| SearchConfiguration.Read.All, SearchConfiguration.ReadWrite.All | ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /search/qnas +``` ++## 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 [qna](../resources/search-qna.md) object. ++The following table shows the properties that are available when you create a [qna](../resources/search-qna.md). ++|Property|Type|Description| +|:|:|:| +|displayName|String|Question displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|description|String|Answer displayed in search results. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|webUrl|String|Qna URL link. When users click this qna in search results, they will go to this URL. Inherited from [searchAnswer](../resources/search-searchAnswer.md).| +|availabilityStartDateTime|DateTimeOffset|Timestamp of when the qna will start to appear as a search result. Set as `null` for always available.| +|availabilityEndDateTime|DateTimeOffset|Timestamp of when the qna will stop to appear as a search result. Set as `null` for always available.| +|languageTags|String collection|List of countries or regions able to view this qna.| +|platforms|microsoft.graph.devicePlatformType collection|List of devices and operating systems able to view this qna. Possible values are: `unknown`, `android`, `androidForWork`, `ios`, `macOS`, `windowsPhone81`, `windowsPhone81AndLater`, `windows10AndLater`, `androidWorkProfile`, `androidASOP`.| +|targetedVariations|[microsoft.graph.search.answerVariant](../resources/search-answerVariant.md) collection|Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.| +|keywords|[microsoft.graph.search.answerKeyword](../resources/search-answerKeyword.md)|Keywords that trigger this qna to appear in search results.| +|state|microsoft.graph.search.answerState|State of the qna. Possible values are: `published`, `draft`, `excluded`, or `unknownFutureValue`.| +|groupIds|String collection|List of security groups able to view this qna.| ++++## Response ++If successful, this method returns a `201 Created` response code with the ID of the question and answer created. ++## Examples ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_qna_from_qnas" +}--> +```http +POST https://graph.microsoft.com/beta/search/qnas +Content-Type: application/json ++{ + "displayName": "Global Country Holidays", + "webUrl": "http://www.contoso.com/", + "description": "The dates that Contoso offices will be closed to observe holidays. These dates may differ from the actual date of the holiday in cases where the holiday falls on a weeΓÇïkend. <table> <thead> <tr> <td><strong>2021 Dates</strong></td> <td><strong>Holiday</strong></td> </tr> </thead> <tbody> <tr> <td>January 1, 2021</td> <td>New Year's Day</td> </tr> <tr> <td>January 18, 2021</td> <td>Martin Luther King Day</td> </tr> <tr> <td>February 15, 2021</td> <td>Presidents Day</td> </tr> <tr> <td>May 31, 2021</td> <td>Memorial Day</td> </tr> <tr> <td>July 5, 2021</td> <td>Independence Day</td> </tr> <tr> <td>September 6, 2021</td> <td>Labor Day</td> </tr> <tr> <td>November 25, 2021 - November 26, 2021</td> <td>Thanksgiving Day and Day after Thanksgiving</td> </tr> <tr> <td>December 23, 2021 - December 24, 2021</td> <td>Christmas Eve and Christmas Day</td> </tr> </tbody> </table>", + "keywords": { + "keywords": ["new years day", "martin luther king day", "presidents day", "memorial day", "independence day", "labor day", "thanksgiving", "christmas"], + "reservedKeywords": ["holidays", "paid days off"], + "matchSimilarKeywords": true + }, + "availabilityStartDateTime": "2020-09-21T20:01:37Z", + "availabilityEndDateTime": "2021-12-31T20:01:37Z", + "languageTags": ["en-US"], + "platforms": ["ios"], + "groupIds": ["groupId"], + "state": "published" +} +``` +# [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. +<!--{ + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.search.qna" +}--> +```http +HTTP/1.1 201 CREATED +Location: /733b26d5-af76-4eea-ac69-1a0ce8716897 +Content-Type: application/json ++{ + "id": "733b26d5-af76-4eea-ac69-1a0ce8716897" +} +``` + |
v1.0 | Sectiongroup List Sectiongroups | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/sectiongroup-list-sectiongroups.md | GET https://graph.microsoft.com/beta/me/onenote/sectionGroups/{id}/sectionGroups [!INCLUDE [sample-code](../includes/snippets/go/get-sectiongroups-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + ##### Response |
v1.0 | Serviceannouncement List Healthoverviews | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceannouncement-list-healthoverviews.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/healthOverviews [!INCLUDE [sample-code](../includes/snippets/go/list-healthoverviews-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/healthOverviews?$ [!INCLUDE [sample-code](../includes/snippets/go/list-healthoverviews-with-issues-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceannouncement List Issues | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceannouncement-list-issues.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/issues [!INCLUDE [sample-code](../includes/snippets/go/list-servicehealthissue-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceannouncement List Messages | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceannouncement-list-messages.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/messages [!INCLUDE [sample-code](../includes/snippets/go/list-serviceupdatemessage-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceannouncementattachment Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceannouncementattachment-get.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/messages/MC54091/ [!INCLUDE [sample-code](../includes/snippets/go/get-serviceannouncementattachment-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/messages/MC54091/ [!INCLUDE [sample-code](../includes/snippets/go/get-serviceannouncementattachment-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Servicehealth Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/servicehealth-get.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/healthOverviews/M [!INCLUDE [sample-code](../includes/snippets/go/get-servicehealth-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/healthOverviews/M [!INCLUDE [sample-code](../includes/snippets/go/get-servicehealth-with-issues-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Servicehealthissue Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/servicehealthissue-get.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/issues/MO226784 [!INCLUDE [sample-code](../includes/snippets/go/get-servicehealthissue-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Servicehealthissue Incidentreport | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/servicehealthissue-incidentreport.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/issues/MO248163/i [!INCLUDE [sample-code](../includes/snippets/go/servicehealthissue-incidentreport-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipal-get.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account) | Not supported. | |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All | +> [!NOTE] +> A service principal can retrieve its own application and service principal details without being granted any application permissions. + ## HTTP request <!-- { "blockType": "ignored" } --> ```http GET /servicePrincipals/{id} ``` ## Optional query parameters-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. +This method supports the [OData query parameters](/graph/query-parameters) to help customize the response. This method supports the `$count`, `$expand`, `$filter`, `$orderBy`, `$search`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. 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). |
v1.0 | Serviceprincipal List Approleassignedto | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipal-list-approleassignedto.md | For example, if the resource service principal is the service principal for the If the resource service principal is an application that has app roles granted to users and groups, this will return all the users and groups assigned app roles for this application. +>**Note** This request might have replication delays for app role assignments that were recently granted or removed. + ## 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 | Serviceprincipal List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipal-list-approleassignments.md | Retrieve the list of [appRoleAssignment](../resources/approleassignment.md) that App roles that are assigned to service principals are also known as [application permissions](/azure/active-directory/develop/v2-permissions-and-consent#permission-types). Application permissions can be granted directly by creating app role assignments, or through a [consent experience](/azure/active-directory/develop/application-consent-experience). ++>**Note** This request might have replication delays for app role assignments that were recently granted or removed. + ## 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 | Serviceprincipal Removekey | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipal-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 servicePrincipal'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 servicePrincipal 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 | Serviceprincipal Removepassword | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipal-removepassword.md | POST /servicePrincipals/{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 | Serviceprincipalriskdetection Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceprincipalriskdetection-get.md | If successful, this method returns a `200 OK` response code and a [servicePrinci ### Example 1: Get a specific risk detection object #### Request++# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_serviceprincipalriskdetection" If successful, this method returns a `200 OK` response code and a [servicePrinci ``` http GET https://graph.microsoft.com/beta/identityProtection/servicePrincipalRiskDetections/{servicePrincipalRiskDetectionId} ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) +++ #### Response |
v1.0 | Serviceupdatemessage Archive | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-archive.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/serviceupdatemessage-archive-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceupdatemessage Favorite | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-favorite.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/serviceupdatemessage-favorite-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceupdatemessage Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-get.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/messages/MC172851 [!INCLUDE [sample-code](../includes/snippets/go/get-serviceupdatemessage-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceupdatemessage List Attachments | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-list-attachments.md | GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/messages/MC54091/ [!INCLUDE [sample-code](../includes/snippets/go/list-serviceannouncementattachment-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + GET https://graph.microsoft.com/beta/admin/serviceAnnouncement/messages/MC54091/ [!INCLUDE [sample-code](../includes/snippets/go/list-serviceannouncementattachment-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceupdatemessage Markread | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-markread.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/serviceupdatemessage-markread-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceupdatemessage Markunread | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-markunread.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/serviceupdatemessage-markunread-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceupdatemessage Unarchive | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-unarchive.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/serviceupdatemessage-unarchive-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Serviceupdatemessage Unfavorite | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/serviceupdatemessage-unfavorite.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/go/serviceupdatemessage-unfavorite-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + |
v1.0 | Shift Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/shift-delete.md | Title: "Delete shift" description: "Delete a shift from the schedule."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Shift Put | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/shift-put.md | Title: "Replace shift" description: "Replace an existing shift."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Site Follow | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/site-follow.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Site List Subsites | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/site-list-subsites.md | description: "Get a collection of subsites defined for a site." Previously updated : 09/10/2017 Title: List the subsites for a SharePoint site ms.localizationpriority: medium ms.prod: "sharepoint" One of the following permissions is required to call this API. To learn more, in ## HTTP request +<!-- { "blockType": "ignored" } --> + ```http GET /sites/{site-id}/sites ``` +## Request headers ++| Name |Description| +|:-|:-| +| Authorization | Bearer {code}. 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 [site][] objects in the response body. + ## Example ### Request +The following is an example of a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list-subsites", "scopes": "service.sharepoint sites.read.all" } --> GET https://graph.microsoft.com/beta/sites/{site-id}/sites ### Response +The following is an example of the response. + <!-- { "blockType": "response", "@type": "microsoft.graph.site", "isCollection": true, "truncated": true } --> ```http |
v1.0 | Site Unfollow | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/site-unfollow.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response |
v1.0 | Smsauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-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 | Smsauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-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 | Smsauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/smsauthenticationmethodconfiguration-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 | Subjectrightsrequest Getfinalattachment | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/subjectrightsrequest-getfinalattachment.md | Do not supply a request body for this method. ## Response -If successful, this function will redirect to the Microsoft Azure blob storage link with the SAS token and return a `302` response code. +If successful, this function will redirect to the Microsoft Azure blob storage link with the SAS token and return a `200` response code. ## Examples GET https://graph.microsoft.com/beta/privacy/subjectRightsRequests/{subjectRight } --> ``` http-HTTP/1.1 302 +HTTP/1.1 200 ``` |
v1.0 | Subscription Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/subscription-delete.md | Namespace: microsoft.graph Delete a subscription. -See the table in the [Permissions](#permissions) section for the list of resources that support subscribing to change notifications. +For the list of resources that support subscribing to change notifications, see the table in the [Permissions](#permissions) section. ## Permissions Depending on the resource and the permission type (delegated or application) req | Supported resource | Delegated (work or school account) | Delegated (personal Microsoft account) | Application | |:--|:--|:--|:--|-|[callRecord](../resources/callrecords-callrecord.md) | Not supported | Not supported | CallRecords.Read.All | -|[channels](../resources/channel.md) (/teams/getAllChannels ΓÇô all channels in an organization) | Not supported | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All | -|[channels](../resources/channel.md) (/teams/{id}/channels) | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported | Channel.ReadBasic.All, ChannelSettings.Read.All | -|[chat](../resources/chat.md) (/chats ΓÇô all chats in an organization) | Not supported | Not supported | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | -|[chat](../resources/chat.md) (/chats/{id}) | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | -|[chatMessage](../resources/chatmessage.md) (/teams/{id}/channels/{id}/messages) | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported | ChannelMessage.Read.Group*, ChannelMessage.Read.All | -|[chatMessage](../resources/chatmessage.md) (/teams/getAllMessages -- all channel messages in organization) | Not supported | Not supported | ChannelMessage.Read.All | -|[chatMessage](../resources/chatmessage.md) (/chats/{id}/messages) | Chat.Read, Chat.ReadWrite | Not supported | Chat.Read.All | -|[chatMessage](../resources/chatmessage.md) (/chats/getAllMessages -- all chat messages in organization) | Not supported | Not supported | Chat.Read.All | -|[chatMessage](../resources/chatmessage.md) (/users/{id}/chats/getAllMessages -- chat messages for all chats a particular user is part of) | Chat.Read, Chat.ReadWrite | Not supported | Chat.Read.All, Chat.ReadWrite.All | +|[callRecord](../resources/callrecords-callrecord.md) | Not supported. | Not supported. | CallRecords.Read.All | +|[channels](../resources/channel.md) (/teams/getAllChannels ΓÇô all channels in an organization) | Not supported. | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | +|[channels](../resources/channel.md) (/teams/{id}/channels) | Channel.ReadBasic.All, ChannelSettings.Read.All | Not supported. | Channel.ReadBasic.All, ChannelSettings.Read.All | +|[chat](../resources/chat.md) (/chats ΓÇô all chats in an organization) | Not supported. | Not supported. | Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chat](../resources/chat.md) (/chats/{id}) | Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatSettings.Read.Chat*, ChatSettings.ReadWrite.Chat*, Chat.Manage.Chat*, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[chatMessage](../resources/chatmessage.md) (/teams/{id}/channels/{id}/messages) | ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All | Not supported. | ChannelMessage.Read.Group*, ChannelMessage.Read.All | +|[chatMessage](../resources/chatmessage.md) (/teams/getAllMessages -- all channel messages in organization) | Not supported. | Not supported. | ChannelMessage.Read.All | +|[chatMessage](../resources/chatmessage.md) (/chats/{id}/messages) | Chat.Read, Chat.ReadWrite | Not supported. | Chat.Read.All | +|[chatMessage](../resources/chatmessage.md) (/chats/getAllMessages -- all chat messages in organization) | Not supported. | Not supported. | Chat.Read.All | +|[chatMessage](../resources/chatmessage.md) (/users/{id}/chats/getAllMessages -- chat messages for all chats a particular user is part of) | Chat.Read, Chat.ReadWrite | Not supported. | Chat.Read.All, Chat.ReadWrite.All | |[contact](../resources/contact.md) | Contacts.Read | Contacts.Read | Contacts.Read |-|[conversationMember](../resources/conversationmember.md) (/chats/getAllMembers) | Not supported | Not supported | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | -|[conversationMember](../resources/conversationmember.md) (/chats/{id}/members) | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | -|[conversationMember](../resources/conversationmember.md) (/teams/getAllMembers) | Not supported | Not supported | TeamMember.Read.All, TeamMember.ReadWrite.All | -|[conversationMember](../resources/conversationmember.md) (/teams/{id}/members) | TeamMember.Read.All | Not supported | TeamMember.Read.All | -|[conversationMember](../resources/conversationmember.md) (/teams/{id}/channels/getAllMembers) | Not supported | Not supported | ChannelMember.Read.All | -|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported | Files.ReadWrite | Not supported | -|[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.ReadWrite.All | Not supported | Files.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) (/chats/getAllMembers) | Not supported. | Not supported. | ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) (/chats/{id}/members) | ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite | Not supported. | ChatMember.Read.Chat*, Chat.Manage.Chat*, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) (/teams/getAllMembers) | Not supported. | Not supported. | TeamMember.Read.All, TeamMember.ReadWrite.All | +|[conversationMember](../resources/conversationmember.md) (/teams/{id}/members) | TeamMember.Read.All | Not supported. | TeamMember.Read.All | +|[conversationMember](../resources/conversationmember.md) (/teams/{id}/channels/getAllMembers) | Not supported. | Not supported. | ChannelMember.Read.All | +|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported. | Files.ReadWrite | Not supported. | +|[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.ReadWrite.All | Not supported. | Files.ReadWrite.All | |[event](../resources/event.md) | Calendars.Read | Calendars.Read | Calendars.Read |-|[group](../resources/group.md) | Group.Read.All | Not supported | Group.Read.All | -|[group conversation](../resources/conversation.md) | Group.Read.All | Not supported | Not supported | -|[list](../resources/list.md) | Sites.ReadWrite.All | Not supported | Sites.ReadWrite.All | +|[group](../resources/group.md) | Group.Read.All | Not supported. | Group.Read.All | +|[group conversation](../resources/conversation.md) | Group.Read.All | Not supported. | Not supported. | +|[list](../resources/list.md) | Sites.ReadWrite.All | Not supported. | Sites.ReadWrite.All | |[message](../resources/message.md) | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read |-|[presence](../resources/presence.md) | Presence.Read.All | Not supported | Not supported | -|[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | -|[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | -|[security alert](../resources/alert.md) | SecurityEvents.ReadWrite.All | Not supported | SecurityEvents.ReadWrite.All | -|[teams](../resources/team.md) (/teams ΓÇô all teams in an organization) | Not supported | Not supported | Team.ReadBasic.All, TeamSettings.Read.All | -|[teams](../resources/team.md) (/teams/{id}) | Team.ReadBasic.All, TeamSettings.Read.All | Not supported | Team.ReadBasic.All, TeamSettings.Read.All | -|[todoTask](../resources/todotask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported | -|[baseTask](../resources/basetask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported | +|[online meeting](../resources/onlinemeeting.md) | Not supported | Not supported | OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All | +|[presence](../resources/presence.md) | Presence.Read.All | Not supported. | Not supported. | +|[printer](../resources/printer.md) | Not supported. | Not supported. | Printer.Read.All, Printer.ReadWrite.All | +|[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported. | Not supported. | PrintTaskDefinition.ReadWrite.All | +|[security alert](../resources/alert.md) | SecurityEvents.ReadWrite.All | Not supported. | SecurityEvents.ReadWrite.All | +|[teams](../resources/team.md) (/teams ΓÇô all teams in an organization) | Not supported. | Not supported. | Team.ReadBasic.All, TeamSettings.Read.All | +|[teams](../resources/team.md) (/teams/{id}) | Team.ReadBasic.All, TeamSettings.Read.All | Not supported. | Team.ReadBasic.All, TeamSettings.Read.All | +|[todoTask](../resources/todotask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported. | +|[baseTask](../resources/basetask.md) | Tasks.ReadWrite | Tasks.ReadWrite | Not supported. | |[user](../resources/user.md) | User.Read.All | User.Read.All | User.Read.All | > **Note**: Permissions marked with * use [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). On a personal OneDrive, you can subscribe to the root folder or any subfolder in ### contact, event, and message -Additional limitations apply for subscriptions on Outlook items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions. +You can subscribe to changes in Outlook **contact**, **event**, or **message** resources and optionally specify in the POST request payload whether to include encrypted resource data in notifications. -- Delegated permission supports subscribing to items in folders in only the signed-in user's mailbox. For example, you cannot use the delegated permission Calendars.Read to subscribe to events in another userΓÇÖs mailbox.-- To subscribe to change notifications of Outlook contacts, events, or messages in _shared or delegated_ folders: - - Use the corresponding application permission to subscribe to changes of items in a folder or mailbox of _any_ user in the tenant. - - Do not use the Outlook sharing permissions (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared, and their read/write counterparts), as they do **not** support subscribing to change notifications on items in shared or delegated folders. +### onlineMeetings, presence -### presence --**presence** subscriptions require [encryption](/graph/webhooks-with-resource-data). Subscription creation will fail if [encryptionCertificate](../resources/subscription.md) is not specified. +**onlineMeetings** and **presence** subscriptions require [encryption](/graph/webhooks-with-resource-data) for notifications with resource data. Subscription creation will fail if [encryptionCertificate](../resources/subscription.md) and [encryptionCertificateId](../resources/subscription.md) are not specified if resource data is desired in notifications. ## HTTP request For details about how errors are returned, see [Error responses][error-response] ## Example -##### Request +### Request -Here is an example of the request. +The following is an example of a request. # [HTTP](#tab/http) <!-- { DELETE https://graph.microsoft.com/beta/subscriptions/7f105c7d-2dc5-4530-97cd-4e -##### Response +### Response -Here is an example of the response. +The following is an example of the response. <!-- { "blockType": "response" } --> |
v1.0 | Subscription Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/subscription-get.md | Depending on the resource and the permission type (delegated or application) req |[group conversation](../resources/conversation.md) | Group.Read.All | Not supported | Not supported | |[list](../resources/list.md) | Sites.ReadWrite.All | Not supported | Sites.ReadWrite.All | |[message](../resources/message.md) | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read |+|[online meeting](../resources/onlinemeeting.md) | Not supported | Not supported | OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All | |[presence](../resources/presence.md) | Presence.Read.All | Not supported | Not supported | |[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | On a personal OneDrive, you can subscribe to the root folder or any subfolder in ### contact, event, and message -Additional limitations apply for subscriptions on Outlook items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions. +You can subscribe to changes in Outlook **contact**, **event**, or **message** resources and optionally specify in the POST request payload whether to include encrypted resource data in notifications. -- Delegated permission supports subscribing to items in folders in only the signed-in user's mailbox. For example, you cannot use the delegated permission Calendars.Read to subscribe to events in another userΓÇÖs mailbox.-- To subscribe to change notifications of Outlook contacts, events, or messages in _shared or delegated_ folders: - - Use the corresponding application permission to subscribe to changes of items in a folder or mailbox of _any_ user in the tenant. - - Do not use the Outlook sharing permissions (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared, and their read/write counterparts), as they do **not** support subscribing to change notifications on items in shared or delegated folders. +### onlineMeetings, presence -### presence --**presence** subscriptions require [encryption](/graph/webhooks-with-resource-data). Subscription creation will fail if [encryptionCertificate](../resources/subscription.md) is not specified. +**onlineMeetings** and **presence** subscriptions require [encryption](/graph/webhooks-with-resource-data) for notifications with resource data. Subscription creation will fail if [encryptionCertificate](../resources/subscription.md) and [encryptionCertificateId](../resources/subscription.md) are not specified if resource data is desired in notifications. ## HTTP request |
v1.0 | Subscription List | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/subscription-list.md | This API supports the following permission scopes; to learn more, including how |[group conversation](../resources/conversation.md) | Group.Read.All, Subscription.Read.All | Not supported | Not supported | |[list](../resources/list.md) | Sites.ReadWrite.All, Subscription.Read.All | Not supported | Sites.ReadWrite.All | |[message](../resources/message.md) | Mail.ReadBasic, Mail.Read, Subscription.Read.All | Mail.ReadBasic, Mail.Read, Subscription.Read.All | Mail.ReadBasic, Mail.Read |+|[online meeting](../resources/onlinemeeting.md) | Not supported | Not supported | OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All | |[presence](../resources/presence.md) | Presence.Read.All, Subscription.Read.All | Not supported | Not supported | |[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | |
v1.0 | Subscription Post Subscriptions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/subscription-post-subscriptions.md | Subscribes a listener application to receive change notifications when the reque See the table in the [Permissions](#permissions) section for the list of resources that support subscribing to change notifications. +Some resources support the option to include encrypted resource data in change notifications. These resources include [chatMessage](../resources/chatmessage.md), [contact](../resources/contact.md), [event](../resources/event.md), [message](../resources/message.md), [onlineMeetings](../resources/onlinemeeting.md) and [presence](../resources/presence.md). For more information, see [Set up change notifications that include resource data](/graph/webhooks-with-resource-data) and [Change notifications for Outlook resources in Microsoft Graph](/graph/outlook-change-notification-overview). + ## Permissions Creating a subscription requires read permission to the resource. For example, to get change notifications on messages, your app needs the Mail.Read permission. Depending on the resource and the permission type (delegated or application) req |[group conversation](../resources/conversation.md) | Group.Read.All | Not supported | Not supported | |[list](../resources/list.md) | Sites.ReadWrite.All | Not supported | Sites.ReadWrite.All | |[message](../resources/message.md) | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read |+|[online meeting](../resources/onlinemeeting.md) | Not supported | Not supported | OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All | |[presence](../resources/presence.md) | Presence.Read.All | Not supported | Not supported | |[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | OneDrive for Business and SharePoint support sending your application notificati ### contact, event, and message -Additional limitations apply for subscriptions on Outlook items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions. --- Delegated permission supports subscribing to items in folders in only the signed-in user's mailbox. For example, you cannot use the delegated permission Calendars.Read to subscribe to events in another user’s mailbox.-- To subscribe to change notifications of Outlook contacts, events, or messages in _shared or delegated_ folders:+You can subscribe to changes in Outlook **contact**, **event**, or **message** resources and optionally specify in the POST request payload whether to include encrypted resource data in notifications. - - Use the corresponding application permission to subscribe to changes of items in a folder or mailbox of _any_ user in the tenant. - - Do not use the Outlook sharing permissions (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared, and their read/write counterparts), as they do **not** support subscribing to change notifications on items in shared or delegated folders. -### presence +### onlineMeetings, presence -Subscriptions on **presence** require any resource data included in a change notification to be encrypted. Always specify the **encryptionCertificate** parameter when [creating a subscription](/graph/webhooks-with-resource-data#creating-a-subscription) to avoid failure. See more information about [setting up change notifications to include resource data](/graph/webhooks-with-resource-data). +Subscriptions on **onlineMeetings** and **presence** require the **encryptionCertificate** and **encryptionCertificateId** property when [creating a subscription](/graph/webhooks-with-resource-data#creating-a-subscription) for notifications with encrypted resource data. For more information, see [setting up change notifications to include resource data](/graph/webhooks-with-resource-data). ## HTTP request The following are valid values for the resource property. |[Groups](../resources/group.md)|`groups`| |[List](../resources/list.md)|`sites/{site-id}/lists/{list-id}`| |[Mail](../resources/message.md)|`me/mailfolders('inbox')/messages`, `me/messages`|+|[OnlineMeetings](../resources/onlinemeeting.md)|`/communications/onlineMeetings/?$filter=JoinWebUrl eq '{WebJoinUrl}'`| |[Presence](../resources/presence.md)| `/communications/presences/{id}` (single user), `/communications/presences?$filter=id in ('{id}','{id}',…)` (multiple users)| |[printer](../resources/printer.md) |`print/printers/{id}/jobs`| |[PrintTaskDefinition](../resources/printtaskdefinition.md)|`print/taskDefinitions/{id}/tasks`| |
v1.0 | Subscription Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/subscription-update.md | Depending on the resource and the permission type (delegated or application) req |[group conversation](../resources/conversation.md) | Group.Read.All | Not supported | Not supported | |[list](../resources/list.md) | Sites.ReadWrite.All | Not supported | Sites.ReadWrite.All | |[message](../resources/message.md) | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read |+|[online meeting](../resources/onlinemeeting.md) | Not supported | Not supported | OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All | |[presence](../resources/presence.md) | Presence.Read.All | Not supported | Not supported | |[printer](../resources/printer.md) | Not supported | Not supported | Printer.Read.All, Printer.ReadWrite.All | |[printTaskDefinition](../resources/printtaskdefinition.md) | Not supported | Not supported | PrintTaskDefinition.ReadWrite.All | On a personal OneDrive, you can subscribe to the root folder or any subfolder in ### contact, event, and message -Additional limitations apply for subscriptions on Outlook items. The limitations apply to creating as well as managing (getting, updating, and deleting) subscriptions. +You can subscribe to changes in Outlook **contact**, **event**, or **message** resources and optionally specify in the POST request payload whether to include encrypted resource data in notifications. -- Delegated permission supports subscribing to items in folders in only the signed-in user's mailbox. For example, you cannot use the delegated permission Calendars.Read to subscribe to events in another userΓÇÖs mailbox.-- To subscribe to change notifications of Outlook contacts, events, or messages in _shared or delegated_ folders: - - Use the corresponding application permission to subscribe to changes of items in a folder or mailbox of _any_ user in the tenant. - - Do not use the Outlook sharing permissions (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared, and their read/write counterparts), as they do **not** support subscribing to change notifications on items in shared or delegated folders. +### onlineMeetings, presence -### presence --**presence** subscriptions require [encryption](/graph/webhooks-with-resource-data). Subscription creation will fail if [encryptionCertificate](../resources/subscription.md) is not specified. +**onlineMeetings** and **presence** subscriptions require [encryption](/graph/webhooks-with-resource-data) for notifications with resource data. Subscription creation will fail if [encryptionCertificate](../resources/subscription.md) and [encryptionCertificateId](../resources/subscription.md) are not specified if resource data is desired in notifications. ## HTTP request |
v1.0 | Tasklist Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tasklist-update.md | Content-Type: application/json Content-length: 82 {+ "@odata.type": "#microsoft.graph.taskList", "displayName": "Travel Plan" } ``` |
v1.0 | Tasks Post Lists | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tasks-post-lists.md | POST https://graph.microsoft.com/beta/me/tasks/lists Content-Type: application/json {+ "@odata.type": "#microsoft.graph.taskList", "displayName": "Shopping list" } ``` |
v1.0 | Team Delete Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-delete-installedapps.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) | TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | +|Delegated (work or school account) | TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | |Delegated (personal Microsoft account) | Not supported. |-|Application | TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | +|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. |
v1.0 | Team Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-get.md | Content-type: application/json }, "discoverySettings": { "showInTeamsSearchAndSuggestions": true+ }, + "summary": { + "ownersCount": 2, + "membersCount": 3, + "guestsCount": 4, } } ``` |
v1.0 | Team List Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-list-installedapps.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) | TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteForTeam, Group.Read.All**, Group.ReadWrite.All**, Directory.Read.All**, Directory.ReadWrite.All** | +|Delegated (work or school account) | TeamsAppInstallation.ReadForTeam, TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, Group.Read.All**, Group.ReadWrite.All**, Directory.Read.All**, Directory.ReadWrite.All** | |Delegated (personal Microsoft account) | Not supported. |-|Application | TeamsAppInstallation.Read.Group*, TeamsAppInstallation.ReadForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, Group.Read.All**, Group.ReadWrite.All**, Directory.Read.All**, Directory.ReadWrite.All** | +|Application | TeamsAppInstallation.Read.Group*, TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, Group.Read.All**, Group.ReadWrite.All**, Directory.Read.All**, Directory.ReadWrite.All** | [!INCLUDE [teamwork-permissions-note](../../../includes/teamwork-permissions-note.md)] |
v1.0 | Team Post Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-post-installedapps.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) | TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | +|Delegated (work or school account) | TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | |Delegated (personal Microsoft account) | Not supported. |-|Application | TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | +|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. |
v1.0 | Team Post Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-post-members.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Add a new [conversationMember](../resources/conversationmember.md) to a [team](../resources/team.md). +Add a new [conversation member](../resources/conversationmember.md) to a [team](../resources/team.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 |Delegated (personal Microsoft account) | Not supported. | |Application| TeamMember.ReadWrite.All | +> [!NOTE] +> Using application permissions to [add guest members](/microsoft-365/admin/add-users/about-guest-users?view=o365-worldwide&preserve-view=true) to a team is not supported. + ## HTTP request <!-- { |
v1.0 | Team Teamsappinstallation Upgrade | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-teamsappinstallation-upgrade.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) | TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | +|Delegated (work or school account) | TeamsAppInstallation.ReadWriteSelfForTeam, TeamsAppInstallation.ReadWriteForTeam, Group.ReadWrite.All**, Directory.ReadWrite.All** | |Delegated (personal Microsoft account) | Not supported. |-|Application | TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | +|Application | TeamsAppInstallation.ReadWriteSelfForTeam.All, TeamsAppInstallation.ReadWriteForTeam.All, Group.ReadWrite.All**, Directory.ReadWrite.All** | > **Note**: Permissions marked with ** are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. |
v1.0 | Team Update Members | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/team-update-members.md | Namespace: microsoft.graph Update the role of a [conversationMember](../resources/conversationmember.md) in a [team](../resources/team.md). +> [!NOTE] +> Team members with the role of `guest` cannot be given the role of `owner`. + ## 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 | Temporaryaccesspassauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/temporaryaccesspassauthenticationmethodconfiguration-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 | Temporaryaccesspassauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/temporaryaccesspassauthenticationmethodconfiguration-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 | Tenantappmanagementpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/tenantappmanagementpolicy-update.md | Update the properties of a [tenantAppManagementPolicy](../resources/tenantAppMan 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) | Policy.ReadWrite.ApplicationConfiguration | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Policy.ReadWrite.ApplicationConfiguration | +| Permission type | Permissions (from least to most privileged) | +| :- | : | +| Delegated (work or school account) | Policy.ReadWrite.ApplicationConfiguration | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Policy.ReadWrite.ApplicationConfiguration | ## HTTP request PATCH /policies/defaultAppManagementPolicy In the request body, supply the values for relevant fields from the [tenantAppManagementPolicy](../resources/tenantAppManagementPolicy.md) that should be updated. Existing properties that are not included in the request body will maintain their previous values. For best performance, do not include unchanged values in the request payload. -| Property | Type | Description | -|:|:-|:-| -| displayName | String | The display name of the default policy. Inherited from [policyBase](../resources/policybase.md). | -| description | String | The description of the default policy. Inherited from [policyBase](../resources/policybase.md). | -| isEnabled | Boolean | Denotes if the policy is enabled. Default value is false. | -| applicationRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all application objects in the tenant. | -| servicePrincipalRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all service principal objects in the tenant. | +| Property | Type | Description | +| : | :-- | :-- | +| applicationRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all application objects in the tenant. | +| displayName | String | The display name of the default policy. Inherited from [policyBase](../resources/policybase.md). | +| description | String | The description of the default policy. Inherited from [policyBase](../resources/policybase.md). | +| isEnabled | Boolean | Denotes if the policy is enabled. Default value is false. | +| servicePrincipalRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all service principal objects in the tenant. | ## Response If successful, this method returns a `204 No Content` response code. It does not The following is an example of the request. -- # [HTTP](#tab/http)+ <!-- { "blockType": "request", "name": "update_tenantAppManagementPolicy" Content-Type: application/json { "restrictionType": "passwordAddition", "maxLifetime": null,- "restrictForAppsCreatedAfterDateTime": "2021-04-01T10:37:00Z" + "restrictForAppsCreatedAfterDateTime": "2021-01-01T10:37:00Z" }, { "restrictionType": "passwordLifetime", "maxLifetime": "P4DT12H30M5S",- "restrictForAppsCreatedAfterDateTime": "2019-01-01T10:37:00Z" + "restrictForAppsCreatedAfterDateTime": "2017-01-01T10:37:00Z" }, { "restrictionType": "symmetricKeyAddition", "maxLifetime": null,- "restrictForAppsCreatedAfterDateTime": "2021-04-01T10:37:00Z" + "restrictForAppsCreatedAfterDateTime": "2021-01-01T10:37:00Z" + }, + { + "restrictionType": "customPasswordAddition", + "maxLifetime": null, + "restrictForAppsCreatedAfterDateTime": "2015-01-01T10:37:00Z" }, { "restrictionType": "symmetricKeyLifetime", "maxLifetime": "P40D",- "restrictForAppsCreatedAfterDateTime": "2015-04-01T10:37:00Z" + "restrictForAppsCreatedAfterDateTime": "2015-01-01T10:37:00Z" } ], "keyCredentials":[ Content-Type: application/json } } ```+ # [C#](#tab/csharp) [!INCLUDE [sample-code](../includes/snippets/csharp/update-tenantappmanagementpolicy-csharp-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/update-tenantappmanagementpolicy-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Objective-C](#tab/objc) [!INCLUDE [sample-code](../includes/snippets/objc/update-tenantappmanagementpolicy-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/update-tenantappmanagementpolicy-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sample-code](../includes/snippets/powershell/update-tenantappmanagementpolicy-powershell-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] - ### Response The following is an example of the response. |
v1.0 | Termsofusecontainer List Agreements | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/termsofusecontainer-list-agreements.md | When calling on behalf of a user, the user needs to belong to one of the followi ```http GET /identityGovernance/termsOfUse/agreements ```-<!-- ++ ## Optional query parameters-This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. >+This method supports the `$select`, `$filter`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers | Name | Type | Description | GET https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements [!INCLUDE [sample-code](../includes/snippets/go/get-agreements-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + HTTP/1.1 200 OK Content-type: application/json {- "value": [ - { - "displayName": "displayName-value", - "isViewingBeforeAcceptanceRequired": true, - "id": "id-value" - } - ] + "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements", + "value": [ + { + "id": "0ec9f6a6-159d-4dd8-a563-1f0b5935e80b", + "displayName": "All users terms of use", + "termsExpiration": null, + "userReacceptRequiredFrequency": "P90D", + "isViewingBeforeAcceptanceRequired": false, + "isPerDeviceAcceptanceRequired": false + }, + { + "id": "920f5775-d5d7-454b-861f-14685bb24e2c", + "displayName": "ToU", + "termsExpiration": null, + "userReacceptRequiredFrequency": "P90D", + "isViewingBeforeAcceptanceRequired": false, + "isPerDeviceAcceptanceRequired": false + }, + { + "id": "94410bbf-3d3e-4683-8149-f034e55c39dd", + "displayName": "Contoso ToU for guest users", + "termsExpiration": null, + "userReacceptRequiredFrequency": null, + "isViewingBeforeAcceptanceRequired": true, + "isPerDeviceAcceptanceRequired": false + } + ] } ``` |
v1.0 | Termsofusecontainer Post Agreements | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/termsofusecontainer-post-agreements.md | POST https://graph.microsoft.com/beta/identityGovernance/termsOfUse/agreements Content-type: application/json {- "displayName": "MSGraph Sample", + "displayName": "Contoso ToU for guest users", "isViewingBeforeAcceptanceRequired": true, "files": [ { Content-type: application/json "language": "en", "isDefault": true, "fileData": {- "data": "SGVsbG8gd29ybGQ=" + "data": "SGVsbG8gd29ybGQ=//truncated-binary" } } ] Content-type: application/json [!INCLUDE [sample-code](../includes/snippets/go/create-agreement-from-agreements-go-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + HTTP/1.1 201 Created Content-type: application/json {- "displayName": "MSGraph Sample", - "isViewingBeforeAcceptanceRequired": true, - "id": "id-value" + "@odata.context": "https://graph.microsoft.com/beta/$metadata#agreements/$entity", + "id": "94410bbf-3d3e-4683-8149-f034e55c39dd", + "displayName": "Contoso ToU for guest users", + "termsExpiration": null, + "userReacceptRequiredFrequency": null, + "isViewingBeforeAcceptanceRequired": true, + "isPerDeviceAcceptanceRequired": false } ``` |
v1.0 | Termstore Group Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/termstore-group-get.md | Content-Type: application/json # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "get_group" + "name": "get_group_termstore" } --> Content-Type: application/json GET https://graph.microsoft.com/beta/sites/microsoft.sharepoint.com,c6482504-4a85-4b21-858a-7e88dafc8232,d90ca07d-25c0-4ce7-864b-d68b607e697f/termStore/groups/1FFD3F87-9464-488A-A0EC-8FB90911182C?$select=*,parentSiteId ``` # [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)] # [Objective-C](#tab/objc) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)++# [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-Type: application/json # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "get_group" + "name": "get_group_termstore_sites" } --> Content-Type: application/json GET https://graph.microsoft.com/beta/sites/microsoft.sharepoint.com,c6482504-4a85-4b21-858a-7e88dafc8232,d90ca07d-25c0-4ce7-864b-d68b607e697f/termStore/groups/1FFD3F87-9464-488A-A0EC-8FB90911182C ``` # [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)] # [Objective-C](#tab/objc) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java)++# [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Termstore Set Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/termstore-set-get.md | GET https://graph.microsoft.com/beta/sites/microsoft.sharepoint.com,c6482504-4a8 [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Termstore Term Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/termstore-term-get.md | GET https://graph.microsoft.com/beta/termStore/groups/1FFD3F87-9464-488A-A0EC-8F [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + #### Response GET https://graph.microsoft.com/beta/sites/microsoft.sharepoint.com,c6482504-4a8 [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | Timeoff Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/timeoff-delete.md | Title: "Delete timeOff" description: "Delete a timeOff instance from a schedule."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Timeoff Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/timeoff-get.md | Title: "Get timeOff" description: "Get a timeOff by ID."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Timeoff Put | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/timeoff-put.md | Title: "Replace timeOff" description: "Replace an existing timeOff."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Timeoffreason Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/timeoffreason-get.md | Title: "Get timeOffReason" description: "Get a timeOffReason by ID."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Timeoffreason Put | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/timeoffreason-put.md | Title: "Replace timeOffReason" description: "Replace an existing timeOffReason."-+ ms.localizationpriority: medium ms.prod: "microsoft-teams" doc_type: apiPageType |
v1.0 | Unifiedrbacresourceaction Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedrbacresourceaction-get.md | + + Title: "Get unifiedRbacResourceAction" +description: "Read the properties and relationships of an unifiedRbacResourceAction object." ++ms.localizationpriority: medium +++# Get unifiedRbacResourceAction +Namespace: microsoft.graph +++Read the properties and relationships of an [unifiedRbacResourceAction](../resources/unifiedrbacresourceaction.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)|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /roleManagement/directory/resourceNamespaces/{unifiedRbacResourceNamespaceId}/resourceActions/{unifiedRbacResourceActionId} +``` ++## 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 [unifiedRbacResourceAction](../resources/unifiedrbacresourceaction.md) object in the response body. ++## Examples ++The following example gets the action with the identifier `microsoft.directory-accessReviews-allProperties-read-get` for the resource namespace with the identifier of `microsoft.directory`. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_unifiedrbacresourceaction" +} +--> +``` http +GET https://graph.microsoft.com/beta/roleManagement/directory/resourceNamespaces/microsoft.directory/resourceActions/microsoft.directory-accessReviews-allProperties-read-get +``` +# [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.unifiedRbacResourceAction" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/resourceNamespaces('microsoft.directory')/resourceActions/$entity", + "actionVerb": "GET", + "description": "Read all properties of access reviews", + "id": "microsoft.directory-accessReviews-allProperties-read-get", + "name": "microsoft.directory/accessReviews/allProperties/read", + "resourceScopeId": null +} +``` |
v1.0 | Unifiedrbacresourcenamespace Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedrbacresourcenamespace-get.md | + + Title: "Get unifiedRbacResourceNamespace" +description: "Read the properties and relationships of an unifiedRbacResourceNamespace object." ++ms.localizationpriority: medium +++# Get unifiedRbacResourceNamespace +Namespace: microsoft.graph +++Read the properties and relationships of an [unifiedRbacResourceNamespace](../resources/unifiedrbacresourcenamespace.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)|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /roleManagement/directory/resourceNamespaces/{unifiedRbacResourceNamespaceId} +``` ++## 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 [unifiedRbacResourceNamespace](../resources/unifiedrbacresourcenamespace.md) object in the response body. ++## Examples ++The following example gets the resource namespace with the identifier of `microsoft.aad.b2c`. ++### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_unifiedrbacresourcenamespace" +} +--> +``` http +GET https://graph.microsoft.com/beta/roleManagement/directory/resourceNamespaces/microsoft.aad.b2c +``` +# [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.unifiedRbacResourceNamespace" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/resourceNamespaces/$entity", + "id": "microsoft.aad.b2c", + "name": "microsoft.aad.b2c" +} +``` |
v1.0 | Unifiedrbacresourcenamespace List Resourceactions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedrbacresourcenamespace-list-resourceactions.md | + + Title: "List resourceActions" +description: "Get a list of the unifiedRbacResourceAction objects and their properties." ++ms.localizationpriority: medium +++# List resourceActions +Namespace: microsoft.graph +++Get a list of the [unifiedRbacResourceAction](../resources/unifiedrbacresourceaction.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)|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| +|Delegated (personal Microsoft account)|Not supported.| +|Application|RoleManagement.Read.Directory, RoleManagement.Read.All, RoleManagement.ReadWrite.Directory| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /roleManagement/directory/resourceNamespaces/{unifiedRbacResourceNamespaceId}/resourceActions +``` ++## Optional query parameters +This method supports the `$filter`, `$select`, `$top`, and `$skipToken` OData query parameters to help customize the response. This method supports `$filter` (`eq`) for **actionVerb**, **description**, **id**, and **name** properties. This method returns a default page size of 100 **resourceActions** and supports `$top` and `$skipToken` for paging. 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 [unifiedRbacResourceAction](../resources/unifiedrbacresourceaction.md) objects in the response body. ++## Examples ++### Example 1: Get microsoft.directory actions ++The following example gets the actions for the resource namespace with the identifier of `microsoft.directory`. ++This method returns a maximum of 100 actions. If there are more actions, you can use `@odata.nextLink` to get the next set of actions. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_unifiedrbacresourceaction_directory" +} +--> +``` http +GET https://graph.microsoft.com/beta/roleManagement/directory/resourceNamespaces/microsoft.directory/resourceActions +``` +# [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 has been shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.unifiedRbacResourceAction)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/resourceNamespaces('microsoft.directory')/resourceActions", + "@odata.nextLink": "https://graph.microsoft.com/beta/roleManagement/directory/resourceNamespaces/microsoft.directory/resourceActions?$skiptoken=bWljcm9z...", + "value": [ + { + "actionVerb": null, + "description": "Create and delete access reviews, and read and update all properties of access reviews in Azure AD", + "id": "microsoft.directory-accessReviews-allProperties-allTasks", + "name": "microsoft.directory/accessReviews/allProperties/allTasks", + "resourceScopeId": null + }, + { + "actionVerb": "GET", + "description": "Read all properties of access reviews", + "id": "microsoft.directory-accessReviews-allProperties-read-get", + "name": "microsoft.directory/accessReviews/allProperties/read", + "resourceScopeId": null + }, + { + "actionVerb": null, + "description": "Manage access reviews of application role assignments in Azure AD", + "id": "microsoft.directory-accessReviews-definitions.applications-allProperties-allTasks", + "name": "microsoft.directory/accessReviews/definitions.applications/allProperties/allTasks", + "resourceScopeId": null + } + ] +} +``` ++### Example 2: Get microsoft.insights actions ++The following example gets the actions for the resource namespace with the identifier of `microsoft.insights`. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_unifiedrbacresourceaction_insights" +} +--> +``` http +GET https://graph.microsoft.com/beta/roleManagement/directory/resourceNamespaces/microsoft.insights/resourceActions +``` +# [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": "Collection(microsoft.graph.unifiedRbacResourceAction)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#roleManagement/directory/resourceNamespaces('microsoft.insights')/resourceActions", + "value": [ + { + "actionVerb": null, + "description": "Manage all aspects of Insights app", + "id": "microsoft.insights-allEntities-allProperties-allTasks", + "name": "microsoft.insights/allEntities/allProperties/allTasks", + "resourceScopeId": null + }, + { + "actionVerb": null, + "description": "Read all aspects of Viva Insights", + "id": "microsoft.insights-allEntities-allProperties-read", + "name": "microsoft.insights/allEntities/allProperties/read", + "resourceScopeId": null + }, + { + "actionVerb": "PATCH", + "description": "Deploy and manage programs in Insights app", + "id": "microsoft.insights-programs-allProperties-update-patch", + "name": "microsoft.insights/programs/allProperties/update", + "resourceScopeId": null + }, + { + "actionVerb": null, + "description": "Run and manage queries in Viva Insights", + "id": "microsoft.insights-queries-allProperties-allTasks", + "name": "microsoft.insights/queries/allProperties/allTasks", + "resourceScopeId": null + }, + { + "actionVerb": "GET", + "description": "View reports and dashboard in Insights app", + "id": "microsoft.insights-reports-allProperties-read-get", + "name": "microsoft.insights/reports/allProperties/read", + "resourceScopeId": null + } + ] +} +``` |
v1.0 | Unifiedroledefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedroledefinition-delete.md | Depending on the RBAC provider and the permission type (delegated or application |Permission type | Permissions (from least to most privileged) | |:--|:|-|Delegated (work or school account) | CloudPC.ReadWrite.All | +|Delegated (work or school account) | RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | CloudPC.ReadWrite.All | +|Application | RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All | ### For a device management (Intune) provider |
v1.0 | Unifiedroledefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedroledefinition-get.md | Depending on the RBAC provider and the permission type (delegated or application |Permission type | Permissions (from least to most privileged) | |:--|:|-|Delegated (work or school account) | CloudPC.Read.All, CloudPC.ReadWrite.All, RoleManagement.Read.All | +|Delegated (work or school account) | RoleManagement.Read.CloudPC, CloudPC.Read.All, RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All, RoleManagement.Read.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | CloudPC.Read.All, CloudPC.ReadWrite.All, RoleManagement.Read.All | +|Application | RoleManagement.Read.CloudPC, CloudPC.Read.All, RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All, RoleManagement.Read.All | ### For a device management (Intune) provider |
v1.0 | Unifiedroledefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/unifiedroledefinition-update.md | Depending on the RBAC provider and the permission type (delegated or application |Permission type | Permissions (from least to most privileged) | |:--|:|-|Delegated (work or school account) | CloudPC.ReadWrite.All | +|Delegated (work or school account) | RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | CloudPC.ReadWrite.All | +|Application | RoleManagement.ReadWrite.CloudPC, CloudPC.ReadWrite.All | ### For a device management (Intune) provider |
v1.0 | User Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-assignlicense.md | In the request body, provide a JSON object with the following parameters. If successful, this method returns `200 OK` response code and an updated [user](../resources/user.md) object in the response body. -## Example -Add licenses to the user. -##### Request +## Examples ++### Example 1: Assign licenses to the signed-in user ++#### Request # [HTTP](#tab/http) <!-- { POST https://graph.microsoft.com/beta/me/assignLicense Content-type: application/json {- "addLicenses": [ - { - "disabledPlans": [ "11b0131d-43c8-4bbb-b2c8-e80f9a50834a" ], - "skuId": "skuId-value-1" - }, - { - "disabledPlans": [ "a571ebcc-fqe0-4ca2-8c8c-7a284fd6c235" ], - "skuId": "skuId-value-2" - } - ], - "removeLicenses": [] + "addLicenses": [ + { + "disabledPlans": [ + "8a256a2b-b617-496d-b51b-e76466e88db0" + ], + "skuId": "84a661c4-e949-4bd2-a560-ed7766fcaf2b" + }, + { + "disabledPlans": [], + "skuId": "f30db892-07e9-47e9-837c-80727f46fd3d" + } + ], + "removeLicenses": [] } ``` # [C#](#tab/csharp) Content-type: application/json -## Example -Remove licenses from the user. +#### Response +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.user" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "accountEnabled": true, + "assignedLicenses": [ + { + "disabledPlans": [ + "8a256a2b-b617-496d-b51b-e76466e88db0" + ], + "skuId": "84a661c4-e949-4bd2-a560-ed7766fcaf2b" + }, + { + "disabledPlans": [], + "skuId": "f30db892-07e9-47e9-837c-80727f46fd3d" + } + ], + "city": "Nairobi", + "companyName": "Contoso" +} +``` ++### Example 2: Remove licenses from the signed-in user -##### Request +#### Request +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "user_assignlicense_removelicenses" +}--> ```http POST https://graph.microsoft.com/beta/me/assignLicense Content-type: application/json {- "addLicenses": [], - "removeLicenses": ["skuId-value-1", "skuId-value-2"] + "addLicenses": [], + "removeLicenses": [ + "f30db892-07e9-47e9-837c-80727f46fd3d", + "84a661c4-e949-4bd2-a560-ed7766fcaf2b" + ] } ```+# [C#](#tab/csharp) ++# [JavaScript](#tab/javascript) ++# [Objective-C](#tab/objc) ++# [Java](#tab/java) ++# [Go](#tab/go) -##### Response -In both examples, the response is the updated user object. Note: The response object shown here might be shortened for readability. +# [PowerShell](#tab/powershell) +++++#### Response +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, Content-type: application/json { "accountEnabled": true,- "assignedLicenses": [ - { - "disabledPlans": [ "11b0131d-43c8-4bbb-b2c8-e80f9a50834a" ], - "skuId": "skuId-value" - } - ], - "assignedPlans": [ - { - "assignedDateTime": "2016-10-19T10:37:00Z", - "capabilityStatus": "capabilityStatus-value", - "service": "service-value", - "servicePlanId": "bea13e0c-3828-4daa-a392-28af7ff61a0f" - } - ], - "businessPhones": [ - "businessPhones-value" - ], - "city": "city-value", - "companyName": "companyName-value" + "assignedLicenses": [], + "city": "Nairobi", + "companyName": "Contoso" } ``` |
v1.0 | User Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-delete.md | If successful, this method returns `204 No Content` response code. It does not r ### Request -Here is an example of the request. +The following is an example of a request. # [HTTP](#tab/http) <!-- { DELETE https://graph.microsoft.com/beta/users/ba9a3254-9f18-4209-aeb3-9e42a35b5b ### Response -Here is an example of the response. +The following is an example of the response. <!-- { "blockType": "response", "truncated": true |
v1.0 | User Get Transitivereports | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-get-transitivereports.md | GET https://graph.microsoft.com/beta/users/45b7d2e7-b882-4a80-ba97-10b7a63b8fa4/ [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + |
v1.0 | User List Agreementacceptances | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-agreementacceptances.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a list of a user's [agreementAcceptance](../resources/agreementacceptance.md) objects. +Retrieve the signed-in user's [agreementAcceptance](../resources/agreementacceptance.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). One of the following permissions is required to call this API. To learn more, in <!-- { "blockType": "ignored" } --> ```http GET /me/agreementAcceptances++# where the id or userPrincipalName is the signed-in user's + GET /users/{id | userPrincipalName}/agreementAcceptances ``` <!-- HTTP/1.1 200 OK Content-type: application/json {- "value": [ - { - "agreementId": "agreementId-value", - "userId": "userId-value", - "agreementFileId": "agreementFileId-value", - "recordedDateTime": "datetime-value", - "userDisplayName": "userDisplayName-value", - "userPrincipalName": "userPrincipalName-value" - } - ] + "@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@M365x43961174.OnMicrosoft.com", + "userEmail": "MeganB@M365x43961174.OnMicrosoft.com", + "recordedDateTime": "2022-03-04T14:11:22.6658376Z", + "expirationDateTime": null, + "state": "accepted" + } + ] } ``` |
v1.0 | User List Licensedetails | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-licensedetails.md | Title: "List licenseDetails" description: "Retrieve a list of licenseDetails objects."-+ ms.localizationpriority: medium ms.prod: "users" doc_type: apiPageType |
v1.0 | User List Manager | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-manager.md | ConsistencyLevel: eventual [!INCLUDE [sample-code](../includes/snippets/powershell/get-transitive-managers-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 | User List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-list-transitivememberof.md | Title: "List user transitive memberOf" description: "Get groups, directory roles and administrative units that the user is a member of. This API request is transitive, and will also return all groups the user is a nested member of." ms.localizationpriority: medium-+ ms.prod: "users" doc_type: apiPageType |
v1.0 | User Revokesigninsessions | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-revokesigninsessions.md | This operation has no request content. ## Response -If successful, this method returns a `204 No Content` response code. +If successful, this method returns a `200 OK` response code. >[!NOTE]->This API has a [known issue](/graph/known-issues#revoke-sign-in-sessions-returns-wrong-HTTP-code). It returns a different HTTP response code. +>This API has a [known issue](/graph/known-issues#revoke-sign-in-sessions-returns-wrong-http-code). It returns a different HTTP response code. ## Example The following example shows how to call this API. -##### Request +### Request # [HTTP](#tab/http) <!-- {- "blockType": "request", + "blockType": "ignored", "name": "user_revokesigninsessionss" }--> ```http POST https://graph.microsoft.com/beta/me/revokeSignInSessions -##### Response +### Response <!-- { "blockType": "response", "truncated": true } --> ```http-HTTP/1.1 204 No Content +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Edm.Boolean", + "value": true +} ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/user-update.md | Because the **user** resource supports [extensions](/graph/extensibility-overvie add, update, or delete your own app-specific data in custom properties of an extension in an existing **user** instance. > [!NOTE] -> The follow properties cannot be updated by an app with only application permissions: **aboutMe**, **birthday**, **employeeHireDate**, **interests**, **mySite**, **pastProjects**, **preferredName**, **responsibilities**, **schools**, and **skills**. +> - The following properties cannot be updated by an app with only application permissions: **aboutMe**, **birthday**, **employeeHireDate**, **interests**, **mySite**, **pastProjects**, **preferredName**, **responsibilities**, **schools**, and **skills**. +> - To update the following properties, you must specify them in their own PATCH request, without including the other properties listed in the table above: **aboutMe**, **birthday**, **interests**, **mySite**, **pastProjects**, **preferredName**, **responsibilities**, **schools**, and **skills**. ## Response |
v1.0 | Virtualendpoint List Snapshots | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/virtualendpoint-list-snapshots.md | + + Title: "List snapshots" +description: "Get a list of cloudPcSnapshot objects and their properties." ++ms.localizationpriority: medium +++# List snapshots +Namespace: microsoft.graph +++Get a list of [cloudPcSnapshot](../resources/cloudpcsnapshot.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)|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 +``` ++## Optional query parameters +This method supports the `$filter` 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 collection of [cloudPcSnapshot](../resources/cloudpcsnapshot.md) objects in the response body. ++## Examples ++### Request ++The following is an example of a request. +++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_cloudpcsnapshot" +} +--> +``` http +GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/snapshots +``` +# [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", + "isCollection": true +} +--> +``` 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", + "lastRestoredDateTime": "2021-09-01T09:28:32.8260338Z", + "id": "A00009UV000_93aff428-61f2-467f-a879-1102af6fd4a8", + "status": "ready" + } + ] +} +``` + |
v1.0 | Virtualendpoint List Usersettings | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/virtualendpoint-list-usersettings.md | Content-Type: application/json "displayName": "Test1", "selfServiceEnabled": true, "localAdminEnabled": false,+ "restorePointSetting": { + "frequencyInHours": 16, + "userRestoreEnabled": true + }, "lastModifiedDateTime": "2021-02-01T10:29:57Z", "createdDateTime": "2021-02-01T10:29:57Z" } |
v1.0 | Virtualendpoint Post Usersettings | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/virtualendpoint-post-usersettings.md | The following table shows the properties that are required when you create the [ |displayName|String|The setting name as it appears in the UI. | |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'.ΓÇ»| ## Response Content-Type: application/json "@odata.type": "#microsoft.graph.cloudPcUserSetting", "displayName": "Example", "selfServiceEnabled": false,- "localAdminEnabled": true + "localAdminEnabled": true, + "restorePointSetting": { + "frequencyInHours": 16, + "userRestoreEnabled": true + } } ``` # [C#](#tab/csharp) Content-Type: application/json "displayName": "Example", "selfServiceEnabled": false, "localAdminEnabled": true,+ "restorePointSetting": { + "frequencyInHours": 16, + "userRestoreEnabled": true + }, "lastModifiedDateTime": "2021-02-01T10:29:57Z"ΓÇ» } ``` |
v1.0 | Windowshelloforbusinessauthenticationmethod Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/windowshelloforbusinessauthenticationmethod-get.md | GET /me/authentication/windowsHelloForBusinessMethods/{windowsHelloForBusinessAu GET /users/{id | userPrincipalName}/authentication/windowsHelloForBusinessMethods/{windowsHelloForBusinessAuthenticationMethodId} ``` +>**Note:** To read the **device** navigation property for another user, specify it in an `$expand` query as follows: `/users/{id}/authentication/windowsHelloForBusinessMethods/{id}?$expand=device`. + ## Optional query parameters Not supported. |
v1.0 | Windowsupdates Deploymentaudience Updateaudience | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/windowsupdates-deploymentaudience-updateaudience.md | Content-Type: application/json { "addMembers": [ {- "@odata.type": "#microsoft.graph.windowsUpdates.updatableAsset", + "@odata.type": "#microsoft.graph.windowsUpdates.azureADDevice", "id": "String (identifier)" } ], "removeMembers": [ {- "@odata.type": "#microsoft.graph.windowsUpdates.updatableAsset", + "@odata.type": "#microsoft.graph.windowsUpdates.azureADDevice", "id": "String (identifier)" } ], "addExclusions": [ {- "@odata.type": "#microsoft.graph.windowsUpdates.updatableAsset", + "@odata.type": "#microsoft.graph.windowsUpdates.azureADDevice", "id": "String (identifier)" } ], "removeExclusions": [ {- "@odata.type": "#microsoft.graph.windowsUpdates.updatableAsset", + "@odata.type": "#microsoft.graph.windowsUpdates.azureADDevice", "id": "String (identifier)" } ] |
v1.0 | X509certificateauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-delete.md | Title: "Delete x509CertificateAuthenticationMethodConfiguration" -description: "Delete a x509CertificateAuthenticationMethodConfiguration object and restores all the other properties to their default settings" +description: "Delete the tenant-customized x509CertificateAuthenticationMethodConfiguration object and restore the default configuration." ms.localizationpriority: medium ms.prod: "identity-and-sign-in" Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Restore the [x509CertificateAuthenticationMethodConfiguration](../resources/x509certificateauthenticationmethodconfiguration.md) object to its default configuration. +Delete the tenant-customized [x509CertificateAuthenticationMethodConfiguration](../resources/x509certificateauthenticationmethodconfiguration.md) object and restore the default configuration. ## 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 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 | X509certificateauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-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) + ### Response++The following response object shows an x509CertificateAuthenticationMethodConfiguration with its default configuration. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", HTTP/1.1 200 OK Content-Type: application/json {- "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration", - "id": "X509Certificate", - "state": "disabled", - "certificateUserBindings": [{ - "x509CertificateField": "PrincipalName", - "userProperty": "onPremisesUserPrincipalName", - "priority": 1 - }, - { - "x509CertificateField": "RFC822Name", - "userProperty": "userPrincipalName", - "priority": 2 - } - ], - "authenticationModeConfiguration": { - "x509CertificateAuthenticationDefaultMode": "x509CertificateSingleFactor", - "rules": [] - }, - "includeTargets": [{ - "targetType": "group", - "id": "all_users", - "isRegistrationRequired": false - }] + "@odata.context": "https://graph.microsoft.com/beta/$metadata#authenticationMethodConfigurations/$entity", + "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration", + "id": "X509Certificate", + "state": "disabled", + "certificateUserBindings": [ + { + "x509CertificateField": "PrincipalName", + "userProperty": "onPremisesUserPrincipalName", + "priority": 1 + }, + { + "x509CertificateField": "RFC822Name", + "userProperty": "userPrincipalName", + "priority": 2 + } + ], + "authenticationModeConfiguration": { + "x509CertificateAuthenticationDefaultMode": "x509CertificateSingleFactor", + "rules": [] + }, + "includeTargets@odata.context": "https://graph.microsoft.com/beta/$metadata#policies/authenticationMethodsPolicy/authenticationMethodConfigurations('X509Certificate')/microsoft.graph.x509CertificateAuthenticationMethodConfiguration/includeTargets", + "includeTargets": [ + { + "targetType": "group", + "id": "all_users", + "isRegistrationRequired": false + } + ] } ``` |
v1.0 | X509certificateauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/api/x509certificateauthenticationmethodconfiguration-update.md | If successful, this method returns a `204 No Content` response code and an updat ### Request +The following is an example of an update request with the following settings: +++ Enables the x509 certificate authentication method in the tenant.++ Configures only one user binding between the certificate **PrincipalName** and the Azure AD **onPremisesUserPrincipalName** properties.++ Defines multi-factor authentication as requirement.++ Configures the binding rules for the strong authentication method against the rule type.+ # [HTTP](#tab/http) <!-- { "blockType": "request", PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/auth Content-Type: application/json {- "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration", - "id": "X509Certificate", - "state": "disabled", - "certificateUserBindings": [{ - "x509CertificateField": "PrincipalName", - "userProperty": "onPremisesUserPrincipalName", - "priority": 1 - }, - { - "x509CertificateField": "RFC822Name", - "userProperty": "userPrincipalName", - "priority": 2 - } - ], - "authenticationModeConfiguration": { - "x509CertificateAuthenticationDefaultMode": "x509CertificateSingleFactor", - "rules": [] - }, - "includeTargets": [{ - "targetType": "group", - "id": "all_users", - "isRegistrationRequired": false - }] + "@odata.type": "#microsoft.graph.x509CertificateAuthenticationMethodConfiguration", + "id": "X509Certificate", + "state": "enabled", + "certificateUserBindings": [ + { + "x509CertificateField": "PrincipalName", + "userProperty": "onPremisesUserPrincipalName", + "priority": 1 + } + ], + "authenticationModeConfiguration": { + "x509CertificateAuthenticationDefaultMode": "x509CertificateMultiFactor", + "rules": [ + { + "x509CertificateRuleType": "issuerSubject", + "identifier": "CN=ContosoCA,DC=Contoso,DC=org ", + "x509CertificateAuthenticationMode": "x509CertificateMultiFactor" + }, + { + "x509CertificateRuleType": "policyOID", + "identifier": "1.2.3.4", + "x509CertificateAuthenticationMode": "x509CertificateMultiFactor" + } + ] + }, + "includeTargets": [ + { + "targetType": "group", + "id": "all_users", + "isRegistrationRequired": false + } + ] } ``` # [JavaScript](#tab/javascript) Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + ### Response <!-- {- "blockType": "response", - "truncated": true + "blockType": "response" } --> ``` http HTTP/1.1 204 No Content-Content-Type: application/json ``` |
v1.0 | Accesspackageassignmentpolicy | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentpolicy.md | To assign a user to an access package, [create an accessPackageAssignmentRequest | Relationship | Type | Description | |:-|:|:| |accessPackage|[accessPackage](accesspackage.md)| The access package with this policy. Read-only. Nullable. Supports `$expand`.|+|customExtensionHandlers|[customExtensionHandler](../resources/customextensionhandler.md) collection| The collection of stages when to execute one or more custom access package workflow extensions. Supports `$expand`.| ++ ## JSON representation The following is a JSON representation of the resource. ```json {- "id": "string", - "accessPackageId": "string", - "displayName": "string", - "description": "string", - "isDenyPolicy": false, - "canExtend": false, - "durationInDays": 365, - "requestorSettings": { - "scopeType": "string", - "acceptRequests": true, - "allowedRequestors": [{ - "@odata.type": "#microsoft.graph.userSet" - }] - }, - "requestApprovalSettings": { - "isApprovalRequired": false, - "isApprovalRequiredForExtension": false, - "isRequestorJustificationRequired": false, - "approvalMode": "string", - "approvalStages": [{ - "approvalStageTimeOutInDays": 14, - "isApproverJustificationRequired": true, - "isEscalationEnabled": true, - "escalationTimeInMinutes": 11520, - "primaryApprovers": [{ - "@odata.type": "#microsoft.graph.userSet" - }], - "escalationApprovers": [{ - "@odata.type": "#microsoft.graph.userSet" - }] - }] - }, - "accessReviewSettings": null, - "questions": [{ - "@odata.type": "#microsoft.graph.question" - }] + "@odata.type": "#microsoft.graph.accessPackageAssignmentPolicy", + "id": "String (identifier)", + "accessPackageId": "String", + "displayName": "String", + "description": "String", + "canExtend": "Boolean", + "durationInDays": "Integer", + "expirationDateTime": "String (timestamp)", + "createdBy": "String", + "createdDateTime": "String (timestamp)", + "modifiedBy": "String", + "modifiedDateTime": "String (timestamp)", + "questions": [ + { + "@odata.type": "microsoft.graph.accessPackageMultipleChoiceQuestion" + } + ], + "requestorSettings": { + "@odata.type": "microsoft.graph.requestorSettings" + }, + "requestApprovalSettings": { + "@odata.type": "microsoft.graph.approvalSettings" + }, + "accessReviewSettings": { + "@odata.type": "microsoft.graph.assignmentReviewSettings" + } } ``` |
v1.0 | Accesspackageassignmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageassignmentrequest.md | In [Azure AD Entitlement Management](entitlementmanagement-overview.md), an acce |:-|:|:| |completedDate|DateTimeOffset|The date of the end of processing, either successful or failure, of a request. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| |createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.|+|customExtensionHandlerInstances|[customExtensionHandlerInstance](../resources/customextensionhandlerinstance.md) collection| A collection of [custom workflow extension](customaccesspackageworkflowextension.md) instances being run on an assignment request. Read-only. | |id|String| Read-only.| |isValidationOnly|Boolean|True if the request is not to be processed for assignment.| |justification|String|The requestor's supplied justification.| In [Azure AD Entitlement Management](entitlementmanagement-overview.md), an acce ## JSON representation + The following is a JSON representation of the resource. <!-- { The following is a JSON representation of the resource. ```json {- "createdDateTime": "string", - "completedDate": "string", - "id": "string", - "requestType": "string", - "requestState": "string", - "requestStatus": "string", - "isValidationOnly": false, - "justification": "string", - "answers": [{ - "@odata.type": "#microsoft.graph.accessPackageAnswerString", - "value": "string", - "answeredQuestion": { - "id": "string", - "text": { - "defaultText": "string", - "localizedTexts": [{ - "text": "string", - "languageCode": "string" - }] - }, - "isRequired": true, - "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", - "isSingleLineQuestion": true - } - }] + "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest", + "id": "String (identifier)", + "requestType": "String", + "requestState": "String", + "requestStatus": "String", + "isValidationOnly": "Boolean", + "createdDateTime": "String (timestamp)", + "completedDate": "String (timestamp)", + "expirationDateTime": "String (timestamp)", + "justification": "String", + "schedule": { + "@odata.type": "microsoft.graph.requestSchedule" + }, + "answers": [ + { + "@odata.type": "microsoft.graph.accessPackageAnswerString" + } + ], + "customExtensionHandlerInstances": [ + { + "@odata.type": "microsoft.graph.customExtensionHandlerInstance" + } + ] } ``` |
v1.0 | Accesspackagecatalog | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackagecatalog.md | Namespace: microsoft.graph In [Azure AD entitlement management](entitlementmanagement-overview.md), an access package catalog is a container for zero or more access packages. An access package catalog might also have linked resources that are used in those access packages to provide access. To view or change the membership of catalog-scoped roles, use the [role assignments](unifiedroleassignment.md) API with the entitlement management RBAC provider. - ## Methods | Method | Return Type | Description | In [Azure AD entitlement management](entitlementmanagement-overview.md), an acce | [Get accessPackageCatalog](../api/accesspackagecatalog-get.md) | [accessPackageCatalog](accesspackagecatalog.md) | Read properties and relationships of an accessPackageCatalog object. | | [Update accessPackageCatalog](../api/accesspackagecatalog-update.md)|None | Update the properties of an accessPackageCatalog object. | | [Delete accessPackageCatalog](../api/accesspackagecatalog-delete.md) | | Delete accessPackageCatalog. |+| **Access package resources**| | | | [List accessPackageCatalog resources](../api/accesspackagecatalog-list-accesspackageresources.md) | [accessPackageResource](accesspackageresource.md) collection | Retrieve a list of accessPackageResource objects in a catalog. |+| **Access package resource roles**| | | | [List accessPackageCatalog resource roles](../api/accesspackagecatalog-list-accesspackageresourceroles.md) | [accessPackageResourceRole](accesspackageresourcerole.md) collection | Retrieve a list of accessPackageResourceRole objects for resources in a catalog. |+| **Custom access package package workflow extensions**| | | +|[List customAccessPackageWorkflowExtensions](../api/accesspackagecatalog-list-customaccesspackageworkflowextensions.md)|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) collection|Get a list of the [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) objects and their properties.| +|[Create customAccessPackageWorkflowExtensions](../api/accesspackagecatalog-post-customaccesspackageworkflowextensions.md)|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md)|Create a new [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object.| +|[Get customAccessPackageWorkflowExtension](../api/customaccesspackageworkflowextension-get.md)|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md)|Read the properties and relationships of a [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object.| +|[Update customAccessPackageWorkflowExtension](../api/customaccesspackageworkflowextension-update.md)|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md)|Update the properties of a [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object.| +|[Delete customAccessPackageWorkflowExtension](../api/customaccesspackageworkflowextension-delete.md)|None|Deletes a [customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) object.| ## Properties In [Azure AD entitlement management](entitlementmanagement-overview.md), an acce |:-|:|:| |accessPackages|[accessPackage](accesspackage.md) collection| The access packages in this catalog. Read-only. Nullable. Supports `$expand`.| |accessPackageResources|[accessPackageResource](accesspackageresource.md) collection| Read-only. Nullable.|+|accessPackageResourceRoles|[accessPackageResourceRole](accesspackageresourcerole.md) collection|The roles in each resource in a catalog. Read-only.| +|accessPackageResourceScopes|[accessPackageResourceScope](accesspackageresourcescope.md) collection|Read-only.| +|customAccessPackageWorkflowExtension|[customAccessPackageWorkflowExtension](../resources/customaccesspackageworkflowextension.md) collection|The attributes of a logic app, which can be called at various stages of an access package request and assignment cycle. | ## JSON representation |
v1.0 | Accesspackageresource | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accesspackageresource.md | In [Azure AD Entitlement Management](entitlementmanagement-overview.md), an acce | Property | Type | Description | |:-|:|:|-|accessPackageResourceEnvironment|[accessPackageResourceEnvironment](../resources/accesspackageresourceenvironment.md)|Contains the environment information for the resource. This can be set using either the `@odata.bind` annotation or the environment's *originId*.| |attributes|[accessPackageResourceAttribute](../resources/accesspackageresourceattribute.md) collection| Contains information about the attributes to be collected from the requestor and sent to the resource application. | |addedBy|String|The name of the user or application that first added this resource. Read-only.| |addedOn|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| In [Azure AD Entitlement Management](entitlementmanagement-overview.md), an acce | Relationship | Type | Description | |:-|:|:|-|accessPackageResourceEnvironment|[accessPackageResourceEnvironment](accesspackageresourceenvironment.md)| Nullable. Supports `$expand`.| +|accessPackageResourceEnvironment|[accessPackageResourceEnvironment](../resources/accesspackageresourceenvironment.md)|Contains the environment information for the resource. This can be set using either the `@odata.bind` annotation or the environment's *originId*.Supports `$expand`.| |accessPackageResourceRoles|[accessPackageResourceRole](accesspackageresourcerole.md) collection| Read-only. Nullable. Supports `$expand`.| |accessPackageResourceScopes|[accessPackageResourceScope](accesspackageresourcescope.md) collection| Read-only. Nullable. Supports `$expand`.| |
v1.0 | Accessreviewsv2 Overview | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/accessreviewsv2-overview.md | Typical customer scenarios for access reviews include: - Customers can review and certify employee access to Azure AD resources. - Customers can review and audit assignments to Azure AD privileged roles. This supports organizations in the management of privileged access. -Note that the access reviews feature, including the API, is included in Azure AD Premium P2. The tenant where an access review is being created must have a valid purchased or trial Azure AD Premium P2 or EMS E5 subscription. +Note that the access reviews feature, including the API, is included in Azure AD Premium P2. The tenant where an access review is being created must have a valid purchased or trial Azure AD Premium P2 or EMS E5 subscription. For more information about the license requirements, see [Access reviews license requirements](/azure/active-directory/governance/access-reviews-overview#license-requirements). ## Methods |
v1.0 | Activateservice | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/activateservice.md | Represents a service to be activated. | Property | Type | Description | | -- | | - | | service| String | The name of the service to activate. |-| servicePlanId | GUID | The plan identifier of the service plan to activate. | -| skuId | GUID | The SKU identifier of the service plan. | +| servicePlanId | Guid | The plan identifier of the service plan to activate. | +| skuId | Guid | The SKU identifier of the service plan. | ## JSON representation Here is a JSON representation of the resource. ```json {- "service": "string", - "skuId": "guid", - "servicePlanId": "guid" + "service": "String", + "skuId": "Guid", + "servicePlanId": "Guid" } ``` |
v1.0 | Addin | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/addin.md | Here is a JSON representation of the resource. ```json {- "id": "guid", + "id": "GUID", "properties": [{"@odata.type": "microsoft.graph.keyValue"}],- "type": "string" + "type": "String" } ``` |
v1.0 | Administrativeunit | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/administrativeunit.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An administrative unit provides a conceptual container for User and Group directory objects. Using administrative units, a company administrator can now delegate administrative responsibilities to manage the users and groups contained within or scoped to an administrative unit to a regional or departmental administrator. +An administrative unit provides a conceptual container for user, group, and device directory objects. Using administrative units, a company administrator can now delegate administrative responsibilities to manage the users, groups, and devices contained within or scoped to an administrative unit to a regional or departmental administrator. This resource supports using [delta query](/graph/delta-query-overview) to track incremental additions, deletions, and updates, by providing a [delta](../api/administrativeunit-delta.md) function. This resource is an open type that allows other properties to be passed in. This topic provides descriptions of the declared properties and navigation prope | Method | Return Type | Description | |:|:--|:-|-|[Create](../api/administrativeunit-post-administrativeunits.md) | [administrativeUnit](administrativeunit.md) | Create a new administrative unit.| -|[List](../api/administrativeunit-list.md) | [administrativeUnit](administrativeunit.md) collection |List properties of all administrativeUnits.| +|[Create](../api/directory-post-administrativeunits.md) | [administrativeUnit](administrativeunit.md) | Create a new administrative unit.| +|[List](../api/directory-list-administrativeunits.md) | [administrativeUnit](administrativeunit.md) collection |List properties of all administrativeUnits.| |[Get](../api/administrativeunit-get.md) | [administrativeUnit](administrativeunit.md) |Read properties and relationships of a specific administrativeUnit object.| |[Update](../api/administrativeunit-update.md) | [administrativeUnit](administrativeunit.md) |Update administrativeUnit object. | |[Delete](../api/administrativeunit-delete.md) | None |Delete administrativeUnit object. | |[Get delta](../api/administrativeunit-delta.md)|[administrativeUnit](administrativeunit.md)|Get newly created, updated, or deleted **administrativeUnits** without having to perform a full read of the entire resource collection.|-|[Add a member](../api/administrativeunit-post-members.md) |[directoryObject](directoryobject.md)| Add a member (user or group).| -|[List members](../api/administrativeunit-list-members.md) |[directoryObject](directoryobject.md) collection| Get the list of (user and group) members.| +|[Add a member](../api/administrativeunit-post-members.md) |[directoryObject](directoryobject.md)| Add a member (user, group, or device).| +|[List members](../api/administrativeunit-list-members.md) |[directoryObject](directoryobject.md) collection| Get the list of (user, group, and device) members.| |[Get a member](../api/administrativeunit-get-members.md) |[directoryObject](directoryobject.md)| Get a specific member.| |[Remove a member](../api/administrativeunit-delete-members.md) |[directoryObject](directoryobject.md)| Remove a member.| |[Add scoped-role member](../api/administrativeunit-post-scopedrolemembers.md) |[scopedRoleMembership](scopedrolemembership.md)| Add a scoped-role member.| This topic provides descriptions of the declared properties and navigation prope | Property | Type |Description| |:|:--|:-|-|description|string|An optional description for the administrative unit. Supports `$filter` (`eq`, `ne`, `in`, `startsWith`), `$search`.| -|displayName|string|Display name for the administrative unit. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderBy`.| -|id|string|Unique identifier for the administrative unit. Read-only. Supports `$filter` (`eq`).| -|visibility|string|Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership` or `Public`. If not set, default behavior is `Public`. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit.| +|description|String|An optional description for the administrative unit. Supports `$filter` (`eq`, `ne`, `in`, `startsWith`), `$search`.| +|displayName|String|Display name for the administrative unit. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderBy`.| +|id|String|Unique identifier for the administrative unit. Read-only. Supports `$filter` (`eq`).| +|visibility|String|Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership`. If not set (value is `null`), the default behavior is public. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit.| ## Relationships | Relationship | Type |Description| This topic provides descriptions of the declared properties and navigation prope ## JSON representation -Here is a JSON representation of the resource. +The following is a JSON representation of the resource. <!-- { "blockType": "resource", Here is a JSON representation of the resource. ```json {- "description": "string", - "displayName": "string", - "id": "string (identifier)", - "visibility": "string" + "description": "String", + "displayName": "String", + "id": "String (identifier)", + "visibility": "String" } ``` |
v1.0 | Agreement | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/agreement.md | Represents a tenant's customizable terms of use agreement that is created and ma | Method | Return Type | Description | |:-|:|:|-| [Create agreements](../api/termsofusecontainer-post-agreements.md) | [agreement](agreement.md) | Create a new agreement by posting to the agreement collection. | -| [List agreements](../api/termsofusecontainer-list-agreements.md) | [agreement](agreement.md) collection | Get an agreement object collection. | -| [Get agreement](../api/agreement-get.md) | [agreement](agreement.md) | Read properties and relationships of an agreement object. | -| [Update agreement](../api/agreement-update.md) | [agreement](agreement.md) | Update an agreement object. | -| [Delete agreement](../api/agreement-delete.md) | None | Delete an agreement object. | -<!-- -| [Create agreementFile](../api/agreement-post-files.md) | [agreementFile](agreementfile.md) | Create a new agreementFile by posting to the files collection. | -| [List files](../api/agreement-list-files.md) | [agreementFile](agreementfile.md) collection | Get an agreementFile object collection. | >+| [Create](../api/termsofusecontainer-post-agreements.md) | [agreement](agreement.md) | Create a new agreement by posting to the agreement collection. | +| [List](../api/termsofusecontainer-list-agreements.md) | [agreement](agreement.md) collection | Get an agreement object collection. | +| [Get](../api/agreement-get.md) | [agreement](agreement.md) | Read properties and relationships of an agreement object. | +| [Update](../api/agreement-update.md) | None | Update an agreement object. | +| [Delete](../api/agreement-delete.md) | None | Delete an agreement object. | +|[List acceptances](../api/agreement-list-acceptances.md)|[agreementAcceptance](../resources/agreementacceptance.md) collection|Get the details about the acceptance records for a specific agreement.| +|[List agreementAcceptances](../api/user-list-agreementacceptances.md)|[agreementAcceptance](../resources/agreementacceptance.md) collection|Get the agreement acceptances for the signed-in user.| +|[Get agreementFile](../api/agreementfile-get.md)|[agreementFile](../resources/agreementfile.md) collection|Retrieve the details of the default file for an agreement, including the language and version information.| +|[List files](../api/agreement-list-files.md)|[agreementFileLocalization](../resources/agreementfilelocalization.md) collection|Retrieve all localized files related to an agreement.| +|[Create agreementFileLocalization](../api/agreement-post-files.md)|[agreementFileLocalization](../resources/agreementfilelocalization.md)|Create a new localized agreement file.| + ## Properties | Property | Type | Description | |:-|:|:|-|displayName|String|Display name of the agreement. The display name is used for internal tracking of the agreement but is not shown to end users who view the agreement.| -|id|String| Read-only.| -|isPerDeviceAcceptanceRequired|Boolean|This setting enables you to require end users to accept this agreement on every device that they are accessing it from. The end user will be required to register their device in Azure AD, if they haven't already done so.| -|isViewingBeforeAcceptanceRequired|Boolean|Indicates whether the user has to expand the agreement before accepting.| -|termsExpiration|[termsExpiration](termsexpiration.md)| Expiration schedule and frequency of agreement for all users. | +|displayName|String|Display name of the agreement. The display name is used for internal tracking of the agreement but is not shown to end users who view the agreement. Supports `$filter` (`eq`).| +|id|String| Read-only. Supports `$filter` (`eq`).| +|isPerDeviceAcceptanceRequired|Boolean|This setting enables you to require end users to accept this agreement on every device that they are accessing it from. The end user will be required to register their device in Azure AD, if they haven't already done so. Supports `$filter` (`eq`).| +|isViewingBeforeAcceptanceRequired|Boolean|Indicates whether the user has to expand the agreement before accepting. Supports `$filter` (`eq`).| +|termsExpiration|[termsExpiration](termsexpiration.md)| Expiration schedule and frequency of agreement for all users. Supports `$filter` (`eq`).| |userReacceptRequiredFrequency|Duration|The duration after which the user must re-accept the terms of use. The value is represented in ISO 8601 format for durations.| |
v1.0 | Agreementacceptance | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/agreementacceptance.md | Represents the current status of a user's response to a company's customizable t |expirationDateTime|DateTimeOffset|The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |id|String| Read-only.| |recordedDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`|-|state|string| Possible values are: `accepted`, `declined`.| +|state|string| Possible values are: `accepted`, `declined`. Supports `$filter` (`eq`).| |userDisplayName|String|Display name of the user when the acceptance was recorded.| |userEmail|String|Email of the user when the acceptance was recorded.| |userId|String|ID of the user who accepted the agreement.| |
v1.0 | Agreementfile | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/agreementfile.md | None. ## Properties | Property | Type | Description | |:-|:|:|-|createdDateTime|DateTimeOffset|The date time representing when the file was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [agreementFileProperties](../resources/agreementfileproperties.md).| +|createdDateTime|DateTimeOffset|The date time representing when the file was created.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Inherited from [agreementFileProperties](../resources/agreementfileproperties.md).| |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. Inherited from [agreementFileProperties](../resources/agreementfileproperties.md).| |fileData|[agreementFileData](agreementfiledata.md)|Data that represents the terms of use PDF document. Read-only. Inherited from [agreementFileProperties](../resources/agreementfileproperties.md).| |fileName|String|Name of the agreement file (for example, TOU.pdf). Read-only. Inherited from [agreementFileProperties](../resources/agreementfileproperties.md).| |
v1.0 | Agreementfiledata | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/agreementfiledata.md | Namespace: microsoft.graph Represents the blob of an Azure Active Directory (Azure AD) terms of use agreement file. ## Properties-| Method | Return Type | Description | +| Property | Type | Description | |:-|:|:|-|data|Binary|Data representing the terms of use PDF document. Read-only.| +|data|Binary|Data that represents the terms of use PDF document. Read-only. <br/><br/>**Note:** You can use the .NET [Convert.ToBase64String](/dotnet/api/system.convert.tobase64string) method to convert your file to binary data for uploading using the [Create agreements](../api/termsofusecontainer-post-agreements.md) API. A sample syntax using this method in PowerShell is `[convert]::ToBase64String((Get-Content -path "your_file_path" -Encoding byte))`. | ## JSON representation |
v1.0 | Appidentity | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/appidentity.md | Indicates the identity of the application that performed the action or was chang ## Properties | Property | Type |Description| |:|:--|:-|-|appId|String|Refers to the Unique GUID representing Application Id in the Azure Active Directory.| +|appId|String|Refers to the unique identifier representing Application Id in the Azure Active Directory.| |displayName|String|Refers to the Application Name displayed in the Azure Portal.|-|servicePrincipalId|String|Refers to the Unique GUID indicating Service Principal Id in Azure Active Directory for the corresponding App.| +|servicePrincipalId|String|Refers to the unique identifier indicating Service Principal Id in Azure Active Directory for the corresponding App.| |servicePrincipalName|String|Refers to the Service Principal Name is the Application name in the tenant. | ## JSON representation |
v1.0 | Application | https://github.com/microsoftgraph/microsoft-graph-docs/commits/main/api-reference/beta/resources/application.md | This resource supports using [delta query](/graph/delta-query-overview) to track |[Add key](../api/application-addkey.md)|[keyCredential](keycredential.md)|Add a key credential to an application.| |[Remove key](../api/application-removekey.md)|None|Remove a key credential from an application.| |**Extensions**| | |-| [List extensions](../api/application-list-extensionproperty.md) | [extensionProperty](extensionProperty.md) collection | List extension properties on an application object. | -| [Create extension](../api/application-post-extensionproperty.md) | [extensionProperty](extensionProperty.md) | Create an extension property on an application object. | -| [Delete extension](../api/application-delete-extensionproperty.md) | None | Delete an extension property from an application object. | +| [List extensionProperties](../api/application-list-extensionproperty.md) | [extensionProperty](extensionProperty.md) collection | List extension properties on an application object. | +| [Create extensionProperties](../api/application-post-extensionproperty.md) | [extensionProperty](extensionProperty.md) | Create an extension property on an application object. | +| [Get extensionProperty](../api/extensionproperty-delete.md) | None | Get an extension property from an application object. | +| [Delete extensionProperty](../api/extensionproperty-delete.md) | None | Delete an extension property from an application object. | |**Federated identity credentials**| | | | [List federatedIdentityCredential](../api/application-list-federatedidentitycredentials.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) collection | List federated identity credentials on an application object. | | [Create federatedIdentityCredential](../api/application-post-federatedidentitycredentials.md) | [federatedIdentityCredential](../resources/federatedidentitycredential.md) | Create a federated identity credential on an application object. | This resource supports using [delta query](/graph/delta-query-overview) to track | verifiedPublisher | [verifiedPublisher](verifiedPublisher.md) | Specifies the verified publisher of the application. For more information about how publisher verification helps support application security, trustworthiness, and compliance, see [Publisher verification](/azure/active-directory/develop/publisher-verification-overview).| | uniqueName | String | The unique identifier that can be assigned to an application as an alternative identifier. Immutable. Read-only. | | web |[webApplication](webapplication.md)| Specifies settings for a web application. |+| windows |[windowsApplication |