Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
v1.0 | Accesspackage Filterbycurrentuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-filterbycurrentuser.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!CAUTION] +> The **filterByCurrentUser** function is on a deprecation path and exists only to support current customers. We don't recommend using this function. + In [Microsoft Entra Entitlement Management](../resources/entitlementmanagement-overview.md), retrieve a list of [accessPackage](../resources/accesspackage.md) objects filtered on the signed-in user. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Accesspackageassignmentrequest Resume | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackageassignmentrequest-resume.md | Title: "accessPackageAssignmentRequest: resume" -description: "Resume accessPackageAssignmentRequest objects." +description: "Resume a user's access package request after waiting for a callback from a custom extension." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -In [Microsoft Entra entitlement management](../resources/entitlementmanagement-overview.md), when an access package policy has been enabled to call out a custom extension and the request processing is waiting for the callback from the customer, the customer can initiate a resume action. It is performed on an [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object whose **requestStatus** is in a `WaitingForCallback` state. +Resume a user's access package request after waiting for a callback from a custom extension. ++In [Microsoft Entra entitlement management](../resources/entitlementmanagement-overview.md), when an access package policy has been enabled to call out a custom extension and the request processing is waiting for the callback from the customer, the customer can initiate a resume action. It's performed on an [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object whose **requestStatus** is in a `WaitingForCallback` state. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "accesspackageassignmentrequest_resume" } --> [!INCLUDE [permissions-table](../includes/permissions/accesspackageassignmentrequest-resume-permissions.md)] +> [!IMPORTANT] +> App-only access can be authorized *without* granting the `EntitlementManagement.ReadWrite.All` application permission to the caller. Instead, assign the caller an [Entitlement Management role](/entr#example-4-create-a-role-assignment-with-access-package-catalog-scope) or [Delegate access governance to access package managers in entitlement management](/entra/id-governance/entitlement-management-delegate-managers#as-a-catalog-owner-delegate-to-an-access-package-manager). + ## HTTP request > [!NOTE] |
v1.0 | Administrativeunit Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted **administrativeUnits** without having to perform a full read of the entire resource collection. For details, see [Using delta query](/graph/delta-query-overview). +Get newly created, updated, or deleted **administrativeUnits** without having to perform a full read of the entire resource collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_delta" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-delta-permissions.md)] + ## HTTP request To begin tracking changes, you make a request that includes the delta function on the **administrativeUnit** resource. You only need to specify any query parameters once up front. In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response. That URL already includes the encoded parameters. -| Query parameter | Type |Description| +| Query parameter | Type |Description| |:|:--|:-| | $deltatoken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call for the same resource collection, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL including this token in the first request of the next round of change tracking for that collection.| | $skiptoken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating there are further changes to be tracked in the same resource collection. | |
v1.0 | Administrativeunit Get Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-get-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_get_members" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-get-members-permissions.md)] + ## HTTP request ```http |
v1.0 | Administrativeunit Get Scopedrolemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-get-scopedrolemembers.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_get_scopedrolemembers" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-get-scopedrolemembers-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Administrativeunit List Scopedrolemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-list-scopedrolemembers.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_list_scopedrolemembers" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-list-scopedrolemembers-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Administrativeunit Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-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 | AdministrativeUnit.ReadWrite.All | -To add a user, group, or device to an administrative unit, the calling user must be assigned the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ### Permissions to create a new group <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> To add a user, group, or device to an administrative unit, the calling user must |Delegated (personal Microsoft account) | Not supported. | |Application | Group.Create and AdministrativeUnit.Read.All, Group.ReadWrite.All and AdministrativeUnit.Read.All, Directory.ReadWrite.All | -To create a new group in an administrative unit, the calling principal must be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) at the scope of the administrative unit: --* Groups Administrator -* User Administrator --When these roles are assigned to a service principal, additional permissions are required to read the directory, such as assignment to the Directory Readers role, or having Microsoft Graph application permissions, such as Directory.Read.All. +> [!IMPORTANT] +> To create a new group in an administrative unit, the calling principal must be assigned at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) at the scope of the administrative unit: +> - Groups Administrator +> - User Administrator +> +> For app-only scenarios - apart from these roles, the service principal requires additional permissions to read the directory. These permissions can be granted via assignment of supported Microsoft Entra roles, such the Directory Readers role; or they can be granted via Microsoft Graph application permissions that allow reading the directory, such as *Directory.Read.All*. ## HTTP request |
v1.0 | Administrativeunit Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/administrativeunit-update.md | Title: "Update administrativeunit" + Title: "Update administrativeUnit" description: "Update the properties of an administrativeUnit object." ms.localizationpriority: medium-# Update administrativeunit +# Update administrativeUnit Namespace: microsoft.graph Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_update" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-update-permissions.md)] -In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the `microsoft.directory/administrativeUnits/allProperties/allTasks` role permission. *Privileged Role Administrator* is the least privileged role for this operation. ## HTTP request <!-- { "blockType": "ignored" } --> PATCH /directory/administrativeUnits/{id} ## Request body -In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains 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 | Description for the administrative unit.| | displayName | String | Display name for the administrative unit. |-| membershipRule | String | Dynamic membership rule for the administrative unit. For more about the rules that you can use for dynamic administrative units and dynamic groups, see [Using attributes to create advanced rules](https://azure.microsoft.com/documentation/articles/active-directory-accessmanagement-groups-with-advanced-rules/).| -| membershipRuleProcessingState | String | Used to control whether the dynamic membership rule is actively processed. Set to `On` when you want the dynamic membership rule to be active and `Paused` if you want to stop updating membership dynamically. | -| membershipType | String | Membership type for the administrative unit. Can be `dynamic` or `assigned`. | -| 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 nonmembers. | +| membershipRule | String | The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see [Manage rules for dynamic membership groups in Microsoft Entra ID](/entra/identity/users/groups-dynamic-membership).| +| membershipRuleProcessingState | String | Controls whether the dynamic membership rule is actively processed. Set to `On` to activate the dynamic membership rule, or `Paused` to stop updating membership dynamically. | +| membershipType | String | Indicates the membership type for the administrative unit. The possible values are: `dynamic`, `assigned`. If not set, the default value is `null` and the default behavior is assigned. | +| visibility | String | The visibility of the administrative unit. If not set, the default value is `null` and the default behavior is public. It can be set to `HiddenMembership` to hide the membership from nonmembers. | -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. +The **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), which allows you to 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. ## Examples -The following example sets a dynamic membership rule on an existing administrative unit to include all users whose country is United States. It also updates the administrative unit display name. - ### Request +The following example shows a request that sets a dynamic membership rule on an existing administrative unit to include all users whose country is the United States. It also updates the display name of the administrative unit. + # [HTTP](#tab/http) <!-- { "blockType": "request", Content-type: application/json ### Response +The following example shows the response. + <!-- { "blockType": "response" } --> |
v1.0 | Adminreportsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminreportsettings-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "adminreportsettings_get" } --> [!INCLUDE [permissions-table](../includes/permissions/adminreportsettings-get-permissions.md)] -> **Note:** For delegated permissions to allow apps to get report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization). +> **Note:** For delegated permissions to allow apps to get report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization). ## HTTP request Choose the permission or permissions marked as least privileged for this API. Us GET /admin/reportSettings ``` +## Optional query parameters ++This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response. + ## Request headers | Name | Description | |
v1.0 | Adminreportsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminreportsettings-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "adminreportsettings_update" } --> [!INCLUDE [permissions-table](../includes/permissions/adminreportsettings-update-permissions.md)] -> **Note:** For delegated permissions to allow apps to update report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization). +> **Note:** For delegated permissions to allow apps to update report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization). ## HTTP request <!-- { "blockType": "ignored" } --> PATCH /admin/reportSettings | Property | Type | Description | | -- | -- | - |-| displayConcealedNames | Boolean | If set to `true`, all reports will conceal user information such as usernames, groups, and sites. If `false`, all reports will show identifiable information. This property represents a setting in the Microsoft 365 admin center. Required. | +| displayConcealedNames | Boolean | If set to `true`, all reports conceal user information such as usernames, groups, and sites. If `false`, all reports show identifiable information. This property represents a setting in the Microsoft 365 admin center. Required. | ## Response |
v1.0 | Adminwindowsupdates List Deploymentaudiences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-deploymentaudiences.md | Title: "List deploymentAudiences" description: "Get a list of deploymentAudience objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates List Deployments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-deployments.md | Title: "List deployments" description: "Get a list of deployment objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates List Resourceconnections Operationalinsightsconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-resourceconnections-operationalinsightsconnection.md | Title: "List operationalInsightsConnections" description: "Get a list of the operationalInsightsConnection objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates List Resourceconnections | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-resourceconnections.md | Title: "List resourceConnections" description: "Get a list of the resourceConnection objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates List Updatableassets Azureaddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-updatableassets-azureaddevice.md | Title: "List azureADDevice resources" description: "Get a list of azureADDevice objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates List Updatableassets Updatableassetgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-updatableassets-updatableassetgroup.md | Title: "List updatableAssetGroup resources" description: "Get a list of updatableAssetGroup objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates List Updatableassets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-updatableassets.md | Title: "List updatableAssets" description: "Get a list of updatableAsset objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates List Updatepolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-list-updatepolicies.md | Title: "List updatePolicies" description: "Get a list of updatePolicy objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates Post Deploymentaudiences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-post-deploymentaudiences.md | Title: "Create deploymentAudience" description: "Create a new deploymentAudience object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates Post Deployments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-post-deployments.md | Title: "Create deployment" description: "Create a new deployment object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates Post Resourceconnections Operationalinsightsconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-post-resourceconnections-operationalinsightsconnection.md | Title: "Create operationalInsightsConnection" description: "Create a new operationalInsightsConnection object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates Post Updatableassets Updatableassetgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-post-updatableassets-updatableassetgroup.md | Title: "Create updatableAssetGroup" description: "Create a new updatableAssetGroup object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Adminwindowsupdates Post Updatepolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminwindowsupdates-post-updatepolicies.md | Title: "Create updatePolicy" description: "Create a new updatePolicy object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Alert Updatealerts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/alert-updatealerts.md | POST /security/alerts/updateAlerts | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Allowedvalue Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/allowedvalue-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "allowedvalue_get" } --> [!INCLUDE [permissions-table](../includes/permissions/allowedvalue-get-permissions.md)] -The signed-in user must also be assigned one of the following [directory roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --+ Attribute Definition Reader -+ Attribute Definition Administrator --By default, Global Administrator and other administrator roles do not have permissions to read, define, or assign custom security attributes. +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following privileged roles are supported for this operation. +> - Attribute Definition Reader +> - Attribute Definition Administrator +> +> - By default, Global Administrator and other administrator roles do not have permissions to read, define, or assign custom security attributes. ## HTTP request |
v1.0 | Appcatalogs List Teamsapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appcatalogs-list-teamsapps.md | Title: "List teamsApp" description: "List apps from the Microsoft Teams app catalog."-+ ms.localizationpriority: medium doc_type: apiPageType Content-Type: application/json { "id": "YTUyMjhjMjYtYTlhZS00NzAyLTkwZTAtNzlhNTI0NmQyZjdkIyMxLjAuMCMjUHVibGlzaGVk", "authorization": {+ "clientAppId": "6ed63604-0ba7-4a28-bb3a-dda03ea18d54", "requiredPermissionSet": { "resourceSpecificPermissions": [ { Content-Type: application/json "serializedInternalDefinition": null, "createdBy": null, "authorization": {+ "clientAppId": null, "requiredPermissionSet": { "resourceSpecificPermissions": [] } Content-Type: application/json "serializedInternalDefinition": null, "createdBy": null, "authorization": {+ "clientAppId": null, "requiredPermissionSet": { "resourceSpecificPermissions": [] } |
v1.0 | Application Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted applications without having to perform a full read of the entire resource collection. See [Using Delta Query](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted applications without having to perform a full read of the entire resource collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Application List Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-list-owners.md | Title: "List owners" -description: "Retrieve a list of owners (directoryObject objects) for an application." + Title: "List owners of an application" +description: "Retrieve a list of owners for an application." ms.localizationpriority: medium doc_type: apiPageType -# List owners +# List owners of an application Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a list of owners for an application that are [directoryObject](../resources/directoryobject.md) objects. +Retrieve a list of owners for an application that are [directoryObject](../resources/directoryobject.md) types. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] -- ## HTTP request You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center. GET /applications(appId='{appId}')/owners ``` ## Optional query parameters-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 directory objects](/graph/aad-advanced-queries). ## Request headers | Name | Description | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body. ## Example-##### Request -The following example shows a request. +### Request +The following example shows a request that uses the **appId** alternate key to query the owners of an application. -# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "application_get_owners" }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/applications/{id}/owners +GET https://graph.microsoft.com/beta/applications(appId='bbec3106-565f-4907-941e-96b4dbfef21c')/owners ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) --# [JavaScript](#tab/javascript) --# [PHP](#tab/php) --# [PowerShell](#tab/powershell) --# [Python](#tab/python) ----##### Response -The following example shows the response. Note: The response object shown here might be shortened for readability. +### Response +The following example shows the response. It shows only the **id** property as populated while other properties as `null`. This is because the caller did not have permissions to read users in the tenant. +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, HTTP/1.1 200 OK Content-type: application/json {- "value": [ - { - "id": "id-value" - } - ] + "@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET applications(appId=<key>)/owners?$select=deletedDateTime", + "value": [ + { + "@odata.type": "#microsoft.graph.user", + "id": "ce4770b3-70b2-4a38-a242-76631e9f7408", + "businessPhones": [], + "displayName": null, + "givenName": null, + "jobTitle": null, + "mail": null, + "mobilePhone": null, + "officeLocation": null, + "preferredLanguage": null, + "surname": null, + "userPrincipalName": null + }, + { + "@odata.type": "#microsoft.graph.user", + "id": "858a9c90-38b3-4e78-b915-234aece712c4", + }, + { + "@odata.type": "#microsoft.graph.user", + "id": "7585d967-f300-43de-b817-7119a6404c5e", + } + ] } ``` |
v1.0 | Application Post Calls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-calls.md | Namespace: microsoft.graph Create [call](../resources/call.md) enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. You need to [register the calling bot](/microsoftteams/platform/concepts/calls-and-meetings/registering-calling-bot) and go through the list of permissions needed. +This API supports the following PSTN scenarios: +++ Incoming call to bot's PSTN number and then bot invites another PSTN.++ Incoming call to bot's PSTN number and then bot transfer to another PSTN.++ Incoming call to bot's PSTN number and then bot redirects to another PSTN.++ Incoming call to bot's instance identifier and then bot invites another PSTN.++ Incoming call to bot's instance identifier and then bot transfer to another PSTN.++ Incoming call to bot's instance identifier and then bot redirects to another PSTN.++ Incoming call to bot's instance identifier from Scheduled Meeting and then bot invites PSTN.++ Outgoing call from bot (with instance identifier) to a PSTN.++ P2P call between bot and another peer (Teams user, PSTN), bot invites another PSTN.++ P2P call between bot and another peer (Teams user, PSTN), bot invites another Teams user.++ Bot join the scheduled meeting and then invite PSTN.+ [!INCLUDE [national-cloud-support](../../includes/global-only.md)] ## Permissions If successful, this method returns a `201 Created` response code and a [call](.. The following example shows a request that makes a peer-to-peer call between the bot and the specified user. In this example, the media is hosted by the service. The values of authorization token, callback URL, application ID, application name, user ID, user name, and tenant ID must be replaced with actual values to make the example work. # [HTTP](#tab/http)- <!-- { "blockType": "request", "name": "create-call-service-hosted-media-1", Content-Type: application/json ], "callOptions": { "@odata.type": "#microsoft.graph.outgoingCallOptions",- "isContentSharingNotificationEnabled": true + "isContentSharingNotificationEnabled": true, + "isDeltaRosterEnabled": true }, "mediaConfig": { "@odata.type": "#microsoft.graph.serviceHostedMediaConfig" Content-Type: application/json "chatInfo": null, "meetingInfo": null, "transcription": null,+ "callOptions": { + "@odata.type": "#microsoft.graph.outgoingCallOptions", + "isContentSharingNotificationEnabled": true, + "isDeltaRosterEnabled": true + }, "meetingCapability": null, "toneInfo": null } |
v1.0 | Application Post Federatedidentitycredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-post-federatedidentitycredentials.md | The following table lists the properties that are required when you create the [ |Property|Type|Description| |:|:|:|-|audiences|String collection|The audience that can appear in the external token. This field is mandatory and should be set to `api://AzureADTokenExchange` for Microsoft Entra ID. It says what Microsoft identity platform should accept in the `aud` claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required.| -|issuer|String|TThe URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of **issuer** and **subject** must be unique on the app. It has a limit of 600 characters. Required.| -|name|String|The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created| +|audiences|String collection|Required. The audience that can appear in the external token. This field is mandatory and should be set to `api://AzureADTokenExchange` for Microsoft Entra ID. It says what Microsoft identity platform should accept in the `aud` claim in the incoming token. This value represents Microsoft Entra ID in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters.| +|issuer|String|Required. The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of **issuer** and **subject** must be unique on the app. It has a limit of 600 characters.| +|name|String|Required. The unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created.| |subject|String|Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Microsoft Entra ID. It has a limit of 600 characters. The combination of **issuer** and **subject** must be unique on the app.| |
v1.0 | Application Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/application-upsert.md | Create a new [application](../resources/application.md) object if it doesn't exi > [!IMPORTANT] > Using PATCH to set [**passwordCredential**](../resources/passwordcredential.md) is not supported. Use the [addPassword](./application-addpassword.md) and [removePassword](./application-removepassword.md) methods to update the password or secret for an application. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). |
v1.0 | Applicationsignindetailedsummary Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationsignindetailedsummary-get.md | This method supports the [OData query parameters](/graph/query-parameters) to he | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Applicationtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-get.md | For general information, see [OData query parameters](/graph/query-parameters). | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Applicationtemplate Instantiate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-instantiate.md | Namespace: microsoft.graph Add an instance of an application from the [Microsoft Entra application gallery](../resources/applicationtemplate.md) into your directory. -The application template with ID `8adf8e6e-67b2-4cf2-a259-e3dc5476c621` can be used to add a [non-gallery app](/azure/active-directory/manage-apps/add-non-gallery-app) that you can configure different single-sign on (SSO) modes like SAML SSO and password-based SSO. +For [non-gallery apps](/entra/identity/enterprise-apps/add-application-portal), use an application template with one of the following IDs to configure different single sign-on (SSO) modes like SAML SSO and password-based SSO. ++- Global service: `8adf8e6e-67b2-4cf2-a259-e3dc5476c621` +- US government: `4602d0b4-76bb-404b-bca9-2652e1a39c6d` +- China operated by 21Vianet: `5a532e38-1581-4918-9658-008dc27c1d68` [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us POST /applicationTemplates/{applicationTemplate-id}/instantiate ``` -To instantiate non-gallery apps, use the `8adf8e6e-67b2-4cf2-a259-e3dc5476c621` for the `{applicationTemplate-id}`. - ## Request headers | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body In the request body, provide a JSON object with the following parameters. | Parameter | Type | Description | |:-|:|:| |displayName|String|Custom name of the application|+|serviceManagementReference|String|The service tree ID for this service. Optional.| ## Response The following example shows how to call this API. ### Request -The following example shows a request. The request URL specifies `8adf8e6e-67b2-4cf2-a259-e3dc5476c621` as the application template ID. This means the request is instantiating a non-gallery app. +The following example shows a request. The request URL specifies `8adf8e6e-67b2-4cf2-a259-e3dc5476c621` as the application template ID, which means that the request is instantiating a non-gallery app. # [HTTP](#tab/http) <!-- { |
v1.0 | Applicationtemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/applicationtemplate-list.md | For general information, see [OData query parameters](/graph/query-parameters). | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Appmanagementpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appmanagementpolicy-get.md | Content-type: application/json ], "maxLifetime": null }- ] + ], + "applicationRestrictions": { + "identifierUris": { + "nonDefaultUriAddition": { + "restrictForAppsCreatedAfterDateTime": "2024-01-01T10:37:00Z", + "excludeAppsReceivingV2Tokens": true, + "excludeSaml": true + } + } + } } } ] |
v1.0 | Appmanagementpolicy List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appmanagementpolicy-list.md | Content-type: application/json ], "maxLifetime": null }- ] + ], + "applicationRestrictions": { + "identifierUris": { + "nonDefaultUriAddition": { + "restrictForAppsCreatedAfterDateTime": "2024-01-01T10:37:00Z", + "excludeAppsReceivingV2Tokens": true, + "excludeSaml": true + } + } + } } } ] |
v1.0 | Appmanagementpolicy Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appmanagementpolicy-post.md | POST https://graph.microsoft.com/beta/policies/appManagementPolicies ], "maxLifetime": null }- ] + ], + "applicationRestrictions": { + "identifierUris": { + "nonDefaultUriAddition": { + "restrictForAppsCreatedAfterDateTime": "2024-01-01T10:37:00Z", + "excludeAppsReceivingV2Tokens": true, + "excludeSaml": true + } + } + } } } |
v1.0 | Approleassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approleassignment-get.md | Read the properties and relationships of an [appRoleAssignment](../resources/app ## Permissions -<!-- -### For client service principals -<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> -<!-- -|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 | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All | --### For resource service principals -<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> -<!-- -|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 | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All | --### For groups -<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> -<!-- -|Permission type | Permissions (from least to most privileged) | -|:--|:| -|Delegated (work or school account) | Group.Read.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Group.Read.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All | --### For users -<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> -<!-- -|Permission type | Permissions (from least to most privileged) | -|:--|:| -|Delegated (work or school account) | User.Read, User.ReadBasic.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Directory.Read.All, AppRoleAssignment.ReadWrite.All | ->- The following table shows the least privileged permission or permissions required to call this API on each supported resource type. Follow [best practices](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions) to request least privileged permissions. For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> The following table shows the least privileged permission or permissions require [!INCLUDE [rbac-approleassignments-apis-read](../includes/rbac-for-apis/rbac-approleassignments-apis-read.md)] +### Other supported permissions ++The following higher privileged permissions are supported by each resource: +- Groups: + - Delegated and application permissions: Directory.Read.All, AppRoleAssignment.ReadWrite.All, Directory.ReadWrite.All +- Users: + - Delegated permissions: User.ReadBasic.All, Directory.Read.All, AppRoleAssignment.ReadWrite.All + - Application permissions: Directory.Read.All, AppRoleAssignment.ReadWrite.All +- Service principals: + - Delegated permissions: Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All + - Application permissions: Application.ReadWrite.OwnedBy, Application.ReadWrite.All, Directory.ReadWrite.All + ## HTTP request To get details of an appRole granted to a service principal: |
v1.0 | Approvalitem Cancel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalitem-cancel.md | Namespace: microsoft.graph Cancel the [approval item](../resources/approvalitem.md). The owner of the approval can trigger this endpoint. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalitem-cancel-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalitem_cancel" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalitem-cancel-permissions.md)] ## HTTP request If successful, this method returns a `202 Accepted` response code with the opera ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "approvalitemthis.cancel" The following example shows a request. POST https://graph.microsoft.com/beta/solutions/approval/approvalItems/ad65e077-4920-4bbd-a57e-b7f152958b83/cancel ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalitem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalitem-get.md | Namespace: microsoft.graph Read the properties and relationships of an [approvalItem](../resources/approvalitem.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalitem-get-permissions" -} >-+<!-- { "blockType": "permissions", "name": "approvalitem_get" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalitem-get-permissions.md)] ## HTTP request GET /solutions/approval/approvalItems/{approvalItemId} ## Optional query parameters -This method doesn't support the OData query parameters to customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response. ## Request headers If successful, this method returns a `200 OK` response code and an [approvalItem The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_approvalitem" } --> -```http +```msgraph-interactive GET https://graph.microsoft.com/beta/solutions/approval/approvalItems/d3a7405e-452a-47e0-9c35-9335225ba55d ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) +++ ### Response The following example shows the response. |
v1.0 | Approvalitem List Requests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalitem-list-requests.md | Namespace: microsoft.graph Get a list of [approvalItemRequest](../resources/approvalitemrequest.md) objects. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalitem-list-requests-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalitem_list_requests" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalitem-list-requests-permissions.md)] ## HTTP request GET /solutions/approval/approvalItems/{approvalItemId}/requests ## Optional query parameters -This method doesn't support the OData query parameters to customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$filter`, `$orderby`, `$count` and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers If successful, this method returns a `200 OK` response code and a collection of ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_approvalitemrequest" The following example shows a request. GET https://graph.microsoft.com/beta/solutions/approval/approvalItems/d3a7405e-452a-47e0-9c35-9335225ba55d/requests ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalitem List Responses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalitem-list-responses.md | Namespace: microsoft.graph Get a list of [approvalItemResponse](../resources/approvalitemresponse.md) objects. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalitem-list-responses-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalitem_list_responses" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalitem-list-responses-permissions.md)] ## HTTP request GET /solutions/approval/approvalItems/{approvalItemId}/responses ## Optional query parameters -This method doesn't support the OData query parameters to customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$filter`, `$orderby`, `$count` and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers If successful, this method returns a `200 OK` response code and a collection of ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_approvalitemresponse" The following example shows a request. GET https://graph.microsoft.com/beta/solutions/approval/approvalItems/d3a7405e-452a-47e0-9c35-9335225ba55d/responses ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response Content-Type: application/json "id": "f4d6b152-d3c6-4c27-9bc6-1cd5cdcb8473" } },- "createdDateTime":"2022-04-12T20:51:19Z", - "onBehalfOf":[ - { - "user":{ - "id":"39d1a7fb-5f54-4c89-b513-241683718c9b", - "displayName":"Lilli Allik" - } - } - ] + "createdDateTime":"2022-04-12T20:51:19Z" }, { "id": "d3a7405e-452a-47e0-9c35-9335225ba55d", Content-Type: application/json "displayName": "Lilli Allik" } },- "createdDateTime":"2022-04-12T20:51:19Z", - "onBehalfOf":[ - { - "user":{ - "id":"f4d6b152-d3c6-4c27-9bc6-1cd5cdcb8473", - "displayName":"Jana Pihlak" - } - }, - { - "group":{ - "id":"da9fe780-a3de-48cc-a571-82faa05c8463", - "displayName":"Microsoft Executive" - } - } - ] + "createdDateTime":"2022-04-12T20:51:19Z" } ] } |
v1.0 | Approvalitem Post Responses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalitem-post-responses.md | Namespace: microsoft.graph Create a new [approvalItemResponse](../resources/approvalitemresponse.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalitem-post-responses-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalitem_post_responses" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalitem-post-responses-permissions.md)] ## HTTP request If successful, this method returns a `202 Accepted` response code with the opera ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_approvalitemresponse_from_" Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalitemrequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalitemrequest-get.md | Namespace: microsoft.graph Read the properties and relationships of an [approvalItemRequest](../resources/approvalitemrequest.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalitemrequest-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalitemrequest_get" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalitemrequest-get-permissions.md)] ## HTTP request GET /solutions/approval/approvalItems/{approvalItemId}/requests/{approvalItemReq ## Optional query parameters -This method doesn't support the OData query parameters to customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response. ## Request headers If successful, this method returns a `200 OK` response code and an [approvalItem ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_approvalitemrequest" The following example shows a request. GET https://graph.microsoft.com/beta/solutions/approval/approvalItems/7d096f68-c4fe-4967-99dc-df0248c33a77/requests/817d2849-c546-47f0-9c38-1a1a38ac6648 ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalitemresponse Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalitemresponse-get.md | Namespace: microsoft.graph Read the properties and relationships of an [approvalItemResponse](../resources/approvalitemresponse.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalitemresponse-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalitemresponse_get" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalitemresponse-get-permissions.md)] ## HTTP request GET /solutions/approval/approvalItems/{approvalItemId}/responses/{approvalItemRe ## Optional query parameters -This method doesn't support the OData query parameters to customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response. ## Request headers If successful, this method returns a `200 OK` response code and an [approvalItem ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_approvalitemresponse" The following example shows a request. GET https://graph.microsoft.com/beta/solutions/approval/approvalItems/7d096f68-c4fe-4967-99dc-df0248c33a77/responses/9d4c5640-1da7-4739-924f-d10b70c734c1 ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvaloperation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvaloperation-get.md | Namespace: microsoft.graph Read the properties and relationships of an [approvalOperation](../resources/approvaloperation.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvaloperation-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvaloperation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/approvaloperation-get-permissions.md)] ## HTTP request GET /solutions/approval/operations/{approvalOperationId} ## Optional query parameters -This method doesn't support the OData query parameters to customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$filter`, `$orderby`, `$count` and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. ## Request headers If successful, this method returns a `200 OK` response code and an [approvalOper ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_approvaloperation" The following example shows a request. GET https://graph.microsoft.com/beta/solutions/approval/operations/1c281a99-f105-4f88-86fa-52d797323908 ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalsolution Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalsolution-get.md | Namespace: microsoft.graph Read the properties of an [approvalSolution](../resources/approvalsolution.md) object to determine the [provisioning](../api/approvalsolution-provision.md) state for a tenant. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalsolution-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalsolution_get" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalsolution-get-permissions.md)] ## HTTP request GET /solutions/approval ## Optional query parameters -This method doesn't support the OData query parameters to customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response. ## Request headers If successful, this method returns a `200 OK` response code and an [approvalSolu ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_approvalsolution" The following example shows a request. GET https://graph.microsoft.com/beta/solutions/approval ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalsolution List Approvalitems | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalsolution-list-approvalitems.md | Namespace: microsoft.graph Get a list of the [approvalItem](../resources/approvalitem.md) objects and their properties. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalsolution-list-approvalitems-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalsolution_list_approvalitems" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalsolution-list-approvalitems-permissions.md)] ## HTTP request GET /solutions/approval/approvalItems ## Optional query parameters -This method supports the `$filter`, `$orderby`, `$top`, and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. +This method supports the `$filter`, `$orderby`, `$top`, `$count`, and `$select` [OData query parameters](/graph/query-parameters) to help customize the response. If the result set spans multiple pages, the response body contains an `@odata.nextLink` that you can use to page through the result set. ## Request headers If successful, this method returns a `200 OK` response code and a collection of ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_approvalitem" The following example shows a request. GET https://graph.microsoft.com/beta/solutions/approval/approvalItems ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalsolution Post Approvalitems | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalsolution-post-approvalitems.md | Namespace: microsoft.graph Create a new [approvalItem](../resources/approvalitem.md) object. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalsolution-post-approvalitems-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalsolution_post_approvalitems" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalsolution-post-approvalitems-permissions.md)] ## HTTP request If successful, this method returns a `202 Accepted` response code with the opera ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_approvalitem_from_" Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Approvalsolution Provision | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/approvalsolution-provision.md | Namespace: microsoft.graph Provision an [approvalSolution](../resources/approvalsolution.md) on behalf of a tenant. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "approvalsolution-provision-permissions" -} >+<!-- { "blockType": "permissions", "name": "approvalsolution_provision" } --> [!INCLUDE [permissions-table](../includes/permissions/approvalsolution-provision-permissions.md)] ## HTTP request If successful, this action returns a `204 No Content` response code. ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "approvalsolutionthis.provision" The following example shows a request. POST https://graph.microsoft.com/beta/solutions/approval/provision ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Attachment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attachment-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] - Delete an attachment from a user calendar [event](../resources/event.md), [message](../resources/message.md), [Outlook task](../resources/outlooktask.md), or [post](../resources/post.md). + [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Attachment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/attachment-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] - Read the properties, relationships, or raw contents of an attachment that is attached to a user [event](../resources/event.md), [message](../resources/message.md), [Outlook task](../resources/outlooktask.md), or group [post](../resources/post.md). + An attachment can be one of the following types: * A file. Programmatically, this is a [fileAttachment](../resources/fileattachment.md) resource. See [example 1](#example-1-get-the-properties-of-a-file-attachment). |
v1.0 | Authentication Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authentication-get.md | GET https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/ ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) GET https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/ [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) GET https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/ [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Authentication Post Fido2methods | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authentication-post-fido2methods.md | Create a new [fido2AuthenticationMethod](../resources/fido2authenticationmethod. Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "authentication-post-fido2methods-permissions" -} >+<!-- { "blockType": "permissions", "name": "authentication_post_fido2methods" } --> [!INCLUDE [permissions-table](../includes/permissions/authentication-post-fido2methods-permissions.md)] ## HTTP request |
v1.0 | Authentication Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authentication-update.md | Choose the permission or permissions marked as least privileged for this API. Us #### Permissions acting on self -<!-- { "blockType": "permissions", "name": "authentication_get_2" } --> +<!-- { "blockType": "permissions", "name": "authentication_update_2" } --> [!INCLUDE [permissions-table](../includes/permissions/authentication-update-2-permissions.md)] #### Permissions acting on others -<!-- { "blockType": "permissions", "name": "authentication_get_3" } --> +<!-- { "blockType": "permissions", "name": "authentication_update_3" } --> [!INCLUDE [permissions-table](../includes/permissions/authentication-update-3-permissions.md)] [!INCLUDE [rbac-authentication-methods-policy-apis-write](../includes/rbac-for-apis/rbac-authentication-methods-policy-apis-write.md)] Content-Type: application/json ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) Content-Type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) Content-Type: application/json [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Authenticationcontextclassreference Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationcontextclassreference-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "authenticationcontextclassreference_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/authenticationcontextclassreference-delete-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Authenticationcontextclassreference Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationcontextclassreference-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "authenticationcontextclassreference_get" } --> [!INCLUDE [permissions-table](../includes/permissions/authenticationcontextclassreference-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Authenticationcontextclassreference Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationcontextclassreference-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "authenticationcontextclassreference_update" } --> [!INCLUDE [permissions-table](../includes/permissions/authenticationcontextclassreference-update-permissions.md)] + > [!NOTE] > This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13671) and might require consent to multiple permissions. |
v1.0 | Authenticationeventlistener Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationeventlistener-delete.md | Title: "Delete authenticationEventListener" -description: "Deletes an authenticationEventListener object." +description: "Delete an authenticationEventListener object." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Deletes an [authenticationEventListener](../resources/authenticationeventlistener.md) object. +Delete an [authenticationEventListener](../resources/authenticationeventlistener.md) object. The following derived types are currently supported. ++- [onTokenIssuanceStartListener resource type](../resources/ontokenissuancestartlistener.md) resource type +- [onInteractiveAuthFlowStartListener resource type](../resources/oninteractiveauthflowstartlistener.md) resource type +- [onAuthenticationMethodLoadStartListener resource type](../resources/onauthenticationmethodloadstartlistener.md) resource type +- [onAttributeCollectionListener resource type](../resources/onattributecollectionlistener.md) resource type +- [onUserCreateStartListener resource type](../resources/onusercreatestartlistener.md) resource type +- [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) resource type +- [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md) resource type [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "authenticationeventlistener_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/authenticationeventlistener-delete-permissions.md)] + ## HTTP request |
v1.0 | Authenticationeventlistener Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationeventlistener-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the properties and relationships of an [authenticationEventListener](../resources/authenticationeventlistener.md) object. The **@odata.type** property in the response object indicates the type of the authenticationEventListener object. +Read the properties and relationships of an [authenticationEventListener](../resources/authenticationeventlistener.md) object. The **@odata.type** property in the response object indicates the type of the authenticationEventListener object. The following derived types are currently supported. ++- [onTokenIssuanceStartListener resource type](../resources/ontokenissuancestartlistener.md) resource type +- [onInteractiveAuthFlowStartListener resource type](../resources/oninteractiveauthflowstartlistener.md) resource type +- [onAuthenticationMethodLoadStartListener resource type](../resources/onauthenticationmethodloadstartlistener.md) resource type +- [onAttributeCollectionListener resource type](../resources/onattributecollectionlistener.md) resource type +- [onUserCreateStartListener resource type](../resources/onusercreatestartlistener.md) resource type +- [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) resource type +- [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md) resource type [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "authenticationeventlistener_get" } --> [!INCLUDE [permissions-table](../includes/permissions/authenticationeventlistener-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Authenticationeventlistener Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationeventlistener-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of an [authenticationEventListener](../resources/authenticationeventlistener.md) object. You must specify the **@odata.type** property and the value of the [authenticationEventListener](../resources/authenticationeventlistener.md) object type to update. +Update the properties of an [authenticationEventListener](../resources/authenticationeventlistener.md) object. You must specify the **@odata.type** property and the value of the [authenticationEventListener](../resources/authenticationeventlistener.md) object type to update. The following derived types are currently supported. ++- [onTokenIssuanceStartListener resource type](../resources/ontokenissuancestartlistener.md) resource type +- [onInteractiveAuthFlowStartListener resource type](../resources/oninteractiveauthflowstartlistener.md) resource type +- [onAuthenticationMethodLoadStartListener resource type](../resources/onauthenticationmethodloadstartlistener.md) resource type +- [onAttributeCollectionListener resource type](../resources/onattributecollectionlistener.md) resource type +- [onUserCreateStartListener resource type](../resources/onusercreatestartlistener.md) resource type +- [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) resource type +- [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md) resource type [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "authenticationeventlistener_update" } --> [!INCLUDE [permissions-table](../includes/permissions/authenticationeventlistener-update-permissions.md)] + ## HTTP request <!-- { If successful, this method returns a `204 No Content` response code. ## Examples -### Request -The following example shows a request to update an authentication event listener's trigger conditions or priority: +### Example 1: Update an authentication event listener's trigger conditions or priority ++#### Request +The following example shows a request to update an authentication event listener's trigger conditions or priority. # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json -### Response +#### Response The following example shows the response. <!-- { "blockType": "response", The following example shows the response. ``` http HTTP/1.1 204 No Content ```+### Example 2: Add an application to an authentication event listener's trigger conditions ++#### Request ++The following example shows a request to add an application to an authentication event listener's trigger conditions. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_authenticationeventlistener_2" +} +--> +``` http +POST https://graph.microsoft.com/beta/identity/authenticationEventListeners/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.authenticationConditionApplication", + "appId": "63856651-13d9-4784-9abf-20758d509e19" +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) +# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++++#### Response +The following example shows the response to a request to add an application to an authentication event listener's trigger conditions: ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.authenticationConditionApplication", + "truncated": true, +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventListeners('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications/$entity", + "appId": "63856651-13d9-4784-9abf-20758d509e19" +} +``` |
v1.0 | Authenticationeventsflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationeventsflow-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object. Only the [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object type is supported. +Update the properties of an [authenticationEventsFlow](../resources/authenticationeventsflow.md) object by ID. You must specify the **@odata.type** property and the value of the [authenticationEventsFlow](../resources/authenticationeventsflow.md) object type to update. The following derived subtypes are supported: +- [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) [!INCLUDE [national-cloud-support](../../includes/global-china.md)] You must include the **@odata.type** property with a value of the specific user |priority|Int32|The priority to use for each individual event of the events policy. If multiple competing listeners for an event have the same priority, one is chosen and an error is silently logged. | |onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|The configuration for what to invoke for the onInteractiveAuthFlowStart event. | |onAuthenticationMethodLoadStart|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|The configuration for what to invoke for the onAuthenticationMethodLoadStart event. Must have at least one identity provider linked.|-|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|The configuration for what to invoke for the onAttributeCollection event. You can only update this property if it was configured during user flow creation. If it wasn't, call the [Add attributes to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) API instead.| +|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|The configuration for what to invoke for the onAttributeCollection event. <br/><br/><li> You can only update this property if it was configured during user flow creation. If it wasn't, call the [Add attributes to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) API first. </li><li> You can't add or remove attributes by updating the **attributeCollectionPage** > **views** > **inputs** and **attributes** objects. Use the [Add attribute to user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) or [Remove attribute from user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) APIs instead to update both objects.</li><li> To update the **attributeCollectionPage** > **views** > **inputs** collection, you must include all objects in the collection, not only the changed objects. <li> The order of objects in the **attributeCollectionPage** > **views** > **inputs** collection corresponds to the order in which the attributes are displayed on the app's sign-up UI. | |onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|The configuration for what to invoke for the onUserCreateStart event.| ## Response If successful, this method returns a `204 No Content` response code. If unsucces ### Example 1: Update the display name and priority of an authenticationEventsFlow #### Request-The following example shows a request that updates the display name of a specific external identities user flow (an authentication event type), as well as the priority for all the listeners associated with the policy. +The following example shows a request that updates the display name of a specific external identities user flow, as well as the priority for all the listeners associated with the policy. # [HTTP](#tab/http) <!-- { The following example shows the response. HTTP/1.1 204 No Content ``` -### Example 2: Update the onAttributeCollection event of a self-service sign up user flow +### Example 2: Update the page layout of a self-service sign up user flow -Add city (built-in attribute) as an attribute to be collected during the attribute collection step of a self-service sign up user flow. You must specify in the **inputs** object all attributes that you want to retain, otherwise they are removed from the user flow. +The following request updates the configuration of some of the attributes. All the attributes are marked as required; the email attribute is marked as hidden; the input type of the custom attribute is also updated to a radio button with two options. #### Request Content-Type: application/json "hidden": false, "editable": true, "writeToDirectory": true,- "required": false, + "required": true, "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$", "options": [] }, Content-Type: application/json "hidden": false, "editable": true, "writeToDirectory": true,- "required": false, + "required": true, "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$", "options": [] }, {- "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", - "label": "Favorite color", - "inputType": "text", + "attribute": "extension_331d514c0c18477583ea7dd5a79feda2_RockorCountry", + "label": "Rock music or Country", + "inputType": "radioSingleSelect", "defaultValue": null, "hidden": false, "editable": true, "writeToDirectory": true,- "required": false, + "required": true, "validationRegEx": "^.*",- "options": [] + "options": [ + { + "label": "Rock music", + "value": "Rock" + }, + { + "label": "Country music", + "value": "Country" + } + ] } ] } The following example shows the response. ``` http HTTP/1.1 204 No Content ```--### Example 3: Remove an attribute collected during a self-service sign up user flow --Remove city as an attribute to be collected during the attribute collection step of a self-service sign up user flow. By excluding the city attribute from the request body, the attribute is removed from the user flow. --#### Request --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "update_authenticationeventsflow_onattributecollection_beta_e3" -} >-``` http -PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", - "onAttributeCollection": { - "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp", - "attributeCollectionPage": { - "customStringsFileId": null, - "views": [ - { - "title": null, - "description": null, - "inputs": [ - { - "attribute": "email", - "label": "Email Address", - "inputType": "text", - "defaultValue": null, - "hidden": true, - "editable": false, - "writeToDirectory": true, - "required": true, - "validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$", - "options": [] - }, - { - "attribute": "displayName", - "label": "Display Name", - "inputType": "text", - "defaultValue": null, - "hidden": false, - "editable": true, - "writeToDirectory": true, - "required": false, - "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$", - "options": [] - }, - { - "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor", - "label": "Favorite color", - "inputType": "text", - "defaultValue": null, - "hidden": false, - "editable": true, - "writeToDirectory": true, - "required": false, - "validationRegEx": "^.*", - "options": [] - } - ] - } - ] - } - } -} -``` --# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) --# [JavaScript](#tab/javascript) --# [PHP](#tab/php) --# [PowerShell](#tab/powershell) --# [Python](#tab/python) ----#### Response --The following example shows the response. -<!-- { - "blockType": "response", - "truncated": true -} >-``` http -HTTP/1.1 204 No Content -``` - |
v1.0 | Authenticationmethod Resetpassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/authenticationmethod-resetpassword.md | In the request body, provide a JSON object with the following parameters. ## Response -If successful, this method returns a `202 Accepted` response code and a **Location** header with a URL to check the status of the reset operation. +If the caller provided a password in the request body, this method returns a `202 Accepted` response code and no response body. The response might also include a **Location** header with a URL to check the status of the [reset operation](longrunningoperation-get.md). -If the caller did not submit a password, a Microsoft-generated password is provided in a JSON object in the response body. +If the caller used the system-generated password option, this method returns a `202 Accepted` response code and a [passwordResetResponse](../resources/passwordresetresponse.md) object in the response body which contains a Microsoft-generated password. The response might also include a **Location** header with a URL to check the status of the [reset operation](longrunningoperation-get.md). ### Response headers The following example shows the response. <!-- { "blockType": "response",- "truncated": true, - "@odata.type": "microsoft.graph.entity" + "truncated": true } --> ```http HTTP/1.1 202 Accepted Content-type: application/json Location: https://graph.microsoft.com/beta/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/operations/88e7560c-9ebf-435c-8089-c3998ac1ec51?aadgdc=DUB02P&aadgsu=ssprprod-a -{} ``` <!-- uuid: 16cd6b66-4b1a-43a1-adaf-3a886856ed98 The following example shows the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.entity" + "@odata.type": "microsoft.graph.passwordResetResponse" } --> ```http |
v1.0 | B2cidentityuserflow List Userattributeassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-list-userattributeassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_list_userattributeassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-list-userattributeassignments-permissions.md)] + ## HTTP request <!-- { |
v1.0 | B2cidentityuserflow Post Userattributeassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2cidentityuserflow-post-userattributeassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2cidentityuserflow_post_userattributeassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/b2cidentityuserflow-post-userattributeassignments-permissions.md)] + ## HTTP request <!-- { |
v1.0 | B2xidentityuserflow List Userattributeassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-list-userattributeassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_list_userattributeassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-list-userattributeassignments-permissions.md)] + ## HTTP request <!-- { |
v1.0 | B2xidentityuserflow Post Userattributeassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/b2xidentityuserflow-post-userattributeassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "b2xidentityuserflow_post_userattributeassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/b2xidentityuserflow-post-userattributeassignments-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Backuprestoreroot List Driveprotectionunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-list-driveprotectionunits.md | Title: "List driveProtectionUnits" -description: "Get a list of the drive protection units that are associated with a OneDrive for Business protection policy." +description: "Get a list of the drive protection units that are associated with a OneDrive for work or school protection policy." ms.localizationpriority: medium Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /solutions/backupRestore/driveProtectionUnits +GET /solutions/backupRestore/protectionUnits/microsoft.graph.driveProtectionUnit GET /solutions/backupRestore/oneDriveForBusinessProtectionPolicies/{oneDriveForBusinessProtectionPolicyId}/driveProtectionUnits ``` Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [driveProtectionUnit](../resources/driveprotectionunit.md) in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Example 1: List all the driveProtectionUnits in a tenant The following example shows how to get a list of all the **driveProtectionUnits* #### Request The following example shows a request.+ # [HTTP](#tab/http) <!-- { "blockType": "request", The following example shows a request. } --> ``` http-GET /solutions/backupRestore/driveProtectionUnits +GET /solutions/backupRestore/protectionUnits/microsoft.graph.driveProtectionUnit ``` # [C#](#tab/csharp) The following example shows the response. HTTP/1.1 200 OK {- "@odata.nextLink": "https://graph.microsoft.com/betB8MTYxNjk2NDUwOTgzMg%3d%3d", + "@odata.nextLink": "https://graph.microsoft.com/betB8MTYxNjk2NDUwOTgzMg%3d%3d", "value": [ { "@odata.type": "#microsoft.graph.driveProtectionUnit", HTTP/1.1 200 OK } ``` -### Example 2: List the driveProtectionUnits associated with a OneDrive for Business protection policy +### Example 2: List the driveProtectionUnits associated with a OneDrive for work or school protection policy The following example shows how to list all the **driveProtectionUnits** associated with a **oneDriveForBusinessProtectionPolicy**. |
v1.0 | Backuprestoreroot List Mailboxprotectionunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-list-mailboxprotectionunits.md | Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /solutions/backupRestore/mailboxProtectionUnits +GET /solutions/backupRestore/protectionUnits/microsoft.graph.mailboxProtectionUnit GET /solutions/backupRestore/exchangeProtectionPolicies/{exchangeProtectionPolicyId}/mailboxProtectionUnits/ ``` Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [mailboxProtectionUnit](../resources/mailboxprotectionunit.md) in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Example 1: List all mailboxProtectionUnits in a tenant If successful, this method returns a `200 OK` response code and a [mailboxProtec #### Request The following example shows a request.+ # [HTTP](#tab/http) <!-- { "blockType": "request", The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/solutions/backupRestore/mailboxProtectionUnits +GET https://graph.microsoft.com/beta/solutions/backupRestore/protectionUnits/microsoft.graph.mailboxProtectionUnit ``` # [C#](#tab/csharp) The following example shows the response. HTTP/1.1 200 OK {- "@odata.nextLink": "https://graph.microsoft.com/betB8MTYxNjk2NDUwOTgzMg%3d%3d", + "@odata.nextLink": "https://graph.microsoft.com/betB8MTYxNjk2NDUwOTgzMg%3d%3d", "value": [ { "@odata.type": "#microsoft.graph.mailboxProtectionUnit", |
v1.0 | Backuprestoreroot List Restorepoints | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-list-restorepoints.md | Title: "List restorePoints" -description: "Get a list of the restorePoint objects and their properties." +description: "Get a list of restorePoint objects and their properties." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of the [restorePoint](../resources/restorepoint.md) objects and their properties. +Get a list of [restorePoint](../resources/restorepoint.md) objects and their properties. ++> **Note:** This API returns a maximum of five **restorePoint** objects. If you don't include the `orderBy` parameter, the five most recent restore points are returned. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Choose the permission or permissions marked as least privileged for this API. Us |Delegated (personal Microsoft account)|Not supported.|Not supported.| |Application|BackupRestore-Restore.Read.All|BackupRestore-Restore.ReadWrite.All| - ## HTTP request <!-- { GET /solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq ``` ## Optional query parameters-This method supports the `$expand` and `$filter` [OData puery parameters](/graph/query-parameters), as shown in the following [example](../api/backuprestoreroot-list-restorepoints.md#request). -The two query parameters are required. +This method supports the `$expand`, `$filter` and `orderBy` [OData query parameters](/graph/query-parameters), as shown in the [example](../api/backuprestoreroot-list-restorepoints.md#request) later in this topic. ++The `$expand` and `$filter` query parameters are required. ## Request headers Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [restorePoint](../resources/restorepoint.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Backuprestoreroot List Siteprotectionunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-list-siteprotectionunits.md | Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /solutions/backupRestore/siteProtectionUnits +GET /solutions/backupRestore/protectionUnits/microsoft.graph.siteProtectionUnit GET /solutions/backupRestore/sharePointProtectionPolicies/{sharePointProtectionPolicyId}/siteProtectionUnits ``` Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [siteProtectionUnit](../resources/siteprotectionunit.md) in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Example 1: List all the siteProtectionUnits in a tenant The following example shows how to get a list of all the **siteProtectionUnits** #### Request The following example shows a request.+ # [HTTP](#tab/http) <!-- { "blockType": "request", The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/solutions/backupRestore/siteProtectionUnits +GET https://graph.microsoft.com/beta/solutions/backupRestore/protectionUnits/microsoft.graph.siteProtectionUnit ``` # [C#](#tab/csharp) The following example shows the response. HTTP/1.1 200 OK {- "@odata.nextLink": "https://graph.microsoft.com/betB8MTYxNjk2NDUwOTgzMg%3d%3d", + "@odata.nextLink": "https://graph.microsoft.com/betB8MTYxNjk2NDUwOTgzMg%3d%3d", "value": [ { "@odata.type": "#microsoft.graph.siteProtectionUnit", |
v1.0 | Backuprestoreroot Post Exchangeprotectionpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-post-exchangeprotectionpolicies.md | In the request body, include a JSON representation of the [exchangeProtectionPol If successful, this method returns a `201 Created` response code and an [exchangeProtectionPolicy](../resources/exchangeprotectionpolicy.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Backuprestoreroot Post Exchangerestoresessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-post-exchangerestoresessions.md | You can specify the following properties when you create an **exchangeRestoreSes If successful, this method returns a `201 Created` response code and an [exchangeRestoreSession](../resources/exchangerestoresession.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Example 1: Create exchangeRestoreSession with mailboxRestoreArtifacts Content-Type: application/json ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-Type: application/json The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangerestoresession_create_granularmailboxrestoreartifacts" Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ #### Response The following example shows the response. |
v1.0 | Backuprestoreroot Post Onedriveforbusinessprotectionpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-post-onedriveforbusinessprotectionpolicies.md | You can specify the following properties when creating a **oneDriveForBusinessPr If successful, this method returns a `201 Created` response code and a [oneDriveForBusinessProtectionPolicy](../resources/onedriveforbusinessprotectionpolicy.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Backuprestoreroot Post Onedriveforbusinessrestoresessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-post-onedriveforbusinessrestoresessions.md | You can specify the following properties when you create a **oneDriveForBusiness If successful, this method returns a `201 Created` response code and a [oneDriveForBusinessRestoreSession](../resources/onedriveforbusinessrestoresession.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Backuprestoreroot Post Sharepointprotectionpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-post-sharepointprotectionpolicies.md | You can specify the following properties when creating a **sharePointProtectionP If successful, this method returns a `201 Created` response code and a [sharePointProtectionPolicy](../resources/sharepointprotectionpolicy.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Backuprestoreroot Post Sharepointrestoresessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/backuprestoreroot-post-sharepointrestoresessions.md | You can specify the following properties when you create a **sharePointRestoreSe If successful, this method returns a `201 Created` response code and a [sharePointRestoreSession](../resources/sharepointrestoresession.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Bitlocker List Recoverykeys | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bitlocker-list-recoverykeys.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "bitlocker_list_recoverykeys" } --> [!INCLUDE [permissions-table](../includes/permissions/bitlocker-list-recoverykeys-permissions.md)] -For delegated permissions to allow apps to get **bitLockerRecoveryKey** resources on behalf of the signed-in user, the user must be the registered owner of the device that the BitLocker recovery key was originally backed up from, or the calling user must be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). --* Cloud Device Administrator -* Helpdesk Administrator -* Intune Service Administrator -* Security Administrator -* Security Reader -* Global Reader +> [!IMPORTANT] +> For delegated permissions, the calling user must be the registered owner of the device that the BitLocker recovery key was originally backed up from, or they must be assigned a supported [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).The following least privileged roles are supported for this operation. +> +> - Cloud device administrator +> - Helpdesk administrator +> - Intune service administrator +> - Security administrator +> - Security reader +> - Global reader ## HTTP request To get a list of BitLocker keys within the tenant: |
v1.0 | Bitlockerrecoverykey Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bitlockerrecoverykey-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "bitlockerrecoverykey_get" } --> [!INCLUDE [permissions-table](../includes/permissions/bitlockerrecoverykey-get-permissions.md)] ->**Note:** For delegated permissions to allow apps to get **bitLockerRecoveryKey** resources on behalf of the signed-in user, the tenant administrator must have assigned the user one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json), or the user must be the **registered owner** of the device that the BitLocker key was originally backed up from: --* Cloud Device Administrator -* Helpdesk Administrator -* Intune Service Administrator -* Security Administrator -* Security Reader -* Global Reader +> [!IMPORTANT] +> For delegated permissions, the calling user must be the registered owner of the device that the BitLocker recovery key was originally backed up from, or they must be assigned a supported [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).The following least privileged roles are supported for this operation. +> +> - Cloud device administrator +> - Helpdesk administrator +> - Intune service administrator +> - Security administrator +> - Security reader +> - Global reader ## HTTP request To get the specified BitLocker key without returning the **key** property: |
v1.0 | Bookingappointment Cancel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-cancel.md | POST /solutions/bookingBusinesses/{id}/appointments/{id}/cancel | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingappointment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-delete.md | DELETE /solutions/bookingBusinesses/{id}/appointments/{id} | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingappointment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingappointment-get.md | This method supports the [OData query parameters](/graph/query-parameters) to he | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingbusiness Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-delete.md | DELETE /solutions/bookingBusinesses/{id} ## Request headers | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingbusiness Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-get.md | This method supports the [OData Query Parameters](/graph/query-parameters) to he | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingbusiness List Calendarview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-calendarview.md | This method also supports some of the [OData query parameters](/graph/query-para | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingbusiness List Customers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list-customers.md | This method supports the [OData query parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingbusiness List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-list.md | This method also supports the `query` parameter which accepts a string value. Th ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingbusiness Post Bookingbusinesses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-post-bookingbusinesses.md | POST /solutions/bookingbusinesses ## Request headers | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body In the request body, supply a JSON representation of [bookingBusiness](../resources/bookingbusiness.md) object. |
v1.0 | Bookingbusiness Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-publish.md | POST /solutions/bookingbusinesses/{id}/publish ## Request headers | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingbusiness Unpublish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-unpublish.md | POST /solutions/bookingbusinesses/{id}/unpublish ## Request headers | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingbusiness Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingbusiness-update.md | PATCH /solutions/bookingbusinesses/{id} ## Optional request headers | Name | Description| |:--|:--|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed. |
v1.0 | Bookingcurrency Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcurrency-get.md | This method supports the [OData Query Parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingcurrency List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcurrency-list.md | This method supports the [OData Query Parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingcustomer Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-delete.md | DELETE /solutions/bookingbusinesses/{id}/customers/{id} | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingcustomer Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-get.md | This method supports the [OData query parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingcustomer Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingcustomer-update.md | PATCH /solutions/bookingbusinesses/{id}/customers/{id} | Name | Description| |:--|:--|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body [!INCLUDE [table-intro](../../includes/update-property-table-intro.md)] |
v1.0 | Bookingservice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingservice-delete.md | DELETE /solutions/bookingbusinesses/{id}/services/{id} ## Request headers | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingstaffmember Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-delete.md | DELETE /solutions/bookingbusinesses/{id}/staffMembers/{id} ## Request headers | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Bookingstaffmember Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/bookingstaffmember-get.md | This method supports the [OData query parameters](/graph/query-parameters) to he | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Businessscenarioplanner Delete Tasks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/businessscenarioplanner-delete-tasks.md | DELETE /solutions/businessScenarios/{businessScenarioId}/planner/tasks/{business |Name|Description| |:|:| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|+| If-Match | Last known ETag value for the **businessScenarioTask** to be updated. Required.| ## Request body The following example shows a request. --> ``` http DELETE https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks/pmc1rS1Io0C3rXQhyXIsNmUAOeIi+If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=" ``` # [C#](#tab/csharp) |
v1.0 | Businessscenariotask Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/businessscenariotask-update.md | PATCH /solutions/businessScenarios/{businessScenarioId}/planner/tasks/{businessS |:|:| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| |Content-Type|application/json. Required.|+| If-Match | Last known ETag value for the **businessScenarioTask** to be updated. Required.| ## Request body The following example shows a request. ``` http PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/tasks/pmc1rS1Io0C3rXQhyXIsNmUAOeIi Content-Type: application/json+If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=" { "title": "Customer order #12010", |
v1.0 | Calendar Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calendar-permanentdelete.md | + + Title: "calendar: permanentDelete" +description: "Permanently delete a calendar folder and the events that it contains and remove them from the mailbox." ++ms.localizationpriority: high ++++# calendar: permanentDelete ++Namespace: microsoft.graph +++Permanently delete a calendar folder and the events that it contains and remove them from the mailbox. For more information about item retention, see [Configure Deleted Item retention and Recoverable Items quotas](/exchange/configure-deleted-item-retention-and-recoverable-items-quotas-exchange-2013-help). ++>**Note:** Folders aren't placed in the Purges folder when they are permanently deleted. Permanently deleted folders are removed from the mailbox. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "calendar_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/calendar/permanentDelete +POST /groups/{groupsId}/calendar/permanentDelete +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "calendarthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/calendar/permanentDelete +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Call Answer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/call-answer.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Enable a bot to answer an incoming [call](../resources/call.md). The incoming call request can be an invite from a participant in a group call or a peer-to-peer call. If an invite to a group call is received, the notification contains the [chatInfo](../resources/chatinfo.md) and [meetingInfo](../resources/meetinginfo.md) parameters. +Enable a bot to answer an incoming [call](../resources/call.md). The incoming call request can be an invitation from a participant in a group call or a peer-to-peer call. If an invitation to a group call is received, the notification contains the [chatInfo](../resources/chatinfo.md) and [meetingInfo](../resources/meetinginfo.md) parameters. The bot is expected to answer, [reject](./call-reject.md) or [redirect](./call-redirect.md) the call before the call times out. The current timeout value is 15 seconds. The current timeout value is 15 seconds for regular scenarios, and 5 seconds for policy-based recording scenarios. +This API supports the following PSTN scenarios: +++ Incoming call to bot's PSTN number and then bot invites another PSTN.++ Incoming call to bot's PSTN number and then bot transfer to another PSTN.++ Incoming call to bot's PSTN number and then bot redirects to another PSTN.++ Incoming call to bot's instance identifier and then bot invites another PSTN.++ Incoming call to bot's instance identifier and then bot transfer to another PSTN.++ Incoming call to bot's instance identifier and then bot redirects to another PSTN.++ Incoming call to bot's instance identifier from Scheduled Meeting and then bot invites PSTN.++ Outgoing call from bot (with instance identifier) to a PSTN.++ P2P call between bot and another peer (Teams user, PSTN), bot invites another PSTN.++ P2P call between bot and another peer (Teams user, PSTN), bot invites another Teams user.++ Bot join the scheduled meeting and then invite PSTN.+ [!INCLUDE [national-cloud-support](../../includes/global-only.md)] ## Permissions Content-Length: 211 ], "callOptions": { "@odata.type": "#microsoft.graph.incomingCallOptions",- "isContentSharingNotificationEnabled": true + "isContentSharingNotificationEnabled": true, + "isDeltaRosterEnabled": true }, "participantCapacity": 200 } |
v1.0 | Callrecording Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/callrecording-delta.md | Namespace: microsoft.graph Get a set of [callRecording](../resources/callrecording.md) resources added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user. -Delta query supports both full synchronization that gets all the recordings for online meetings organized by the user, and incremental synchronization that gets recordings added since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that recording view periodically. +Delta query supports both full synchronization that gets all the recordings for online meetings organized by the user, and incremental synchronization that gets recordings added since the last synchronization. Typically, you do an initial full synchronization, and then get incremental changes to that recording view periodically. -A GET request with the delta function returns either: +A GET request with the delta function returns one of the following: -- A `@odata.nextLink` (that contains a URL with a **delta** function call and a `skipToken`), or-- A `@odata.deltaLink` (that contains a URL with a **delta** function call and `deltaToken`).+- An **@odata.nextLink** that contains a URL with a **delta** function call and a `skipToken`. +- An **@odata.deltaLink** that contains a URL with a **delta** function call and a `deltaToken`. -State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL returned from the last GET request to the next **delta** function call for that same recording view. A `@odata.deltaLink` returned in a response signifies that the current round of change tracking is complete. You can save and use the `@odata.deltaLink` URL when you start the next round of synchronization to get the new recordings added after acquiring `@odata.deltaLink`. +State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the **@odata.nextLink** or **@odata.deltaLink** URL returned from the last GET request to the next **delta** function call for that same recording view. An **@odata.deltaLink** returned in a response signifies that the current round of change tracking is complete. You can save and use the **@odata.deltaLink** URL when you start the next round of synchronization to get the new recordings added after you acquire **@odata.deltaLink**. For more information, see the [delta query](/graph/delta-query-overview) documentation. For more information, see the [delta query](/graph/delta-query-overview) documen The following known issues are associated with this API: -- [Using the `$top` query parameter might not return the @odata.nextLink](https://developer.microsoft.com/en-us/graph/known-issues/?search=22931).+- [Using the `$top` query parameter might not return the **@odata.nextLink**](https://developer.microsoft.com/en-us/graph/known-issues/?search=22931). - [Transcript URLs might not include any content](https://developer.microsoft.com/en-us/graph/known-issues/?search=22932). - [Recordings aren't exported for meetings that don't have transcription turned on](https://developer.microsoft.com/en-us/graph/known-issues/?search=22933). - [Delta queries might return older artifacts when meetings have unrelated changes](https://developer.microsoft.com/en-us/graph/known-issues/?search=22934). Choose the permission or permissions marked as least privileged for this API. Us ``` http GET /users/{usersId}/onlineMeetings/getAllRecordings(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta ```->**Note:** If you don't pass the function parameter **meetingOrganizerUserId**, the request fails. +>**Note:** The request fails if you don't pass the function parameter **meetingOrganizerUserId**. ## Query parameters -Tracking changes in call recordings incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltatoken` and `$skiptoken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. +Tracking changes in call recordings incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltaToken` and `$skipToken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the **@odata.nextLink** or **@odata.deltaLink** URL provided in the response. -In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response, as that URL already includes the encoded parameters. +In subsequent requests, copy and apply the **@odata.nextLink** or **@odata.deltaLink** URL from the previous response, as that URL already includes the encoded parameters. | Query parameter | Type |Description| |:|:--|:-|-| `$deltatoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL including this token in the first request of the next round of change tracking for that collection.| -| `$skiptoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating that there are further changes to be tracked. | -| `$top` | integer | Allows the caller to specify the maximum number of objects per page. | +| `$deltaToken` | String | A [state token](/graph/delta-query-overview) returned in the **@odata.deltaLink** URL of the previous **delta** function call that indicates the completion of that round of change tracking. Save and apply the entire **@odata.deltaLink** URL including this token in the first request of the next round of change tracking for that collection.| +| `$skipToken` | String | A [state token](/graph/delta-query-overview) returned in the **@odata.nextLink** URL of the previous **delta** function call that indicates that there are further changes to be tracked. | +| `$top` | Integer | Allows the caller to specify the maximum number of objects per page. | ## Request headers In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLin ## Response -If successful, this method returns a `200 OK` response code and a collection of [callRecording](../resources/callrecording.md) objects in the response body. The response also includes an `@odata.nextLink` URL or an `@odata.deltaLink` URL. +If successful, this method returns a `200 OK` response code and a collection of [callRecording](../resources/callrecording.md) objects in the response body. The response also includes an **@odata.nextLink** URL or an **@odata.deltaLink** URL. ## Examples If successful, this method returns a `200 OK` response code and a collection of The following example shows a series of three requests to synchronize the call recordings available for all the online meetings organized by the user. - Step 1: [initial request](#initial-request) and [response](#initial-response).-- Step 2: [second request](#second-request) and [response](#second-response)+- Step 2: [second request](#second-request) and [response](#second-response). - Step 3: [third request](#third-request) and [final response](#third-and-final-response-for-the-round). -See also what you'll do in the [next round to get more recordings](#example-2-next-round-to-get-more-recordings). +See also what you do in the [next round to get more recordings](#example-2-next-round-to-get-more-recordings). #### Initial request -In this example, the call recordings are being synchronized for the first time, so the initial sync request doesn't include any state token. This round returns all recordings available at the time. +In this example, the call recordings synchronize for the first time and the initial sync request doesn't include any state token. This round returns all recordings available at the time. <!-- { "blockType": "ignored" } --> ```http GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/ #### Initial response -The response includes two call recordings and a `@odata.nextLink` response header with a `skipToken`. The `@odata.nextLink` URL indicates there are more call recordings to retrieve. +The response includes two call recordings and an **@odata.nextLink** response header with a `skipToken`. The **@odata.nextLink** URL indicates that more call recordings are available to retrieve. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callRecording", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callRecording)" } --> ```http HTTP/1.1 200 OK Content-type: application/json #### Second request -The second request specifies the `@odata.nextLink` URL returned from the previous response. Notice that it no longer has to specify the same query parameters as in the initial request, as the `skipToken` in the `@odata.nextLink` URL encodes and includes them. +The second request specifies the **@odata.nextLink** URL returned from the previous response. Notice that it no longer has to specify the same query parameters as in the initial request, as the `skipToken` in the **@odata.nextLink** URL encodes and includes them. <!-- { "blockType": "ignored" } --> ```http $skiptoken={skipToken1} #### Second response -The second response returns one or more next call recordings and a `@odata.nextLink` property with a `skipToken`, which indicates there are more recordings. +The second response returns one or more next call recordings and an **@odata.nextLink** property with a `skipToken` that indicates that more recordings are available. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callRecording", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callRecording)" } --> ```http HTTP/1.1 200 OK Content-type: application/json #### Third request -The third request continues to use the latest `@odata.nextLink` returned from the last sync request. +The third request continues to use the latest **@odata.nextLink** returned from the last sync request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2} +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2} ``` #### Third and final response for the round -The third response returns the only remaining recordings and a `@odata.deltaLink` property with a `deltaToken`, which indicates that all recordings are returned. Save and use the `@odata.deltaLink` URL to query for any new recording that is added from this point onwards. +The third response returns the only remaining recordings and an **@odata.deltaLink** property with a `deltaToken` that indicates that all recordings are returned. Save and use the **@odata.deltaLink** URL to query for any new recording that is added from this point onwards. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callRecording", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callRecording)" } --> ```http HTTP/1.1 200 OK Content-type: application/json ### Example 2: Next round to get more recordings -Using the `@odata.deltaLink` from the last request in the last round, you can get only those recordings added since the `@odata.deltaLink` was acquired. +Using the **@odata.deltaLink** from the last request in the last round, you can get only those recordings added since the **@odata.deltaLink** was acquired. #### Request The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1} +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1} ``` #### Response The following example shows the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callRecording", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callRecording)" } --> ```http HTTP/1.1 200 OK |
v1.0 | Callrecords Callrecord Getpstncalls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/callrecords-callrecord-getpstncalls.md | Namespace: microsoft.graph.callRecords [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get log of PSTN calls as a collection of [pstnCallLogRow](../resources/callrecords-pstncalllogrow.md) entries. +Get a log of PSTN calls as a collection of [pstnCallLogRow](../resources/callrecords-pstncalllogrow.md) entries. ++> [!NOTE] +> This API doesn't return information for **Telstra** or **Softbank** calling plans. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] If there are more than 1,000 entries in the date range, the body also includes a ## Example -The following example shows how to get a collection of records for PSTN calls that occurred in the specified date range. The response includes `"@odata.count": 1000` to enumerate the number of records in this first response, and `@odata.nextLink` to get records beyond the first 1,000. For readability, the response shows only a collection of 1 record. Please assume there are more than 1,000 calls in that date range. +The following example shows how to get a collection of records for PSTN calls that occurred in the specified date range. The response includes `"@odata.count": 1000` to enumerate the number of records in this first response, and `@odata.nextLink` to get records beyond the first 1,000. For readability, the response shows only a collection of one record. Assume there are more than 1,000 calls in that date range. ### Request The following example shows a request. HTTP/1.1 200 OK - [Get aggregated report of the audio conferencing dial-out](callrecords-callrecord-getpstnonlinemeetingdialoutreport.md) - [Get log of users who are blocked from making PSTN calls](callrecords-callrecord-getpstnblockeduserslog.md) - [Get log of sent/received SMS](callrecords-callrecord-getsmslog.md)-- [Get log of direct routing calls](callrecords-callrecord-getdirectroutingcalls.md)+- [Get log of Direct Routing calls](callrecords-callrecord-getdirectroutingcalls.md) - [Microsoft Teams PSTN usage report](/microsoftteams/teams-analytics-and-reports/pstn-usage-report) <!-- { |
v1.0 | Calltranscript Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calltranscript-delta.md | Namespace: microsoft.graph Get a set of [callTranscript](../resources/calltranscript.md) resources added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user. -Delta query supports both full synchronization that gets all the transcripts for online meetings organized by the user, and incremental synchronization that gets transcripts added since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that transcript view periodically. +Delta query supports both full synchronization that gets all the transcripts for online meetings organized by the user, and incremental synchronization that gets transcripts added since the last synchronization. Typically, you do an initial full synchronization, and then get incremental changes to that transcript view periodically. -A GET request with the delta function returns either: +A GET request with the delta function returns one of the following: -- A `@odata.nextLink` (that contains a URL with a **delta** function call and a `skipToken`), or-- A `@odata.deltaLink` (that contains a URL with a **delta** function call and `deltaToken`).+- An **@odata.nextLink** that contains a URL with a **delta** function call and a `skipToken`. +- An **@odata.deltaLink** that contains a URL with a **delta** function call and a `deltaToken`. -State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL returned from the last GET request to the next **delta** function call for that same transcript view. A `@odata.deltaLink` returned in a response signifies that the current round of change tracking is complete. You can save and use the `@odata.deltaLink` URL when you start the next round of synchronization to get the new transcripts added after acquiring `@odata.deltaLink`. +State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the **@odata.nextLink** or **@odata.deltaLink** URL returned from the last GET request to the next **delta** function call for that same transcript view. An **@odata.deltaLink** returned in a response signifies that the current round of change tracking is complete. You can save and use the **@odata.deltaLink** URL when you start the next round of synchronization to get the new transcripts added after you acquire **@odata.deltaLink**. For more information, see the [delta query](/graph/delta-query-overview) documentation. For more information, see the [delta query](/graph/delta-query-overview) documen The following known issues are associated with this API: -- [Using the `$top` query parameter might not return the @odata.nextLink](https://developer.microsoft.com/en-us/graph/known-issues/?search=22931).+- [Using the `$top` query parameter might not return the **@odata.nextLink**](https://developer.microsoft.com/en-us/graph/known-issues/?search=22931). - [Delta queries might return older artifacts when meetings have unrelated changes](https://developer.microsoft.com/en-us/graph/known-issues/?search=22934). ## Permissions Choose the permission or permissions marked as least privileged for this API. Us ``` http GET /users/{usersId}/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta ```->**Note:** If you don't pass the function parameter **meetingOrganizerUserId**, the request fails. +>**Note:** The request fails if you don't pass the function parameter **meetingOrganizerUserId**. ## Query parameters -Tracking changes in call transcripts incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltatoken` and `$skiptoken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. +Tracking changes in call transcripts incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltaToken` and `$skipToken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the **@odata.nextLink** or **@odata.deltaLink** URL provided in the response. -In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response, as that URL already includes the encoded parameters. +In subsequent requests, copy and apply the **@odata.nextLink** or **@odata.deltaLink** URL from the previous response, as that URL already includes the encoded parameters. | Query parameter | Type |Description| |:|:--|:-|-| `$deltatoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL including this token in the first request of the next round of change tracking for that collection.| -| `$skiptoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating that there are further changes to be tracked. | -| `$top` | integer | Allows the caller to specify the maximum number of objects per page. | +| `$deltaToken` | String | A [state token](/graph/delta-query-overview) returned in the **@odata.deltaLink** URL of the previous **delta** function call that indicates the completion of that round of change tracking. Save and apply the entire **@odata.deltaLink** URL including this token in the first request of the next round of change tracking for that collection.| +| `$skipToken` | String | A [state token](/graph/delta-query-overview) returned in the **@odata.nextLink** URL of the previous **delta** function call that indicates that there are further changes to be tracked. | +| `$top` | Integer | Allows the caller to specify the maximum number of objects per page. | ## Request headers In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLin ## Response -If successful, this method returns a `200 OK` response code and a collection of [callTranscript](../resources/calltranscript.md) objects in the response body. The response also includes an `@odata.nextLink` URL or an `@odata.deltaLink` URL. +If successful, this method returns a `200 OK` response code and a collection of [callTranscript](../resources/calltranscript.md) objects in the response body. The response also includes an **@odata.nextLink** URL or an **@odata.deltaLink** URL. ## Examples If successful, this method returns a `200 OK` response code and a collection of The following example shows a series of three requests to synchronize the call transcripts available for all the online meetings organized by the user. - Step 1: [initial request](#initial-request) and [response](#initial-response).-- Step 2: [second request](#second-request) and [response](#second-response)+- Step 2: [second request](#second-request) and [response](#second-response). - Step 3: [third request](#third-request) and [final response](#third-and-final-response-for-the-round). -See also what you'll do in the [next round to get more transcripts](#example-2-next-round-to-get-more-transcripts). +See also what you do in the [next round to get more transcripts](#example-2-next-round-to-get-more-transcripts). #### Initial request -In this example, the call transcripts are being synchronized for the first time, so the initial sync request doesn't include any state token. This round returns all transcripts available at the time. +In this example, the call transcripts synchronize for the first time and the initial sync request doesn't include any state token. This round returns all transcripts available at the time. <!-- { "blockType": "ignored" } --> ```http GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/ #### Initial response -The response includes two call transcripts and a `@odata.nextLink` response header with a `skipToken`. The `@odata.nextLink` URL indicates there are more call transcripts to retrieve. +The response includes two call transcripts and an **@odata.nextLink** response header with a `skipToken`. The **@odata.nextLink** URL indicates that more call transcripts are available to retrieve. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callTranscript", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callTranscript)" } --> ```http HTTP/1.1 200 OK Content-type: application/json #### Second request -The second request specifies the `@odata.nextLink` URL returned from the previous response. Notice that it no longer has to specify the same query parameters as in the initial request, as the `skipToken` in the `@odata.nextLink` URL encodes and includes them. +The second request specifies the **@odata.nextLink** URL returned from the previous response. Notice that it no longer has to specify the same query parameters as in the initial request, as the `skipToken` in the **@odata.nextLink** URL encodes and includes them. <!-- { "blockType": "ignored" } --> ```http $skiptoken={skipToken1} #### Second response -The second response returns one or more next call transcripts and a `@odata.nextLink` property with a `skipToken`, which indicates there are more transcripts. +The second response returns one or more next call transcripts and an **@odata.nextLink** property with a `skipToken` that indicates that more transcripts are available. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callTranscript", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callTranscript)" } --> ```http HTTP/1.1 200 OK Content-type: application/json #### Third request -The third request continues to use the latest `@odata.nextLink` returned from the last sync request. +The third request continues to use the latest **@odata.nextLink** returned from the last sync request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2} +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2} ``` #### Third and final response for the round -The third response returns the only remaining transcripts and a `@odata.deltaLink` property with a `deltaToken`, which indicates that all transcripts are returned. Save and use the `@odata.deltaLink` URL to query for any new transcript that is added from this point onwards. +The third response returns the only remaining transcripts and an **@odata.deltaLink** property with a `deltaToken` that indicates that all transcripts are returned. Save and use the **@odata.deltaLink** URL to query for any new transcript that is added from this point onwards. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callTranscript", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callTranscript)" } --> ```http HTTP/1.1 200 OK Content-type: application/json ### Example 2: Next round to get more transcripts -Using the `@odata.deltaLink` from the last request in the last round, you can get only those transcripts added since the `@odata.deltaLink` was acquired. +Using the **@odata.deltaLink** from the last request in the last round, you can get only those transcripts added since the **@odata.deltaLink** was acquired. #### Request The following example shows a request. <!-- { "blockType": "ignored" } --> ```http-GET https://graph.microsoft.com/beta/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1} +GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1} ``` #### Response The following example shows the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.callTranscript", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callTranscript)" } --> ```http HTTP/1.1 200 OK |
v1.0 | Calltranscript Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/calltranscript-get.md | The following example shows how to get a single transcript of an online meeting The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_callTranscript_using_contentCorrelationId", The following example shows a request. GET https://graph.microsoft.com/betFkLTRmOTUtODA4My0xYjdmOTliM2VkZWIqMCoqMTk6bWVldGluZ19OV1EwWm1GbFpEY3RORFJqTmkwMFlXRm1MV0U1WXpBdE9UZzJNMk0yTm1Nd1pERTNAdGhyZWFkLnYy/transcripts?$filter=contentcorrelationId+eq+'e87c8cf8-50f7-4252-8b9c-ad08ac0fa88d-0' ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ #### Response The following example shows the response. |
v1.0 | Channel Delete Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-delete-tabs.md | Title: "Delete tab from channel" description: "Removes (unpins) a tab from the specified channel within a team. "-+ ms.localizationpriority: medium doc_type: apiPageType Removes (unpins) a tab from the specified [channel](../resources/channel.md) wit ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_delete_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-delete-tabs-permissions.md)] |
v1.0 | Channel Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-delete.md | Title: "Delete channel" description: "Delete the channel."-+ ms.localizationpriority: medium doc_type: apiPageType Delete the [channel](../resources/channel.md). ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-delete-permissions.md)] |
v1.0 | Channel Get Filesfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-get-filesfolder.md | Title: "Get filesFolder" description: "Retrieve the filesFolder navigation path of a channel."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | Channel Get Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-get-tabs.md | Title: "Get tab in channel" description: "Retrieve the properties and relationships of the specified tab in a channel within a team. "-+ ms.localizationpriority: medium doc_type: apiPageType Retrieve the properties and relationships of the specified [tab](../resources/te ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_get_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-get-tabs-permissions.md)] |
v1.0 | Channel Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-get.md | Title: "Get channel" description: "Retrieve the properties and relationships of a channel."-+ doc_type: apiPageType ms.localizationpriority: medium |
v1.0 | Channel Getallretainedmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-getallretainedmessages.md | Title: "channel: getAllRetainedMessages" -description: "Get retained messages across all channels in a team." +description: "Get all retained messages across all channels in a team." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get retained [messages](../resources/chatmessage.md) across all [channels](../resources/channel.md) in a [team](../resources/team.md). +Get all retained [messages](../resources/chatmessage.md) across all [channels](../resources/channel.md) in a [team](../resources/team.md). To learn more about how to use the Microsoft Teams export APIs to export content, see [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content). |
v1.0 | Channel List Messages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-list-messages.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/channel-list-messages-permissions.md)] > [!NOTE]-> - The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). -> - The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> - The `ChannelMessage.Read.Group` permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). +> - The `Group.Read.All` and `Group.ReadWrite.All` permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. ## HTTP request This method supports the following [OData query parameters](/graph/query-paramet The other [OData query parameters](/graph/query-parameters) aren't currently supported. -> **Note:** [GET /teams/{team-id}/channels/{channel-id}/messages/delta](chatmessage-delta.md) supports filtering by date, which provides similar data to GET /teams/{team-id}/channels/{channel-id}/messages . - ## Request headers | Header | Value | Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [chatMessage](../resources/chatmessage.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [chatMessage](../resources/chatmessage.md) objects in the response body. The channel messages in the response are sorted by the last modified date of the entire reply chain, including both the root channel message and its replies. ## Examples GET https://graph.microsoft.com/beta/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/ #### Response The following response shows one channel message on the page, and includes a URL in `@odata.nextLink` for a subsequent operation to get the next message in that channel. -The response includes replies of that channel message. In practice, this operation can return up to 1,000 replies of a channel message, and includes a URL in `replies@odata.nextLink` to get any further replies beyond the page size of 1000. This example assumes more than 1,000 replies in that channel message, but for readability, the following response shows only three replies. +The response includes replies of that channel message. In practice, this operation can return up to 1,000 replies of a channel message, and includes a URL in `replies@odata.nextLink` to get any further replies beyond the page size of 1,000. This example assumes more than 1,000 replies in that channel message, but for readability, the following response shows only three replies. <!-- { "blockType": "response", |
v1.0 | Channel List Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-list-tabs.md | Title: "List tabs in channel" description: "Retrieve the list of tabs in the specified channel within a team. "-+ ms.localizationpriority: medium doc_type: apiPageType Retrieve the list of [tabs](../resources/teamstab.md) in the specified [channel] ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_list_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-list-tabs-permissions.md)] |
v1.0 | Channel Patch Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-patch-tabs.md | Title: "Update tab" description: "Update the properties of the specified tab."-+ ms.localizationpriority: medium doc_type: apiPageType This API can be used to configure the content of the tab. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_patch_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-patch-tabs-permissions.md)] |
v1.0 | Channel Patch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-patch.md | Update the properties of the specified [channel](../resources/channel.md). Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_patch" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-patch-permissions.md)] |
v1.0 | Channel Post Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post-tabs.md | Title: "Add tab to channel" description: "Add (pin) a tab to the specified channel within a team. "-+ ms.localizationpriority: medium doc_type: apiPageType Add (pin) a [tab](../resources/teamstab.md) to the specified [channel](../resour Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_post_tabs" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-tabs-permissions.md)] |
v1.0 | Channel Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/channel-post.md | You can add a maximum of 200 members when you create a private channel. Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they aren't a member of. <!-- { "blockType": "permissions", "name": "channel_post" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-permissions.md)] |
v1.0 | Chat Getallretainedmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-getallretainedmessages.md | Title: "chat: getAllRetainedMessages" -description: "Get retained messages from all chats that a user is a participant in, including one-on-one chats, group chats, and meeting chats." +description: "Get all retained messages from all chats that a user is a participant in, including one-on-one chats, group chats, and meeting chats." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get all retained messages from all [chats](../resources/chatmessage.md) that a user is a participant in, including one-on-one chats, group chats, and meeting chats. +Get all retained [messages](../resources/chatmessage.md) from all [chats](../resources/chat.md) that a user is a participant in, including one-on-one chats, group chats, and meeting chats. To learn more about how to use the Microsoft Teams export APIs to export content, see [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content). The following table lists examples that show how to use the `$filter` parameter. |Scenario | `$filter` parameter |Possible values | |:--|:|:--|-|Get messages sent by user identity type |$filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' |aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser| -|Get messages sent by application type |$filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}' |aadApplication, bot, tenantBot, office365Connector, outgoingWebhook | +|Get messages sent by user identity type |$filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' |`aadUser`, `onPremiseAadUser`, `anonymousGuest`, `federatedUser`, `personalMicrosoftAccountUser`, `skypeUser`, `phoneUser`| +|Get messages sent by application type |$filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}' |`aadApplication`, `bot`, `tenantBot`, `office365Connector`, `outgoingWebhook` | |Get messages sent by user ID |$filter=from/user/id eq '{oid}' || |Get control (system event) messages |$filter=messageType eq 'systemEventMessage' || |Exclude control (system event) messages |$filter=messageType ne 'systemEventMessage' || |
v1.0 | Chat Post Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chat-post-tabs.md | Title: "Add tab to chat" description: "Adds (pins) a tab to the specified chat. "-+ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Chatmessage Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-delta.md | Title: "chatMessage: delta" -description: "Retrieve the list of messages (without the replies) in a channel of a team. By using delta query, you can get new or updated messages in a channel." +description: "Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats." ms.localizationpriority: high doc_type: apiPageType-+ Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the list of [messages](../resources/chatmessage.md) (without the replies) in a [channel](../resources/channel.md) of a [team](../resources/team.md). By using delta query, you can get new or updated messages in a channel. +Get the list of [messages](../resources/chatmessage.md) from all [chats](../resources/chat.md) in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can obtain new or updated messages. -> **Note:** Delta will only return messages within the last eight months. You can use [GET /teams/{team-id}/channels/{channel-id}/messages](channel-list-messages.md) to retrieve older messages. +> **Note:** Delta only returns messages within the last eight months. You can use [GET /users/{id | user-principal-name}/chats/getAllMessages](chats-getallmessages.md) to retrieve older messages. +Delta query supports both full synchronization that gets all the messages from all chats in which a user is a participant, and incremental synchronization that gets messages added or changed since the last synchronization. Typically, you do an initial full synchronization, and then get incremental changes to that messages view periodically. -Delta query supports both full synchronization that retrieves all the messages in the specified channel, and incremental synchronization that retrieves those messages that have been added or changed in the channel since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that messages view periodically. +To get the replies for a message, use the [list message replies](chatmessage-list-replies.md) or the [get message reply](chatmessage-get.md) operations. -To get the replies for a message, use the [list message replies](chatmessage-list-replies.md) or the [get message reply](chatmessage-get.md) operation. +A GET request with the delta function returns one of the following: -A GET request with the delta function returns either: +- An **@odata.nextLink** that contains a URL with a **delta** function call and a `skipToken`. +- An **@odata.deltaLink** that contains a URL with a **delta** function call and a `deltaToken`. -- A `@odata.nextLink` (that contains a URL with a **delta** function call and a `skipToken`), or-- A `@odata.deltaLink` (that contains a URL with a **delta** function call and `deltaToken`).--State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL returned from the last GET request to the next delta function call for that same calendar view. A `@odata.deltaLink` returned in a response signifies that the current round of change tracking is complete. You can save and use the `@odata.deltaLink` URL when you begin the to retrieve additional changes (messages changed or posted after acquiring `@odata.deltaLink`). +State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the **@odata.nextLink** or **@odata.deltaLink** URL returned from the last GET request to the next **delta** function call. An **@odata.deltaLink** returned in a response signifies that the current round of change tracking is complete. You can save and use the **@odata.deltaLink** URL when you begin to retrieve more changes (messages changed or posted after you acquire **@odata.deltaLink**). For more information, see the [delta query](/graph/delta-query-overview) documentation. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "chatmessage_delta" } --> [!INCLUDE [permissions-table](../includes/permissions/chatmessage-delta-permissions.md)] -> [!NOTE] -> - The ChannelMessage.Read.Group permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). -> - The Group.Read.All and Group.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. - ## HTTP request+ <!-- { "blockType": "ignored" } --> ```http-GET /teams/{team-id}/channels/{channel-id}/messages/delta +GET /users/{id | user-principal-name}/chats/getAllMessages/delta ``` ## Query parameters -Tracking changes in channel messages incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltatoken` and `$skiptoken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. +Tracking changes in messages incurs a round of one or more **delta** function calls. If you use any query parameter (other than `$deltatoken` and `$skiptoken`), you must specify it in the initial **delta** request. Microsoft Graph automatically encodes any specified parameters into the token portion of the **@odata.nextLink** or **@odata.deltaLink** URL provided in the response. -You only need to specify any query parameters once upfront. +You only need to specify query parameters once. -In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response, as that URL already includes the encoded parameters. +In subsequent requests, copy and apply the **@odata.nextLink** or **@odata.deltaLink** URL from the previous response, as that URL already includes the encoded parameters. | Query parameter | Type |Description| |:|:--|:-|-| `$deltatoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL including this token in the first request of the next iteration of change tracking for that collection.| -| `$skiptoken` | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating that there are further changes to be tracked. | +| `$deltatoken` | String | A [state token](/graph/delta-query-overview) returned in the **@odata.deltaLink** URL of the previous **delta** function call that indicates that the completion of that round of change tracking. Save and apply the entire **@odata.deltaLink** URL including this token in the first request of the next iteration of change tracking for that collection.| +| `$skiptoken` | String | A [state token](/graph/delta-query-overview) returned in the **@odata.nextLink** URL of the previous **delta** function call that indicates that further changes are available to be tracked. | ### Optional OData query parameters -The following [OData query parameters](/graph/query-parameters) are supported by this API: -- `$top` represents maximum number of messages to fetch in a call. The upper limit is **50**.+This API supports the following [OData query parameters](/graph/query-parameters): +- `$top` represents the maximum number of messages to fetch in a call. The upper limit is `50`. - `$skip` represents how many messages to skip at the beginning of the list.-- `$filter` allows returning messages that meet a certain criteria. The only property that supports filtering is `lastModifiedDateTime`, and only the **gt** operator is supported. For example, `../messages/delta?$filter=lastModifiedDateTime gt 2019-02-27T07:13:28.000z` will fetch any **reply chain (each channel post message and associated reply messages)** created or changed after the specified date time.-- `$expand` allows expanding properties for each channel message. Only **replies** is supported. If a channel message contains more than 1000 replies, `replies@odata.nextLink` is provided for pagination. --> **Note:** For `$expand` query parameter, please refer to [List Channel Messages](channel-list-messages.md#example-3-request-with-top-and-expand-query-options-on-replies). +- `$filter` returns messages that meet a certain criteria. The only property that supports filters is **lastModifiedDateTime**`, and only the `gt` operator is supported. For example, `../messages/delta?$filter=lastModifiedDateTime gt 2024-08-27T07:13:28.000z` fetches any message created or changed after the specified date and time. ## Request headers+ | Header | Value | ||| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [chatMessage](../resources/chatmessage.md) objects in the response body. The response also includes a `@odata.nextLink` URL or a `@odata.deltaLink` URL. +If successful, this method returns a `200 OK` response code and a collection of [chatMessage](../resources/chatmessage.md) objects in the response body. The response also includes an **@odata.nextLink** URL or an **@odata.deltaLink** URL. ## Examples ### Example 1: Initial synchronization -The following example shows a series of three requests to synchronize the messages in the given channel. There are five messages in the channel. +The following example shows a series of three requests to synchronize the messages. The response consists of three messages: - Step 1: [initial request](#initial-request) and [response](#initial-request-response). - Step 2: [second request](#second-request) and [response](#second-request-response) - Step 3: [third request](#third-request) and [final response](#third-request-response). -For brevity, the sample responses show only a subset of the properties for an event. In an actual call, most event properties are returned. +For brevity, the sample responses show only a subset of the properties for a message. In an actual call, most message properties are returned. -See also what you can do [to retrieve additional changes](#example-2-retrieving-additional-changes). +See also what you can do in the [next round to get more messages](#example-2-the-next-round-to-get-more-messages). #### Initial request -In this example, the channel messages are being synchronized for the first time, so the initial sync request doesn't include any state token, and returns all the events in that calendar view. --The request specifies the optional request header, odata.top, returning two events at a time. +In this example, the chat messages synchronize for the first time and the initial sync request doesn't include any state token. +The request specifies the optional `$top` query parameter that returns two messages at a time. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "get_chatmessagedeltachannel_1", - "sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] + "name": "get_chatmessagedeltachats_1" }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$top=2 +GET https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?$top=2 ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) - # [JavaScript](#tab/javascript)--# [PHP](#tab/php) --# [PowerShell](#tab/powershell) --# [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] #### Initial request response -The response includes two messages and a `@odata.nextLink` response header with a `skipToken`. The `@odata.nextLink` URL indicates there are more messages in the channel to get. +The response includes two messages and an **@odata.nextLink** response header with a `skipToken`. The **@odata.nextLink** URL indicates that more messages in the chats are available to retrieve. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.chatMessage", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.chatMessage)" } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)", - "@odata.nextLink": "https://graph.microsoft.com/beta/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$skiptoken=-FG3FPHv7HuyuazNLuy3eXlzQGbEjYLUsW9-pYkmXgn5KGsaOwrCoor2W23dGNNM1KtAX4AyvpFQNVsBgsEwUOX9lw8x9zDumgJy-C-UbjZLlZDQACyC9FyrVelZus9n.--rshdLwy_WBFJd8anPXJPbSUtUD7r3V4neB5tcrG58", - "value": [ - { - "@odata.type": "#microsoft.graph.chatMessage", - "replyToId": null, - "etag": "1606515483514", - "messageType": "message", - "createdDateTime": "2020-11-27T22:18:03.514Z", - "lastModifiedDateTime": "2020-11-27T22:18:03.514Z", - "lastEditedDateTime": null, - "deletedDateTime": null, - "subject": null, - "summary": null, - "chatId": null, - "importance": "normal", - "locale": "en-us", - "webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1606515483514?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1606515483514&parentMessageId=1606515483514", - "policyViolation": null, - "eventDetail": null, - "id": "1606515483514", - "from": { - "application": null, - "device": null, - "conversation": null, - "user": { - "@odata.type": "#microsoft.graph.teamworkUserIdentity", - "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", - "displayName": "Robin Kline", - "userIdentityType": "aadUser", - "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca" - } - }, - "body": { - "contentType": "text", - "content": "Test" - }, - "channelIdentity": { - "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", - "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" - }, - "onBehalfOf": null, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] - }, - { - "@odata.type": "#microsoft.graph.chatMessage", - "replyToId": null, - "etag": "1606691795113", - "messageType": "message", - "createdDateTime": "2020-11-29T23:16:35.113Z", - "lastModifiedDateTime": "2020-11-29T23:16:35.113Z", - "lastEditedDateTime": null, - "deletedDateTime": null, - "subject": null, - "summary": null, - "chatId": null, - "importance": "normal", - "locale": "en-us", - "webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1606691795113?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1606691795113&parentMessageId=1606691795113", - "policyViolation": null, - "eventDetail": null, - "id": "1606691795113", - "from": { - "application": null, - "device": null, - "conversation": null, - "user": { - "@odata.type": "#microsoft.graph.teamworkUserIdentity", - "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", - "displayName": "Robin Kline", - "userIdentityType": "aadUser", - "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca" - } - }, - "body": { - "contentType": "text", - "content": "HelloWorld 11/29/2020 3:16:31 PM -08:00" - }, - "channelIdentity": { - "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", - "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" - }, - "onBehalfOf": null, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.chatMessage)", + "@odata.nextLink": "https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?$skiptoken=a-5fqdzHFr_L_cc7C0q1F-HCB8Z9SjwOsMN37XV5yfSnYgK4jVGVGEl25GFlxKWq0Wv6quL-5qcNg4nUnxzof6namZ_DM5no-hcL515cSrRGDoRLn38fZE1AXoDugSTOohOq3YRCYLqJbFGIoovMPTar32oLuoltHixme-Bf1lZtscv1wv5uu-MtkpYZIT0uDw-umQUK7mLNjMcyhNaifDrdemGUDMaQ25_QuHukNbkXcxsKMJdJ288p9IkaSeEyJHX5a6T_kEdAmuffsdzOGY8mLbLc7VEsUL75rGdt2aiKkywaPHsT9bDGV7MBo7WM2g_kdPeLdRPSdSxxhkGpNA.y_WMscy7negz0HZPhgjH-YyzsdeXzr2UDSfNrdzC78A", + "value": [ + { + "replyToId": null, + "etag": "1727366299993", + "messageType": "message", + "createdDateTime": "2024-09-26T15:58:19.993Z", + "lastModifiedDateTime": "2024-09-26T15:58:19.993Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": "", + "summary": null, + "chatId": "19:65a44130a0f249359d77858287ed39f0@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "policyViolation": null, + "eventDetail": null, + "id": "1727366299993", + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "43383bf2-f7ab-4ba3-bf5e-12d071db189b", + "displayName": "CFCC5", + "userIdentityType": "aadUser", + "tenantId": "f54e6700-e876-410b-8996-d6447d64098a" }- ] + }, + "body": { + "contentType": "html", + "content": "<div>\n<div itemprop=\"copy-paste-block\">reply 9 to new conv</div>\n</div>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + }, + { + "replyToId": null, + "etag": "1727216579286", + "messageType": "message", + "createdDateTime": "2024-09-24T22:22:59.286Z", + "lastModifiedDateTime": "2024-09-24T22:22:59.286Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": "", + "summary": null, + "chatId": "19:2a247d5dadc24f408d009e4ae84502cf@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "policyViolation": null, + "eventDetail": null, + "id": "1727216579286", + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "43383bf2-f7ab-4ba3-bf5e-12d071db189b", + "displayName": "CFCC5", + "userIdentityType": "aadUser", + "tenantId": "f54e6700-e876-410b-8996-d6447d64098a" + } + }, + "body": { + "contentType": "html", + "content": "<div>\n<div itemprop=\"copy-paste-block\">reply 10 to new conv</div>\n</div>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + ] } ``` #### Second request -The second request specifies the `@odata.nextLink` URL returned from the previous response. Notice that it no longer has to specify the same top parameters as in the initial request, as the `skipToken` in the `@odata.nextLink` URL encodes and includes them. -+The second request specifies the **@odata.nextLink** URL returned from the previous response. Notice that it no longer has to specify the same `$top` parameter as in the initial request, as the `skipToken` in the **@odata.nextLink** URL encodes and includes those parameters. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "get_chatmessagedeltachannel_2", - "sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] + "name": "get_chatmessagedeltachats_2" }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$skiptoken=-FG3FPHv7HuyuazNLuy3eXlzQGbEjYLUsW9-pYkmXgn5KGsaOwrCoor2W23dGNNM1KtAX4AyvpFQNVsBgsEwUOX9lw8x9zDumgJy-C-UbjZLlZDQACyC9FyrVelZus9n.--rshdLwy_WBFJd8anPXJPbSUtUD7r3V4neB5tcrG58 +GET https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?&%24skiptoken=a-5fqdzHFr_L_cc7C0q1F-HCB8Z9SjwOsMN37XV5yfSnYgK4jVGVGEl25GFlxKWq0Wv6quL-5qcNg4nUnxzof6namZ_DM5no-hcL515cSrRGDoRLn38fZE1AXoDugSTOohOq3YRCYLqJbFGIoovMPTar32oLuoltHixme-Bf1lZtscv1wv5uu-MtkpYZIT0uDw-umQUK7mLNjMcyhNaifMIVTT-htmEOClLVwgcyWLR-sl9Qb73uTTtPXdFdMK6FDE4gpwvvKxvo2ChsW2c4eo77LDh6ZL_WQ8Luq00koQ6vHIrLBHPMUdOAxDxu-U7N7H4hsFn9aRDRdwRky7067A.V2a-J-86yXTd9SJMA4CHP6enI-Ab-bQzRgYujwsIwDo ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) - # [JavaScript](#tab/javascript)--# [PHP](#tab/php) --# [PowerShell](#tab/powershell) --# [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] #### Second request response -The second response returns the next two messages and a `@odata.nextLink` response header with a `skipToken`, indicates there are more messages in the channel to get. +The second response returns the next two messages and an **@odata.nextLink** response header with a `skipToken` that indicates that more messages are available to retrieve. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.chatMessage", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.chatMessage)" } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)", - "@odata.nextLink": "https://graph.microsoft.com/beta/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$skiptoken=8UusBixEHS9UUau6uGcryrA6FpnWwMJbuTYILM1PArHxnZzDVcsHQrijNzCyIVeEauMQsKUfMhNjLWFs1o4sBS_LofJ7xMftZUfec_pijuT6cAk5ugcWCca9RCjK7iVj.DKZ9w4bX9vCR7Sj9P0_qxjLAAPiEZgxlOxxmCLMzHJ4", - "value": [ - { - "@odata.type": "#microsoft.graph.chatMessage", - "replyToId": null, - "etag": "1606691812117", - "messageType": "message", - "createdDateTime": "2020-11-29T23:16:52.117Z", - "lastModifiedDateTime": "2020-11-29T23:16:52.117Z", - "lastEditedDateTime": null, - "deletedDateTime": null, - "subject": null, - "summary": null, - "chatId": null, - "importance": "normal", - "locale": "en-us", - "webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1606691812117?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1606691812117&parentMessageId=1606691812117", - "policyViolation": null, - "id": "1606691812117", - "from": { - "application": null, - "device": null, - "conversation": null, - "user": { - "@odata.type": "#microsoft.graph.teamworkUserIdentity", - "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", - "displayName": "Robin Kline", - "userIdentityType": "aadUser", - "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca" - } - }, - "body": { - "contentType": "text", - "content": "HelloWorld 11/29/2020 3:16:51 PM -08:00" - }, - "channelIdentity": { - "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", - "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" - }, - "onBehalfOf": null, - "attachments": [], - "mentions": [], - "reactions": [] - }, - { - "@odata.type": "#microsoft.graph.chatMessage", - "replyToId": null, - "etag": "1606691846203", - "messageType": "message", - "createdDateTime": "2020-11-29T23:17:26.203Z", - "lastModifiedDateTime": "2020-11-29T23:17:26.203Z", - "lastEditedDateTime": null, - "deletedDateTime": null, - "subject": null, - "summary": null, - "chatId": null, - "importance": "normal", - "locale": "en-us", - "webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1606691846203?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1606691846203&parentMessageId=1606691846203", - "policyViolation": null, - "id": "1606691846203", - "from": { - "application": null, - "device": null, - "conversation": null, - "user": { - "@odata.type": "#microsoft.graph.teamworkUserIdentity", - "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", - "displayName": "Robin Kline", - "userIdentityType": "aadUser", - "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca" - } - }, - "body": { - "contentType": "text", - "content": "HelloWorld 11/29/2020 3:17:25 PM -08:00" - }, - "channelIdentity": { - "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", - "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" - }, - "onBehalfOf": null, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.chatMessage)", + "@odata.nextLink": "https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?$skiptoken=yJQeoV00BlfhYsCMsrn1GnNz7v5S39NShp1U4rzLZnPsraIATwnnsvbdv52hvKp7AAG-Bcwdu7dA7UweXHvGYQ2M5eysh-cNz6EZICZp7kM9HtmQHu7JU-_sX5S1edvEQxyAgm1R2HXk4R9_TWn9ZAu1BRQ-elS9hg0f8BlwKLCIluuSPS2ZuNVnQTOOYMMpmzKGX4wVVQUv0UlrIFZIPWTeriNpg5sJFd91n2GHSMnS7WaRTh3NSmvJE08ww-2CjGml2RjPyHfLHSqywuNt5BGNVj_vqsLbjetdDIYZFa_yaQqV_Bp5DaWM_nXD8RjVULH7H4ATXoUiG3Etsd_Nhd_GIYoxV6x2_rmbh928WPGSsenCOa352tyFxmuyTH0ozDmU4onVbGnOBQEYJDKZjuIeNVW-E19VHthjZ9GvYGE.NHJkfAbRu3Qoozl699AinriiHvWofLVnWkB5wEJmZlk", + "value": [ + { + "replyToId": null, + "etag": "1726706286844", + "messageType": "message", + "createdDateTime": "2024-09-19T00:38:06.844Z", + "lastModifiedDateTime": "2024-09-19T00:38:06.844Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": "", + "summary": null, + "chatId": "19:65a44130a0f249359d77858287ed39f0@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "policyViolation": null, + "eventDetail": null, + "id": "1726706286844", + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "43383bf2-f7ab-4ba3-bf5e-12d071db189b", + "displayName": "CFCC5", + "userIdentityType": "aadUser", + "tenantId": "f54e6700-e876-410b-8996-d6447d64098a" }- ] + }, + "body": { + "contentType": "html", + "content": "<p>Not one message, but several combined together to give you the full picture</p>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + }, + { + "replyToId": null, + "etag": "1726706276201", + "messageType": "message", + "createdDateTime": "2024-09-19T00:37:56.201Z", + "lastModifiedDateTime": "2024-09-19T00:37:56.201Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": "", + "summary": null, + "chatId": "19:65a44130a0f249359d77858287ed39f0@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "policyViolation": null, + "eventDetail": null, + "id": "1726706276201", + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "43383bf2-f7ab-4ba3-bf5e-12d071db189b", + "displayName": "CFCC5", + "userIdentityType": "aadUser", + "tenantId": "f54e6700-e876-410b-8996-d6447d64098a" + } + }, + "body": { + "contentType": "html", + "content": "<p>Dive into the possibilities of incorporating context into ML evaluations by looking at entire conversations</p>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + ] } ``` #### Third request -The third request continues to use the latest `@odata.nextLink` returned from the last sync request. -+The third request continues to use the latest **@odata.nextLink** returned from the last sync request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "get_chatmessagedeltachannel_3", - "sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] + "name": "get_chatmessagedeltachats_3" }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$skiptoken=8UusBixEHS9UUau6uGcryrA6FpnWwMJbuTYILM1PArHxnZzDVcsHQrijNzCyIVeEauMQsKUfMhNjLWFs1o4sBS_LofJ7xMftZUfec_pijuT6cAk5ugcWCca9RCjK7iVj.DKZ9w4bX9vCR7Sj9P0_qxjLAAPiEZgxlOxxmCLMzHJ4 +GET https://graph.microsoft.com/beta/users/5ed12dd6-24f8-4777-be3d-0d234e06cefa/chats/getAllMessages/delta?$skiptoken=8UusBixEHS9UUau6uGcryrA6FpnWwMJbuTYILM1PArHxnZzDVcsHQrijNzCyIVeEauMQsKUfMhNjLWFs1o4sBS_LofJ7xMftZUfec_pijuT6cAk5ugcWCca9RCjK7iVj.DKZ9w4bX9vCR7Sj9P0_qxjLAAPiEZgxlOxxmCLMzHJ4 ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) - # [JavaScript](#tab/javascript)--# [PHP](#tab/php) --# [PowerShell](#tab/powershell) --# [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] #### Third request response -The third response returns the only remaining messages in the channel and a `@odata.deltaLink` response header with a `deltaToken` which indicates that all messages in the channel have been read. Save and use the `@odata.deltaLink` URL to query for any new messages starting from this point onwards. +The third response returns the only remaining messages and an **@odata.deltaLink** response header with a `deltaToken` which indicates that all messages are returned. Save and use the **@odata.deltaLink** URL to query for any new messages added or changed from this point onwards. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.chatMessage", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.chatMessage)" } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)", - "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4", - "value": [ - { - "@odata.type": "#microsoft.graph.chatMessage", - "replyToId": null, - "etag": "1611351582080", - "messageType": "message", - "createdDateTime": "2021-01-22T21:39:42.08Z", - "lastModifiedDateTime": "2021-01-22T21:39:42.08Z", - "lastEditedDateTime": null, - "deletedDateTime": null, - "subject": null, - "summary": null, - "chatId": null, - "importance": "normal", - "locale": "en-us", - "webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1611351582080?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1611351582080&parentMessageId=1611351582080", - "policyViolation": null, - "id": "1611351582080", - "from": { - "application": null, - "device": null, - "conversation": null, - "user": { - "@odata.type": "#microsoft.graph.teamworkUserIdentity", - "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", - "displayName": "Robin Kline", - "userIdentityType": "aadUser", - "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca" - } - }, - "body": { - "contentType": "text", - "content": "HelloWorld 1/22/2021 1:39:39 PM -08:00" - }, - "channelIdentity": { - "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", - "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" - }, - "onBehalfOf": null, - "attachments": [], - "mentions": [], - "reactions": [] - }, - { - "@odata.type": "#microsoft.graph.chatMessage", - "replyToId": null, - "etag": "1611351603178", - "messageType": "message", - "createdDateTime": "2021-01-22T21:40:03.178Z", - "lastModifiedDateTime": "2021-01-22T21:40:03.178Z", - "lastEditedDateTime": null, - "deletedDateTime": null, - "subject": null, - "summary": null, - "chatId": null, - "importance": "normal", - "locale": "en-us", - "webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1611351603178?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1611351603178&parentMessageId=1611351603178", - "policyViolation": null, - "id": "1611351603178", - "from": { - "application": null, - "device": null, - "conversation": null, - "user": { - "@odata.type": "#microsoft.graph.teamworkUserIdentity", - "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", - "displayName": "Robin Kline", - "userIdentityType": "aadUser", - "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca" - } - }, - "body": { - "contentType": "text", - "content": "HelloWorld 1/22/2021 1:40:00 PM -08:00" - }, - "channelIdentity": { - "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", - "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" - }, - "onBehalfOf": null, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.chatMessage)", + "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4", + "value": [ + { + "replyToId": null, + "etag": "1726706340932", + "messageType": "message", + "createdDateTime": "2024-09-19T00:39:00.932Z", + "lastModifiedDateTime": "2024-09-19T00:39:00.932Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": "", + "summary": null, + "chatId": "19:65a44130a0f249359d77858287ed39f0@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "policyViolation": null, + "eventDetail": null, + "id": "1726706340932", + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "43383bf2-f7ab-4ba3-bf5e-12d071db189b", + "displayName": "CFCC5", + "userIdentityType": "aadUser", + "tenantId": "f54e6700-e876-410b-8996-d6447d64098a" }- ] + }, + "body": { + "contentType": "html", + "content": "<p>let's get started!</p>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + ] } ``` -### Example 2: Retrieving additional changes +### Example 2: The next round to get more messages -When you use the `@odata.deltaLink` from the last request in the last round, you get only those messages that have changed (by being added, or updated) in that channel since then. Your request looks like the following, assuming you prefer to keep the same maximum page size in the response: +Using the **@odata.deltaLink** from the last request in the last round, you can get only those messages that changed (added or updated) since the **@odata.deltaLink** was acquired. Your request should look like the following, assuming you want to keep the same maximum page size in the response. #### Request +The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "get_chatmessagedeltachannel_4", - "sampleKeys": ["fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"] + "name": "get_chatmessagedeltachats_4" }--> ```msgraph-interactive-GET https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4 +GET https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4 ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Go](#tab/go) --# [Java](#tab/java) - # [JavaScript](#tab/javascript)--# [PHP](#tab/php) --# [PowerShell](#tab/powershell) --# [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] #### Response +The following example shows the response. + >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.chatMessage", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.chatMessage)" } --> ```http HTTP/1.1 200 OK Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)", - "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_yjz2nsMoh1gXNtXii7s78HapCi5woifXqwXlVNxICh8wUUnvE2gExsa8eZ2Vy_ch5rVIhm067_1mUPML3iYUVyg.3o0rhgaBUduuxOr98An5pjBDP5JjKUiVWku3flSiOsk", - "value": [ - { - "@odata.type": "#microsoft.graph.chatMessage", - "replyToId": null, - "etag": "1616989510408", - "messageType": "message", - "createdDateTime": "2021-03-29T03:45:10.408Z", - "lastModifiedDateTime": "2021-03-29T03:45:10.408Z", - "lastEditedDateTime": null, - "deletedDateTime": null, - "subject": null, - "summary": null, - "chatId": null, - "importance": "normal", - "locale": "en-us", - "webUrl": "https://teams.microsoft.com/l/message/19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2/1616989510408?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1616989510408&parentMessageId=1616989510408", - "policyViolation": null, - "id": "1616989510408", - "from": { - "application": null, - "device": null, - "conversation": null, - "user": { - "@odata.type": "#microsoft.graph.teamworkUserIdentity", - "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", - "displayName": "Robin Kline", - "userIdentityType": "aadUser", - "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca" - } - }, - "body": { - "contentType": "text", - "content": "Hello World 28th March 2021" - }, - "channelIdentity": { - "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", - "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" - }, - "onBehalfOf": null, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(chatMessage)", + "@odata.deltaLink": "https://graph.microsoft.com/betik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_yjz2nsMoh1gXNtXii7s78HapCi5woifXqwXlVNxICh8wUUnvE2gExsa8eZ2Vy_ch5rVIhm067_1mUPML3iYUVyg.3o0rhgaBUduuxOr98An5pjBDP5JjKUiVWku3flSiOsk", + "value": [ + { + "replyToId": null, + "etag": "1727366299999", + "messageType": "message", + "createdDateTime": "2024-09-26T15:58:19.993Z", + "lastModifiedDateTime": "2024-09-26T17:58:19.993Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": "", + "summary": null, + "chatId": "19:65a44130a0f249359d77858287ed39f0@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "policyViolation": null, + "eventDetail": null, + "id": "1727366299999", + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "43383bf2-f7ab-4ba3-bf5e-12d071db189b", + "displayName": "CFCC5", + "userIdentityType": "aadUser", + "tenantId": "f54e6700-e876-410b-8996-d6447d64098a" }- ] + }, + "body": { + "contentType": "html", + "content": "newly added content" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + ] } ``` Content-type: application/json <!-- { "type": "#page.annotation",- "description": "Channel messages: delta", + "description": "Chat messages: delta", "keywords": "", "section": "documentation", "tocPath": "", Content-type: application/json ] } -->-- |
v1.0 | Chatmessage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-get.md | Content-type: application/json }, "body": { "contentType": "html",- "content": "<p>I am looking <emoji id=\"1f440_eyes\" alt=\"👀\" title=\"Eyes\"></emoji><customemoji id=\"dGVzdHNjOzAtd3VzLWQyLTdiNWRkZGQ2ZGVjMDNkYzIwNTgxY2NkYTE1MmEyZTM4\" alt=\"testsc\" source=\"https://graph.microsoft.com/beta/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706638496169/hostedContents/aWQ9LHR5cGU9MSx1cmw9aHR0cHM6Ly91cy1jYW5hcnkuYXN5bmNndy50ZWFtcy5taWNyb3NvZnQuY29tL3YxL29iamVjdHMvMC13dXMtZDItN2I1ZGRkZDZkZWMwM2RjMjA1ODFjY2RhMTUyYTJlMzgvdmlld3MvaW1ndDJfYW5pbQ==/$value\"></customemoji></p>" + "content": "<p>I am looking <emoji id=\"1f440_eyes\" alt=\"👀\" title=\"Eyes\"></emoji><customemoji id=\"dGVzdHNjOzAtd3VzLWQyLTdiNWRkZGQ2ZGVjMDNkYzIwNTgxY2NkYTE1MmEyZTM4\" alt=\"microsoft_teams\" source=\"https://graph.microsoft.com/beta/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706638496169/hostedContents/aWQ9LHR5cGU9MSx1cmw9aHR0cHM6Ly91cy1jYW5hcnkuYXN5bmNndy50ZWFtcy5taWNyb3NvZnQuY29tL3YxL29iamVjdHMvMC13dXMtZDItN2I1ZGRkZDZkZWMwM2RjMjA1ODFjY2RhMTUyYTJlMzgvdmlld3MvaW1ndDJfYW5pbQ==/$value\"></customemoji></p>" }, "attachments": [], "mentions": [], "reactions": [ { "reactionType": "💯",+ "displayName": "Hundred points", "reactionContentUrl": null, "createdDateTime": "2024-02-14T22:07:36.3Z", "user": { Content-type: application/json }, { "reactionType": "custom",+ "displayName": "microsoft_teams", "reactionContentUrl": "https://graph.microsoft.com/beta/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706763669648/hostedContents/aWQ9MC13dXMtZDExLTc3ZmI2NmY4MTMwMGI2OGEzYzRkOWUyNmU1YTc5ZmMyLHR5cGU9MSx1cmw9/$value", "createdDateTime": "2024-02-14T22:07:02.288Z", "user": { Content-type: application/json } ``` +### Example 5: Get a chat message with an @mention for everyone ++The following example shows a request to get a chat message that @mentions everyone in a group chat. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_chatmessage_5", + "sampleKeys": ["19:80a7ff67c0ef43c19d88a7638be436b1@thread.v2", "1725986575123"] +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/chats/19:80a7ff67c0ef43c19d88a7638be436b1@thread.v2/messages/1725986575123 +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. The message body contains an @mention for everyone in a group chat that is represented by the `<at></at>` tag. The **conversationIdentityType** property is set to `chat` in the **conversation** identity of the **mentioned** object. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.chatMessage" +} --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#chats('19%3A80a7ff67c0ef43c19d88a7638be436b1%40thread.v2')/messages/$entity", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET chats('<key>')/messages('<key>')?$select=attachments,body", + "id": "1725986575123", + "replyToId": null, + "etag": "1725986575123", + "messageType": "message", + "createdDateTime": "2024-09-10T16:42:55.123Z", + "lastModifiedDateTime": "2024-09-10T16:42:55.123Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:80a7ff67c0ef43c19d88a7638be436b1@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "onBehalfOf": null, + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "28c10244-4bad-4fda-993c-f332faef94f0", + "displayName": "Adele Vance", + "userIdentityType": "aadUser", + "tenantId": "2432b57b-0abd-43db-aa7b-16eadd115d34" + } + }, + "body": { + "contentType": "html", + "content": "<p>Hi <at id=\"0\">Everyone</at></p>" + }, + "attachments": [], + "mentions": [ + { + "id": 0, + "mentionText": "Everyone", + "mentioned": { + "application": null, + "device": null, + "user": null, + "tag": null, + "conversation": { + "id": "19:80a7ff67c0ef43c19d88a7638be436b1@thread.v2", + "displayName": "Everyone", + "conversationIdentityType": "chat" + } + } + } + ], + "reactions": [] +} +``` ++### Example 6: Get a chat message with a forwarded message ++The following example shows a request that gets a chat message with a forwarded message as an attachment. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_chatmessage_6", + "sampleKeys": ["19:e2ed97baac8e4bffbb91299a38996790@thread.v2", "1727903166936"] +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/chats/19:e2ed97baac8e4bffbb91299a38996790@thread.v2/messages/1727903166936 +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. The message body contains a forwarded message as an attachment. The **contentType** for the forwarded message is identified as `forwardedMessageReference`. The original message that was forwarded is also available in the attachment **content**. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.chatMessage" +} --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#chats('19%3Ae2ed97baac8e4bffbb91299a38996790%40thread.v2')/messages/$entity", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET chats('<key>')/messages('<key>')?$select=attachments,body", + "id": "1727903166936", + "replyToId": null, + "etag": "1727903166936", + "messageType": "message", + "createdDateTime": "2024-10-02T21:06:06.936Z", + "lastModifiedDateTime": "2024-10-02T21:06:06.936Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:e2ed97baac8e4bffbb91299a38996790@thread.v2", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "onBehalfOf": null, + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "28c10244-4bad-4fda-993c-f332faef94f0", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "2432b57b-0abd-43db-aa7b-16eadd115d34" + } + }, + "body": { + "contentType": "html", + "content": "<attachment id=\"1727881360458\"></attachment>" + }, + "attachments": [ + { + "id": "1727881360458", + "contentType": "forwardedMessageReference", + "contentUrl": null, + "content": "{\"originalMessageId\":\"1727881360458\",\"originalMessageContent\":\"\\n<p>hello</p>\\n\",\"originalConversationId\":\"19:97641583cf154265a237da28ebbde27a@thread.v2\",\"originalSentDateTime\":\"2024-10-02T15:02:40.458+00:00\",\"originalMessageSender\":{\"application\":null,\"device\":null,\"user\":{\"userIdentityType\":\"aadUser\",\"tenantId\":\"2432b57b-0abd-43db-aa7b-16eadd115d34\",\"id\":\"28c10244-4bad-4fda-993c-f332faef94f0\",\"displayName\":null}}}", + "name": null, + "thumbnailUrl": null, + "teamsAppId": null + } + ], + "mentions": [], + "reactions": [] +} +``` + ## Related content - [List messages in a channel](channel-list-messages.md) |
v1.0 | Chatmessage List Hostedcontents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessage-list-hostedcontents.md | This operation doesn't support the [OData query parameters](/graph/query-paramet | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Chatmessagehostedcontent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/chatmessagehostedcontent-get.md | This operation doesn't support the [OData query parameters](/graph/query-paramet | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Cloudlicensing Groupcloudlicensing List Usagerights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudlicensing-groupcloudlicensing-list-usagerights.md | + + Title: "List usageRights for group" +description: "Get a list of the usageRight objects granted to a group." ++ms.localizationpriority: medium ++++# List usageRights for group ++Namespace: microsoft.graph.cloudLicensing +++Get a list of the [usageRight](../resources/cloudlicensing-usageright.md) objects granted to a group. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "cloudlicensing_groupcloudlicensing_list_usagerights" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /groups/{groupId}/cloudLicensing/usageRights +``` ++## Optional query parameters ++This method supports the `$select` and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++The following examples show how to get usage rights information for groups based on specific filters: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=skuId eq 639dec6b-bb19-468b-871c-c5c441c4b0cb +GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=skuId in (639dec6b-bb19-468b-871c-c5c441c4b0cb, a403ebcc-fae0-4ca2-8c8c-7a907fd6c235) +GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318) +GET /groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=services/any(c:c/planId in (113feb6c-3fe4-4440-bddc-54d774bf0318, 2049e525-b859-401b-b2a0-e0a31c4b1fe4)) +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) objects in the response body. ++## Examples ++### Example 1: Get all usage rights for a group ++The following example shows how to get all usage rights granted to a group. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudlicensing-groupusageright-list-example-1" +} +--> +``` http +GET https://graph.microsoft.com/beta/groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.cloudLicensing.usageRight)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudLicensing.usageRight", + "id": "1e373a1d-1f05-28cf-bfc0-ee0ecfd3db15", + "skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb", + "skuPartNumber": "Microsoft_365_Copilot", + "services": [ + { + "@odata.type": "microsoft.graph.cloudLicensing.service", + "assignableTo": "user,group", + "planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c", + "planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365" + } + ] + } + ] +} +``` ++### Example 2: Get all usage rights for a group with a specific service plan ++The following example shows how to get all usage rights granted to a group for a specific service plan. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudlicensing-groupusageright-list-example-2" +} +--> +``` http +GET https://graph.microsoft.com/beta/groups/0003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318) +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.cloudLicensing.usageRight)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudLicensing.usageRight", + "id": "5bbc716a-f73f-4cc1-bf16-53d38b407b8f", + "skuId": "75398b2a-b060-4057-9ae2-9eb00ef68579", + "skuPartNumber": "Copilot_Pro", + "services": [ + { + "@odata.type": "microsoft.graph.cloudLicensing.service", + "assignableTo": "group", + "planId": "113feb6c-3fe4-4440-bddc-54d774bf0318", + "planName": "EXCHANGE_S_FOUNDATION" + } + ] + } + ] +} +``` |
v1.0 | Cloudlicensing Usageright Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudlicensing-usageright-get.md | + + Title: "Get usageRight" +description: "Get the properties and relationships of a usageRight for a user or group." ++ms.localizationpriority: medium ++++# Get usageRight ++Namespace: microsoft.graph.cloudLicensing +++Get the properties and relationships of a [usageRight](../resources/cloudlicensing-usageright.md) for a [user](../resources/user.md) or [group](../resources/group.md). ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++Permissions to get a **usageRight** for a user: ++<!-- { "blockType": "ignored"} --> +``` http +GET /me/cloudLicensing/usageRights/{usageRightId} +GET /users/{userId}/cloudLicensing/usageRights/{usageRightId} +``` ++<!-- { "blockType": "permissions", "name": "cloudlicensing_usageright_get" } --> ++Permissions to get a **usageRight** for a group: ++<!-- { "blockType": "ignored"} --> +``` http +GET /groups/{groupId}/cloudLicensing/usageRights/{usageRightId} +``` ++<!-- { "blockType": "permissions", "name": "cloudlicensing_usageright_get", "requestUrls": "GET /groups/{groupId}/cloudLicensing/usageRights/{usageRightId}" } --> +|Permission type|Least privileged permissions|Higher privileged permissions| +|:|:|:| +|Delegated (work or school account)|Group-UsageRight.Read.All|Directory.Read.All, Directory.ReadWrite.All, Group-CloudLicensing.Read, Group-CloudLicensing.Read.All, Group.Read.All, Group.ReadWrite.All, User.Read.All, User.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.|Not supported.| +|Application|Group-UsageRight.Read.All|Directory.Read.All, Directory.ReadWrite.All, Group-CloudLicensing.Read.All, Group.Read.All, Group.ReadWrite.All, User.Read.All, User.ReadWrite.All| ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /groups/{groupId}/cloudLicensing/usageRights/{usageRightId} +GET /me/cloudLicensing/usageRights/{usageRightId} +GET /users/{userId}/cloudLicensing/usageRights/{usageRightId} +``` ++## 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. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) object in the response body. ++## Examples ++### Example 1: Get a usageRight for a user ++The following example shows how to get a usage right for a user. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudlicensing-usageright-get-example", + "sampleKeys": ["48fbdf70-9e09-40df-9dbe-17af483ab113","i6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby3"] +} +--> +``` http +GET https://graph.microsoft.com/beta/users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights/i6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby3 +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.cloudLicensing.usageRight" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.cloudLicensing.usageRight", + "id": "i6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby3", + "skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb", + "skuPartNumber": "Microsoft_365_Copilot", + "services": [ + { + "@odata.type": "microsoft.graph.cloudLicensing.service", + "assignableTo": "user,group", + "planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c", + "planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365" + } + ] +} +``` ++### Example 2: Get a usageRight for a group ++The following example shows how to get a usage right for a group. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudlicensing-usageright-get-2-example", + "sampleKeys": ["1003985b-dfc1-4f42-97d4-65f70a335ca8","j6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby4"] +} +--> +``` http +GET https://graph.microsoft.com/beta/groups/1003985b-dfc1-4f42-97d4-65f70a335ca8/cloudLicensing/usageRights/j6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby4 +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.cloudLicensing.usageRight" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.cloudLicensing.usageRight", + "id": "j6sq63x2vd3esbkifv7m42xdaugc6lfpqf3ozgvdlvk3ttnamby4", + "skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb", + "skuPartNumber": "Microsoft_365_Copilot", + "services": [ + { + "@odata.type": "microsoft.graph.cloudLicensing.service", + "assignableTo": "user,group", + "planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c", + "planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365" + } + ] +} +``` |
v1.0 | Cloudlicensing Usercloudlicensing List Usagerights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudlicensing-usercloudlicensing-list-usagerights.md | + + Title: "List usageRights for user" +description: "Get a list of the usageRight objects granted to a user." ++ms.localizationpriority: medium ++++# List usageRights for user ++Namespace: microsoft.graph.cloudLicensing +++Get a list of the [usageRight](../resources/cloudlicensing-usageright.md) objects granted to a user. This API returns details about licenses that are directly assigned to a user and those licenses transitively assigned through membership in licensed groups. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "cloudlicensing_usercloudlicensing_list_usagerights" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /me/cloudLicensing/usageRights +GET /users/{userId}/cloudLicensing/usageRights +``` ++## Optional query parameters ++This method supports the `$select` and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++The following examples show how to get usage rights information for users based on specific filters: ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=skuId eq 639dec6b-bb19-468b-871c-c5c441c4b0cb +GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=skuId in (639dec6b-bb19-468b-871c-c5c441c4b0cb, a403ebcc-fae0-4ca2-8c8c-7a907fd6c235) +GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318) +GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=services/any(c:c/planId in (113feb6c-3fe4-4440-bddc-54d774bf0318, 2049e525-b859-401b-b2a0-e0a31c4b1fe4)) +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.cloudLicensing.usageRight](../resources/usageright.md) objects in the response body. ++## Examples ++### Example 1: Get all usage rights for a user ++The following example shows how to get all usage rights granted to a user. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudlicensing-userusageright-list-example-1" +} +--> +``` http +GET https://graph.microsoft.com/beta/users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.cloudLicensing.usageRight)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudLicensing.usageRight", + "id": "1e373a1d-1f05-28cf-bfc0-ee0ecfd3db15", + "skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb", + "skuPartNumber": "Microsoft_365_Copilot", + "services": [ + { + "@odata.type": "microsoft.graph.cloudLicensing.service", + "assignableTo": "user,group", + "planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c", + "planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365" + } + ] + } + ] +} +``` ++### Example 2: Get all usage rights for a user with a specific service plan ++The following example shows how to get all usage rights granted to a user for a specific service plan. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudlicensing-userusageright-list-example-2" +} +--> +``` http +GET https://graph.microsoft.com/beta/users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318) +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.cloudLicensing.usageRight)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudLicensing.usageRight", + "id": "5bbc716a-f73f-4cc1-bf16-53d38b407b8f", + "skuId": "75398b2a-b060-4057-9ae2-9eb00ef68579", + "skuPartNumber": "Copilot_Pro", + "services": [ + { + "@odata.type": "microsoft.graph.cloudLicensing.service", + "assignableTo": "user", + "planId": "113feb6c-3fe4-4440-bddc-54d774bf0318", + "planName": "EXCHANGE_S_FOUNDATION" + } + ] + } + ] +} +``` |
v1.0 | Cloudpc Getfrontlinecloudpcaccessstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-getfrontlinecloudpcaccessstate.md | Content-Type: application/json { "@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String",- "value": "noLicensesAvailable" + "value": "active" } ``` Content-Type: application/json { "@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String",- "value": "noLicensesAvailable" + "value": "active" } ``` |
v1.0 | Cloudpc Getprovisionedcloudpcs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-getprovisionedcloudpcs.md | Choose the permission or permissions marked as least privileged for this API. Us GET /deviceManagement/virtualEndpoint/cloudPCs/getProvisionedCloudPCs(groupId='{groupId}',servicePlanId='{servicePlanId}') ``` +## Optional query parameters ++This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response. You can use `$select` to get specific properties, including those properties that aren't returned by default. + ## Request headers |Name|Description| If successful, this method returns a `200 OK` response code and a collection of ## Examples -### Request +### Example 1: Get all provisioned Cloud PCs and their default properties ++The following example shows how to get all provisioned Cloud PCs and their default properties. ++#### Request The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "cloudpc.getProvisionedCloudPCs" + "name": "cloudpc.getProvisionedCloudPCs_1" } --> ``` http GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/g ``` # [C#](#tab/csharp) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [CLI](#tab/cli) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Go](#tab/go) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Java](#tab/java) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PHP](#tab/php) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [PowerShell](#tab/powershell) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -### Response +#### Response -The following example shows the response. +The following example shows the response. It includes only the default properties. ++> **Note:** The response object shown here might be shortened for readability. All the default properties are returned in an actual call. <!-- { "blockType": "response", "@odata.type": "Collection(microsoft.graph.cloudPC)",- "name": "cloudpc.getProvisionedCloudPCs", + "name": "cloudpc.getProvisionedCloudPCs_1", "truncated": true } --> Content-Type: application/json "servicePlanName": "Cloud PC Enterprise 4vCPU/16GB/256GB", "servicePlanType": "enterprise", "status": "provisioned",- "powerState": "running", "userPrincipalName": "pmitchell@contoso.com", "lastModifiedDateTime": "2020-07-23T10:29:57Z", "statusDetails": null, "provisioningType": "dedicated", "allotmentDisplayName": null, "deviceRegionName": "eastus2",- "connectivityResult": "", "gracePeriodEndDateTime": null,- "lastLoginResult": "2020-07-23T10:29:57Z", - "lastRemoteActionResult": "Succeed", "onPremisesConnectionName": "Test-OPNC",- "osVersion": null, "partnerAgentInstallResults": null,- "provisioningPolicyName": "Test-Policy", - "userAccountType": null + "provisioningPolicyName": "Test-Policy" }, { "@odata.type": "#microsoft.graph.cloudPC", Content-Type: application/json "servicePlanName": "Cloud PC Enterprise 4vCPU/16GB/256GB", "servicePlanType": "enterprise", "status": "provisioned",- "powerState": "running", "userPrincipalName": "pmitchell@contoso.com", "lastModifiedDateTime": "2020-07-28T18:14:34Z", "statusDetails": null, "provisioningType": "dedicated", "allotmentDisplayName": null, "deviceRegionName": "eastus2",- "connectivityResult": "", "gracePeriodEndDateTime": null,- "lastLoginResult": "2020-07-23T10:29:57Z", - "lastRemoteActionResult": "Succeed", "onPremisesConnectionName": "Test-OPNC",- "osVersion": null, "partnerAgentInstallResults": null,- "provisioningPolicyName": "Test-Policy", - "userAccountType": null + "provisioningPolicyName": "Test-Policy" } ] } ```++### Example 2: Get all provisioned Cloud PCs and specific properties ++The following example shows how to get all provisioned Cloud PCs and use `$select` to get specific properties, including those properties that aren't returned by default. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "cloudpc.getProvisionedCloudPCs_2" +} +--> +``` http +GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/getProvisionedCloudPCs(groupId='30d0e128-de93-41dc-89ec-33d84bb662a0',servicePlanId='9ecf691d-8b82-46cb-b254-cd061b2c02fb')?$select=id,displayName,powerState,connectivityResult,lastLoginResult,lastRemoteActionResult,osVersion,provisioningPolicyName,userAccountType +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "@odata.type": "Collection(microsoft.graph.cloudPC)", + "name": "cloudpc.getProvisionedCloudPCs_2", + "truncated": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudPC", + "id": "662009bc-7732-4f6f-8726-25883518b33e", + "displayName": "Demo-0", + "powerState": "running", + "connectivityResult": "", + "lastLoginResult": "2020-07-23T10:29:57Z", + "lastRemoteActionResult": "Succeed", + "osVersion": null, + "provisioningPolicyName": "Test-Policy", + "userAccountType": null + }, + { + "@odata.type": "#microsoft.graph.cloudPC", + "id": "ac74ae8b-85f7-4272-88cc-5419267403ed", + "displayName": "Demo-1", + "powerState": "running", + "connectivityResult": "", + "lastLoginResult": "2020-07-23T10:29:57Z", + "lastRemoteActionResult": "Succeed", + "osVersion": null, + "provisioningPolicyName": "Test-Policy", + "userAccountType": null + } + ] +} +``` |
v1.0 | Cloudpc Getshiftworkcloudpcaccessstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-getshiftworkcloudpcaccessstate.md | - Title: "cloudPC: getShiftWorkCloudPcAccessState (deprecated)" -description: "Get the access state of a shift work Cloud PC. Callers can get the latest shift work Cloud PC accessState and determine if the shift work Cloud PC is accessible to the user." ---doc_type: apiPageType ---# cloudPC: getShiftWorkCloudPcAccessState (deprecated) -Namespace: microsoft.graph ---> [!CAUTION] -> This API is deprecated and will stop returning data on April 24, 2024. Going forward, use the [getFrontlineCloudPcAccessState](../api/cloudpc-getfrontlinecloudpcaccessstate.md) API. --Get the [shiftWorkCloudPcAccessState](../resources/cloudpc.md#shiftworkcloudpcaccessstate-values-deprecated) of a shift work Cloud PC. --This API only supports shared-use licenses. For more information, see [cloudPcProvisioningPolicy](../resources/cloudpcprovisioningpolicy.md#cloudpcprovisioningtype-values). Shared-use licenses allow three users per license, with one user signed in at a time. Callers can get the latest shift work Cloud PC **accessState** and determine whether the shift work Cloud PC is accessible to the user. --If a web client needs to connect to a shift work Cloud PC, the **sharedCloudPcAccessState** validates the bookmark scenario. If **sharedCloudPcAccessState** is not active/activating/standbyMode, the web client shows a "bad bookmark". ---## Permissions -Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). --<!-- { "blockType": "permissions", "name": "cloudpc_getshiftworkcloudpcaccessstate" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >-``` http -GET /me/cloudPCs/{cloudPCId}/getShiftWorkCloudPcAccessState -``` --## Request headers -|Name|Description| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| --## Request body -Don't supply a request body for this method. --## Response --If successful, this function returns a `200 OK` response code and a [shiftWorkCloudPcAccessState](../resources/cloudpc.md#shiftworkcloudpcaccessstate-values-deprecated) object in the response body. --If the Cloud PC has been provisioned as a dedicated device, this method returns `400 Bad request`. --## Examples --### Request -<!-- { - "blockType": "request", - "name": "cloudpc.getShiftWorkCloudPcAccessState" -} >-``` http -GET https://graph.microsoft.com/beta/me/cloudPCs/{cloudPCId}/getShiftWorkCloudPcAccessState -``` --### Response -<!-- { - "blockType": "response", - "truncated": true, - "@odata.type": "string" -} >-``` http -HTTP/1.1 200 OK -Content-Type: application/json --{ - "@odata.context":"https://graph.microsoft.com/beta/$metadata#Edm.String", - "value": "noLicensesAvailable" -} -``` - |
v1.0 | Cloudpc Retrievecloudpcremoteactionresults | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-retrievecloudpcremoteactionresults.md | GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/4 [!INCLUDE [sample-code](../includes/snippets/php/cloudpc-retrievecloudpcremoteactionresults-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/cloudpc-retrievecloudpcremoteactionresults-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Cloudpc Retrievesnapshots | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpc-retrievesnapshots.md | + + Title: "cloudPC: retrieveSnapshots" +description: "List all snapshots of a Cloud PC." ++ms.localizationpriority: medium ++++# cloudPC: retrieveSnapshots ++Namespace: microsoft.graph +++List all [cloudPcSnapshot](../resources/cloudpcsnapshot.md) resources for a Cloud PC. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "cloudpc_retrievesnapshots" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +GET /cloudPCs/{cloudPCId}/retrieveSnapshots +``` ++## Request headers ++|Name |Description | +|:- |: | +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a list of [cloudPcSnapshot](../resources/cloudpcsnapshot.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "cloudpc.retrieveSnapshots" +} +--> ++``` http +GET https://graph.microsoft.com/beta/cloudPCs/b0a9cde2-e170-4dd9-97c3-ad1d3328a711/retrieveSnapshots +``` ++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.cloudPcSnapshot)" +} +--> ++``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.cloudPcSnapshot)", + "value": [ + { + "id": "CPC_d4cfdeb2-d409-4e97-87ce-618b704d75f1_d95c0bde-485d-400e-9bef-083905e1b768", + "cloudPcId": "d8b39ec3-03c9-457f-824e-25f48197cec6", + "status": "ready", + "createdDateTime": "2024-08-19T14:05:17.2480723Z", + "lastRestoredDateTime": null, + "snapshotType": "automatic", + "expirationDateTime": null + }, + { + "id": "CPC_d4cfdeb2-d409-4e97-87ce-618b704d75f1_423e5d9d-06e0-4b3b-8f0c-80f5a5215a10", + "cloudPcId": "d8b39ec3-03c9-457f-824e-25f48197cec6", + "status": "ready", + "createdDateTime": "2024-08-19T02:05:15.624315Z", + "lastRestoredDateTime": null, + "snapshotType": "automatic", + "expirationDateTime": null + } + ] +} +``` |
v1.0 | Cloudpcdeviceimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcdeviceimage-get.md | Content-Type: application/json "lastModifiedDateTime": "2023-11-03T07:03:44.97Z", "status": "ready", "statusDetails": null,- "errorCode": null + "errorCode": null, + "osVersionNumber": "10.0.22631.3593" } ``` |
v1.0 | Cloudpcgalleryimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcgalleryimage-get.md | Content-Type: application/json "sizeInGB": 64, "startDate": "2019-11-12", "endDate": "2022-05-10",- "expirationDate": "2022-11-10" + "expirationDate": "2022-11-10", + "osVersionNumber": "10.0.18363.720" } ``` |
v1.0 | Cloudpcprovisioningpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-get.md | Content-Type: application/json "autopatch": { "autopatchGroupId": "91197a0b-3a74-408d-ba88-bce3fdc4e5eb" },+ "autopilotConfiguration": { + "devicePreparationProfileId": "59e5d3d2-ec68-4bfe-9693-27975b318990", + "applicationTimeoutInMinutes": 60, + "onFailureDeviceAccessDenied": false + }, "enableSingleSignOn": true, "id": "1d164206-bf41-4fd2-8424-a3192d39ffff", "imageDisplayName": "Image Display Name value", Content-Type: application/json "autopatch": { "autopatchGroupId": "91197a0b-3a74-408d-ba88-bce3fdc4e5eb" },+ "autopilotConfiguration": { + "devicePreparationProfileId": "59e5d3d2-ec68-4bfe-9693-27975b318990", + "applicationTimeoutInMinutes": 60, + "onFailureDeviceAccessDenied": false + }, "enableSingleSignOn": true, "id": "1d164206-bf41-4fd2-8424-a3192d39ffff", "imageDisplayName": "Image Display Name value", |
v1.0 | Cloudpcprovisioningpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcprovisioningpolicy-update.md | The following table shows the properties that can be updated for the [cloudPcPro |Property|Type|Description| |:|:|:| |autopatch|[cloudPcProvisioningPolicyAutopatch](../resources/cloudpcprovisioningpolicyautopatch.md)|The specific settings for Windows Autopatch that enable its customers to experience it on Cloud PC. The settings take effect when the tenant enrolls in Windows Autopatch and the **managedType** of the **microsoftManagedDesktop** property is set as `starterManaged`.|+|autopilotConfiguration|[cloudPcAutopilotConfiguration](../resources/cloudpcautopilotconfiguration.md)|The specific settings for Windows Autopilot that enable Windows 365 customers to experience it on Cloud PC.| |description|String|The provisioning policy description.| |displayName|String|The display name for the provisioning policy. | |domainJoinConfigurations|[cloudPcDomainJoinConfiguration](../resources/cloudpcdomainjoinconfiguration.md) collection|Specifies a list ordered by priority on how Cloud PCs join Microsoft Entra ID.| The following example shows a request. --> ``` http-PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/{id} +PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff Content-Type: application/json { Content-Type: application/json }, "autopatch": { "autopatchGroupId": "91197a0b-3a74-408d-ba88-bce3fdc4e5eb"+ }, + "autopilotConfiguration": { + "devicePreparationProfileId": "59e5d3d2-ec68-4bfe-9693-27975b318990", + "applicationTimeoutInMinutes": 30, + "onFailureDeviceAccessDenied": false } } ``` The following example shows the response. <!-- { "blockType": "response",- "truncated": true, + "truncated": true } --> ``` http |
v1.0 | Cloudpcreports Getconnectionqualityreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-getconnectionqualityreports.md | Title: "cloudPcReports: getConnectionQualityReports" + Title: "cloudPcReports: getConnectionQualityReports (deprecated)" description: "Get the overall connection quality reports for all devices within a current tenant during a given time period, including metrics like the average round trip time (P50), average available bandwidth, and UDP connection percentage." ms.localizationpriority: medium-# cloudPcReports: getConnectionQualityReports +# cloudPcReports: getConnectionQualityReports (deprecated) Namespace: microsoft.graph Namespace: microsoft.graph Get the overall connection quality reports for all devices within a current tenant during a given time period, including metrics like the average round trip time (P50), average available bandwidth, and UDP connection percentage. Get also other real-time metrics such as last connection round trip time, last connection client IP, last connection gateway, and last connection protocol. +>[!CAUTION] +> This API is deprecated and will stop returning data on December 31, 2024. Going forward, use the [retrieveConnectionQualityReports](cloudpcreports-retrieveconnectionqualityreports.md) API. + [!INCLUDE [national-cloud-support](../../includes/global-us.md)] ## Permissions |
v1.0 | Cloudpcreports Post Exportjobs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-post-exportjobs.md | You can specify the following properties when you create a **cloudPcExportJob**. |Property|Type|Description| |:|:|:| |filter|String|The filter applied on the report. Optional.|-|reportName|cloudPcReportName|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`.| +|reportName|cloudPcReportName|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`.| |select|String collection|The selected columns of the report. Optional.| ## Response |
v1.0 | Cloudpcreports Retrievebulkactionstatusreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-retrievebulkactionstatusreport.md | + + Title: "cloudPcReports: retrieveBulkActionStatusReport" +description: "Get the bulk remote action status reports, including data such as the bulk action ID, bulk action display name, initiating user's principal name, action type, and action state." ++ms.localizationpriority: medium ++++# cloudPcReports: retrieveBulkActionStatusReport ++Namespace: microsoft.graph +++Get the bulk remote action status report, including data such as the bulk action ID, bulk action display name, initiating user's principal name, action type, and action state. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "cloudpcreports_retrieveBulkActionStatusReport" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/virtualEndpoint/reports/retrieveBulkActionStatusReport +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|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 method. ++| Parameter | Type | Description | +|:-|:|:-| +| filter | String | OData `$filter` syntax. Supported filters are: `and`, `or`, `gt` ,`ge`, and `eq`. | +| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the **select** parameter. | +| orderBy | String collection | Specifies the order by columns name. The default **orderBy** column is `RequestDateTime`. | +| search | String | Specifies a string to search for. | +| select | String collection | OData `$select` syntax. The selected columns of the reports. | +| skip | Int32 | Number of records to skip. | +| top | Int32 | The number of top records to return. If not specified, the default limit is 25, with a maximum of 100. | ++## Response ++If successful, this method returns a `200 OK` response code and a stream object in the response body. ++## Examples ++### Request ++The following example shows a request. ++<!-- { + "blockType": "request", + "name": "cloudpcreports.retrieveBulkActionStatusReport" +} +--> +``` http +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveBulkActionStatusReport +Content-Type: application/octet-stream ++{ + "filter": "RequestDateTime ge datetime'2024-08-30'", + "select": [ + "BulkActionId", + "BulkActionDisplayName", + "Action", + "BulkActionStatus", + "InitiatedByUserPrincipalName", + "RequestDateTime", + "SucceedCount", + "FailedCount", + "InprogressCount", + "TotalCount", + "Completion" + ], + "skip": 0, + "top": 50 +} +``` ++### Response ++The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Edm.Stream" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/octet-stream ++{ + "TotalRowCount": 1, + "Schema": [ + { + "Column": "BulkActionId", + "PropertyType": "String" + }, + { + "Column": "BulkActionDisplayName", + "PropertyType": "String" + }, + { + "Column": "Action", + "PropertyType": "String" + }, + { + "Column": "BulkActionStatus", + "PropertyType": "String" + }, + { + "Column": "RequestDateTime", + "PropertyType": "DateTime" + }, + { + "Column": "SucceedCount", + "PropertyType": "Int64" + }, + { + "Column": "FailedCount", + "PropertyType": "Int64" + }, + { + "Column": "InprogressCount", + "PropertyType": "Int64" + }, + { + "Column": "TotalCount", + "PropertyType": "Int64" + } + ], + "Values": [ + [ + "63792ef5-db62-437f-8d7e-7b3b695abb48", + "BulkRestart on 2024-8-22 17:26:52 GMT+0800 (China Standard Time)", + "Restart", + "", + "2024-08-22T09:26:54", + 1, + 0, + 0, + 1 + ] + ] +} +``` |
v1.0 | Cloudpcreports Retrieveconnectionqualityreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcreports-retrieveconnectionqualityreports.md | + + Title: "cloudPcReports: retrieveConnectionQualityReports" +description: "Get the overall connection quality reports for all devices in the current tenant, the regional connection quality trend report, and the regional connection quality insight report, including round trip time, available bandwidth, UPD usage, and drop connections." ++ms.localizationpriority: medium ++++# cloudPcReports: retrieveConnectionQualityReports ++Namespace: microsoft.graph +++Get the overall connection quality reports for all devices in the current tenant. This includes the regional connection quality trend report, and the regional connection quality insight report, including round trip time, available bandwidth, UPD usage, and drop connections. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "cloudpcreports_retrieveconnectionqualityreports" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/virtualEndpoint/reports/retrieveConnectionQualityReports +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|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| +|:|:|:| +|filter|String|OData `$filter` syntax. Supported filters include: `and`, `or`, `lt`, `le`, `gt`, `ge`, and `eq`.| +|groupBy|String collection|Specifies how to group the reports. If used, must have the same contents as the **select** parameter.| +|orderBy|String collection|Specifies how to sort the reports.| +|search|String|Specifies a String to search.| +|select|String collection|OData `$select` syntax. The selected columns of the reports. | +|skip|Int32|The number of records to skip.| +|top|Int32|The number of top records to return.| ++## Response ++If successful, this action returns a `200 OK` response code and a Stream in the response body. ++## Examples ++### Request ++The following example shows a request. ++``` http +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveConnectionQualityReports +Content-Type: application/json +Content-length: 200 ++{ + "reportName":"regionalConnectionQualityTrendReport", + "filter": "", + "select": ["GatewayRegion", "RoundTripTimeTrend", "AvailableBandwidthTrend", "UDPUtilizationTrend", "DroppedConnectionTrend", "WeeklyAvgRoundTripTimeInMs", "DailyAvgRoundTripTimeInMs", "WeeklyAvailableBandwidthInMBps", "DailyAvailableBandwidthInMBps", "WeeklyUdpUtilization", "DailyWeeklyUdpUtilization", "WeeklyDroppedConnectionsCount", "DailyDroppedConnectionsCount"], + "search": "", + "skip": 0, + "top": 50 +} +``` ++### Response ++The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Edm.Stream" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/octet-stream ++{ + "TotalRowCount": 2, + "Schema": [ + { + "Column": "GatewayRegion", + "PropertyType": "String" + }, + { + "Column": "RoundTripTimeTrend", + "PropertyType": "String" + }, + { + "Column": "AvailableBandwidthTrend", + "PropertyType": "String" + }, + { + "Column": "UDPUtilizationTrend", + "PropertyType": "String" + }, + { + "Column": "DroppedConnectionTrend", + "PropertyType": "String" + }, + { + "Column": "WeeklyAvgRoundTripTimeInMs", + "PropertyType": "Double" + }, + { + "Column": "DailyAvgRoundTripTimeInMs", + "PropertyType": "Double" + }, + { + "Column": "WeeklyAvailableBandwidthInMBps", + "PropertyType": "Double" + }, + { + "Column": "DailyAvailableBandwidthInMBps", + "PropertyType": "Double" + }, + { + "Column": "WeeklyUdpUtilization", + "PropertyType": "Double" + }, + { + "Column": "DailyWeeklyUdpUtilization", + "PropertyType": "Double" + }, + { + "Column": "WeeklyDroppedConnectionsCount", + "PropertyType": "Int32" + }, + { + "Column": "DailyDroppedConnectionsCount", + "PropertyType": "Int32" + } + ], + "Values" :[ + ["Japan East", "Increasing", "Decreasing", "Static", "Decreasing", "296.25", "350.50", "3.1", "2,1", "51.2", "47.8", "19", "29"], + ["Southeast Asia", "Decreasing", "Static", "Increasing", "Increasing", "337.14", "299.50", "1.7", "2,2", "33.5", "67.8", "17", "16"], + ] +} +``` |
v1.0 | Cloudpcshareduseserviceplan Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/cloudpcshareduseserviceplan-get.md | - Title: "Get cloudPcSharedUseServicePlan (deprecated)" -description: "Read the properties and relationships of a cloudPcSharedUseServicePlan object." ---doc_type: apiPageType ---# Get cloudPcSharedUseServicePlan (deprecated) --Namespace: microsoft.graph ---> [!CAUTION] -> The **cloudPcSharedUseServicePlan** resource is deprecated and stopped returning data on April 24, 2024. Going forward, use the [cloudPcFrontLineServicePlan](../resources/cloudpcfrontlineserviceplan.md). --Read the properties and relationships of a [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) object. ---## Permissions --Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). --<!-- { "blockType": "permissions", "name": "cloudpcshareduseserviceplan_get" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/virtualEndpoint/sharedUseServicePlans/{cloudPcSharedUseServicePlanId} -``` --## 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. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| --## Request body --Don't supply a request body for this method. --## Response --If successful, this method returns a `200 OK` response code and a [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) object in the response body. --## Examples --### Request --The following example shows a request. --<!-- { - "blockType": "request", - "name": "get_cloudpcshareduseserviceplan" -} >-``` http -GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/sharedUseServicePlans/613a8d85-6c33-1268-9f55-b96a6540017c -``` --### Response --The following example shows the response. -->**Note:** The response object shown here might be shortened for readability. -<!-- { - "blockType": "response", - "truncated": true, - "@odata.type": "microsoft.graph.cloudPcSharedUseServicePlan" -} >-``` http -HTTP/1.1 200 OK -Content-Type: application/json --{ - "value": { - "@odata.type": "#microsoft.graph.cloudPcSharedUseServicePlan", - "id": "613a8d85-6c33-1268-9f55-b96a6540017c", - "displayName": "Display Name Value", - "usedCount": "10", - "totalCount": "20" - } -} -``` |
v1.0 | Community Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/community-delete.md | Title: "Delete community" -description: "Delete a community in Viva Engage." +description: "Delete a Viva Engage community along with all associated Microsoft 365 content, including the connected Microsoft 365 group, OneNote notebook, and Planner plans." ms.localizationpriority: medium |
v1.0 | Companysubscription Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/companysubscription-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "companysubscription_get" } --> [!INCLUDE [permissions-table](../includes/permissions/companysubscription-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Compliantnetworknamedlocation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/compliantnetworknamedlocation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "compliantnetworknamedlocation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/compliantnetworknamedlocation-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Compliantnetworknamedlocation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/compliantnetworknamedlocation-update.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | Policy.Read.All and Policy.ReadWrite.ConditionalAccess | + ## HTTP request <!-- { |
v1.0 | Conditionalaccesspolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccesspolicy-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccesspolicy-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conditionalaccesspolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccesspolicy-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "conditionalaccesspolicy_get" } --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccesspolicy-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conditionalaccesspolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccesspolicy-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccesspolicy-update-permissions.md)] + > [!NOTE] > This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13671) and may require consent to multiple permissions. |
v1.0 | Conditionalaccessroot List Authenticationcontextclassreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccessroot-list-authenticationcontextclassreferences.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "conditionalaccessroot_list_authenticationcontextclassreferences" } --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccessroot-list-authenticationcontextclassreferences-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conditionalaccessroot List Namedlocations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccessroot-list-namedlocations.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "conditionalaccessroot_list_namedlocations" } --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccessroot-list-namedlocations-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conditionalaccessroot List Policies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccessroot-list-policies.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "conditionalaccessroot_list_policies" } --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccessroot-list-policies-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conditionalaccessroot List Templates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccessroot-list-templates.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "conditionalaccessroot_list_templates" } --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccessroot-list-templates-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Conditionalaccessroot Post Authenticationcontextclassreferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccessroot-post-authenticationcontextclassreferences.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "conditionalaccessroot_post_authenticationcontextclassreferences" } --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccessroot-post-authenticationcontextclassreferences-permissions.md)] + > [!NOTE] > This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13671) and may require consent to multiple permissions. |
v1.0 | Conditionalaccessroot Post Namedlocations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccessroot-post-namedlocations.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccessroot-post-namedlocations-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conditionalaccessroot Post Policies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccessroot-post-policies.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccessroot-post-policies-permissions.md)] + > [!NOTE] > This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13671) and may require consent to multiple permissions. |
v1.0 | Conditionalaccesstemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conditionalaccesstemplate-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "conditionalaccesstemplate_get" } --> [!INCLUDE [permissions-table](../includes/permissions/conditionalaccesstemplate-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Contact Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contact-permanentdelete.md | + + Title: "contact: permanentDelete" +description: "Permanently delete a contact and place it in the Purges folder in the user's mailbox." ++ms.localizationpriority: high ++++# contact: permanentDelete ++Namespace: microsoft.graph +++Permanently delete a contact and place it in the Purges folder in the dumpster in the user's mailbox. Email clients such as Outlook or Outlook on the web can't access permanently deleted items. Unless there's a hold set on the mailbox, the items are permanently deleted after a set period of time. ++For more information about item retention, see [Configure Deleted Item retention and Recoverable Items quotas](/exchange/configure-deleted-item-retention-and-recoverable-items-quotas-exchange-2013-help). +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "contact_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/contacts/{contactId}/permanentDelete +POST /users/{usersId}/contactFolders/{contactFolderId}/contacts/{contactId}/permanentDelete +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "contactthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/contacts/{contactId}/permanentDelete +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Contactfolder Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contactfolder-permanentdelete.md | + + Title: "contactFolder: permanentDelete" +description: "Permanently delete a contact folder and remove its items from the user's mailbox." ++ms.localizationpriority: high ++++# contactFolder: permanentDelete ++Namespace: microsoft.graph +++Permanently delete a contact folder and remove its items from the user's mailbox. For more information about item retention, see [Configure Deleted Item retention and Recoverable Items quotas](/exchange/configure-deleted-item-retention-and-recoverable-items-quotas-exchange-2013-help). ++>**Note:** Folders aren't placed in the Purges folder when they are permanently deleted. Permanently deleted folders are removed from the mailbox. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "contactfolder_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/contactFolders/{contactFolderId}/permanentDelete +POST /users/{usersId}/contactFolders/{contactFolderId}/childFolders/{contactFolderId}/permanentDelete +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "contactfolderthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/contactFolders/{contactFolderId}/permanentDelete +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Contentmodel Addtodrive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contentmodel-addtodrive.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/contentmodelthisaddtodrive-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/contentmodelthisaddtodrive-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Contentmodel Getapplieddrives | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contentmodel-getapplieddrives.md | GET https://graph.microsoft.com/beta/sites/ede4bb84-6c94-4c39-8acf-3d9dbb667fba/ [!INCLUDE [sample-code](../includes/snippets/php/contentmodelthisgetapplieddrives-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/contentmodelthisgetapplieddrives-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Contentmodel Removefromdrive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contentmodel-removefromdrive.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/contentmodelthisremovefromdrive-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/contentmodelthisremovefromdrive-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Continuousaccessevaluationpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/continuousaccessevaluationpolicy-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "continuousaccessevaluationpolicy_get" } --> [!INCLUDE [permissions-table](../includes/permissions/continuousaccessevaluationpolicy-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored"} --> |
v1.0 | Continuousaccessevaluationpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/continuousaccessevaluationpolicy-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/continuousaccessevaluationpolicy-update-permissions.md)] + > [!NOTE] > This method has a [known permissions issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=13671) and may require consent to multiple permissions. |
v1.0 | Contract Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contract-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "contract_get" } --> [!INCLUDE [permissions-table](../includes/permissions/contract-get-permissions.md)] +> [!IMPORTANT] +> +> In delegated scenarios with work or school accounts, the signed-in user be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *Directory Readers* is the only least privileged role supported for this operation. + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Contract List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/contract-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "contract_list" } --> [!INCLUDE [permissions-table](../includes/permissions/contract-list-permissions.md)] +> [!IMPORTANT] +> +> In delegated scenarios with work or school accounts, the signed-in user be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *Directory Readers* is the only least privileged role supported for this operation. + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conversationmember Remove | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conversationmember-remove.md | + + Title: "conversationMember: remove" +description: "Remove members in bulk from a team." ++ms.localizationpriority: high ++++# conversationMember: remove ++Namespace: microsoft.graph +++Remove multiple members from a [team](../resources/team.md) in a single request. The response provides details about which memberships could and couldn't be removed. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "conversationmember_remove" } --> +++## HTTP request ++This is a bound action to remove multiple elements from a [conversationMember](../resources/conversationmember.md) collection in a single request. +<!-- { "blockType": "ignored" } --> ++```http +POST /teams/{team-id}/members/remove +``` ++## Request headers ++| Header | Value | +| : | : | +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +| Content-Type | application/json. Required. | ++## Request body ++In the request body, supply the JSON representation of the list of **conversationMember** derivatives to be removed from a team. A maximum of 20 **conversationMember** derivatives can be removed in a single request. ++The following table shows the parameter that you can use with this method. ++|Parameter|Type|Description| +|:|:|:| +|values|[conversationMember](../resources/conversationmember.md) collection|A list of conversation members that should be removed.| ++## Response ++If successful, this method returns either a `204 No Content` response if all specified members were successfully removed from the team or a `207 Multi-Status` response if only some members were removed. The caller should inspect the response payload to identify which member removals failed. The response body contains a collection of derivatives of the [actionResultPart](../resources/actionresultpart.md) resource. If the request fails, the API returns an error. For more information about Microsoft Graph errors, see [Microsoft Graph error responses and resource types](/graph/errors). ++## Examples ++### Example 1: Remove members in bulk from a team ++The following example shows how to remove multiple members from a **team** in a single request. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "bulkremovemembers_team" +}--> ++```http +POST https://graph.microsoft.com/beta/teams/e4183b04-c9a2-417c-bde4-70e3ee46a6dc/members/remove +Content-Type: application/json ++{ + "values": [ + { + "@odata.type": "microsoft.graph.aadUserConversationMember", + "user@odata.bind": "https://graph.microsoft.com/beta/users('18a80140-b0fb-4489-b360-2f6efaf225a0')" + }, + { + "@odata.type": "microsoft.graph.aadUserConversationMember", + "user@odata.bind": "https://graph.microsoft.com/beta/users('86503198-b81b-43fe-81ee-ad45b8848ac9')" + } + ] +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": false +} --> ++```http +HTTP/1.1 204 No Content +``` ++### Example 2: Remove members in bulk from a team using user principal name ++The following example shows how to remove multiple members from a **team** in a single request using their user principal names. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "bulkdeletemembers_team_upn" +}--> ++```http +POST https://graph.microsoft.com/beta/teams/e4183b04-c9a2-417c-bde4-70e3ee46a6dc/members/remove +Content-Type: application/json ++{ + "values": [ + { + "@odata.type": "microsoft.graph.aadUserConversationMember", + "user@odata.bind": "https://graph.microsoft.com/beta/users('jacob@contoso.com')" + }, + { + "@odata.type": "microsoft.graph.aadUserConversationMember", + "user@odata.bind": "https://graph.microsoft.com/beta/users('alex@contoso.com')" + } + ] +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": false +} --> ++```http +HTTP/1.1 204 No Content +``` ++### Example 3: Remove members in bulk from a team with failed removals ++The following example shows how to remove multiple members from a **team** when the removal of a member fails. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "bulkdeletemembers_team_partial" +}--> ++```http +POST https://graph.microsoft.com/beta/teams/e4183b04-c9a2-417c-bde4-70e3ee46a6dc/members/remove +Content-Type: application/json ++{ + "values": [ + { + "@odata.type": "microsoft.graph.aadUserConversationMember", + "user@odata.bind": "https://graph.microsoft.com/beta/users('c04f28bf-ab68-40a2-974b-e6af31fa78fb')" + }, + { + "@odata.type": "microsoft.graph.aadUserConversationMember", + "user@odata.bind": "https://graph.microsoft.com/beta/users('86503198-b81b-43fe-81ee-ad45b8848ac9')" + } + ] +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. ++> **Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.actionResultPart)" +} --> ++```http +HTTP/1.1 207 Multi-Status +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.aadUserConversationMemberResult)", + "value": [ + { + "@odata.type": "#microsoft.graph.aadUserConversationMemberResult", + "userId": "c04f28bf-ab68-40a2-974b-e6af31fa78fb", + "error": { + "code": "NotFound", + "message": "Could not find resource" + } + }, + { + "@odata.type": "#microsoft.graph.aadUserConversationMemberResult", + "userId": "86503198-b81b-43fe-81ee-ad45b8848ac9", + "error": null + } + ] +} +``` ++## Related content ++[Remove member from team](team-delete-members.md) ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2024-09-12 06:02:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Remove members from a team in bulk.", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [] +} +--> + |
v1.0 | Conversationmembers Add | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/conversationmembers-add.md | Title: "conversationMember: add" description: "Add members in bulk to a team."-+ doc_type: "apiPageType" ms.localizationpriority: high |
v1.0 | Countrynamedlocation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/countrynamedlocation-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/countrynamedlocation-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Countrynamedlocation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/countrynamedlocation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "countrynamedlocation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/countrynamedlocation-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Countrynamedlocation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/countrynamedlocation-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/countrynamedlocation-update-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Crosstenantaccesspolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicy-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicy_get" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicy-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicy List Partners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicy-list-partners.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicy_list_partners" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicy-list-partners-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicy Post Partners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicy-post-partners.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicy_post_partners" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicy-post-partners-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicy-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicy_update" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicy-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicyconfigurationdefault Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationdefault-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicyconfigurationdefault_get" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicyconfigurationdefault-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicyconfigurationdefault Resettosystemdefault | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationdefault-resettosystemdefault.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicyconfigurationdefault_resettosystemdefault" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicyconfigurationdefault-resettosystemdefault-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicyconfigurationdefault Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationdefault-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicyconfigurationdefault_update" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicyconfigurationdefault-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicyconfigurationpartner Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationpartner-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicyconfigurationpartner_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicyconfigurationpartner-delete-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicyconfigurationpartner Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationpartner-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicyconfigurationpartner_get" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicyconfigurationpartner-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantaccesspolicyconfigurationpartner Put Identitysynchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationpartner-put-identitysynchronization.md | Namespace: microsoft.graph Create a cross-tenant user synchronization policy for a partner-specific configuration. ## Permissions Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicyconfigurationpartner_put_identitysynchronization" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicyconfigurationpartner-put-identitysynchronization-permissions.md)] -The signed-in user must also be assigned the following minimum [directory role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Security Administrator ## HTTP request |
v1.0 | Crosstenantaccesspolicyconfigurationpartner Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantaccesspolicyconfigurationpartner-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantaccesspolicyconfigurationpartner_update" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantaccesspolicyconfigurationpartner-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Crosstenantidentitysyncpolicypartner Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantidentitysyncpolicypartner-delete.md | Namespace: microsoft.graph Delete the user synchronization policy for a partner-specific configuration. ## Permissions Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantidentitysyncpolicypartner_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantidentitysyncpolicypartner-delete-permissions.md)] -The signed-in user must also be assigned the following minimum [directory role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Security Administrator ## HTTP request |
v1.0 | Crosstenantidentitysyncpolicypartner Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantidentitysyncpolicypartner-get.md | Namespace: microsoft.graph Get the user synchronization policy of a partner-specific configuration. ## Permissions Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantidentitysyncpolicypartner_get" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantidentitysyncpolicypartner-get-permissions.md)] -The signed-in user must also be assigned the following minimum [directory role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Security Administrator ## HTTP request |
v1.0 | Crosstenantidentitysyncpolicypartner Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/crosstenantidentitysyncpolicypartner-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "crosstenantidentitysyncpolicypartner_update" } --> [!INCLUDE [permissions-table](../includes/permissions/crosstenantidentitysyncpolicypartner-update-permissions.md)] -The signed-in user must also be assigned the following minimum [directory role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Security Administrator ## HTTP request |
v1.0 | Customauthenticationextension Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customauthenticationextension-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Delete a [customAuthenticationExtension](../resources/customauthenticationextension.md) object. +Delete a [customAuthenticationExtension](../resources/customauthenticationextension.md) object. The following derived types are currently supported. ++- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type. +- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type. +- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "customauthenticationextension_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/customauthenticationextension-delete-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Customauthenticationextension Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customauthenticationextension-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the properties and relationships of a [customAuthenticationExtension](../resources/customauthenticationextension.md) object. +Read the properties and relationships of a [customAuthenticationExtension](../resources/customauthenticationextension.md) object. The following derived types are currently supported. ++- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type. +- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type. +- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "customauthenticationextension_get" } --> [!INCLUDE [permissions-table](../includes/permissions/customauthenticationextension-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Customauthenticationextension Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customauthenticationextension-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of a [customAuthenticationExtension](../resources/customauthenticationextension.md) object. +Update the properties of a [customAuthenticationExtension](../resources/customauthenticationextension.md) object. The following derived types are currently supported. ++- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type. +- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type. +- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "customauthenticationextension_update" } --> [!INCLUDE [permissions-table](../includes/permissions/customauthenticationextension-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Customauthenticationextension Validateauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/customauthenticationextension-validateauthenticationconfiguration.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An API to check validity of the endpoint and and authentication configuration for a customAuthenticationExtension. +An API to check validity of the endpoint and and authentication configuration for a [customAuthenticationExtension](../resources/customauthenticationextension.md) object, which can represent one of the following derived types: ++- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type. +- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type. +- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "customauthenticationextension_validateauthenticationconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/customauthenticationextension-validateauthenticationconfiguration-permissions.md)] + ## HTTP request To validate the endpoint and authentication configuration for a customAuthenticationExtension by its ID. |
v1.0 | Daynote Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/daynote-delete.md | Delete a [day note](../resources/daynote.md) object. ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). +<!-- { "blockType": "permissions", "name": "daynote_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/daynote-delete-permissions.md)] ## HTTP request |
v1.0 | Daynote Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/daynote-get.md | Read the properties and relationships of a [day note](../resources/daynote.md) o ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). +<!-- { "blockType": "permissions", "name": "daynote_get" } --> [!INCLUDE [permissions-table](../includes/permissions/daynote-get-permissions.md)] ## HTTP request |
v1.0 | Daynote List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/daynote-list.md | Retrieve the properties and relationships of all [day notes](../resources/daynot ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). +<!-- { "blockType": "permissions", "name": "daynote_list" } --> [!INCLUDE [permissions-table](../includes/permissions/daynote-list-permissions.md)] ## HTTP request |
v1.0 | Device Delete Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-delete-registeredowners.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Device Delete Registeredusers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-delete-registeredusers.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] -The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator* or *Windows 365 Administrator*. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Device Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/device-delete-permissions.md)] -The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator*, *Windows 365 Administrator*, or *Cloud Device Administrator*. +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Intune Administrator +> - Windows 365 Administrator +> - Cloud Device Administrator ## HTTP request |
v1.0 | Device Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-delta.md | doc_type: apiPageType Namespace: microsoft.graph -Get newly created, updated, or deleted devices without performing a full read of the entire resource collection. For more information, see [Using delta query](/graph/delta-query-overview). +Get newly created, updated, or deleted devices without performing a full read of the entire resource collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_delta" } --> [!INCLUDE [permissions-table](../includes/permissions/device-delta-permissions.md)] + ## HTTP request To begin tracking changes, you make a request including the delta function on the **device** resource. GET /devices/delta Tracking changes incurs a round of one or more **delta** function calls. To use any query parameter other than `$deltatoken` and `$skiptoken`, you must specify it in the initial **delta** request and Microsoft Graph automatically encodes any specified parameters into the `$deltatoken` portion of the `@odata.nextLink` or `@odata.deltaLink` URL provided in the response. -| Query parameter | Type |Description| +| Query parameter | Type |Description| |:|:--|:-| | $deltatoken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.deltaLink` URL of the previous **delta** function call for the same resource collection, indicating the completion of that round of change tracking. Save and apply the entire `@odata.deltaLink` URL including this token in the first request of the next round of change tracking for that collection.| | $skiptoken | string | A [state token](/graph/delta-query-overview) returned in the `@odata.nextLink` URL of the previous **delta** function call, indicating that there are further changes to be tracked in the same resource collection. | |
v1.0 | Device Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_get" } --> [!INCLUDE [permissions-table](../includes/permissions/device-get-permissions.md)] -The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Users -* Directory Readers -* Directory Writers -* Compliance Administrator -* Device Managers -* Application Administrator -* Security Reader -* Security Administrator -* Privileged Role Administrator -* Cloud Application Administrator -* Customer LockBox Access Approver -* Dynamics 365 Administrator -* Power BI Administrator -* Desktop Analytics Administrator -* Microsoft Managed Desktop Administrator -* Teams Communications Administrator -* Teams Communications Support Engineer -* Teams Communications Support Specialist -* Teams Administrator -* Compliance Data Administrator -* Security Operator -* Kaizala Administrator -* Global Reader -* Directory Reviewer -* Windows 365 Administrator ## HTTP request |
v1.0 | Device List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list-memberof.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Directory Readers +> - Global Reader +> - Intune Administrator +> - Windows 365 Administrator + ## HTTP request You can address the device using either its **id** or **deviceId**. |
v1.0 | Device List Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list-registeredowners.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Directory Readers +> - Global Reader +> - Intune Administrator +> - Windows 365 Administrator + ## HTTP request You can address the device using either its **id** or **deviceId**. |
v1.0 | Device List Registeredusers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list-registeredusers.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] -The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Users -* Directory Readers -* Directory Writers -* Compliance Administrator -* Device Managers -* Application Administrator -* Security Reader -* Security Administrator -* Privileged Role Administrator -* Cloud Application Administrator -* Customer LockBox Access Approver -* Dynamics 365 Administrator -* Power BI Administrator -* Desktop Analytics Administrator -* Microsoft Managed Desktop Administrator -* Teams Communications Administrator -* Teams Communications Support Engineer -* Teams Communications Support Specialist -* Teams Administrator -* Compliance Data Administrator -* Security Operator -* Kaizala Administrator -* Global Reader -* Directory Reviewer -* Windows 365 Administrator +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Directory Readers +> - Global Reader +> - Intune Administrator +> - Windows 365 Administrator ## HTTP request |
v1.0 | Device List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list-transitivememberof.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Directory Readers +> - Global Reader +> - Intune Administrator +> - Windows 365 Administrator + ## HTTP request |
v1.0 | Device List Usagerights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list-usagerights.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_list_usagerights" } --> [!INCLUDE [permissions-table](../includes/permissions/device-list-usagerights-permissions.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Directory Readers +> - Global Reader +> - Intune Administrator +> - Windows 365 Administrator + ## HTTP request You can address the device using either its **id** or **deviceId**. |
v1.0 | Device List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_list" } --> [!INCLUDE [permissions-table](../includes/permissions/device-list-permissions.md)] -The calling user must also be in one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Users -* Directory Readers -* Directory Writers -* Compliance Administrator -* Device Managers -* Application Administrator -* Security Reader -* Security Administrator -* Privileged Role Administrator -* Cloud Application Administrator -* Customer LockBox Access Approver -* Dynamics 365 Administrator -* Power BI Administrator -* Desktop Analytics Administrator -* Microsoft Managed Desktop Administrator -* Teams Communications Administrator -* Teams Communications Support Engineer -* Teams Communications Support Specialist -* Teams Administrator -* Compliance Data Administrator -* Security Operator -* Kaizala Administrator -* Global Reader -* Directory Reviewer -* Windows 365 Administrator ## HTTP request |
v1.0 | Device Post Devices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-post-devices.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_post_devices" } --> [!INCLUDE [permissions-table](../includes/permissions/device-post-devices-permissions.md)] -The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator* or *Windows 365 Administrator*. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Device Post Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-post-registeredowners.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_post_registeredowners" } --> [!INCLUDE [permissions-table](../includes/permissions/device-post-registeredowners-permissions.md)] + ## HTTP request You can address the device using either its **id** or **deviceId**. |
v1.0 | Device Post Registeredusers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-post-registeredusers.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "device_post_registeredusers" } --> [!INCLUDE [permissions-table](../includes/permissions/device-post-registeredusers-permissions.md)] -The calling user must also be in at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): *Intune Administrator* or *Windows 365 Administrator*. ## HTTP request |
v1.0 | Device Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/device-update.md | Choose the permission or permissions marked as least privileged for this API. Us In application-only scenarios and for non-Windows devices, that is, where the **operatingSystem** property is not `Windows`, the app can update only the **extensionAttributes** property. -The calling user must also be in at least the *Intune Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). A calling user in the *Cloud Device Administrator* role can only enable or disable devices and a user with the *Windows 365 Administrator* role can only update basic device properties. +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *Intune Administrator* is the least privileged role supported for this operation. A calling user in the *Cloud Device Administrator* role can only enable or disable devices and a user with the *Windows 365 Administrator* role can only update basic device properties. ## HTTP request |
v1.0 | Devicelocalcredentialinfo Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/devicelocalcredentialinfo-get.md | Choose the permission or permissions marked as least privileged for this API. Us To access the actual passwords on the device, done by including `$select=credentials` as part of the query parameters, the app must be assigned the *DeviceLocalCredential.Read.All* permission and *DeviceLocalCredential.ReadBasic.All* is insufficient. +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Cloud Device Administrator +> - Helpdesk Administrator +> - Intune Service Administrator +> - Security Administrator +> - Security Reader +> - Global Reader +> +> To access the actual passwords on the device by using the `$select=credentials` query parameter, the following least privileged roles are supported: +> - Cloud Device Administrator +> - Intune Service Administrator ## HTTP request To get the device local credential for a specific device object: -> [!CAUTION] -> The `GET /deviceLocalCredentials` endpoint will be deprecated on December 31, 2023. Use the `GET /directory/deviceLocalCredentials` endpoint instead. -> - <!-- { "blockType": "ignored" } --> ``` http GET /directory/deviceLocalCredentials/{deviceId}-GET /deviceLocalCredentials/{deviceId} ``` ## Request headers |
v1.0 | Directory Delete Externaluserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-externaluserprofiles.md | Delete an [externalUserProfile](../resources/externaluserprofile.md) object. Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "directory-delete-externaluserprofiles-permissions" -} >+<!-- { "blockType": "permissions", "name": "directory_delete_externaluserprofiles" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-delete-externaluserprofiles-permissions.md)] [!INCLUDE [rbac-externaluserprofiles-apis-write](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-write.md)] |
v1.0 | Directory Delete Pendingexternaluserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-delete-pendingexternaluserprofiles.md | Delete a [pendingExternalUserProfile](../resources/pendingexternaluserprofile.md Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "directory-delete-pendingexternaluserprofiles-permissions" -} >+<!-- { "blockType": "permissions", "name": "directory_delete_pendingexternaluserprofiles" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-delete-pendingexternaluserprofiles-permissions.md)] [!INCLUDE [rbac-externaluserprofiles-apis-write](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-write.md)] |
v1.0 | Directory List Customsecurityattributedefinitions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-customsecurityattributedefinitions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directory_list_customsecurityattributedefinitions" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-list-customsecurityattributedefinitions-permissions.md)] -The signed-in user must also be assigned one of the following [directory roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --+ Attribute Definition Reader -+ Attribute Assignment Administrator -+ Attribute Definition Administrator --By default, Global Administrator and other administrator roles do not have permissions to read, define, or assign custom security attributes. +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following privileged roles are supported for this operation. +> - Attribute Definition Reader +> - Attribute Assignment Administrator +> - Attribute Definition Administrator +> +> By default, Global Administrator and other administrator roles do not have permissions to read, define, or assign custom security attributes. ## HTTP request |
v1.0 | Directory List Devicelocalcredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-devicelocalcredentials.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directory_list_devicelocalcredentials" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-list-devicelocalcredentials-permissions.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Cloud Device Administrator +> - Helpdesk Administrator +> - Intune Service Administrator +> - Security Administrator +> - Security Reader +> - Global Reader ## HTTP request To get a list of deviceLocalCredentialInfo within the tenant: -> [!CAUTION] -> The `GET /deviceLocalCredentials` endpoint will be deprecated on December 31, 2023. Use the `GET /directory/deviceLocalCredentials` endpoint instead. - <!-- { "blockType": "ignored" } --> ``` http GET /directory/deviceLocalCredentials-GET /deviceLocalCredentials ``` ## Optional query parameters |
v1.0 | Directory List Externaluserprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-externaluserprofiles.md | Retrieve the properties of all [externalUserProfiles](../resources/externaluserp Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "directory-list-externaluserprofiles-permissions" -} >+<!-- { "blockType": "permissions", "name": "directory_list_externaluserprofiles" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-list-externaluserprofiles-permissions.md)] [!INCLUDE [rbac-externaluserprofiles-apis-read](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-read.md)] |
v1.0 | Directory List Pendingexternaluserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-pendingexternaluserprofile.md | Retrieve the properties of all [pendingExternalUserProfiles](../resources/pendin Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "directory-list-pendingexternaluserprofiles-permissions" -} >+<!-- { "blockType": "permissions", "name": "directory_list_pendingexternaluserprofile" } --> [!INCLUDE [rbac-externaluserprofiles-apis-read](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-read.md)] |
v1.0 | Directory List Subscriptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-list-subscriptions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directory_list_subscriptions" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-list-subscriptions-permissions.md)] ++ ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Directory Post Administrativeunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-administrativeunits.md | Title: "Create administrativeUnit" -description: "Use this API to create a new administrativeUnit." +description: "Create a new administrativeUnit." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Use this API to create a new [administrativeUnit](../resources/administrativeunit.md). +Create a new [administrativeUnit](../resources/administrativeunit.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directory_post_administrativeunits" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-post-administrativeunits-permissions.md)] -In delegated scenarios, the signed-in user must also be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the `microsoft.directory/administrativeUnits/allProperties/allTasks` role permission. *Privileged Role Administrator* is the least privileged role for this operation. ## HTTP request <!-- { "blockType": "ignored" } --> In delegated scenarios, the signed-in user must also be assigned a supported [Mi POST /administrativeUnits POST /directory/administrativeUnits ```+ ## Request headers | Name |Description| |:-|:-| POST /directory/administrativeUnits ## Request body In the request body, supply a JSON representation of an [administrativeUnit](../resources/administrativeunit.md) object. -You can specify the following properties when creating an **administrativeUnit**. +You can specify the following properties when you create an **administrativeUnit**. | Property | Type |Description| |:|:--|:-| | description | String | Description for the administrative unit. Optional. | | displayName | String | Display name for the administrative unit. Required. | | isMemberManagementRestricted | Boolean | `true` if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. Default value is `false`. Use this property to define administrative units whose roles don't inherit from tenant-level administrators, and management of individual member objects is limited to administrators scoped to a restricted management administrative unit. Immutable, so can't be changed later. Optional. |-| membershipRule | String | Dynamic membership rule for the administrative unit. For more about the rules that you can use for dynamic administrative units and dynamic groups, see [Using attributes to create advanced rules](https://azure.microsoft.com/documentation/articles/active-directory-accessmanagement-groups-with-advanced-rules/). Optional. | -| membershipRuleProcessingState | String | Used to control whether the dynamic membership rule is actively processed. Set to `On` when you want the dynamic membership rule to be active and `Paused` if you want to stop updating membership dynamically. Optional. | -| membershipType | String | Membership type for the administrative unit. Can be `dynamic` or `assigned`. Optional. | -| 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. Optional. | +| membershipRule | String | The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see [Manage rules for dynamic membership groups in Microsoft Entra ID](/entra/identity/users/groups-dynamic-membership). Optional.| +| membershipRuleProcessingState | String | Controls whether the dynamic membership rule is actively processed. Set to `On` to activate the dynamic membership rule, or `Paused` to stop updating membership dynamically. Optional. | +| membershipType | String | Indicates the membership type for the administrative unit. The possible values are: `dynamic`, `assigned`. If not set, the default value is `null` and the default behavior is assigned. Optional. | +| visibility | String | The visibility of the administrative unit. If not set, the default value is `null` and the default behavior is public. It can be set to `HiddenMembership` to hide the membership from nonmembers. Optional. | -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. +The **administrativeUnit** resource supports [extensions](/graph/extensibility-overview), which allows you to use the `POST` operation to add custom properties with your own data when you create the administrative unit. ## Response If successful, this method returns a `201 Created` response code and an [adminis The following example creates a new administrative unit with a dynamic membership rule to include all users whose country is United States. #### Request-+The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request", Content-type: application/json The following example creates a new restricted management administrative unit. The `isMemberManagementRestricted` property is immutable, so can't be changed later. #### Request+The following example shows a request. # [HTTP](#tab/http) <!-- { "blockType": "request", Content-type: application/json -In the request body, supply a JSON representation of an [administrativeUnit](../resources/administrativeunit.md) object. - #### Response+The following example shows the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", |
v1.0 | Directory Post Pendingexternaluserprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directory-post-pendingexternaluserprofile.md | Create a new [pendingExternalUserProfile](../resources/pendingexternaluserprofil Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "directory-post-pendingexternaluserprofiles-permissions" -} >+<!-- { "blockType": "permissions", "name": "directory_post_pendingexternaluserprofile" } --> [!INCLUDE [rbac-externaluserprofiles-apis-write](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-write.md)] |
v1.0 | Directoryaudit Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryaudit-get.md | This method doesn't support any OData query parameters to help customize the res | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Directoryaudit List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryaudit-list.md | This method supports the `$filter` (`eq`, `ge`, `le`, `startswith`), `$top`, `$o | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Directoryobject Checkmembergroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryobject-checkmembergroups.md | One of the following permissions is required to call this API. To learn more, in | Delegated (personal Microsoft account) | Not supported. | | Application | User.Read.All, Directory.Read.All | -### Group memberships for a user +### Group memberships for the signed-in user +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> +| Permission type | Permissions (from least to most privileged) | +|:-|:-| +| Delegated (work or school account) | User.Read, User.ReadBasic.All, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All | +| Delegated (personal Microsoft account) | Not supported. | +| Application | Not supported. | ++### Group memberships for other users <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> | Permission type | Permissions (from least to most privileged) | |:-|:-| One of the following permissions is required to call this API. To learn more, in |Application | Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All | ### Group memberships for an organizational contact-<!-- { "blockType": "permissions", "name": "directoryobject_checkmembergroups_5" } --> --<!-- -The following table lists the permission types to use for different scenarios. --| Scenario | Permissions | -|:-|:-| -| To get group memberships for the signed-in user | Use one of the following sets of permissions: <br/> <li> **User.Read** and **GroupMember.Read.All** <li>**User.Read** and **Group.Read.All** | -| To get group memberships for any user | Use one of the following sets of permissions: <br/> <li> **User.ReadBasic.All** and **GroupMember.Read.All** <li>**User.Read.All** and **GroupMember.Read.All** <li>**User.ReadBasic.All** and **Group.Read.All** <li>**User.Read.All** and **Group.Read.All** | -| To get group memberships for a group | Use either the **GroupMember.Read.All** or **Group.Read.All** permission. | -| To get group memberships for a service principal | Use one of the following sets of permissions <br/> <li>**Application.ReadWrite.All** and **GroupMember.Read.All** <li>**Application.ReadWrite.All** and **Group.Read.All** | -| To get group memberships for a directory object | Use the **Directory.Read.All** permission. | >+<!-- { "blockType": "permissions", "name": "directoryobject_checkmembergroups_6" } --> ## HTTP request Group memberships for a directory object (user, group, service principal, or org POST /directoryObjects/{id}/checkMemberGroups ``` -Group memberships for the signed-in user or other users. +Group memberships for the signed-in user. <!-- { "blockType": "ignored" } --> ```http POST /me/checkMemberGroups+``` ++Group memberships for other users. +<!-- { "blockType": "ignored" } --> +```http POST /users/{id | userPrincipalName}/checkMemberGroups ``` |
v1.0 | Directoryobject Checkmemberobjects | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryobject-checkmemberobjects.md | One of the following permissions is required to call this API. To learn more, in |Delegated (personal Microsoft account) | Not supported. | |Application | Directory.Read.All | -### Memberships for a user +### Memberships for the signed-in user <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> |Permission type | Permissions (from least to most privileged) | |:--|:| |Delegated (work or school account) | User.Read, User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All | |Delegated (personal Microsoft account) | Not supported. |+|Application | Not supported. | ++### Memberships for other users +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> +|Permission type | Permissions (from least to most privileged) | +|:--|:| +|Delegated (work or school account) | User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All | +|Delegated (personal Microsoft account) | Not supported. | |Application | User.Read.All, Directory.Read.All, User.ReadWrite.All, Directory.ReadWrite.All | ### Memberships for a group Memberships for a directory object. POST /directoryObjects/{id}/checkMemberObjects ``` -Memberships for a user. +Memberships for the signed-in user. <!-- { "blockType": "ignored" } --> ```http POST /me/checkMemberObjects POST /users/{id | userPrincipalName}/checkMemberObjects ``` +Memberships for other users. +<!-- { "blockType": "ignored" } --> +```http +POST /users/{id | userPrincipalName}/checkMemberObjects +``` + Memberships for a group. <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Directoryobject Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryobject-delta.md | doc_type: apiPageType Namespace: microsoft.graph -Get newly created, updated, or deleted directory objects without performing a full read of the entire directoryObject collection. For more information about the delta function, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted directory objects without performing a full read of the entire directoryObject collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Directoryobject Getmembergroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryobject-getmembergroups.md | One of the following permissions is required to call this API. To learn more, in ### Group memberships for a directory object +Here, the permission allows you to read *any* directory object, regardless of the object type. To scope the operation to a specific object type and use lesser-privileged permissions, refer to other permissions tables on this page. + <!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> |Permission type | Permissions (from least to most privileged) | |:--|:|-|Delegated (work or school account) | User.ReadBasic.All and GroupMember.Read.All, User.Read.All and GroupMember.Read.All, User.ReadBasic.All and Group.Read.All, User.Read.All and Group.Read.All, Directory.Read.All | +|Delegated (work or school account) | Directory.Read.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | User.Read.All and GroupMember.Read.All, User.Read.All and Group.Read.All, Directory.Read.All | +|Application | Directory.Read.All | ### Group memberships for a user One of the following permissions is required to call this API. To learn more, in |:--|:| |Delegated (work or school account) | User.ReadBasic.All and GroupMember.Read.All, User.Read.All and GroupMember.Read.All, User.ReadBasic.All and Group.Read.All, User.Read.All and Group.Read.All, Directory.Read.All | |Delegated (personal Microsoft account) | Not supported. |-|Application | User.Read.All and GroupMember.Read.All, User.Read.All and Group.Read.All, Directory.Read.All | +|Application | User.ReadBasic.All and GroupMember.Read.All, User.Read.All and GroupMember.Read.All, User.ReadBasic.All and Group.Read.All, User.Read.All and Group.Read.All, Directory.Read.All | ### Group memberships for a group |
v1.0 | Directoryrole Delete Member | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-delete-member.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [Delete unifiedRoleAssignment](./unifiedroleassignment-delete.md). + Remove a member from a directoryRole. You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids). |
v1.0 | Directoryrole Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted directory roles without having to perform a full read of the entire resource collection. See [Using Delta Query](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted directory roles without having to perform a full read of the entire resource collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Directoryrole Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [Get unifiedRoleDefinition](./unifiedroledefinition-get.md). + Retrieve the properties of a directoryRole object. You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids). |
v1.0 | Directoryrole List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-list-members.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [List unifiedRoleAssignments](./rbacapplication-list-roleassignments.md). + Retrieve a list of the users that are assigned to the directory role. Only users can be assigned to a directory role. You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids). |
v1.0 | Directoryrole List Scopedmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-list-scopedmembers.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [List unifiedRoleAssignments](./rbacapplication-list-roleassignments.md). + Retrieve a list of [scopedRoleMembership](../resources/scopedrolemembership.md) objects for a directory role. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Directoryrole List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [List roleDefinitions](./rbacapplication-list-roledefinitions.md). + List the directory roles that are activated in the tenant. This operation only returns roles that have been activated. A role becomes activated when an admin activates the role using the [Activate directoryRole](directoryrole-post-directoryroles.md) API. Not all built-in roles are initially activated. |
v1.0 | Directoryrole Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryrole-post-members.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [Create unifiedRoleAssignment](./rbacapplication-post-roleassignments.md). + Create a new directory role member. You can use both the object ID and template ID of the **directoryRole** with this API. The template ID of a built-in role is immutable and can be seen in the role description on the Microsoft Entra admin center. For details, see [Role template IDs](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#role-template-ids). |
v1.0 | Directoryroletemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryroletemplate-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [Get unifiedRoleDefinition](./unifiedroledefinition-get.md). + Retrieve the properties and relationships of a directoryroletemplate object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryroletemplate_get" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryroletemplate-get-permissions.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *Global Reader* is the least privileged role supported for this operation. + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Directoryroletemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directoryroletemplate-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!NOTE] +> Microsoft recommends that you use the unified RBAC API instead of this API. The unified RBAC API provides more functionality and flexibility. For more information, see [List roleDefinitions](./rbacapplication-list-roledefinitions.md). + Retrieve a list of directoryroletemplate objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryroletemplate_list" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryroletemplate-list-permissions.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. *Global Reader* is the least privileged role supported for this operation. + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Directorysettingtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directorysettingtemplate-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directorysettingtemplate_get" } --> [!INCLUDE [permissions-table](../includes/permissions/directorysettingtemplate-get-permissions.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Microsoft Entra Joined Device Local Administrator - basic properties only +> - Directory Readers +> - Global Reader + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Directorysettingtemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directorysettingtemplate-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directorysettingtemplate_list" } --> [!INCLUDE [permissions-table](../includes/permissions/directorysettingtemplate-list-permissions.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation. +> - Microsoft Entra Joined Device Local Administrator - basic properties only +> - Directory Readers +> - Global Reader + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Domain Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-delete-permissions.md)] -The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Domain Forcedelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-forcedelete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_forcedelete" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-forcedelete-permissions.md)] -The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Domain Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_get" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-get-permissions.md)] -The work or school account needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). --* User Administrator -* Helpdesk Administrator -* Service Support Administrator -* Billing Administrator -* Mailbox Administrator -* Directory Readers -* Directory Writers -* AdHoc License Administrator -* Application Administrator -* Security Reader -* Security Administrator -* Privileged Role Administrator -* Cloud Application Administrator -* Customer LockBox Access Approver -* Dynamics 365 Administrator -* Power BI Administrator -* Azure Information Protection Administrator -* Desktop Analytics Administrator -* License Administrator -* Microsoft Managed Desktop Administrator -* Authentication Administrator -* Privileged Authentication Administrator -* Teams Communications Administrator -* Teams Communications Support Engineer -* Teams Communications Support Specialist -* Teams Administrator -* Insights Administrator -* Compliance Data Administrator -* Security Operator -* Kaizala Administrator -* Global Reader -* Volume Licensing Business Center User -* Volume Licensing Service Center User -* Modern Commerce Administrator -* Microsoft Store for Business User -* Directory Reviewer ## HTTP request If successful, this method returns a `200 OK` response code and [domain](../reso <!-- { "blockType": "request", "name": "get_domain",- "sampleKeys": ["contoso.com"] + "sampleKeys": ["woodgrovedemo.com"] }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/domains/contoso.com +GET https://graph.microsoft.com/beta/domains/woodgrovedemo.com ``` # [C#](#tab/csharp) HTTP/1.1 200 OK Content-type: application/json {- "authenticationType": "authenticationType-value", - "availabilityStatus": "availabilityStatus-value", - "id": "contoso.com", - "isAdminManaged": true, - "isDefault": true, - "isInitial": true, - "isRoot": true + "@odata.context": "https://graph.microsoft.com/beta/$metadata#domains/$entity", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET domains('<key>')?$select=authenticationType,availabilityStatus", + "authenticationType": "Managed", + "availabilityStatus": null, + "id": "woodgrovedemo.com", + "isAdminManaged": true, + "isDefault": true, + "isInitial": true, + "isRoot": true, + "isVerified": true, + "supportedServices": [ + "Email", + "OfficeCommunicationsOnline", + "CustomUrlDomain" + ], + "passwordValidityPeriodInDays": 2147483647, + "passwordNotificationWindowInDays": 14, + "state": null } ``` |
v1.0 | Domain List Domainnamereferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-domainnamereferences.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] -The work or school account needs to belong to at least the *Domain Name Administrator* or*Global Reader* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation: *Domain Name Administrator* or *Global Reader*. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Domain List Federationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-federationconfiguration.md | Content-Type: application/json "isSignedAuthenticationRequestRequired": true, "nextSigningCertificate": "MIIE3jCCAsagAwIBAgIQQcyDaZz3MI", "federatedIdpMfaBehavior": "rejectMfaByFederatedIdp",+ "passwordResetUri": "https://sts.contoso.com/adfs/passwordReset", "signingCertificateUpdateStatus": { "certificateUpdateResult": "Success", "lastRunDateTime": "2021-08-25T07:44:46.2616778Z" |
v1.0 | Domain List Rootdomain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-rootdomain.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_list_rootdomain" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-rootdomain-permissions.md)] + ## HTTP request <!-- { GET https://graph.microsoft.com/beta/domains/sub.contoso.com/rootDomain [!INCLUDE [sample-code](../includes/snippets/php/get-rootdomain-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/get-rootdomain-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Domain List Serviceconfigurationrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-serviceconfigurationrecords.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_list_serviceconfigurationrecords" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-serviceconfigurationrecords-permissions.md)] +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation: *Domain Name Administrator* or *Global Reader*. + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Domain List Verificationdnsrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list-verificationdnsrecords.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_list_verificationdnsrecords" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-verificationdnsrecords-permissions.md)] -The work or school account needs to belong to at least the *Domain Name Administrator* or *Global Reader* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +> [!IMPORTANT] +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with a supported role permission. The following least privileged roles are supported for this operation: *Domain Name Administrator* or *Global Reader*. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Domain List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_list" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-permissions.md)] -The work or school account needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* User Administrator -* Helpdesk Administrator -* Service Support Administrator -* Billing Administrator -* Mailbox Administrator -* Directory Readers -* Directory Writers -* AdHoc License Administrator -* Application Administrator -* Security Reader -* Security Administrator -* Privileged Role Administrator -* Cloud Application Administrator -* Customer LockBox Access Approver -* Dynamics 365 Administrator -* Power BI Administrator -* Azure Information Protection Administrator -* Desktop Analytics Administrator -* License Administrator -* Microsoft Managed Desktop Administrator -* Privileged Authentication Administrator -* Teams Communications Administrator -* Teams Communications Support Engineer -* Authentication Administrator -* Teams Communications Support Specialist -* Teams Administrator -* Insights Administrator -* Compliance Data Administrator -* Security Operator -* Kaizala Administrator -* Global Reader -* Volume Licensing Business Center User -* Volume Licensing Service Center User -* Modern Commerce Administrator -* Microsoft Store for Business User -* Directory Reviewer -* Domain Name Administrator -* Users -* Guest User -* Restricted Guest User ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Domain Post Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-post-domains.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_post_domains" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-post-domains-permissions.md)] -The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Domain Post Federationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-post-federationconfiguration.md | You can specify the following properties when creating an **internalDomainFedera |Property|Type|Description| |:|:|:|+|activeSignInUri|String|URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Microsoft Entra ID. Corresponds to the **ActiveLogOnUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |displayName|String|The display name of the federated identity provider.|+|federatedIdpMfaBehavior|federatedIdpMfaBehavior|Determines whether Microsoft Entra ID accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: `acceptIfMfaDoneByFederatedIdp`, `enforceMfaByFederatedIdp`, `rejectMfaByFederatedIdp`, `unknownFutureValue`. For more information, see [federatedIdpMfaBehavior values](#federatedidpmfabehavior-values).| +|isSignedAuthenticationRequestRequired|Boolean|If true, when SAML authentication requests are sent to the federated SAML IDP, Microsoft Entra ID signs those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IDP aren't signed.| |issuerUri|String|Issuer URI of the federation server.| |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications.|-|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and updates the federation settings for the domain when a new certificate is available.| +|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base 64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the autorollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.| |passiveSignInUri|String|URI that web-based clients are directed to when signing in to Microsoft Entra services.|-|preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`.| -|activeSignInUri|String|URL of the endpoint used by active clients when authenticating with federated domains set up for single sign-on in Microsoft Entra ID. Corresponds to the **ActiveLogOnUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| -|signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| +|passwordResetUri|String|URI that clients are redirected to for resetting their password.| +|preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. This parameter must be configured explicitly for the federation passive authentication flow to work. The possible values are: `wsFed`, `saml`, `unknownFutureValue`.| |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.|-|isSignedAuthenticationRequestRequired|Boolean|If true, when SAML authentication requests are sent to the federated SAML IDP, Microsoft Entra ID signs those requests using the OrgID signing key. If false (default), the SAML authentication requests sent to the federated IDP aren't signed.| -|nextSigningCertificate|String|Fallback token signing certificate that is used to sign tokens when the primary signing certificate expires. Formatted as Base 64 encoded strings of the public portion of the federated IdP's token signing certificate. Needs to be compatible with the X509Certificate2 class. Much like the **signingCertificate**, the **nextSigningCertificate** property is used if a rollover is required outside of the autorollover update, a new federation service is being set up, or if the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.| +|signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base 64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. <br>This property is used in the following scenarios: <li> If a rollover is required outside of the autorollover update <li> A new federation service is being set up <li> If the new token signing certificate isn't present in the federation properties after the federation service certificate has been updated.<br>Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and updates the federation settings for the domain when a new certificate is available.| +|signOutUri|String|URI that clients are redirected to when they sign out of Microsoft Entra services. Corresponds to the **LogOffUri** property of the [Set-MsolDomainFederationSettings MSOnline v1 PowerShell cmdlet](/powershell/module/msonline/set-msoldomainfederationsettings).| |signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.|-|federatedIdpMfaBehavior|federatedIdpMfaBehavior|Determines whether Microsoft Entra ID accepts the MFA performed by the federated IdP when a federated user accesses an application that is governed by a conditional access policy that requires MFA. The possible values are: `acceptIfMfaDoneByFederatedIdp`, `enforceMfaByFederatedIdp`, `rejectMfaByFederatedIdp`, `unknownFutureValue`. For more information, see [federatedIdpMfaBehavior values](#federatedidpmfabehavior-values).| [!INCLUDE [Azure AD PowerShell deprecation note](~/../api-reference/reusable-content/msgraph-powershell/includes/aad-powershell-deprecation-note.md)] Content-Type: application/json "promptLoginBehavior": "nativeSupport", "isSignedAuthenticationRequestRequired": true, "nextSigningCertificate": "MIIE3jCCAsagAwIBAgIQQcyDaZz3MI",- "federatedIdpMfaBehavior": "rejectMfaByFederatedIdp" + "federatedIdpMfaBehavior": "rejectMfaByFederatedIdp", + "passwordResetUri": "https://sts.contoso.com/adfs/passwordReset" } ``` Content-Type: application/json "certificateUpdateResult": "Success", "lastRunDateTime": "2021-08-25T07:44:46.2616778Z" },- "federatedIdpMfaBehavior": "rejectMfaByFederatedIdp" + "federatedIdpMfaBehavior": "rejectMfaByFederatedIdp", + "passwordResetUri": "https://sts.contoso.com/adfs/passwordReset" } ``` |
v1.0 | Domain Promote | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-promote.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_promote" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-promote-permissions.md)] -The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Domain Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_update" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-update-permissions.md)] -The work or school account needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --* Domain Name Administrator -* Security Administrator -* External Identity Provider Administrator +> [!IMPORTANT] +> The work or school account needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): +> - Domain Name Administrator +> - Security Administrator +> - External Identity Provider Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Domain Verify | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/domain-verify.md | Validate the ownership of a domain. > **Important:** > Only applies to an unverified domain. For an unverified domain, the isVerified property of the [domain](../resources/domain.md) is false. +> [!NOTE] +> Verifying a domain through Microsoft Graph doesn't configure the domain for use with Office 365 services like Exchange. Fully configuring the domain to work with Microsoft 365 products might require extra steps. For more information, see [Microsoft 365 admin setup](/microsoft-365/admin/setup/add-domain). + [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_verify" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-verify-permissions.md)] -The work or school account needs to belong to at least the *Domain Name Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Driveitem Copy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-copy.md | In the request body, provide a JSON object with the following parameters. | parentReference | [ItemReference](../resources/itemreference.md) | Optional. Reference to the parent item the copy is created in. | | name | string | Optional. The new name for the copy. If this information isn't provided, the same name is used as the original. | | childrenOnly | Boolean | Optional. If set to `true`, the children of the **driveItem** are copied but not the **driveItem** itself. The default value is `false`. Valid _only_ on folder items. |+| includeAllVersionHistory | Boolean | Optional. If set to `true`, source files version history (major versions and minor versions, if any) should be copied to the destination, within the target version setting limit. If `false`, only the latest major version is copied to the destination. The default value is `false`. | >[!NOTE] Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" }, "name": "contoso plan (copy).txt" Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" }, "childrenOnly": true Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" } } Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" } } HTTP/1.1 202 Accepted Location: https://contoso.sharepoint.com/_api/v2.0/monitor/4A3407B5-88FC-4504-8B21-0AABD3412717 ``` -### Example 5: Copy the children in a folder from root +### Example 5: Copy operation preserve version history ++The following example copies the item identified by `{item-id}` into a folder identified with a `driveId` and `id` value. It also copies the version history to the target folder. If the source file contains 20 versions and the destination version limit setting is 10, the copy only transfers the maximum number of versions the destination site allows, starting from the most recent. ++#### Request ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "copy-item-5", "scopes": "files.readwrite", "target": "action" } --> ++```http +POST https://graph.microsoft.com/beta/me/drive/items/{item-id}/copy +Content-Type: application/json ++{ + "parentReference": { + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", + "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" + }, + "includeAllVersionHistory": true +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. ++<!-- { "blockType": "response" } --> +```http +HTTP/1.1 202 Accepted +Location: https://contoso.sharepoint.com/_api/v2.0/monitor/4A3407B5-88FC-4504-8B21-0AABD3412717 ++``` ++### Example 6: Copy the children in a folder from root The following example attempts to copy the children in a folder identified by `{item-id}` (also known as root) into a folder identified with a `driveId` and `id` value. The `childrenOnly` parameter isn't set to true. The request fails because the copy operation can't be done in the root folder. #### Request-<!-- { "blockType": "ignored", "name": "copy-item-5" } --> +<!-- { "blockType": "ignored", "name": "copy-item-6" } --> ```http POST https://graph.microsoft.com/beta/me/drive/items/root/copy Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" } } Content-Length: 283 ``` To resolve this error, set the `childrenOnly` parameter to true. -### Example 6: Copy the children in a folder where source has more than 150 direct children +### Example 7: Copy the children in a folder where source has more than 150 direct children The following example attempts to copy the children in a folder identified by `{item-id}` into a folder identified with a `driveId` and `id` value. The `childrenOnly` parameter is set to true. The drive item identified by `{item-id}` contains more than 150 direct children. The request fails because the limit is 150 direct children. #### Request-<!-- { "blockType": "ignored", "name": "copy-item-6" } --> +<!-- { "blockType": "ignored", "name": "copy-item-7" } --> ```http POST https://graph.microsoft.com/beta/me/drive/items/{item-id}/copy Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" } } Content-Length: 341 ``` To resolve this error, reorganize the source folder structure only to have 150 children. -### Example 7: Copy the children where the source item is a file +### Example 8: Copy the children where the source item is a file The following example attempts to copy the children in a folder identified by `{item-id}` into a folder identified with a `driveId` and `id` value. The `{item-id}` refers to a file, not a folder. The `childrenOnly` parameter is set to true. The request fails since the `{item-id}` is a nonfolder driveItem. #### Request-<!-- { "blockType": "ignored", "name": "copy-item-7" } --> +<!-- { "blockType": "ignored", "name": "copy-item-8" } --> ```http POST https://graph.microsoft.com/beta/me/drive/items/{item-id}/copy Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" }, "childrenOnly": true Content-Length: 290 } ``` -### Example 8: Copy the children in a folder with childrenOnly and name +### Example 9: Copy the children in a folder with childrenOnly and name The following example attempts to copy the children in a folder identified by `{item-id}` into a folder identified with a `driveId` and `id` value. The `childrenOnly` parameter is set to true and specify a `name` value. The request fails because `childrenOnly` and `name` can't be used together. #### Request-<!-- { "blockType": "ignored", "name": "copy-item-8" } --> +<!-- { "blockType": "ignored", "name": "copy-item-9" } --> ```http POST https://graph.microsoft.com/beta/me/drive/items/{item-id}/copy Content-Type: application/json { "parentReference": {- "driveId": "6F7D00BF-FC4D-4E62-9769-6AEA81F3A21B", + "driveId": "b!s8RqPCGh0ESQS2EYnKM0IKS3lM7GxjdAviiob7oc5pXv_0LiL-62Qq3IXyrXnEop", "id": "DCD0D3AD-8989-4F23-A5A2-2C086050513F" }, "name": "contoso plan (copy).txt", |
v1.0 | Driveitem Discardcheckout | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-discardcheckout.md | Don't supply a request body for this method. If successful, this action returns a `204 No Content` response code. +### Error responses ++The request returns `400 Bad Request` if the file isn't checked out. Requests made with delegated access return `423 Locked` if another user has the file checked out. Requests made with application access can discard any checkout. ++For more information about how errors are returned, see [Error responses][error-response]. + ## Examples ### Request POST https://graph.microsoft.com/beta/drives/{drive-id}/items/{item-id}/discardC [!INCLUDE [sample-code](../includes/snippets/php/driveitemthisdiscardcheckout-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + # [Python](#tab/python) [!INCLUDE [sample-code](../includes/snippets/python/driveitemthisdiscardcheckout-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] The following example shows the response. HTTP/1.1 204 No content ``` -+[error-response]: /graph/errors |
v1.0 | Driveitem Getretentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-getretentionlabel.md | For information about retention labels from an administrator's perspective, see ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -| Permission type | Permissions (from least to most privileged) | -|:|:-| -| Delegated (work or school account) | Files.Read.All, Sites.Read.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Files.Read.All, Sites.Read.All | +<!-- { "blockType": "permissions", "name": "driveitem_getretentionlabel" } --> ## HTTP request |
v1.0 | Driveitem Lockorunlockrecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-lockorunlockrecord.md | For more information about how you can lock and unlock retention labels, see [Us ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -| Permission type | Permissions (from least to most privileged) | -|:|:--| -| Delegated (work or school account) | Files.ReadWrite.All, Sites.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Files.ReadWrite.All, Sites.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "driveitem_lockorunlockrecord" } --> ## HTTP request |
v1.0 | Driveitem Removeretentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-removeretentionlabel.md | For information about retention labels from an administrator's perspective, see ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -| Permission type | Permissions (from least to most privileged) | -|:|:--| -| Delegated (work or school account) | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All, Sites.FullControl.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "driveitem_removeretentionlabel" } --> >**Note:** `Sites.FullControl.All` is the least privileged permission required to remove retention labels that classify the content as records. |
v1.0 | Driveitem Setretentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveitem-setretentionlabel.md | When a retention label is applied to a folder, all the items in the folder are t ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -| Permission type | Permissions (from least to most privileged) | -|:|:--| -| Delegated (work or school account) | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Files.Read.All, Files.ReadWrite.All, Sites.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "driveitem_setretentionlabel" } --> >**Note:** `Sites.FullControl.All` is the least privileged permission required to change retention labels that classify the content as records. |
v1.0 | Driveprotectionunitsbulkadditionjobs Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveprotectionunitsbulkadditionjobs-get.md | + + Title: "Get driveProtectionUnitsBulkAdditionJob" +description: "Get a driveProtectionUnitsBulkAdditionJob in a OneDrive protection policy." ++ms.localizationpriority: medium ++++# Get driveProtectionUnitsBulkAdditionJob ++Namespace: microsoft.graph +++Get a [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) object by the ID associated with a [oneDriveForBusinessProtectionPolicy](../resources/onedriveforbusinessprotectionpolicy.md). +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "driveprotectionunitsbulkadditionjobs_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +GET /solutions/backupRestore/oneDriveForBusinessProtectionPolicies/{driveProtectionPolicyId}/driveProtectionUnitsBulkAdditionJobs/{driveProtectionUnitsBulkAdditionJobId} +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "driveprotectionunitsbulkadditionjobs_get" +} +--> ++``` http +GET https://graph.microsoft.com/beta/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveProtectionUnitsBulkAdditionJobs/71633878-8321-4950-bfaf-ed285bdd1461 +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.driveProtectionUnitsBulkAdditionJob" +} +--> ++``` http +HTTP/1.1 200 OK +Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveProtectionUnitsBulkAdditionJobs/61633878-8321-4950-bfaf-ed285bdd1461 ++{ + "@odata.type": "#microsoft.graph.driveProtectionUnitsBulkAdditionJob", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "drives-I", + "drives" : ["amala@contoso.com", "conrad@contoso.com", "lothar@contoso.com"], + "directoryObjectIds": ["71633878-8321-4950-bfaf-ed285bdd1461"], + "status" : "CompletedWithErrors", + "createdBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "createdDateTime":"2015-06-19T12-01-03.45Z", + "lastModifiedBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "lastModifiedDateTime":"2015-06-19T12-01-03.45Z", + "error":{ + "code" : "ProtectionResourcesNotFound", + "message": "Errors while resolving protection resources", + "details": + [ + { + "code": "EmailNotFound", + "message": "Email address 'amala@contoso.com' not found in directory", + "target" : "amala@contoso.com" + }, + { + "code": "EmailNotFound", + "message": "Email address 'conrad@contoso.com' not found in directory", + "target" : "conrad@contoso.com" + }, + { + "code": "EmailNotFound", + "message": "Email address 'lothar@contoso.com' not found in directory", + "target" : "lothar@contoso.com" + } + ] + } +} +``` |
v1.0 | Driveprotectionunitsbulkadditionjobs Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/driveprotectionunitsbulkadditionjobs-post.md | + + Title: "Create driveProtectionUnitsBulkAdditionJob" +description: "Create driveProtectionUnitsBulkAdditionJob for a OneDrive protection policy." ++ms.localizationpriority: medium ++++# Create driveProtectionUnitsBulkAdditionJob ++Namespace: microsoft.graph +++Create a [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) object associated with a [oneDriveForBusinessProtectionPolicy](../resources/onedriveforbusinessprotectionpolicy.md). ++The initial status upon creation of the job is `active`. When all the `drives` and `directoryObjectIds` are added into the corresponding OneDrive protection policy, the status of job is `completed`. ++If any failures occur, the status of the job eventually is `completedWithErrors`. ++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "driveprotectionunitsbulkadditionjobs_post" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/backupRestore/oneDriveForBusinessProtectionPolicies/{oneDriveForBusinessProtectionPolicyId}/driveProtectionUnitsBulkAdditionJobs +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Content-Type|application/json| ++## Request body ++In the request body, include a JSON representation of the [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) object. ++## Response ++If successful, this method returns a `201 Created` response code and a [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "driveprotectionunitsbulkadditionjobs_post" +} +--> ++```http +POST https://graph.microsoft.com/beta/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveProtectionUnitsBulkAdditionJobs +Content-Type: application/json ++{ + "displayName" : "drives-I", + "drives" : ["amala@contoso.com", "conrad@contoso.com", "lothar@contoso.com"], + "directoryObjectIds" : ["1fec4e78-bce4-4aaf-ab1b-5451cc387264"] +} ++``` ++# [JavaScript](#tab/javascript) ++++++### Response ++The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.driveProtectionUnitsBulkAdditionJob" +} +--> +``` http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.driveProtectionUnitsBulkAdditionJob", + "id" :"71633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "drives-I", + "status" : "active", + "drives" : ["amala@contoso.com", "conrad@contoso.com", "lothar@contoso.com"], + "directoryObjectIds" : ["1fec4e78-bce4-4aaf-ab1b-5451cc387264"], + "createdBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "createdDateTime":"2015-06-19T12-01-03.45Z", + "lastModifiedBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "lastModifiedDateTime":"2015-06-19T12-01-03.45Z", +} +``` |
v1.0 | Educationalactivity Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationalactivity-delete.md | Delete an [educationalActivity](../resources/educationalactivity.md) object from ## Permissions -Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). +The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow [best practices](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions) to request least privileged permissions. For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { "blockType": "permissions", "name": "educationalactivity_delete" } --> +Permissions for the following HTTP syntax: ++<!-- { "blockType": "ignored" } --> ++```http +DELETE /me/profile/educationalActivities/{id} +``` ++<!-- { + "blockType": "permissions", + "name": "educationalactivity_delete", + "requestUrls": ["DELETE /me/profile/educationalActivities/{id}"] + } --> [!INCLUDE [permissions-table](../includes/permissions/educationalactivity-delete-permissions.md)] +Permissions for the following HTTP syntax: ++<!-- { "blockType": "ignored" } --> ++```http +DELETE /users/{id | userPrincipalName}/profile/educationalActivities/{id} +``` ++<!-- { + "blockType": "permissions", + "name": "educationalactivity_delete_2", + "requestUrls": ["DELETE /users/{id | userPrincipalName}/profile/educationalActivities/{id}"] + } --> + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Educationalactivity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationalactivity-get.md | Retrieve the properties and relationships of an [educationalActivity](../resourc ## Permissions -Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). +The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow [best practices](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions) to request least privileged permissions. For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { "blockType": "permissions", "name": "educationalactivity_get" } --> +Permissions for the following HTTP syntax: ++<!-- { "blockType": "ignored" } --> ++```http +GET /me/profile/educationalActivities/{id} +``` ++<!-- { + "blockType": "permissions", + "name": "educationalactivity_get", + "requestUrls": ["GET /me/profile/educationalActivities/{id}"] + } --> [!INCLUDE [permissions-table](../includes/permissions/educationalactivity-get-permissions.md)] +Permissions for the following HTTP syntax: ++<!-- { "blockType": "ignored" } --> ++```http +GET /users/{id | userPrincipalName}/profile/educationalActivities/{id} +``` ++<!-- { + "blockType": "permissions", + "name": "educationalactivity_get_2", + "requestUrls": ["GET /users/{id | userPrincipalName}/profile/educationalActivities/{id}"] + } --> + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Educationalactivity Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationalactivity-update.md | Update the properties of an [educationalActivity](../resources/educationalactivi ## Permissions -Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). +The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow [best practices](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions) to request least privileged permissions. For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { "blockType": "permissions", "name": "educationalactivity_update" } --> +Permissions for the following HTTP syntax: ++<!-- { "blockType": "ignored" } --> ++```http +PATCH /me/profile/educationalActivities/{id} +``` ++<!-- { + "blockType": "permissions", + "name": "educationalactivity_update", + "requestUrls": ["PATCH /me/profile/educationalActivities/{id}"] + } --> [!INCLUDE [permissions-table](../includes/permissions/educationalactivity-update-permissions.md)] +Permissions for the following HTTP syntax: ++<!-- { "blockType": "ignored" } --> ++```http +PATCH /users/{id | userPrincipalName}/profile/educationalActivities/{id} +``` ++<!-- { + "blockType": "permissions", + "name": "educationalactivity_update_2", + "requestUrls": ["PATCH /users/{id | userPrincipalName}/profile/educationalActivities/{id}"] + } --> + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Educationassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-get.md | Choose the permission or permissions marked as least privileged for this API. Us GET /education/classes/{id}/assignments/{id} ``` ## Optional query parameters-This method supports the `$select` and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select`, `$orderby`, and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++You can use `$orderby` with the following properties of the [educationAssignment](../resources/educationassignment.md) resource: **assignDateTime**, **assignedDateTime**, **closeDateTime**, **createdDateTime**, **displayName**, **dueDateTime**, **lastModifiedDateTime**, **moduleUrl**, and **status**. The following `$expand` options are available for this method: `categories`, `resources`, `rubric`, `submissions`, `gradingScheme`, `gradingCategory`, and `*`. `*` specifies all the previous options. |
v1.0 | Educationassignment Post Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-post-categories.md | POST /education/classes/{id}/assignments/{id}/categories/$ref | Content-Type | application/json | ## Request body-In the request body, supply the odata.id of the existing [educationCategory](../resources/educationcategory.md) object(s) to add to this assignment. -+In the request body, supply the **odata.id** of an existing [educationCategory](../resources/educationcategory.md) object to add to this assignment. ## Response If successful, this method returns a `204 No Content` response code. ## Example-##### Request +### Request The following example shows a request.+# [HTTP](#tab/http) <!-- {- "blockType": "ignored", - "name": "add_educationcategory_to_educationassignment", - "sampleKeys": ["11021", "19002"] + "blockType": "request", + "name": "add_educationcategory_to_educationassignment" }--> ```http-POST https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/categories/$ref +POST https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignments/70b7077c-7c1c-4e56-9b3b-2365411900c6/categories/$ref Content-type: application/json {- "@odata.id": "https://graph.microsoft.com/v1.0/education/classes/11021/assignmentCategories/ec98f158-341d-4fea-9f8c-14a250d489ac" + "@odata.id": "https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignmentCategories/39e3d9dc-7244-42d7-8b4d-1071aae5eb41" }- ```-In the request body, supply the odata.id of the existing [educationCategory](../resources/educationcategory.md) object to add to this assignment. -##### Response -The following example shows the response. ->**Note:** The response object shown here might be shortened for readability. +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) +# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++### Response +The following example shows the response. <!-- {- "blockType": "ignored", - "truncated": true, - "@odata.type": "microsoft.graph.educationAssignmentResource" + "blockType": "response", + "truncated": true } --> ```http HTTP/1.1 204 No Content ```+ <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- HTTP/1.1 204 No Content "suppressions": [] } -->-- |
v1.0 | Educationassignment Remove Category | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationassignment-remove-category.md | If successful, this method returns a `204 No Content` response code. ## Example ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- {- "blockType": "ignored", - "name": "add_educationcategory_to_educationassignment", - "sampleKeys": ["11021", "19002", "ec98f158-341d-4fea-9f8c-14a250d489ac"] + "blockType": "request", + "name": "remove_educationcategory_from_educationassignment" }--> ```http-DELETE https://graph.microsoft.com/beta/education/classes/11021/assignments/19002/categories/ec98f158-341d-4fea-9f8c-14a250d489ac/$ref +DELETE https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignments/e98aaae1-7c98-4e65-bb62-1994fe410552/categories/39e3d9dc-7244-42d7-8b4d-1071aae5eb41/$ref ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ ### Response The following example shows the response. <!-- {- "blockType": "ignored", - "truncated": true, - "@odata.type": "microsoft.graph.educationAssignmentResource" + "blockType": "response", + "truncated": true } --> ```http HTTP/1.1 204 No Content |
v1.0 | Educationcategory Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationcategory-delete.md | If successful, this method returns a `204 No Content` response code. It doesn't The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "delete_educationassignment_2", - "sampleKeys": ["11014", "19002"] + "name": "delete_educationassignment_2" }--> ```http-DELETE https://graph.microsoft.com/beta/education/classes/11014/assignmentCategories/19002 +DELETE https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/assignmentCategories/39e3d9dc-7244-42d7-8b4d-1071aae5eb41 ``` # [C#](#tab/csharp) |
v1.0 | Educationcategory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationcategory-get.md | GET /education/classes/{id}/assignmentCategories/{id} ## 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). +This method supports the `$select` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++You can use `$orderby` with the **displayName** property of the [educationCategory](../resources/educationcategory.md) resource. ## Request headers | Header | Value | |
v1.0 | Educationclass Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationclass-delta.md | GET /education/classes/delta | Name | Description | | : | : |-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Educationclass Getrecentlymodifiedsubmissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationclass-getrecentlymodifiedsubmissions.md | + + Title: "educationClass: getRecentlyModifiedSubmissions" +description: "Retrieve submissions modified in the previous seven days." ++ms.localizationpriority: medium ++++# educationClass: getRecentlyModifiedSubmissions ++Namespace: microsoft.graph +++Retrieve submissions modified in the previous seven days. Only teachers and applications with application permissions can perform this operation. ++A **submission** object represents a student's work for an [assignment](../resources/educationassignment.md). Resources associated with the submission represent their work. ++A teacher or application with application permissions has full access to all **submission** objects. ++The grade and feedback from a teacher are part of the [educationOutcome](../resources/educationoutcome.md) associated with this object. Only teachers or applications with application permissions can add or change grades and feedback. Students can't see the grade or feedback until the **assignment** is released. +++## Permissions +Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "educationclass_getrecentlymodifiedsubmissions" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +```http +GET /education/classes/{class-id}/getRecentlyModifiedSubmissions +``` ++## Optional query parameters +This method supports the `$orderby`, `$top`, `$filter`, `$select`, and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++The `$orderby` query parameter only supports the **lastModifiedDateTime** property of the [educationSubmission](../resources/educationsubmission.md) resource. ++The default ordering is by descending **lastModifiedDateTime** property values. ++## Request headers +| Header | Value | +|:|:--| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body +Don't supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and a collection of [educationSubmission](../resources/educationsubmission.md) objects in the response body. ++If you specify an unsupported property for the `$orderby` query parameter, the method returns a `400` error message. ++```http +HTTP/1.1 400 Bad Request +Content-type: application/json ++{ + "error": { + "code": "20143", + "message": "The OData query is invalid. $orderby clause is only supported for these properties : (lastModifiedDateTime).", + "innerError": { + "date": "2024-08-27T13:04:10", + "request-id": "218ae0dc-664c-4928-b4e1-f3b37c27c472", + "client-request-id": "ed8c66ed-fd50-d7ec-d989-5a92140999c1" + } + } +} +``` +If you specify an unsupported value for the `$filter` query parameter, the method returns a `400` error message. ++```http +HTTP/1.1 400 Bad Request +Content-type: application/json ++{ + "error": { + "code": "BadRequest", + "message": "Invalid filter clause: The $filter expression must evaluate to a single boolean value.", + "innerError": { + "date": "2024-08-27T13:05:11", + "request-id": "31233bf3-c442-4a8d-a1ff-56c665239e25", + "client-request-id": "30f9e18f-f311-741b-bf48-23fd4feecdb9" + } + } +} +``` ++## Examples ++### Example 1: Get recently modified submissions ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_educationclass_getrecentlymodifiedsubmissions" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/education/classes/bf1f1963-05f6-4cba-903c-5892b4ce3bd7/getRecentlyModifiedSubmissions +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response +The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.educationSubmission)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.educationSubmission)", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET education/classes('<guid>')/microsoft.graph.getRecentlyModifiedSubmissions?$select=excusedBy,excusedDateTime", + "value": [ + { + "status": "returned", + "submittedDateTime": null, + "unsubmittedDateTime": "2024-08-14T05:48:30.9345815Z", + "returnedDateTime": "2024-08-14T05:47:41.4128921Z", + "reassignedDateTime": "2024-08-14T05:47:18.3007671Z", + "excusedDateTime": "2024-08-14T05:47:41.4128921Z", + "lastModifiedDateTime": "2024-08-14T06:37:17.9779374Z", + "resourcesFolderUrl": null, + "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%22bf1f1963-05f6-4cba-903c-5892b4ce3bd7%5C%22,%5C%22assignmentIds%5C%22%3A%5B%5C%22db8e6b0b-dba4-4c69-81b2-9ba7313c0b7a%5C%22%5D,%5C%22submissionId%5C%22%3A%5C%224bca096a-7de3-8675-5e86-2fa149923860%5C%22%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22speed-grader%5C%22,%5C%22appId%5C%22%3A%5C%22de8bc8b5-d9f9-48b1-a8ad-b748da725064%5C%22%7D%22,%22channelId%22%3Anull%7D", + "id": "4bca096a-7de3-8675-5e86-2fa149923860", + "recipient": { + "@odata.type": "#microsoft.graph.educationSubmissionIndividualRecipient", + "userId": "61243ddb-6f39-499d-b232-9fa8cef26b3a" + }, + "submittedBy": { + "application": null, + "device": null, + "user": { + "id": "61243ddb-6f39-499d-b232-9fa8cef26b3a", + "displayName": null + } + }, + "unsubmittedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "returnedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "reassignedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "excusedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null + } + } + } + ] +} +``` ++### Example 2: Get recently modified submissions with `$select` and `$filter` options on assignmentId property ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_educationclass_getrecentlymodifiedsubmissions_filter_select_assignmentId" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/getrecentlymodifiedsubmissions?$filter=assignmentId eq 'b20d6737-f88e-4892-8174-73aa26d18784'&$select=LastModifiedDateTime,status +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response +The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.educationSubmission)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.educationSubmission)", + "value": [ + { + "status": "submitted", + "lastModifiedDateTime": "2024-09-09T10:18:33.4052415Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.6464644Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.588738Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.5295878Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.4718648Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.3513158Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.2866527Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.2219998Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.1602788Z" + }, + { + "status": "working", + "lastModifiedDateTime": "2024-09-09T10:18:07.0884058Z" + } + ] +} +``` ++### Example 3: Get recently modified submissions with `$expand` option ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_educationclass_getrecentlymodifiedsubmissions_expand" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/getRecentlyModifiedSubmissions?$expand=outcomes +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response +The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.educationSubmission)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.educationSubmission)", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET education/classes('<guid>')/microsoft.graph.getRecentlyModifiedSubmissions?$select=excusedBy,excusedDateTime", + "value": [ + { + "status": "working", + "submittedDateTime": null, + "unsubmittedDateTime": null, + "returnedDateTime": null, + "reassignedDateTime": null, + "excusedDateTime": null, + "lastModifiedDateTime": "2024-08-26T20:45:51.3485047Z", + "resourcesFolderUrl": null, + "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%2237d99af7-cfc5-4e3b-8566-f7d40e4a2070%5C%22,%5C%22assignmentIds%5C%22%3A%5B%5C%2273b252e5-5f2c-42d6-8896-bfe924ce5fe9%5C%22%5D,%5C%22submissionId%5C%22%3A%5C%225af42a11-37cc-c144-fa4c-7db855942011%5C%22%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22speed-grader%5C%22,%5C%22appId%5C%22%3A%5C%22de8bc8b5-d9f9-48b1-a8ad-b748da725064%5C%22%7D%22,%22channelId%22%3Anull%7D", + "id": "5af42a11-37cc-c144-fa4c-7db855942011", + "recipient": { + "@odata.type": "#microsoft.graph.educationSubmissionIndividualRecipient", + "userId": "e5c17181-ad7e-4a66-86bf-b560ce0c8b29" + }, + "submittedBy": { + "application": null, + "device": null, + "user": { + "id": "e5c17181-ad7e-4a66-86bf-b560ce0c8b29", + "displayName": null + } + }, + "unsubmittedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "returnedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "reassignedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "excusedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "7254e396-868c-4bf7-96b2-6fe763590b5a", + "displayName": null + } + }, + "outcomes": [ + { + "@odata.type": "#microsoft.graph.educationFeedbackOutcome", + "lastModifiedDateTime": null, + "id": "ca05367a-b292-42d5-aff7-5d279feeace8", + "lastModifiedBy": null, + "feedback": null, + "publishedFeedback": null + }, + { + "@odata.type": "#microsoft.graph.educationPointsOutcome", + "lastModifiedDateTime": null, + "id": "ea1351f6-ba33-4940-b2cb-6a7254af2dc8", + "lastModifiedBy": null, + "points": null, + "publishedPoints": null + } + ] + } + ] +} +``` ++### Example 4: Get recently modified submissions with `$filter` option ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_educationclass_getrecentlymodifiedsubmissions_filter" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/education/classes/bf1f1963-05f6-4cba-903c-5892b4ce3bd7/getRecentlyModifiedSubmissions?$filter=status eq 'working' +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response +The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.educationSubmission)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.educationSubmission)", + "@odata.nextLink": "https://graph.microsoft.com/beta/education/classes/37d99af7-cfc5-4e3b-8566-f7d40e4a2070/getRecentlyModifiedSubmissions?$filter=status+eq+%27working%27&$skiptoken=eyJJbm5lclNraXBUb2tlbiI6Ik15WlJWa1pDVVZWR1FsRlZSa1phTVd4Q1VWVkdRbEZWUmtKU1JXeENVVlZHUWxWWFZscE9SM040U3pCc1RGWlRjM2RTTUhkNlZGVlJlRlJzUW1oa2VqQTUifQ%3d%3d", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET education/classes('<guid>')/microsoft.graph.getRecentlyModifiedSubmissions?$select=excusedBy,excusedDateTime", + "value": [ + { + "status": "working", + "submittedDateTime": null, + "unsubmittedDateTime": null, + "returnedDateTime": null, + "reassignedDateTime": null, + "excusedDateTime": null, + "lastModifiedDateTime": "2024-08-26T15:57:23.5476513Z", + "resourcesFolderUrl": null, + "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%2237d99af7-cfc5-4e3b-8566-f7d40e4a2070%5C%22,%5C%22assignmentIds%5C%22%3A%5B%5C%223d2fcfd4-cb6a-4e31-aa63-16ca865e9014%5C%22%5D,%5C%22submissionId%5C%22%3A%5C%227e2e0656-2bf4-1f95-b4b0-967f516340cd%5C%22%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22speed-grader%5C%22,%5C%22appId%5C%22%3A%5C%22de8bc8b5-d9f9-48b1-a8ad-b748da725064%5C%22%7D%22,%22channelId%22%3Anull%7D", + "id": "7e2e0656-2bf4-1f95-b4b0-967f516340cd", + "recipient": { + "@odata.type": "#microsoft.graph.educationSubmissionIndividualRecipient", + "userId": "80cefd93-8d88-40e2-b5d3-67898383e226" + }, + "submittedBy": { + "application": null, + "device": null, + "user": { + "id": "80cefd93-8d88-40e2-b5d3-67898383e226", + "displayName": null + } + }, + "unsubmittedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "returnedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "reassignedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "excusedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "5e3ce6c0-2b1f-4285-8d4b-75ee78787346", + "displayName": null + } + } + } + ] +} +``` ++### Example 5: Get recently modified submissions with `$orderby` and `$top` options ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_educationclass_getrecentlymodifiedsubmissions_orderby_top" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/education/classes/bf1f1963-05f6-4cba-903c-5892b4ce3bd7/getRecentlyModifiedSubmissions?$orderby=lastModifiedDateTime&$top=1 +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response +The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.educationSubmission)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.educationSubmission)", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET education/classes('<guid>')/microsoft.graph.getRecentlyModifiedSubmissions?$select=excusedBy,excusedDateTime", + "value": [ + { + "status": "working", + "submittedDateTime": null, + "unsubmittedDateTime": null, + "returnedDateTime": null, + "reassignedDateTime": null, + "excusedDateTime": null, + "lastModifiedDateTime": "2024-08-26T15:57:23.2992323Z", + "resourcesFolderUrl": null, + "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%2237d99af7-cfc5-4e3b-8566-f7d40e4a2070%5C%22,%5C%22assignmentIds%5C%22%3A%5B%5C%223d2fcfd4-cb6a-4e31-aa63-16ca865e9014%5C%22%5D,%5C%22submissionId%5C%22%3A%5C%223b03a85c-6021-8e5c-fc07-c4ac6d3506d3%5C%22%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22speed-grader%5C%22,%5C%22appId%5C%22%3A%5C%22de8bc8b5-d9f9-48b1-a8ad-b748da725064%5C%22%7D%22,%22channelId%22%3Anull%7D", + "id": "3b03a85c-6021-8e5c-fc07-c4ac6d3506d3", + "recipient": { + "@odata.type": "#microsoft.graph.educationSubmissionIndividualRecipient", + "userId": "2d20b7fc-43bd-459c-81e0-5eb4aa20d5b5" + }, + "submittedBy": { + "application": null, + "device": null, + "user": { + "id": "2d20b7fc-43bd-459c-81e0-5eb4aa20d5b5", + "displayName": null + } + }, + "unsubmittedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "returnedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "reassignedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "excusedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "5e3ce6c0-2b1f-4285-8d4b-75ee78787346", + "displayName": null + } + } + } + ] +} +``` ++### Example 6: Get recently modified submissions with `$select` option ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_educationclass_getrecentlymodifiedsubmissions_select" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/education/classes/bf1f1963-05f6-4cba-903c-5892b4ce3bd7/getRecentlyModifiedSubmissions?$select=excusedDateTime +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response +The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.educationSubmission)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.educationSubmission)", + "value": [ + { + "excusedDateTime": "2024-08-26T16:00:17.535348Z" + }, + { + "excusedDateTime": "2024-08-26T16:00:17.4698345Z" + }, + { + "excusedDateTime": null + } + ] +} +``` +### Example 7: Get recently modified submissions with `$filter` option for a range on lastModifiedDateTime property ++#### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_educationclass_getrecentlymodifiedsubmissions_filter_range" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/education/classes/bf1f1963-05f6-4cba-903c-5892b4ce3bd7/getRecentlyModifiedSubmissions?$filter=lastModifiedDateTime gt 2024-08-25T20:45:51.3485047Z and lastModifiedDateTime lt 2024-08-28T20:45:51.3485047Z +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response +The following example shows the response. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.educationSubmission)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.educationSubmission)", + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET education/classes('<guid>')/microsoft.graph.getRecentlyModifiedSubmissions?$select=excusedBy,excusedDateTime", + "value": [ + { + "status": "working", + "submittedDateTime": null, + "unsubmittedDateTime": null, + "returnedDateTime": null, + "reassignedDateTime": null, + "excusedDateTime": null, + "lastModifiedDateTime": "2024-08-26T20:45:51.3485047Z", + "resourcesFolderUrl": null, + "webUrl": "https://teams.microsoft.com/l/entity/66aeee93-507d-479a-a3ef-8f494af43945/classroom?context=%7B%22subEntityId%22%3A%22%7B%5C%22version%5C%22%3A%5C%221.0%5C%22,%5C%22config%5C%22%3A%7B%5C%22classes%5C%22%3A%5B%7B%5C%22id%5C%22%3A%5C%2237d99af7-cfc5-4e3b-8566-f7d40e4a2070%5C%22,%5C%22assignmentIds%5C%22%3A%5B%5C%2273b252e5-5f2c-42d6-8896-bfe924ce5fe9%5C%22%5D,%5C%22submissionId%5C%22%3A%5C%225af42a11-37cc-c144-fa4c-7db855942011%5C%22%7D%5D%7D,%5C%22action%5C%22%3A%5C%22navigate%5C%22,%5C%22view%5C%22%3A%5C%22speed-grader%5C%22,%5C%22appId%5C%22%3A%5C%22de8bc8b5-d9f9-48b1-a8ad-b748da725064%5C%22%7D%22,%22channelId%22%3Anull%7D", + "id": "5af42a11-37cc-c144-fa4c-7db855942011", + "recipient": { + "@odata.type": "#microsoft.graph.educationSubmissionIndividualRecipient", + "userId": "e5c17181-ad7e-4a66-86bf-b560ce0c8b29" + }, + "submittedBy": { + "application": null, + "device": null, + "user": { + "id": "e5c17181-ad7e-4a66-86bf-b560ce0c8b29", + "displayName": null + } + }, + "unsubmittedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "returnedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "reassignedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "excusedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "7254e396-868c-4bf7-96b2-6fe763590b5a", + "displayName": null + } + } + } + ] +} +``` ++<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 +2024-08-18 14:57:30 UTC --> +<!-- +{ + "type": "#page.annotation", + "description": "Get educationSubmission recentlymodifiedsubmission", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [] +} +--> |
v1.0 | Educationfeedbackresourceoutcome Post Outcomes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationfeedbackresourceoutcome-post-outcomes.md | HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/beta/education/classes('37d99af7-cfc5-4e3b-8566-f7d40e4a2070')/assignments('a3cce0ba-2008-4c4d-bf62-079408562d96')/submissions('2185e6d7-2924-4ed1-dde1-269f89e29184')/outcomes/$entity", + "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/classes('37d99af7-cfc5-4e3b-8566-f7d40e4a2070')/assignments('a3cce0ba-2008-4c4d-bf62-079408562d96')/submissions('2185e6d7-2924-4ed1-dde1-269f89e29184')/outcomes/$entity", "@odata.type": "#microsoft.graph.educationFeedbackResourceOutcome",- "lastModifiedDateTime": "2022-05-06T00:50:30.0772434Z", - "id": "ba12f282-2190-4958-80b3-42b8afb9626a", + "lastModifiedDateTime": "2024-08-14T06:50:11.6979503Z", + "id": "b7e92489-91b6-4734-ab5c-b1370862e4a2", "resourceStatus": "notPublished", "lastModifiedBy": { "application": null, "device": null, "user": {- "id": "cb1a4af3-0aba-4679-aa12-9f99bab0b61a", + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", "displayName": null } }, "feedbackResource": { "@odata.type": "#microsoft.graph.educationWordResource", "displayName": "Document1.docx",- "createdDateTime": "2022-05-06T00:50:30.0772177Z", - "lastModifiedDateTime": "2022-05-06T00:50:30.0772434Z", - "fileUrl": "https://graph.microsoft.com/beta/drives/b!-Ik2sRPLDEWy_bR8l75jfeDcpXQcRKVOmcml10NQLQ1F8CNZWU38SarWxPyWM7jx/items/01VANVJQZQ33I4AJBSURHZJDDQKEJ5TEMJ", + "createdDateTime": "2024-08-14T06:50:11.6979432Z", + "lastModifiedDateTime": "2024-08-14T06:50:11.6979503Z", + "fileUrl": "https://graph.microsoft.com/v1.0/drives/b!-Ik2sRPLDEWy_bR8l75jfeDcpXQcRKVOmcml10NQLQ1F8CNZWU38SarWxPyWM7jx/items/01VANVJQZ6GPYK2SPEXRDKILMSBSL5KNKM", "createdBy": { "application": null, "device": null, "user": {- "id": "cb1a4af3-0aba-4679-aa12-9f99bab0b61a", + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", "displayName": null } }, Content-type: application/json "application": null, "device": null, "user": {- "id": "cb1a4af3-0aba-4679-aa12-9f99bab0b61a", + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", "displayName": null } } |
v1.0 | Educationoutcome Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationoutcome-update.md | The following example shows a request to update a feedback outcome. }--> ```http-PATCH https://graph.microsoft.com/beta/education/classes/{id}/assignments/{id}/submissions/{id}/outcomes/{id} +PATCH https://graph.microsoft.com/beta/education/classes/bf1f1963-05f6-4cba-903c-5892b4ce3bd7/assignments/db8e6b0b-dba4-4c69-81b2-9ba7313c0b7a/submissions/4bca096a-7de3-8675-5e86-2fa149923860/outcomes/ca05367a-b292-42d5-aff7-5d279feeace8 Content-type: application/json { HTTP/1.1 200 OK Content-type: application/json {+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/classes('bf1f1963-05f6-4cba-903c-5892b4ce3bd7')/assignments('db8e6b0b-dba4-4c69-81b2-9ba7313c0b7a')/submissions('4bca096a-7de3-8675-5e86-2fa149923860')/outcomes/$entity", "@odata.type": "#microsoft.graph.educationFeedbackOutcome",+ "lastModifiedDateTime": "2024-08-14T06:37:17.7703021Z", "id": "ca05367a-b292-42d5-aff7-5d279feeace8",+ "publishedFeedback": null, "lastModifiedBy": {+ "application": null, + "device": null, "user": {- "id": "9391878d-903c-406c-bb1c-0f17d00fd878" + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null } }, "feedback": {- "feedbackDateTime": "2019-07-31T21:10:30.3231461Z", + "feedbackDateTime": "2024-08-14T06:37:17.7703021Z", "text": { "content": "This is feedback for the assignment as a whole.", "contentType": "text" }, "feedbackBy": {+ "application": null, + "device": null, "user": {- "id": "9391878d-903c-406c-bb1c-0f17d00fd878", + "id": "fffafb29-e8bc-4de3-8106-be76ed2ad499", + "displayName": null } } } |
v1.0 | Educationschool Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationschool-delta.md | GET /education/schools/delta | Name | Description | | : | : |-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Educationsubmission Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-get.md | GET /education/classes/{class-id}/assignments/{assignment-id}/submissions/{submi ## Optional query parameters -This method supports the `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$select` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++You can use `$orderby` with the following properties of the [educationSubmission](../resources/educationsubmission.md) resource: **excusedDateTime**, **reassignedDateTime**, **returnedDateTime**, **status**, **submittedDateTime**, and **unsubmittedDateTime**. ## Request headers | Header | Value | |
v1.0 | Educationsubmission List Outcomes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-list-outcomes.md | The following example shows a request. }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/education/classes/{id}/assignments/{id}/submissions/{id}/outcomes +GET https://graph.microsoft.com/beta/education/classes/bf1f1963-05f6-4cba-903c-5892b4ce3bd7/assignments/db8e6b0b-dba4-4c69-81b2-9ba7313c0b7a/submissions/4bca096a-7de3-8675-5e86-2fa149923860/outcomes ``` # [C#](#tab/csharp) HTTP/1.1 200 OK Content-type: application/json {+ "@odata.context": "https://graph.microsoft.com/beta/$metadata#education/classes('bf1f1963-05f6-4cba-903c-5892b4ce3bd7')/assignments('db8e6b0b-dba4-4c69-81b2-9ba7313c0b7a')/submissions('4bca096a-7de3-8675-5e86-2fa149923860')/outcomes", "value": [ { "@odata.type": "#microsoft.graph.educationFeedbackOutcome",+ "lastModifiedDateTime": null, "id": "ca05367a-b292-42d5-aff7-5d279feeace8",- "feedback": { - "feedbackDateTime": "2019-07-15T22:35:46.4847754Z", - "text": { - "content": "This is feedback for the assignment as a whole.", - "contentType": "text" - }, - "feedbackBy": { - "user": { - "id": "9391878d-903c-406c-bb1c-0f17d00fd878" - } + "lastModifiedBy": null, + "feedback": null, + "publishedFeedback": null + }, + { + "@odata.type": "#microsoft.graph.educationPointsOutcome", + "lastModifiedDateTime": null, + "id": "ea1351f6-ba33-4940-b2cb-6a7254af2dc8", + "lastModifiedBy": null, + "points": null, + "publishedPoints": null + }, + { + "@odata.type": "#microsoft.graph.educationRubricOutcome", + "lastModifiedDateTime": "2024-08-14T05:47:41.8399565Z", + "id": "65a46d78-1a2b-4a7e-bcf8-78a22ac2611b", + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": null, + "displayName": null } },- "publishedFeedback": { - "feedbackDateTime": "2019-07-15T22:35:46.4847754Z", - "text": { - "content": "This is feedback for the assignment as a whole.", - "contentType": "text" + "rubricQualityFeedback": [ + { + "qualityId": "6b9eccdd-ae31-474d-9ab5-33ba885873f9", + "feedback": null },- "feedbackBy": { - "user": { - "id": "9391878d-903c-406c-bb1c-0f17d00fd878" - } + { + "qualityId": "0fdf030a-2e52-4ea4-b321-74091cef90b0", + "feedback": null + }, + { + "qualityId": "8fdacfb6-0e28-4bce-9153-3196fbcc0eaa", + "feedback": null }- } + ], + "rubricQualitySelectedLevels": [ + { + "qualityId": "6b9eccdd-ae31-474d-9ab5-33ba885873f9", + "columnId": null + }, + { + "qualityId": "0fdf030a-2e52-4ea4-b321-74091cef90b0", + "columnId": null + }, + { + "qualityId": "8fdacfb6-0e28-4bce-9153-3196fbcc0eaa", + "columnId": null + } + ], + "publishedRubricQualityFeedback": [ + { + "qualityId": "6b9eccdd-ae31-474d-9ab5-33ba885873f9", + "feedback": null + }, + { + "qualityId": "0fdf030a-2e52-4ea4-b321-74091cef90b0", + "feedback": null + }, + { + "qualityId": "8fdacfb6-0e28-4bce-9153-3196fbcc0eaa", + "feedback": null + } + ], + "publishedRubricQualitySelectedLevels": [ + { + "qualityId": "6b9eccdd-ae31-474d-9ab5-33ba885873f9", + "columnId": null + }, + { + "qualityId": "0fdf030a-2e52-4ea4-b321-74091cef90b0", + "columnId": null + }, + { + "qualityId": "8fdacfb6-0e28-4bce-9153-3196fbcc0eaa", + "columnId": null + } + ] } ] } Content-type: application/json "value": [ { "@odata.type": "#microsoft.graph.educationFeedbackResourceOutcome",- "lastModifiedDateTime": "2022-05-06T00:52:12.8318457Z", - "id": "8fb409c5-570b-4fe5-8473-d3666e61f3a0", + "lastModifiedDateTime": "2022-05-06T00:52:17.3180275Z", + "id": "0710aeea-590d-46b4-9eb8-1c08b6549677", "resourceStatus": "notPublished", "lastModifiedBy": { "application": null, Content-type: application/json }, "feedbackResource": { "@odata.type": "#microsoft.graph.educationWordResource",- "displayName": "Document2.docx", - "createdDateTime": "2022-05-06T00:52:12.8318064Z", - "lastModifiedDateTime": "2022-05-06T00:52:12.8318457Z", - "fileUrl": "https://graph.microsoft.com/beta/drives/b!-Ik2sRPLDEWy_bR8l75jfeDcpXQcRKVOmcml10NQLQ1F8CNZWU38SarWxPyWM7jx/items/01VANVJQ26WF6K2W2IOFAKDITG4F5GWRH5", + "displayName": "Document3.docx", + "createdDateTime": "2022-05-06T00:52:17.3180176Z", + "lastModifiedDateTime": "2022-05-06T00:52:17.3180275Z", + "fileUrl": "https://graph.microsoft.com/v1.0/drives/b!-Ik2sRPLDEWy_bR8l75jfeDcpXQcRKVOmcml10NQLQ1F8CNZWU38SarWxPyWM7jx/items/01VANVJQ563EMEMHRTBBH2SOZ4GDSNEUZK", "createdBy": { "application": null, "device": null, |
v1.0 | Educationsubmission Reassign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationsubmission-reassign.md | The following is an example of the response when `Prefer: include-unknown-enum-m <!-- { "blockType": "response",+ "truncated": true, "@odata.type": "microsoft.graph.educationSubmission" } --> ```http Prefer: include-unknown-enum-members The following is an example of the response when `Prefer: include-unknown-enum-members` is provided in the request header and the submission hasn't been returned before. <!-- {- "blockType": "response", + "blockType": "response", + "truncated": true, "@odata.type": "microsoft.graph.educationSubmission" } --> ```http |
v1.0 | Educationuser Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationuser-delta.md | GET /education/users/delta | Name | Description | | : | : |-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Educationuser List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/educationuser-list-assignments.md | This method supports the `$top`, `$filter`, `$orderby`, and `$select` OData quer The following `$expand` options are available for this method: `categories`, `resources`, `gradingCategory`, `rubric`, `submissions`, and `*`, which includes all the previous options. -All [properties](../resources/educationassignment.md#properties) are supported for the query parameters `$filter` and `$orderby`. +All [properties](../resources/educationassignment.md#properties) are supported by the `$filter` query parameter. ++You can use `$orderby` with the following properties of the [educationAssignment](../resources/educationassignment.md) resource: **assignDateTime**, **assignedDateTime**, **closeDateTime**, **createdDateTime**, **displayName**, **dueDateTime**, **lastModifiedDateTime**, and **status**. ## Request headers |
v1.0 | Entitlementmanagement Post Assignmentrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/entitlementmanagement-post-assignmentrequests.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -In [Microsoft Entra Entitlement Management](../resources/entitlementmanagement-overview.md), create a new [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object. This operation is used to assign a user to an access package, update the assignment, or to remove an access package assignment. +In [Microsoft Entra Entitlement Management](../resources/entitlementmanagement-overview.md), create a new [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object. This operation is used to assign a user to an access package, update the assignment, or to remove an access package assignment. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] For a non-administrator user to request to update their own assignments, the val If successful, this method returns a 200-series response code and a new [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object in the response body. -If this is an `adminAdd` request, then subsequently an [accessPackageAssignment](../resources/accesspackageassignment.md) and, if needed, an [accessPackageSubject](../resources/accesspackagesubject.md) are also created. You can locate those using the query parameters when [listing accessPackageAssignments](entitlementmanagement-list-accesspackageassignments.md). +If the request type is `adminAdd` for this request, then an [accessPackageAssignment](../resources/accesspackageassignment.md) and, if needed, an [accessPackageSubject](../resources/accesspackagesubject.md) are also created. You can locate those objects using the query parameters when [listing accessPackageAssignments](entitlementmanagement-list-accesspackageassignments.md). ## Examples Content-type: application/json } ``` -### Example 5: Admin requests a direct assignment for a user not yet in the directory +### Example 5: Request a package on behalf of a direct employee ++The following example shows how a manager can request an access package assignment on behalf of their direct employee. ++> [!NOTE] +> The requestor (manager) is extracted from the token, and the target object is determined by the `id` of the direct employee who is receiving access. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_accesspackageassignmentrequest_request_behalf" +}--> +```http +POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests +Content-type: application/json ++{ + "assignment": { + "accessPackageId": "5b98f958-0dea-4a5b-836e-109dccbd530c", + "schedule": { + "startDateTime": null, + "stopDateTime": null + }, + "assignmentPolicyId": "c5f7847f-83a8-4315-a754-d94a6f39b875", + "target": { + "displayName": "Idris Ibrahim", + "email": "IdrisIbrahim@woodgrovebank.com", + "objectId": "21aceaba-fe13-4e3b-aa8c-4c588d5e7387", + "subjectType": "user" + } + }, + "justification": "Access for direct employee", + "requestType": "UserAdd", + "answers": [] +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. ++> **Note:** The response object shown here might be shortened for readability. All the properties are returned from an actual call. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.accessPackageAssignmentRequest" +} --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/entitlementManagement/assignmentRequests/$entity", + "id": "445a3118-6bf2-4a19-94ad-5660295963fd", + "requestType": "userAdd", + "state": "submitted", + "status": "Accepted", + "createdDateTime": null, + "completedDateTime": null, + "schedule": { + "startDateTime": null, + "recurrence": null, + "expiration": { + "endDateTime": null, + "duration": null, + "type": "notSpecified" + } + }, + "answers": [], + "customExtensionCalloutInstances": [] +} +``` +++### Example 6: Admin requests a direct assignment for a user not yet in the directory #### Request Content-type: application/json } ``` -### Example 6: Request an update to answers for an assignment +### Example 7: Request an update to answers for an assignment The following example shows how an admin can request updates to an assignment to edit their responses to questions that were answered during the request for the assignment. Content-type: application/json }--> -### Example 7: Update the expiration date for an access package assignment +### Example 8: Update the expiration date for an access package assignment The following example shows how to update the expiration date for an access package assignment. |
v1.0 | Event Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/event-permanentdelete.md | + + Title: "event: permanentDelete" +description: "Permanently delete an event and place it in the Purges folder in the dumpster in the user's mailbox." ++ms.localizationpriority: high ++++# event: permanentDelete ++Namespace: microsoft.graph +++Permanently delete an event and place it in the Purges folder in the dumpster in the user's mailbox. Email clients such as Outlook or the Outlook on the web can't access permanently deleted items. Unless there's a hold set on the mailbox, the items are permanently deleted after a set period of time. ++For more information about item retention, see [Configure Deleted Item retention and Recoverable Items quotas](/exchange/configure-deleted-item-retention-and-recoverable-items-quotas-exchange-2013-help). ++>**Note:** Folders aren't placed in the Purges folder when they are permanently deleted. Permanently deleted folders are removed from the mailbox. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "event_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/events/{eventId}/permanentDelete +POST /groups/{groupsId}/events/{eventId}/permanentDelete +POST /users/{usersId}/calendarView/{eventId}/permanentDelete +POST /groups/{groupsId}/calendarView/{eventId}/permanentDelete +POST /users/{usersId}/messages/{messageId}/event/permanentDelete +POST /users/{usersId}/messages/{messageId}/event/instances/{eventId}/permanentDelete +POST /users/{usersId}/messages/{messageId}/event/calendar/events/{eventId}/permanentDelete +POST /users/{usersId}/messages/{messageId}/event/exceptionOccurrences/{eventId}/permanentDelete +POST /users/{usersId}/messages/{messageId}/event/calendar/calendarView/{eventId}/permanentDelete +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "eventthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/events/{eventId}/permanentDelete +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Eventmessage Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/eventmessage-permanentdelete.md | + + Title: "eventMessage: permanentDelete" +description: "Permanently delete an event message and place it in the Purges folder in the user's mailbox." ++ms.localizationpriority: high ++++# eventMessage: permanentDelete ++Namespace: microsoft.graph +++Permanently delete an event message and place it in the Purges folder in the user's mailbox. Email clients such as Outlook or the Outlook on the web can't access permanently deleted items. Unless there's a hold set on the mailbox, the items are permanently deleted after a set period of time. ++For more information about item retention, see [Configure Deleted Item retention and Recoverable Items quotas](/exchange/configure-deleted-item-retention-and-recoverable-items-quotas-exchange-2013-help). ++++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "eventmessage_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /me/messages/{id}/permanentDelete +POST /users/{id | userPrincipalName}/messages/{id}/permanentDelete +POST /me/mailFolders/{id}/messages/{id}/permanentDelete +POST /users/{id | userPrincipalName}/mailFolders/{id}/messages/{id}/permanentDelete +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this action returns a `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "eventmessagethis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/me/messages/{id}/permanentDelete +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Exchangeprotectionpolicy List Mailboxprotectionunitsbulkadditionjobs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/exchangeprotectionpolicy-list-mailboxprotectionunitsbulkadditionjobs.md | + + Title: "List mailboxProtectionUnitsBulkAdditionJobs" +description: "List mailboxProtectionUnitsBulkAdditionJobs in an Exchange protection policy." ++ms.localizationpriority: medium ++++# List mailboxProtectionUnitsBulkAdditionJobs ++Namespace: microsoft.graph +++Get a list of [mailboxProtectionUnitsBulkAdditionJobs](../resources/mailboxprotectionunitsbulkadditionjob.md) objects associated with an [exchangeProtectionPolicy](../resources/exchangeprotectionpolicy.md). +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "exchangeprotectionpolicy_list_mailboxprotectionunitsbulkadditionjobs" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/backupRestore/exchangeProtectionPolicies/{exchangeProtectionPolicyId}/mailboxProtectionUnitsBulkAdditionJobs +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a list of [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) objects in the response body. +The `mailboxes` and `directoryObjectIds` fields are omitted from the response body in order to limit the response size. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "exchangeprotectionpolicy_list_mailboxprotectionunitsbulkadditionjobs" +} +--> ++``` http +GET https://graph.microsoft.com/beta/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxProtectionUnitsBulkAdditionJobs +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++++### Response ++The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.mailboxProtectionUnitsBulkAdditionJob)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxProtectionUnitsBulkAdditionJobs ++{ + "@odata.type": "#collection(microsoft.graph.mailboxProtectionUnitsBulkAdditionJob)", + "@odata.context": "/solutions/backupRestore/exchangeProtectionPolicies('71633878-8321-4950-bfaf-ed285bdd1461')/mailboxProtectionUnitsBulkAdditionJobs", + "@odata.nextLink": "/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxProtectionUnitsBulkAdditionJobs?$top=3&$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", + "value": + [ + { + "@odata.type": "#microsoft.graph.mailboxProtectionUnitsBulkAdditionJob", + "displayName" : "Mailbox-I", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "status" : "Completed", + "createdBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "createdDateTime":"2015-06-19T12-01-03.45Z", + "lastModifiedBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "lastModifiedDateTime":"2015-06-19T12-01-03.45Z" + }, + { + "@odata.type": "#microsoft.graph.mailboxProtectionUnitsBulkAdditionJob", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "Mailbox-II", + "status" : "CompletedWithErrors", + "createdBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "createdDateTime":"2015-06-19T12-01-03.45Z", + "lastModifiedBy":{ + "application":{ + "id":"1fec8e78-bce4-4aaf-ab1b-5451cc387264" + }, + "user":{ + "id":"845457dc-4bb2-4815-bef3-8628ebd1952e" + } + }, + "lastModifiedDateTime":"2015-06-19T12-01-03.45Z", + "error":{ + "code" : "ProtectionResourcesNotFound", + "message": "Errors while resolving protection resources", + "details": + [ + { + "code": "EmailNotFound", + "message": "Email address 'test1@microsoft.com' not found in directory", + "target" : "test1@microsoft.com" + }, + { + "code": "EmailNotFound", + "message": "Email address 'test2@microsoft.com' not found in directory", + "target" : "test2@microsoft.com" + }, + { + "code": "EmailNotFound", + "message": "Email address 'test3@microsoft.com' not found in directory", + "target" : "test3@microsoft.com" + } + ] + } + } + ] +} +``` |
v1.0 | Exchangeprotectionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/exchangeprotectionpolicy-update.md | To remove a **mailboxProtectionUnit** from the policy, specify the `@removed` an If successful, this method returns a `200 OK` response code and an updated [exchangeProtectionPolicy](../resources/exchangeprotectionpolicy.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Exchangerestoresession List Mailboxrestoreartifacts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/exchangerestoresession-list-mailboxrestoreartifacts.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [mailboxRestoreArtifact](../resources/mailboxrestoreartifact.md) objects in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Exchangerestoresession Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/exchangerestoresession-update.md | To remove an **exchangeRestoreSession**, specify the @removed annotation in the If successful, this method returns a `200 OK` response code and an updated [exchangeRestoreSession](../resources/exchangerestoresession.md) object in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Externalauthenticationmethodconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-delete.md | Delete an [externalAuthenticationMethodConfiguration](../resources/externalauthe Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "externalauthenticationmethodconfiguration-delete-permissions" -} >+<!-- { "blockType": "permissions", "name": "externalauthenticationmethodconfiguration_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/externalauthenticationmethodconfiguration-delete-permissions.md)] [!INCLUDE [rbac-authentication-methods-policy-apis-write](../includes/rbac-for-apis/rbac-authentication-methods-policy-apis-write.md)] |
v1.0 | Externalauthenticationmethodconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-get.md | Read the properties and relationships of an [externalAuthenticationMethodConfigu Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "externalauthenticationmethodconfiguration-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "externalauthenticationmethodconfiguration_get" } --> [!INCLUDE [permissions-table](../includes/permissions/externalauthenticationmethodconfiguration-get-permissions.md)] [!INCLUDE [rbac-authentication-methods-policy-apis-read](../includes/rbac-for-apis/rbac-authentication-methods-policy-apis-read.md)] |
v1.0 | Externalauthenticationmethodconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalauthenticationmethodconfiguration-update.md | Update the properties of an [externalAuthenticationMethodConfiguration](../resou Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "externalauthenticationmethodconfiguration-update-permissions" -} >+<!-- { "blockType": "permissions", "name": "externalauthenticationmethodconfiguration_update" } --> [!INCLUDE [permissions-table](../includes/permissions/externalauthenticationmethodconfiguration-update-permissions.md)] [!INCLUDE [rbac-authentication-methods-policy-apis-write](../includes/rbac-for-apis/rbac-authentication-methods-policy-apis-write.md)] |
v1.0 | Externalmeetingregistrant Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalmeetingregistrant-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The external meeting registrant API is deprecated and will stop returning data on **December 31, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). +> The external meeting registrant API is deprecated and will stop returning data on **December 12, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). The meeting organizer removes an [externalMeetingRegistrant](../resources/externalmeetingregistrant.md) from an online meeting which has [externalMeetingRegistration](../resources/externalmeetingregistration.md) enabled. |
v1.0 | Externalmeetingregistrant List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalmeetingregistrant-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The external meeting registrant API is deprecated and will stop returning data on **December 31, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). +> The external meeting registrant API is deprecated and will stop returning data on **December 12, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). Get a list of the [externalMeetingRegistrants](../resources/externalmeetingregistrant.md) of an [onlineMeeting](../resources/onlinemeeting.md). |
v1.0 | Externalmeetingregistrant Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalmeetingregistrant-post.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The external meeting registrant API is deprecated and will stop returning data on **December 31, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). +> The external meeting registrant API is deprecated and will stop returning data on **December 12, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). Enroll an [externalMeetingRegistrant](../resources/externalmeetingregistrant.md) in an online meeting which has [externalMeetingRegistration](../resources/externalmeetingregistration.md) enabled. The meeting organizer enrolls someone by providing a unique **id** in the external registration system and gets the unique **joinWebUrl** of this registrant. |
v1.0 | Externalmeetingregistration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalmeetingregistration-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The external meeting registration API is deprecated and will stop returning data on **December 31, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). +> The external meeting registration API is deprecated and will stop returning data on **December 12, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). Disable and delete the [externalMeetingRegistration](../resources/externalmeetingregistration.md) of an [onlineMeeting](../resources/onlinemeeting.md). |
v1.0 | Externalmeetingregistration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalmeetingregistration-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The external meeting registration API is deprecated and will stop returning data on **December 31, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). +> The external meeting registration API is deprecated and will stop returning data on **December 12, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). Get the [externalMeetingRegistration](../resources/externalmeetingregistration.md) details associated with an [onlineMeeting](../resources/onlinemeeting.md). |
v1.0 | Externalmeetingregistration Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externalmeetingregistration-post.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The external meeting registration API is deprecated and will stop returning data on **December 31, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). +> The external meeting registration API is deprecated and will stop returning data on **December 12, 2024**. Please use the new [webinar APIs](../resources/virtualeventwebinar.md). For more information, see [Deprecation of the Microsoft Graph meeting registration beta APIs](https://devblogs.microsoft.com/microsoft365dev/deprecation-of-the-microsoft-graph-meeting-registration-beta-apis/). Enable registration for an [onlineMeeting](../resources/onlinemeeting.md) using an external registration system. An online meeting can only have one registration enabled. |
v1.0 | Externaluserprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-get.md | Retrieve the properties of a specific [externalUserProfile](../resources/externa Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "externaluserprofile-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "externaluserprofile_get" } --> [!INCLUDE [permissions-table](../includes/permissions/externaluserprofile-get-permissions.md)] [!INCLUDE [rbac-externaluserprofiles-apis-read](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-read.md)] |
v1.0 | Externaluserprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/externaluserprofile-update.md | Update the properties of a [externalUserProfile](../resources/externaluserprofil Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "externaluserprofile-update-permissions" -} >+<!-- { "blockType": "permissions", "name": "externaluserprofile_update" } --> [!INCLUDE [permissions-table](../includes/permissions/externaluserprofile-update-permissions.md)] [!INCLUDE [rbac-externaluserprofiles-apis-write](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-write.md)] |
v1.0 | Fido2authenticationmethod Creationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/fido2authenticationmethod-creationoptions.md | Retrieve creation options required to generate and register a Microsoft Entra ID Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). -<!-- { - "blockType": "permissions", - "name": "fido2authenticationmethod-creationoptions-permissions" -} >+<!-- { "blockType": "permissions", "name": "fido2authenticationmethod_creationoptions" } --> [!INCLUDE [permissions-table](../includes/permissions/fido2authenticationmethod-creationoptions-permissions.md)] [!INCLUDE [rbac-authentication-methods-apis-write-others](../includes/rbac-for-apis/rbac-authentication-methods-apis-write-others.md)] Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /users/{usersId}/authentication/fido2Methods/creationOptions +GET /users/{user-id}/authentication/fido2Methods/creationOptions(challengeTimeoutInMinutes={challengeTimeoutInMinutes}) ``` ## Function parameters GET https://graph.microsoft.com/beta/users/{usersId}/authentication/fido2Methods [!INCLUDE [sample-code](../includes/snippets/javascript/fido2authenticationmethodthiscreationoptions-javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PowerShell](#tab/powershell) + ### Response Content-Type: application/json { "value": {- "@odata.type": "microsoft.graph.webauthnCredentialCreationOptions" + "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.webauthnCredentialCreationOptions", + "challengeTimeoutDateTime": "2024-08-14T16:29:58Z", + "publicKey": { + "challenge": "ZXlKaGJHY2lPaUpTVTBFdFQwRkZVQzB5TlRZaUxDSmxibU1pT2lKQk1qVTJSME5OSWl3aWVEVmpJanBiSWsxSlNVUmhSRU5EUVd4...", + "timeout": 0, + "attestation": "direct", + "rp": { + "id": "login.microsoft.com", + "name": "Microsoft" + }, + "user": { + "id": "T0Y6Ehqp2EfQP0iExdt54DFwdWuaH7qIZbZGpOc92RGnvbXyRPvU-8AOp9r1T7Cebfc3", + "displayName": "Kim User", + "name": "kimuser@contoso.com" + }, + "pubKeyCredParams": [ + { + "type": "public-key", + "alg": -7 + }, + { + "type": "public-key", + "alg": -257 + } + ], + "excludeCredentials": [ + { + "id": "0S64X8KwFmCeJjHzK1oE/39T+JYhfYbhFurwOxMMjtvRWc/sLYq8AMJVuva823XQ", + "type": "public-key", + "transports": [] + }, + { + "id": "pgIfj2fnom8rJdb4/h1gKqDkq+gxHFksI+m2aR5T+PNNycBfENAM4ksEBvoXky6d", + "type": "public-key", + "transports": [] + }, + { + "id": "u5wuw6SGH0VhAz7OXCLRkCuxhm4UrCB7hcLccyMU6calP1hWexfKe5PJNM69neAM", + "type": "public-key", + "transports": [] + }, + { + "id": "6rc0zTSz2YRlaKlCjqxsNDjDe8qY8TSL95Z4WhxEaaP4XfvfSnAGMk49RSwm/uAO", + "type": "public-key", + "transports": [] + } + ], + "authenticatorSelection": { + "authenticatorAttachment": "cross-platform", + "requireResidentKey": true, + "userVerification": "required" + }, + "extensions": { + "hmacCreateSecret": true, + "enforceCredentialProtectionPolicy": true, + "credentialProtectionPolicy": "userVerificationOptional" + } + } } } ``` |
v1.0 | Filestorage Delete Deletedcontainers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-delete-deletedcontainers.md | Namespace: microsoft.graph Permanently remove a [fileStorageContainer](../resources/filestoragecontainer.md) from the deleted container collection. Removing a file storage container with this API permanently removes it from the deleted container collection. Therefore, it can't be restored later. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-DELETE /deletedStorageContainers/{containerId} +DELETE /storage/fileStorage/deletedContainers/{containerId} ``` ## Request headers If successful, this method returns a `204 No Content` response code. ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "remove_deleted_filestoragecontainer" } --> ``` http-DELETE https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z +DELETE https://graph.microsoft.com/beta/storage/fileStorage/deletedContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestorage Get Deletedcontainers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-get-deletedcontainers.md | Namespace: microsoft.graph Retrieve the properties of a deleted [fileStorageContainer](../resources/filestoragecontainer.md) from the deleted container collection. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /deletedStorageContainers/{containerId} +GET /storage/fileStorage/deletedContainers/{containerId} ``` ## Request headers If successful, this method returns a `200 OK` response code. ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_deleted_filestoragecontainer" } --> ``` http-GET https://graph.microsoft.com/beta/deletedStorageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z?$select=*,members +GET https://graph.microsoft.com/beta/storage/fileStorage/deletedContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z?$select=*,members ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestorage List Deletedcontainers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestorage-list-deletedcontainers.md | Namespace: microsoft.graph Retrieve the list of [fileStorageContainer](../resources/filestoragecontainer.md) objects from the deleted container collection. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /deletedStorageContainers?$filter=containerTypeId eq {containerTypeId} +GET /storage/fileStorage/deletedContainers?$filter=containerTypeId eq {containerTypeId} ``` ## Query parameters If successful, this method returns a `200 OK` response code and a collection of ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_deleted_filestoragecontainer" } --> ``` http-GET https://graph.microsoft.com/beta/deletedStorageContainers?$filter=containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082 +GET https://graph.microsoft.com/beta/storage/fileStorage/deletedContainers?$filter=containerTypeId eq e2756c4d-fa33-4452-9c36-2325686e1082 ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestoragecontainer Delete Permissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-delete-permissions.md | Namespace: microsoft.graph Delete permissions from a [fileStorageContainer](../resources/filestoragecontainer.md) object. +By default, this API removes access for an identity to the container and all items within the container, regardless of whether the identity has container-scoped or item-level permissions. You can optimize this behavior by adding an optional `Prefer: onlyRemoveContainerScopedPermission` header when you call the API. When you include the `Prefer:onlyRemoveContainerScopedPermission` header, only the identity's container-scoped permission is removed. All item-level permissions explicitly granted to the identity (if any) are retained. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Choose the permission or permissions marked as least privileged for this API. Us ``` http DELETE /storage/fileStorage/containers/{containerId}/permissions/{permissionId} ```- ## Request headers |Name|Description| |:|:| If successful, this method returns a `204 No Content` response code. ### Request The following example shows a request.+ # [HTTP](#tab/http) <!-- { "blockType": "request", The following example shows a request. } --> ``` http-DELETE https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/permissions/{permissionId} +DELETE https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permissions/cmVhZGVyX2k6MCMuZnxtZW1iZXJzaGlwfHJvcnlicjExMUBvdXRsb29rLmNvbQ ``` # [C#](#tab/csharp) The following example shows the response. HTTP/1.1 204 No Content ``` + |
v1.0 | Filestoragecontainer Delete Recyclebin Items | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-delete-recyclebin-items.md | Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-POST /storageContainers/{containerId}/recycleBin/items/delete +POST /storage/fileStorage/containers/{containerId}/recycleBin/items/delete ``` ## Request headers If successful, this method returns a `204 No Content` response code. ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_filestoragecontainer_recyclebin_items", The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/delete +POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/delete Content-Type: application/json { Content-Type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ### Response The following example shows the response. |
v1.0 | Filestoragecontainer List Columns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-list-columns.md | Namespace: microsoft.graph Get the collection of columns represented as [columnDefinition](../resources/columndefinition.md) resources in a [fileStorageContainer](../resources/filestoragecontainer.md). + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us --> ``` http-GET /storageContainers/{containerId}/columns +GET /storage/fileStorage/containers/{containerId}/columns ``` ## Request headers If successful, this method returns a `200 OK` response code and a collection of ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_columndefinition" The following example shows a request. --> ``` http-GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns +GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestoragecontainer List Customproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-list-customproperty.md | The following example shows how to get a custom property named `clientUniquieId` } --> ``` http-GET https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/customProperties/clientUniqueId +GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/customProperties/clientUniqueId ``` # [JavaScript](#tab/javascript) The following example shows how to get all the custom properties of a **fileStor } --> ``` http-GET https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/customProperties/ +GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/customProperties ``` # [JavaScript](#tab/javascript) |
v1.0 | Filestoragecontainer List Permissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-list-permissions.md | Choose the permission or permissions marked as least privileged for this API. Us ``` http GET /storage/fileStorage/containers/{containerId}/permissions ```- ## Optional query parameters This method supports the `$skip`, `$top`, `$orderBy`, and `$filter` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +By default, this API lists only container-scoped permissions. You can use the `includeAllContainerUsers=true` query parameter to include entries for identities that may have at least one item-level permission in the container but don't have container-scoped permission. + ## Request headers |Name|Description| |:|:| The following example shows a request. } --> ``` http-GET https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/permissions +GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permissions ``` # [C#](#tab/csharp) |
v1.0 | Filestoragecontainer List Recyclebin Items | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-list-recyclebin-items.md | Namespace: microsoft.graph Get a list of [recycleBinItem](../resources/recyclebinitem.md) objects from the [recycleBin](../resources/recyclebin.md) of a [fileStorageContainer](../resources/filestoragecontainer.md). + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us --> ``` http-GET /storageContainers/{containerId}/recycleBin/items +GET /storage/fileStorage/containers/{containerId}/recycleBin/items ``` ## Request headers If successful, this method returns a `200 OK` response code and a collection of The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_recyclebin_items" The following example shows a request. --> ``` http-GET https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items +GET https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestoragecontainer Lock | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-lock.md | Choose the permission or permissions marked as least privileged for this API. Us ## HTTP request ``` http-POST /storageContainers/{containerId}/lock +POST /storage/fileStorage/containers/{containerId}/lock ``` ## Request body If successful, this method returns a `204 No Content` response code. The following example shows how to lock a fileStorageContainer. ``` http-POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/lock +POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/lock { "lockState": "lockedReadOnly" |
v1.0 | Filestoragecontainer Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-permanentdelete.md | Namespace: microsoft.graph Permanently delete a [fileStorageContainer](../resources/filestoragecontainer.md) object. Deleting a file storage container with this method permanently removes it. It isn't sent to the deleted container collection. Therefore, it can't be restored later. + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-POST /storageContainers/{containerId}/permanentDelete +POST /storage/fileStorage/containers/{containerId}/permanentDelete ``` ## Request headers If successful, this action returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "filestoragecontainerthis.permanentdelete", The following example shows a request. --> ``` http-POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permanentDelete +POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permanentDelete ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestoragecontainer Post Columns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-post-columns.md | Namespace: microsoft.graph Create a column for a [fileStorageContainer](../resources/filestoragecontainer.md) that specifies a [columnDefinition](../resources/columndefinition.md). + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-POST /storageContainers/{containerId}/columns +POST /storage/fileStorage/containers/{containerId}/columns ``` ## Request headers If successful, this method returns a `201 Created` response code and a [columnDe The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_columndefinition_for_fileStorageContainer" The following example shows a request. --> ``` http-POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns +POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns Content-Type: application/json { Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestoragecontainer Post Customproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-post-customproperty.md | The following example shows how to create a custom property called `clientUnique } --> ``` http-PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/customProperties +PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/customProperties Content-Type: application/json { The following example shows how to create a searchable custom property called `c } --> ``` http-PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/customProperties +PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/customProperties Content-Type: application/json { |
v1.0 | Filestoragecontainer Post Permissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-post-permissions.md | Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-POST /storage/fileStorage/containers/{fileStorageContainerId}/permissions +POST /storage/fileStorage/containers/{containerId}/permissions ``` ## Request headers The following example shows how to add a new user as a reader to a container. } --> ``` http-POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/permissions +POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permissions Content-type: application/json { |
v1.0 | Filestoragecontainer Restore Recyclebin Items | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-restore-recyclebin-items.md | Choose the permission or permissions marked as least privileged for this API. Us --> ``` http-POST /storageContainers/{containerId}/recycleBin/items/restore +POST /storage/fileStorage/containers/{containerId}/recycleBin/items/restore ``` ## Request headers If successful, this method returns a `207 Multi-Status` response code and the se The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "restore_filestoragecontainer_recyclebin_items", The following example shows a request. --> ``` http-POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/restore +POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/items/restore Content-Type: application/json { Content-Type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ### Response The following example shows the response. |
v1.0 | Filestoragecontainer Unlock | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-unlock.md | When delegated permissions are used, only members in the `owner` role can call t ## HTTP request ``` http-POST /storageContainers/{containerId}/unlock +POST /storage/fileStorage/containers/{containerId}/unlock ``` ## Request headers If successful, this method returns a `204 No Content` response code. The following example shows how to unlock a **fileStorageContainer**. ``` http-POST https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/unlock +POST https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/unlock ``` ### Response |
v1.0 | Filestoragecontainer Update Column | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-update-column.md | Namespace: microsoft.graph Update an existing column represented as a [columnDefinition](../resources/columndefinition.md) in a [fileStorageContainer](../resources/filestoragecontainer.md). + ## Permissions Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-PATCH /storageContainers/{containerId}/columns/{column-id} +PATCH /storage/fileStorage/containers/{containerId}/columns/{column-id} ``` ## Request headers If successful, this method returns a `200 OK` response code and a [columnDefinit The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_columndefinition_for_fileStorageContainer" } --> ``` http-PATCH https://graph.microsoft.com/beta/storageContainers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/11dfef35-e2f7-4f17-82b0-6fba34445103 +PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/columns/11dfef35-e2f7-4f17-82b0-6fba34445103 Content-Type: application/json { Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++ ### Response |
v1.0 | Filestoragecontainer Update Customproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-update-customproperty.md | The following example updates the `value` property of the custom properties `cli } --> ``` http-PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/customProperties +PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/customProperties Content-type: application/json { |
v1.0 | Filestoragecontainer Update Permissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-update-permissions.md | The following example shows a request. } --> ``` http-PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/permissions/{permissionId} +PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/permissions/cmVhZGVyX2k6MCMuZnxtZW1iZXJzaGlwfHJvcnlicjExMUBvdXRsb29rLmNvbQ Content-Type: application/json { |
v1.0 | Filestoragecontainer Update Recyclebinsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-update-recyclebinsettings.md | + + Title: "Update recycleBinSettings" +description: "Update recycleBin settings for a fileStorageContainer." ++ms.localizationpriority: medium ++++# Update recycleBinSettings +++Namespace: microsoft.graph +++Update the setting on the recycleBin for a [fileStorageContainer](../resources/filestoragecontainer.md) by making a PATCH request on the [recycleBinSettings](../resources/recyclebinsettings.md) resource. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "filestoragecontainer-update-recyclebinsettings-permissions" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /storage/fileStorage/containers/{containerId}/recycleBin/settings +``` ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Content-Type|application/json. Required.| ++## Request body +In the request body, supply the new values for the **recycleBinSettings** properties. Existing properties that aren't included in the request body maintain their previous values. To optimize performance, don't include existing values that didn't change. ++## Response ++If successful, this method returns a `200 OK` response code. ++## Examples ++### Request +The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_filestoragecontainer_recyclebin_settings" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z/recycleBin/settings +Content-Type: application/json ++{ + "retentionPeriodOverrideDays": 180 +} +``` ++# [JavaScript](#tab/javascript) ++++### Response +The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 200 OK +``` + |
v1.0 | Filestoragecontainer Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/filestoragecontainer-update.md | The following example shows a request. } --> ``` http-PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId} +PATCH https://graph.microsoft.com/beta/storage/fileStorage/containers/b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z Content-Type: application/json { |
v1.0 | Governanceresource Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceresource-get.md | This method **only** supports `$select` and `$expand` [OData Query Parameters]( ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governanceresource List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceresource-list.md | This method supports the [OData query parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governanceroleassignment Export | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroleassignment-export.md | This method supports the [OData query parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governanceroleassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroleassignment-get.md | This method does **not** supports [OData Query Parameters](/graph/query-paramete ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governanceroleassignment List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroleassignment-list.md | This method supports the [OData Query Parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governanceroleassignmentrequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroleassignmentrequest-get.md | This method supports the [OData Query Parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governanceroleassignmentrequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroleassignmentrequest-list.md | This method supports the [OData query parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governanceroleassignmentrequest Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroleassignmentrequest-post.md | POST /privilegedAccess/azureResources/roleAssignmentRequests | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | Content-type | application/json | ## Request body |
v1.0 | Governanceroleassignmentrequest Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroleassignmentrequest-update.md | POST /privilegedAccess/azureResources/roleAssignmentRequests/{id}/updateRequest ## Request headers | Name | Description| |:|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | Content-type | application/json| ## Request body |
v1.0 | Governanceroledefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroledefinition-get.md | This method does **not** support the [OData Query Parameters](/graph/query-param ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Governanceroledefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governanceroledefinition-list.md | This method supports the [OData query parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governancerolesetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governancerolesetting-get.md | This method supports the [OData Query Parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Governancerolesetting List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/governancerolesetting-list.md | This method supports the [OData query parameters](/graph/query-parameters) to he ## Request headers | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body Don't supply a request body for this method. |
v1.0 | Group Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-assignlicense.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Add or remove licenses on the group. Licenses assigned to the group will be assigned to all users in the group. To learn more about group-based licensing, see [What is group-based licensing in Microsoft Entra ID](/azure/active-directory/fundamentals/active-directory-licensing-whatis-azure-portal). +Add or remove licenses on the group. Licenses assigned to the group will be assigned to all users in the group. Group-based licensing is an alternative to [direct user licensing](../api/user-assignlicense.md). To learn more about group-based licensing, see [What is group-based licensing in Microsoft Entra ID](/azure/active-directory/fundamentals/active-directory-licensing-whatis-azure-portal). To get the subscriptions available in the directory, perform a [GET subscribedSkus request](subscribedsku-list.md). Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "group_assignlicense" } --> [!INCLUDE [permissions-table](../includes/permissions/group-assignlicense-permissions.md)] -For delegated scenarios, the calling user needs at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). -+> [!IMPORTANT] +> +> In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json) or a custom role with the `microsoft.directory/groups/assignLicense` role permission. The following least privileged roles are supported for this operation: - Directory Writers - Groups Administrator - License Administrator 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. Required. | +| removeLicenses | Guid collection | A collection of skuIds that identify the licenses to remove. Required. Can be an empty collection. | ## Response location: https://graph.microsoft.com/v2/e8e96c2a-d787-4eb1-98d7-9e57c965f1de/di "id": "1132b215-826f-42a9-8cfe-1643d19d17fd", "createdDateTime": "2021-03-12T11:15:03Z", "groupTypes": [],- "securityEnabled": true, + "securityEnabled": true } ``` location: https://graph.microsoft.com/v2/e8e96c2a-d787-4eb1-98d7-9e57c965f1de/di "id": "1132b215-826f-42a9-8cfe-1643d19d17fd", "createdDateTime": "2021-03-12T11:15:03Z", "groupTypes": [],- "securityEnabled": true, + "securityEnabled": true } ``` |
v1.0 | Group Delete Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-delete-approleassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "group_delete_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/group-delete-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Group Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted groups, including group membership changes, without having to perform a full read of the entire group collection. See [Using Delta Query](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted groups, including group membership changes, without having to perform a full read of the entire group collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Group List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-approleassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "group_list_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/group-list-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Group List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list.md | Content-type: application/json } ``` -### Example 2: Get a filtered list of groups including the count of returned objects +### Example 2: Get a filtered list of groups -#### Request --The following example shows a request. This request requires the **ConsistencyLevel** header set to `eventual` because `$count` is in the request. For more information about the use of **ConsistencyLevel** and `$count`, see [Advanced query capabilities on directory objects](/graph/aad-advanced-queries). --> **Note:** The `$count` and `$search` query parameters are currently not available in Azure AD B2C tenants. +This request that filters against the **hasMembersWithLicenseErrors** property doesn't support retrieving the count of returned objects. +#### Request # [HTTP](#tab/http) <!-- { The following example shows a request. This request requires the **ConsistencyLe }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/groups?$count=true&$filter=hasMembersWithLicenseErrors+eq+true&$select=id,displayName -ConsistencyLevel: eventual +GET https://graph.microsoft.com/beta/groups?$filter=hasMembersWithLicenseErrors+eq+true&$select=id,displayName ``` # [C#](#tab/csharp) Content-type: application/json { "@odata.context":"https://graph.microsoft.com/beta/$metadata#groups(id,displayName)",- "@odata.count":2, "value":[ { "id":"11111111-2222-3333-4444-555555555555", |
v1.0 | Group Post Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-post-approleassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "group_post_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/group-post-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Group Post Groups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-post-groups.md | The following table lists the properties that are required when you create the [ > [!IMPORTANT] >-> - Creating a group using the **Group.Create** application permission without specifying owners will create the group anonymously and the group will not be modifiable. Add owners to the group while creating it to specify owners who can modify the group. +> - Creating a group using the **Group.Create** application permission without specifying owners creates the group anonymously and the group isn't modifiable. Add owners to the group while creating it so the owners can manage the group. >-> - Creating a Microsoft 365 group programmatically with an app-only context and without specifying owners will create the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken. +> - Creating a Microsoft 365 group in an app-only context and without specifying owners creates the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken. +> +> - Creating a Microsoft 365 or security group in a delegated context, signed in as a non-admin user, and without specifying owners automatically adds the calling user as the group owner. An admin user is automatically added as the group owner of a Microsoft 365 group they create but not of a security group. +> +> - A non-admin user can't add themselves to the group owners collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419). > > - To following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**. Content-type: application/json The following example creates a security group with an owner and members specified. Note that a maximum of 20 relationships, such as owners and members, can be added as part of group creation. You can subsequently add more members by using the [add member](/graph/api/group-post-members?view=graph-rest-beta&preserve-view=true) API or JSON batching. +A non-admin user can't add themselves to the group owners collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419). + #### Request The following example shows a request. |
v1.0 | Group Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-update.md | The following table specifies the properties that can be updated. | Property | Type | Description | | :- | : | :- | | allowExternalSenders | Boolean | Default is `false`. Indicates whether people external to the organization can send messages to the group. |-| assignedLabels | [assignedLabel](../resources/assignedlabel.md) collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group.| +| assignedLabels | [assignedLabel](../resources/assignedlabel.md) collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and [a supported administrator role](/purview/get-started-with-sensitivity-labels#permissions-required-to-create-and-manage-sensitivity-labels).| | autoSubscribeNewMembers | Boolean | Default is `false`. Indicates whether new members added to the group will be auto-subscribed to receive email notifications. **autoSubscribeNewMembers** can't be `true` when **subscriptionEnabled** is set to `false` on the group. | | description | String | An optional description for the group. | | displayName | String | The display name for the group. This property is required when a group is created and it cannot be cleared during updates. | |
v1.0 | Group Upsert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-upsert.md | The following table lists the properties that are required when you create the [ > [!IMPORTANT] > - Creating a group using the **Group.Create** application permission without specifying owners will create the group anonymously and the group will not be modifiable. Add owners to the group while creating it to specify owners who can modify the group. > - Creating a Microsoft 365 group programmatically with an app-only context and without specifying owners will create the group anonymously. Doing so can result in the associated SharePoint Online site not being created automatically until further manual action is taken.+> - A non-admin user can't add themselves to the group owners collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419). > - The following properties can't be set in the initial POST request and must be set in a subsequent PATCH request: **allowExternalSenders**, **autoSubscribeNewMembers**, **hideFromAddressLists**, **hideFromOutlookClients**, **isSubscribedByMail**, **unseenCount**. Because the **group** resource supports [extensions](/graph/extensibility-overview), you can add custom properties with your own data to the group while creating it. Content-type: application/json The following example creates a security group with an owner and members specified because a group with the specified **uniqueName** value does not exist. Note that a maximum of 20 relationships, such as owners and members, can be added as part of group creation. You can subsequently add multiple additional members by using the [add member](/graph/api/group-post-members?view=graph-rest-beta&preserve-view=true) API or JSON batching. +A non-admin user can't add themselves to the group owners collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419). + #### Request The following example shows a request. Content-type: application/json In this example, the specified group already exists, so the operation is treated as an update. +A non-admin user can't add themselves to the group owners collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419). + #### Request The following example shows a request. |
v1.0 | Group Validateproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-validateproperties.md | POST /groups/{id}/validateProperties | Name | Description | | : | : |-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | Content-Type | application/json | ## Request body |
v1.0 | Healthmonitoring Alert Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/healthmonitoring-alert-get.md | + + Title: "Get alert" +description: "Read the properties and relationships of an alert object." ++ms.localizationpriority: medium ++++# Get alert ++Namespace: microsoft.graph.healthMonitoring +++Read the properties and relationships of a Microsoft Entra health monitoring [alert](../resources/healthmonitoring-alert.md) object. The returned alert object contains information about the state, type, date, and impact of each alert that fired within your tenant. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "healthmonitoring_alert_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/healthMonitoring/alerts/{alertId} +``` ++## Optional query parameters ++This method supports the `$select` and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. ++When no `$expand` query parameter is added, this API doesn't return `resourceSampling` property by default. When you want to retrieve a sample of the resources involved in triggering the alert for root cause investigation, you can add `$expand=enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling` to view `resourceSampling` in [directoryObjectImpactSummary](../resources//healthmonitoring-directoryobjectimpactsummary.md). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md) object in the response body. ++## Examples ++### Example 1: Get the properties of the specified alert ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_alert1" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts/{id} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.healthMonitoring.alert" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts/$entity", + "id": "0c56dfcb-13db-4128-bda2-fc3e42742467", + "alertType": "mfaSignInFailure", + "scenario": "mfa", + "category": "authentication", + "createdDateTime": "2024-06-19T11:23:44.1234567Z", + "state": "active", + "enrichment": { + "state": "enriched", + "impacts": [ + { + "@odata.type": "#microsoft.graph.healthMonitoring.userImpactSummary", + "resourceType": "user", + "impactedCount": 143, + "impactedCountLimitExceeded": false + }, + { + "@odata.type": "#microsoft.graph.healthMonitoring.applicationImpactSummary", + "resourceType": "application", + "impactedCount": 1, + "impactedCountLimitExceeded": true + } + ], + "supportingData": { + "signIns": "https://graph.microsoft.com/beta/auditLogs/signIns?$filter=((status/errorCode eq 500121) and createdDateTime gt 2024-06-08T11:23:44.1234567Z and createdDateTime le 2024-06-19T11:23:44.1234567Z and (signInEventTypes/any(t:t eq 'interactiveUser' or t eq 'noninteractiveUser')))", + "audits": "https://graph.microsoft.com/beta/auditLogs/directoryaudits?$filter=(activityDateTime ge 2024-06-08T11:23:44.1234567Z and activityDateTime le 2024-06-19T11:23:44.1234567Z)&$top=50&$orderby=activityDateTime desc" + } + }, + "signals": { + "mfaSignInFailure": "https://graph.microsoft.com/beta/reports/serviceActivity/getMetricsForMfaSignInFailure(inclusiveIntervalStartDateTime=2024-06-08T11:23:44.1234567Z, exclusiveIntervalEndDateTime=2024-06-19T11:23:44.1234567Z, aggregationIntervalInMinutes=5)" + }, + "documentation": { + "troubleshootingGuide": "https://go.microsoft.com/fwlink/?linkid=2280158" + } +} +``` ++### Example 2: Use $select to retrieve specific properties of an alert ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_alert2" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts/{id}?$select=alertType, state, createdDateTime, signals +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.healthMonitoring.alert" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts(alertType,state,createdDateTime,signals)/$entity", + "alertType": "mfaSignInFailure", + "createdDateTime": "2024-06-19T11:23:44.1234567Z", + "state": "active", + "signals": { + "mfaSignInFailure": "https://graph.microsoft.com/beta/reports/serviceActivity/getMetricsForMfaSignInFailure(inclusiveIntervalStartDateTime=2024-06-08T11:23:44.1234567Z, exclusiveIntervalEndDateTime=2024-06-19T11:23:44.1234567Z, aggregationIntervalInMinutes=5)" + } +} +``` ++### Example 3: Use $expand to show resource sampling of an alert ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_alert3" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts/{id}?$expand=enrichment/impacts/microsoft.graph.healthmonitoring.directoryobjectimpactsummary/resourceSampling&$select=alertType, createdDateTime, enrichment' +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++#### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.healthMonitoring.alert" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts/$entity", + "alertType": "mfaSignInFailure", + "createdDateTime": "2024-06-19T11:23:44.1234567Z", + "enrichment": { + "state": "enriched", + "impacts": [ + { + "@odata.type": "#microsoft.graph.healthMonitoring.userImpactSummary", + "resourceType": "user", + "impactedCount": 143, + "impactedCountLimitExceeded": false, + "resourceSampling": [] + }, + { + "@odata.type": "#microsoft.graph.healthMonitoring.applicationImpactSummary", + "resourceType": "application", + "impactedCount": 1, + "impactedCountLimitExceeded": true, + "resourceSampling": [ + { + "id": "63c83fa4-d90c-4274-8460-5463e96f1113" + } + ] + } + ], + "supportingData": { + "signIns": "https://graph.microsoft.com/beta/auditLogs/signIns?$filter=((status/errorCode eq 500121) and createdDateTime gt 2024-06-08T11:23:44.1234567Z and createdDateTime le 2024-06-19T11:23:44.1234567Z and (signInEventTypes/any(t:t eq 'interactiveUser' or t eq 'noninteractiveUser')))", + "audits": "https://graph.microsoft.com/beta/auditLogs/directoryaudits?$filter=(activityDateTime ge 2024-06-08T11:23:44.1234567Z and activityDateTime le 2024-06-19T11:23:44.1234567Z)&$top=50&$orderby=activityDateTime desc" + } + } +} +``` ++> Note: Currently `resourceSampling` only contains `id` of the resource. In the future, it'll be able to show other properties of the resource as well. |
v1.0 | Healthmonitoring Alert Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/healthmonitoring-alert-update.md | + + Title: "Update alert" +description: "Update the properties of an alert object." ++ms.localizationpriority: medium ++++# Update alert ++Namespace: microsoft.graph.healthMonitoring +++Update the properties of a Microsoft Entra health monitoring [alert](../resources/healthmonitoring-alert.md) object. For example, change an alert's state from active to resolved. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "healthmonitoring_alert_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /reports/healthMonitoring/alerts/{alertId} +``` ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Content-Type|application/json. Required.| ++## Request body ++++|Property|Type|Description| +|:|:|:| +|state|microsoft.graph.healthMonitoring.alertState|The current lifecycle state of the alert. The possible values are: `active`, `resolved`, `unknownFutureValue`. Required.| +++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_alert" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/reports/healthMonitoring/alerts/{alertId} +Content-Type: application/json ++{ + "state": "resolved" +} +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.healthMonitoring.alert" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts/$entity", + "id": "0c56dfcb-13db-4128-bda2-fc3e42742467", + "alertType": "mfaSignInFailure", + "scenario": "mfa", + "category": "authentication", + "createdDateTime": "2024-06-19T11:23:44.1234567Z", + "state": "resolved", + "enrichment": { + "state": "enriched", + "impacts": [ + { + "@odata.type": "#microsoft.graph.healthMonitoring.userImpactSummary", + "resourceType": "user", + "impactedCount": 143, + "impactedCountLimitExceeded": false + }, + { + "@odata.type": "#microsoft.graph.healthMonitoring.applicationImpactSummary", + "resourceType": "application", + "impactedCount": 1, + "impactedCountLimitExceeded": true + } + ], + "supportingData": { + "signIns": "https://graph.microsoft.com/beta/auditLogs/signIns?$filter=((status/errorCode eq 500121) and createdDateTime gt 2024-06-08T11:23:44.1234567Z and createdDateTime le 2024-06-19T11:23:44.1234567Z and (signInEventTypes/any(t:t eq 'interactiveUser' or t eq 'noninteractiveUser')))", + "audits": "https://graph.microsoft.com/beta/auditLogs/directoryaudits?$filter=(activityDateTime ge 2024-06-08T11:23:44.1234567Z and activityDateTime le 2024-06-19T11:23:44.1234567Z)&$top=50&$orderby=activityDateTime desc" + } + }, + "signals": { + "mfaSignInFailure": "https://graph.microsoft.com/beta/reports/serviceActivity/getMetricsForMfaSignInFailure(inclusiveIntervalStartDateTime=2024-06-08T11:23:44.1234567Z, exclusiveIntervalEndDateTime=2024-06-19T11:23:44.1234567Z, aggregationIntervalInMinutes=5)" + }, + "documentation": { + "troubleshootingGuide": "https://go.microsoft.com/fwlink/?linkid=2280158" + } +} +``` + |
v1.0 | Healthmonitoring Alertconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/healthmonitoring-alertconfiguration-get.md | + + Title: "Get alertConfiguration" +description: "Read the properties and relationships of an alertConfiguration object." ++ms.localizationpriority: medium ++++# Get alertConfiguration ++Namespace: microsoft.graph.healthMonitoring +++Read the properties and relationships of a Microsoft Entra health monitoring [alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) object. The returned alertConfiguration object contains the settings for the distribution groups where alert notifications are to be sent. +++## Permissions ++Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). ++<!-- { "blockType": "permissions", "name": "healthmonitoring_alertconfiguration_get" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/healthMonitoring/alertConfigurations/{alertConfigurationId} +``` ++## 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. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` response code and a [microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + |