Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
v1.0 | Accesspackage Delete Accesspackageresourcerolescopes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/accesspackage-delete-accesspackageresourcerolescopes.md | Title: "Remove resourceRoleScope from an access package" -description: "Remove a resourceRoleScope from an access package." +description: "Remove an accessPackageResourceRoleScope from an accessPackage list of resource role scopes." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Remove a [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) from an [accessPackage](../resources/accesspackage.md) list of resource role scopes. +Remove an [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) from an [accessPackage](../resources/accesspackage.md) list of resource role scopes. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
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 | Adminconsentrequestpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminconsentrequestpolicy-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "adminconsentrequestpolicy_get" } --> [!INCLUDE [permissions-table](../includes/permissions/adminconsentrequestpolicy-get-permissions.md)] -When calling on behalf of a user, the user 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): -+ Global Reader -+ Cloud Application Administrator -+ Application Administrator ## HTTP request |
v1.0 | Adminconsentrequestpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/adminconsentrequestpolicy-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "adminconsentrequestpolicy_update" } --> [!INCLUDE [permissions-table](../includes/permissions/adminconsentrequestpolicy-update-permissions.md)] -For delegated scenarios, the calling user needs to belong to at least the *Application Administrator* or *Cloud Application Administrator* [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
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 | Appcredentialsigninactivity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/appcredentialsigninactivity-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "appcredentialsigninactivity_get" } --> [!INCLUDE [permissions-table](../includes/permissions/appcredentialsigninactivity-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
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 | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "applicationsignindetailedsummary_get" } --> [!INCLUDE [permissions-table](../includes/permissions/applicationsignindetailedsummary-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ``` http 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 | Callrecords Callrecord List Participants_V2 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/callrecords-callrecord-list-participants_v2.md | Namespace: microsoft.graph.callRecords Get the list of [participant](../resources/callrecords-participant.md) objects associated with a [callRecord](../resources/callrecords-callrecord.md). ## Permissions |
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 | Certificateauthorityasentity Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificateauthorityasentity-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificateauthorityasentity_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/certificateauthorityasentity-delete-permissions.md)] - ## HTTP request |
v1.0 | Certificateauthorityasentity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificateauthorityasentity-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificateauthorityasentity_get" } --> [!INCLUDE [permissions-table](../includes/permissions/certificateauthorityasentity-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Certificateauthorityasentity Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificateauthorityasentity-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificateauthorityasentity_update" } --> [!INCLUDE [permissions-table](../includes/permissions/certificateauthorityasentity-update-permissions.md)] ## HTTP request |
v1.0 | Certificateauthoritypath List Certificatebasedapplicationconfigurations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificateauthoritypath-list-certificatebasedapplicationconfigurations.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificateauthoritypath_list_certificatebasedapplicationconfigurations" } --> [!INCLUDE [permissions-table](../includes/permissions/certificateauthoritypath-list-certificatebasedapplicationconfigurations-permissions.md)] ## HTTP request |
v1.0 | Certificateauthoritypath Post Certificatebasedapplicationconfigurations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificateauthoritypath-post-certificatebasedapplicationconfigurations.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificateauthoritypath_post_certificatebasedapplicationconfigurations" } --> [!INCLUDE [permissions-table](../includes/permissions/certificateauthoritypath-post-certificatebasedapplicationconfigurations-permissions.md)] ## HTTP request You can specify the following properties when you create a **certificateBasedApp |:|:|:| |description|String|The description for the configuration. Optional.| |displayName|String|The friendly name for the configuration. Optional.|-|trustedCertificateAuthorities |[certificateAuthorityAsEntity](../resources/certificateauthorityasentity.md)|Multi-value property that represents a list of trusted certificate authorities. At least one trusted certificate authority must be provided when you create a certificate-based application configuration. | +|trustedCertificateAuthorities |[certificateAuthorityAsEntity](../resources/certificateauthorityasentity.md)|Multi-value property that represents a list of trusted certificate authorities. At least one trusted certificate authority must be provided when you create a certificate-based application configuration. | ## Response |
v1.0 | Certificatebasedapplicationconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedapplicationconfiguration_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedapplicationconfiguration-delete-permissions.md)] ## HTTP request |
v1.0 | Certificatebasedapplicationconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedapplicationconfiguration_get" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedapplicationconfiguration-get-permissions.md)] ## HTTP request |
v1.0 | Certificatebasedapplicationconfiguration List Trustedcertificateauthorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-list-trustedcertificateauthorities.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedapplicationconfiguration_list_trustedcertificateauthorities" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedapplicationconfiguration-list-trustedcertificateauthorities-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Certificatebasedapplicationconfiguration Post Trustedcertificateauthorities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-post-trustedcertificateauthorities.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedapplicationconfiguration_post_trustedcertificateauthorities" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedapplicationconfiguration-post-trustedcertificateauthorities-permissions.md)] ## HTTP request |
v1.0 | Certificatebasedapplicationconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedapplicationconfiguration-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedapplicationconfiguration_update" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedapplicationconfiguration-update-permissions.md)] ## HTTP request |
v1.0 | Certificatebasedauthconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Certificatebasedauthconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_get" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Certificatebasedauthconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_list" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Certificatebasedauthconfiguration Post Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md | Namespace: microsoft.graph Create a new [certificateBasedAuthConfiguration](../resources/certificateBasedAuthConfiguration.md) object. > [!NOTE]-> Only a single instance of a **certificateBasedAuthConfiguration** can be created (the collection can only have one member). It always has a fixed ID with a value of '29728ade-6ae4-4ee9-9103-412912537da5'. +> Only a single instance of a **certificateBasedAuthConfiguration** can be created (the collection can only have one member). It always has a fixed ID with a value of `29728ade-6ae4-4ee9-9103-412912537da5`. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_post_certificatebasedauthconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration-permissions.md)] -For delegated scenarios, the calling user must have the *Global Administrator* [Microsoft Entra role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). ## HTTP request |
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. ++# [HTTP](#tab/http) +<!-- { + "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 +} +``` ++# [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": "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 | 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/directoryaudit-get-permissions.md)] -In addition, apps must be [properly registered](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to Microsoft Entra ID. ## HTTP request 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 | 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/directoryaudit-list-permissions.md)] -In addition, apps must be [properly registered](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to Microsoft Entra ID. ## HTTP request 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 | Directorysetting Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directorysetting-delete.md | Delete a directory setting. ## Permissions 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). -### For all settings except the Consent Policy Settings object +### For tenant-wide settings -<!-- { "blockType": "permissions", "name": "directorysetting_delete" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/directorysetting-delete-permissions.md)] -### For the Consent Policy Settings object +### For group-specific settings -The following permissions are required to update the "Consent Policy Settings" **directorySetting** object. --<!-- { "blockType": "permissions", "name": "directorysetting_delete_2" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/directorysetting-delete-2-permissions.md)] [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
v1.0 | Directorysetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directorysetting-get.md | The following tables show the least privileged permission or permissions require ### List tenant-wide settings -<!-- { "blockType": "permissions", "name": "directorysetting_get" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/directorysetting-get-permissions.md)] ### List group-specific settings -<!-- { "blockType": "permissions", "name": "directorysetting_get_2" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/directorysetting-get-2-permissions.md)] [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
v1.0 | Directorysetting Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/directorysetting-update.md | Update the properties of a specific directory setting object. ## Permissions 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). -### For all settings except the Consent Policy Settings object +### For all settings *except* the Consent Policy Settings object -<!-- { "blockType": "permissions", "name": "directorysetting_update" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/directorysetting-update-permissions.md)] ### For the Consent Policy Settings object The following permissions are required to update the "Consent Policy Settings" **directorySetting** object. -<!-- { "blockType": "permissions", "name": "directorysetting_update_2" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/directorysetting-update-2-permissions.md)] [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
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 Accesspackagecatalogs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/entitlementmanagement-post-accesspackagecatalogs.md | Title: "Create accessPackageCatalog" -description: "Create a new accessPackageCatalog." +description: "Create a new accessPackageCatalog object." ms.localizationpriority: medium |
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 | Entitlementmanagement Post Connectedorganizations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/entitlementmanagement-post-connectedorganizations.md | If successful, this method returns a `201 Created` response code and a new [conn ## Examples +### Example 1: Create a connected organization + ### Request # [HTTP](#tab/http) Content-type: application/json "section": "documentation", "tocPath": "" }-->++### Example 2: Create a connected organization with an identitySource based on a tenant ID ++This example shows creating a connected organization with an identity source based on a tenant ID. The tenant ID can be found, by the domain name, using the [tenantRelationship: findTenantInformationByDomainName](../api/tenantrelationship-findtenantinformationbydomainname.md) call. ++### Request +++<!-- { + "blockType": "request", + "name": "create_connectedorganization_from_connectedorganizations_based_on_tenantID" +} +--> +``` http +POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/connectedOrganizations/ +Content-Type: application/json ++{ + "displayName":"Connected organization name", + "description":"Connected organization description", + "identitySources": [ + { + "@odata.type": "#microsoft.graph.azureActiveDirectoryTenant", + "displayName": "Contoso", + "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee" + } + ], + "state":"proposed" +} ++``` ++### Response ++**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.connectedOrganization" +} +--> +``` http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/connectedOrganizations/$entity", + "id": "922c86cf-65b8-4d94-b6a6-477dde331c7b", + "displayName": "Connected organization name", + "description": "Connected organization description", + "createdDateTime": "2024-10-29T21:55:39.6051923Z", + "modifiedDateTime": "2024-10-29T21:55:39.6051923Z", + "state": "proposed", + "identitySources": [] +} ++``` |
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 Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-owners.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve a list of the group's owners. The owners are a set of users who are allowed to modify the group object. Owners are currently not available in Microsoft Graph for groups that were created in Exchange or groups that are synchronized from an on-premises environment. +Retrieve a list of the group's owners. The owners are a set of users who are allowed to modify the group object. Owners are currently not available in Microsoft Graph for groups that were created in Exchange, distribution groups, or groups that are synchronized from an on-premises environment. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Group List Settings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/group-list-settings.md | One of the following permissions is required to call this API. To learn more, in ### List tenant-wide settings <!-- { "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) | Directory.Read.All, Directory.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Directory.Read.All, Directory.ReadWrite.All | + ### List group-specific settings <!-- { "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, Group.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Group.Read.All, Group.ReadWrite.All | + [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
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) +<!-- { + "blockType": "request", + "name": "get_alertconfiguration" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alertConfigurations/{alertConfigurationId} +``` ++# [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.alertConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alertConfigurations/$entity", + "id": "mfaSignInFailure", + "emailNotificationConfigurations": [ + { + "groupId": "c5140914-9507-4180-b60c-04d5ec5eddcb", + "isEnabled": true + } + ] +} +``` |
v1.0 | Healthmonitoring Alertconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/healthmonitoring-alertconfiguration-update.md | + + Title: "Update alertConfiguration" +description: "Update the properties of an alertConfiguration object." ++ms.localizationpriority: medium ++++# Update alertConfiguration ++Namespace: microsoft.graph.healthMonitoring +++Update the properties of a Microsoft Entra health monitoring [alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) object. You can use alertConfiguration settings to specify the distribution groups where alert notifications are to be sent. ++This API doesn't currently support group validation. +++## 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_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /reports/healthMonitoring/alertConfigurations/{alertConfigurationId} +``` ++## 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| +|:|:|:| +|emailNotificationConfigurations|[microsoft.graph.healthMonitoring.emailNotificationConfiguration](../resources/healthmonitoring-emailnotificationconfiguration.md) collection|Email notification settings for the particular alert type. Currently, only one email notification configuration is supported for an alert configuration, meaning just one group will receive notifications for an alert type.| ++++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. It currently supports only 1 group to receive email notification for an alert type. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_alertconfiguration" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/reports/healthMonitoring/alertConfigurations/{alertConfigurationId} +Content-Type: application/json ++{ + "emailNotificationConfigurations": [ + { + "groupId":"c5140914-9507-4180-b60c-04d5ec5eddcb", + "isEnabled": true + } + ] +} +``` ++# [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.alertConfiguration" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alertConfigurations/$entity", + "id": "mfaSignInFailure", + "emailNotificationConfigurations": [ + { + "groupId": "c5140914-9507-4180-b60c-04d5ec5eddcb", + "isEnabled": true + } + ] +} +``` |
v1.0 | Healthmonitoring Healthmonitoringroot List Alertconfigurations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/healthmonitoring-healthmonitoringroot-list-alertconfigurations.md | + + Title: "List alertConfigurations" +description: "Get a list of the alertConfiguration objects and their properties." ++ms.localizationpriority: medium ++++# List alertConfigurations ++Namespace: microsoft.graph.healthMonitoring +++Get a list of the Microsoft Entra health monitoring [alertConfiguration](../resources/healthmonitoring-alertconfiguration.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": "healthmonitoring_healthmonitoringroot_list_alertconfigurations" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/healthMonitoring/alertConfigurations +``` ++## Optional query parameters ++This method supports the `$count`, `$filter`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. `$skip` isn't supported. The default and maximum page sizes are 100 alert objects. ++## 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 [alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_alertconfiguration" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alertConfigurations +``` ++# [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.healthMonitoring.alertConfiguration)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alertConfigurations", + "value": [ + { + "id": "mfaSignInFailure", + "emailNotificationConfigurations": [ + { + "groupId": "c5140914-9507-4180-b60c-04d5ec5eddcb", + "isEnabled": true + } + ] + }, + { + "id": "managedDeviceSignInFailure", + "emailNotificationConfigurations": [ + { + "groupId": "c5140914-9507-4180-b60c-04d5ec5eddcb", + "isEnabled": false + } + ] + } + ] +} +``` + |
v1.0 | Healthmonitoring Healthmonitoringroot List Alerts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/healthmonitoring-healthmonitoringroot-list-alerts.md | + + Title: "List alerts" +description: "Get the list of Microsoft Entra health monitoring alerts and their properties from the past 30 days." ++ms.localizationpriority: medium ++++# List alerts ++Namespace: microsoft.graph.healthMonitoring +++Get the list of the Microsoft Entra health monitoring [alert](../resources/healthmonitoring-alert.md) objects and their properties from the past 30 days. +++## 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_healthmonitoringroot_list_alerts" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/healthMonitoring/alerts +``` ++## Optional query parameters ++This method supports the `$count`, `$expand`, `$filter`, `$orderby`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. `$skip` isn't supported. The default and maximum page sizes are 100 alert objects. ++`$orderby` is only supported on `createdDateTime` property. ++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 collection of [alert](../resources/healthmonitoring-alert.md) objects in the response body. ++## Examples ++### Example 1: Get all alerts ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_alert1" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts +``` ++# [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.healthMonitoring.alert)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts", + "value": [ + { + "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: Get all active alerts ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_alert2" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts?$filter=state eq microsoft.graph.healthmonitoring.alertState'active'&$select=id, alertType +``` ++# [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.healthMonitoring.alert)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts(id,alertType)", + "value": [ + { + "id": "0c56dfcb-13db-4128-bda2-fc3e42742467", + "alertType": "mfaSignInFailure" + }, + { + "id": "564bc4e2-10f6-4d76-b10c-25657637f748", + "alertType": "managedDeviceSignInFailure" + }, + ] +} +``` ++### Example 3: List the state of all alerts in a specific time range ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_alert3" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts?$filter=createdDateTime gt 2024-06-10T11:23:44Z&$select=id, alertType, createdDateTime, state +``` ++# [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.healthMonitoring.alert)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#reports/healthMonitoring/alerts(id,alertType,createdDateTime,state)", + "value": [ + { + "id": "0c56dfcb-13db-4128-bda2-fc3e42742467", + "alertType": "mfaSignInFailure", + "createdDateTime": "2024-06-19T11:23:44.1234567Z", + "state": "active" + }, + { + "id": "564bc4e2-10f6-4d76-b10c-25657637f748", + "alertType": "managedDeviceSignInFailure", + "createdDateTime": "2024-06-11T01:25:24.1234567Z", + "state": "active" + }, + ] +} +``` ++### Example 4: Use $expand to get all alerts with directory object resource sampling ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_alert4" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/healthMonitoring/alerts?$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": "Collection(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,createdDateTime,enrichment,enrichment/impacts/microsoft.graph.healthMonitoring.directoryObjectImpactSummary/resourceSampling())", + "value": [ + { + "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" + } + } + }, + ] +} +``` |
v1.0 | Identitycontainer List Authenticationeventlisteners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-authenticationeventlisteners.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_authenticationeventlisteners" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-authenticationeventlisteners-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitycontainer List Customauthenticationextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-customauthenticationextensions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_customauthenticationextensions" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-customauthenticationextensions-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitycontainer List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-list-identityproviders.md | Content-type: application/json #### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_identityproviderbase_CIAM" The following example shows a request. GET https://graph.microsoft.com/beta/identity/identityProviders ``` +# [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. Content-type: application/json } ] }-``` +``` |
v1.0 | Identitycontainer Post Authenticationeventlisteners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-authenticationeventlisteners.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_authenticationeventlisteners" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-authenticationeventlisteners-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitycontainer Post Authenticationeventsflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-authenticationeventsflows.md | You can specify the following properties when creating an **authenticationEvents |priority|Int32|Optional. 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. Default is 500. | |onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|Required. The configuration for what to invoke when an authentication flow is ready to be initiated. | |onAuthenticationMethodLoadStart|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|Required. The configuration for what to invoke when authentication methods are ready to be presented to the user. Must have at least one identity provider linked.|-|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Optional. The configuration for what to invoke when attributes are ready to be collected from the user. To configure this property when it wasn't configured during user flow creation, call the [Add attributes to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) API.| +|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Optional. The configuration for what to invoke when attributes are ready to be collected from the user. To configure this property, you must specify both **attributes** and **onAttributeCollectionPage** > **views** objects.| |onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|Optional. The configuration for what to invoke during user creation.| ## Response |
v1.0 | Identitycontainer Post Customauthenticationextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitycontainer-post-customauthenticationextensions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_customauthenticationextensions" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-customauthenticationextensions-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitygovernance Deleteditemcontainer Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-deleteditemcontainer-delete.md | Delete a [workflow](../resources/identitygovernance-workflow.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": "identitygovernance_deletedItemcontainer_delete" } --> +<!-- { "blockType": "permissions", "name": "identitygovernance_deleteditemcontainer_delete" } --> [!INCLUDE [rbac-lifecycle-workflows-apis-write](../includes/rbac-for-apis/rbac-lifecycle-workflows-apis-write.md)] |
v1.0 | Identitygovernance Insights Toptasksprocessedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-toptasksprocessedsummary.md | Namespace: microsoft.graph.identityGovernance Provide a summary of the most processed tasks, known as top tasks, for a specified time period in a tenant. The task definition is provided, along with numerical counts of total, successful, and failed runs. For information about workflows processed, see [insights: topWorkflowsProcessedSummary](identitygovernance-insights-topworkflowsprocessedsummary.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 --> [!INCLUDE [permissions-table](../includes/permissions/identitygovernance-insights-toptasksprocessedsummary-permissions.md)] + ## HTTP request <!-- { Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /identityGovernance/lifecycleWorkflows/insights/topTasksProcessedSummary +GET /identityGovernance/lifecycleWorkflows/insights/topTasksProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime}) ``` ## Function parameters |
v1.0 | Identitygovernance Insights Topworkflowsprocessedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-topworkflowsprocessedsummary.md | Namespace: microsoft.graph.identityGovernance Provide a summary of the workflows processed the most, known as top workflows, for a specified period in a tenant. Workflow basic details are given, along with run information. For information about tasks processed, see [insights: topTasksProcessedSummary](identitygovernance-insights-toptasksprocessedsummary.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 --> [!INCLUDE [permissions-table](../includes/permissions/identitygovernance-insights-topworkflowsprocessedsummary-permissions.md)] + ## HTTP request <!-- { Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary +GET /identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime}) ``` ## Function parameters |
v1.0 | Identitygovernance Insights Workflowsprocessedbycategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-workflowsprocessedbycategory.md | Namespace: microsoft.graph.identityGovernance Provide a summary of workflows processed, by category, in a tenant. This allows you to quickly get category information, by numerical value, bypassing other information found in the [WorkflowsProcessedSummary](identitygovernance-insights-workflowsprocessedsummary.md) call. + ## 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 --> [!INCLUDE [permissions-table](../includes/permissions/identitygovernance-insights-workflowsprocessedbycategory-permissions.md)] + ## HTTP request <!-- { Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory +GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory(startDateTime={startDateTime},endDateTime={endDateTime}) ``` ## Function parameters |
v1.0 | Identitygovernance Insights Workflowsprocessedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-insights-workflowsprocessedsummary.md | Namespace: microsoft.graph.identityGovernance Provide a summary of all workflows processed within a tenant for a specified period. Because the amount of results for listed workflows as returned by the [List workflows](../api/identitygovernance-lifecycleworkflowscontainer-list-workflows.md) does not tell you which workflows were processed from the list of created workflows, this summary gives you a quick overview of processed status based on counts. + ## 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 --> [!INCLUDE [permissions-table](../includes/permissions/identitygovernance-insights-workflowsprocessedsummary-permissions.md)] + ## HTTP request <!-- { Choose the permission or permissions marked as least privileged for this API. Us } --> ``` http-GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedSummary +GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime}) ``` ## Function parameters |
v1.0 | Identitygovernance Lifecycleworkflowscontainer List Taskdefinitions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md | Title: "List taskDefinitions" -description: "Get a list of the taskDefinition objects and their properties." +description: "Get a list of built-in workflow tasks in Lifecycle Workflows." ms.localizationpriority: medium Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of the [taskDefinition](../resources/identitygovernance-taskdefinition.md) objects and their properties. +Get a list of built-in workflow tasks in Lifecycle Workflows. A task is represented by the [taskDefinition](../resources/identitygovernance-taskdefinition.md) object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] GET https://graph.microsoft.com/beta/identityGovernance/lifecycleWorkflows/taskD #### Response The following example shows the response.+<!-- Keep the full response object for this example for other internal purposes--> <!-- { "blockType": "response", Content-Type: application/json { "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",- "@odata.count": 25, + "@odata.count": 24, + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET identityGovernance/lifecycleWorkflows/taskDefinitions?$select=category,continueOnError", "value": [ { "category": "joiner,leaver,mover", Content-Type: application/json }, { "category": "leaver",- "description": "Send offboarding email to userΓÇÖs manager before the last day of work", - "displayName": "Send email before userΓÇÖs last day", + "description": "Send offboarding email to user's manager before the last day of work", + "displayName": "Send email before user's last day", "id": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935", "version": 1, "parameters": [ Content-Type: application/json }, { "category": "leaver",- "description": "Send offboarding email to userΓÇÖs manager on the last day of work", - "displayName": "Send email on userΓÇÖs last day", + "description": "Send offboarding email to user's manager on the last day of work", + "displayName": "Send email on user's last day", "id": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411", "version": 1, "parameters": [ Content-Type: application/json }, { "category": "leaver",- "description": "Send offboarding email to userΓÇÖs manager after the last day of work", - "displayName": "Send email after userΓÇÖs last day", + "description": "Send offboarding email to user's manager after the last day of work", + "displayName": "Send email after user's last day", "id": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce", "version": 1, "parameters": [ Content-Type: application/json }, { "category": "joiner",- "description": "Send onboarding reminder email to userΓÇÖs manager", + "description": "Send onboarding reminder email to user's manager", "displayName": "Send onboarding reminder email", "id": "3C860712-2D37-42A4-928F-5C93935D26A1", "version": 1, Content-Type: application/json }, { "category": "mover",- "description": "Send email to notify userΓÇÖs manager of user move", + "description": "Send email to notify user's manager of user move", "displayName": "Send email to notify manager of user move", "id": "aab41899-9972-422a-9d97-f626014578b7", "version": 1, Content-Type: application/json "valueType": "string" } ]- }, - { - "category": "leaver,mover", - "description": "Transfer groups the user owned to the user's manager", - "displayName": "Transfer group ownership to manager", - "id": "dde2a64c-8420-447b-9075-7309449de5cd", - "version": 1, - "parameters": [] } ] } |
v1.0 | Identitygovernance Taskdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identitygovernance-taskdefinition-get.md | Title: "Get taskDefinition" -description: "Read the details of a built-in workflow task." +description: "Read the details of a built-in workflow task in Lifecycle Workflows." ms.localizationpriority: medium Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Read the details of a built-in workflow [task](../resources/identitygovernance-taskdefinition.md). +Read the details of a built-in workflow [task](../resources/identitygovernance-taskdefinition.md) in Lifecycle Workflows. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Identityprotectionroot List Riskyserviceprincipals | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprotectionroot-list-riskyserviceprincipals.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprotectionroot_list_riskyserviceprincipals" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprotectionroot-list-riskyserviceprincipals-permissions.md)] ## HTTP request |
v1.0 | Identityprotectionroot List Serviceprincipalriskdetections | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityprotectionroot-list-serviceprincipalriskdetections.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprotectionroot_list_serviceprincipalriskdetections" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprotectionroot-list-serviceprincipalriskdetections-permissions.md)] ## HTTP request |
v1.0 | Identityuserflowattributeassignment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattributeassignment-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-delete-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattributeassignment-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Getorder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattributeassignment-getorder.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_getorder" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-getorder-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Setorder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattributeassignment-setorder.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_setorder" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-setorder-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/identityuserflowattributeassignment-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Industrydata Industrydataroot Delete Outboundprovisioningflowsets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-industrydataroot-delete-outboundprovisioningflowsets.md | Delete an [outboundProvisioningFlowSet](../resources/industrydata-outboundprovis 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": "industrydata-industrydataroot-delete-outboundprovisioningflowsets-permissions" -} >-+<!-- { "blockType": "permissions", "name": "industrydata_industrydataroot_delete_outboundprovisioningflowsets" } --> [!INCLUDE [permissions-table](../includes/permissions/industrydata-industrydataroot-delete-outboundprovisioningflowsets-permissions.md)] ## HTTP request |
v1.0 | Industrydata Industrydataroot List Outboundprovisioningflowsets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-industrydataroot-list-outboundprovisioningflowsets.md | Get a list of the [outboundProvisioningFlowSet](../resources/industrydata-outbou 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": "industrydata-industrydataroot-list-outboundprovisioningflowsets-permissions" -} >-+<!-- { "blockType": "permissions", "name": "industrydata_industrydataroot_list_outboundprovisioningflowsets" } --> [!INCLUDE [permissions-table](../includes/permissions/industrydata-industrydataroot-list-outboundprovisioningflowsets-permissions.md)] ## HTTP request |
v1.0 | Industrydata Industrydataroot Post Outboundprovisioningflowsets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-industrydataroot-post-outboundprovisioningflowsets.md | Create a new [outboundProvisioningFlowSet](../resources/industrydata-outboundpro 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": "industrydata-industrydataroot-post-outboundprovisioningflowsets-permissions" -} >-+<!-- { "blockType": "permissions", "name": "industrydata_industrydataroot_post_outboundprovisioningflowsets" } --> [!INCLUDE [permissions-table](../includes/permissions/industrydata-industrydataroot-post-outboundprovisioningflowsets-permissions.md)] ## HTTP request |
v1.0 | Industrydata Outboundprovisioningflowset Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-outboundprovisioningflowset-get.md | Read the properties and relationships of an [outboundProvisioningFlowSet](../res 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": "industrydata-outboundprovisioningflowset-get-permissions" -} >-+<!-- { "blockType": "permissions", "name": "industrydata_outboundprovisioningflowset_get" } --> [!INCLUDE [permissions-table](../includes/permissions/industrydata-outboundprovisioningflowset-get-permissions.md)] ## HTTP request |
v1.0 | Industrydata Outboundprovisioningflowset Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/industrydata-outboundprovisioningflowset-update.md | Update the properties of an [outboundProvisioningFlowSet](../resources/industryd 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": "industrydata-outboundprovisioningflowset-update-permissions" -} >-+<!-- { "blockType": "permissions", "name": "industrydata_outboundprovisioningflowset_update" } --> [!INCLUDE [permissions-table](../includes/permissions/industrydata-outboundprovisioningflowset-update-permissions.md)] ## HTTP request |
v1.0 | Internaldomainfederation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/internaldomainfederation-get.md | 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 | Internaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/internaldomainfederation-update.md | PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId} |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications.| |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 into Microsoft Entra services. |-|preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`. | +|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`.| |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. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId} + If the **federatedIdpMfaBehavior** property is never set, Microsoft Entra ID continues to honor the **SupportsMfa** setting. + If neither **federatedIdpMfaBehavior** nor **SupportsMfa** is set, Microsoft Entra ID defaults to `acceptIfMfaDoneByFederatedIdp` behavior. -- ## Response If successful, this method returns a `200 OK` response code and an updated [internalDomainFederation](../resources/internaldomainfederation.md) object in the response body. Content-Type: application/json "certificateUpdateResult": "Success", "lastRunDateTime": "2021-08-25T07:44:46.2616778Z" },- "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp" + "federatedIdpMfaBehavior": "acceptIfMfaDoneByFederatedIdp", + "passwordResetUri": "https://sts.contoso.com/adfs/passwordReset" } ``` |
v1.0 | Intune Apps Androidlobapp Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidlobapp-create.md | Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps Content-type: application/json-Content-length: 1472 +Content-length: 1552 { "@odata.type": "#microsoft.graph.androidLobApp", Content-length: 1472 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 1644 +Content-Length: 1724 { "@odata.type": "#microsoft.graph.androidLobApp", Content-Length: 1644 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Androidlobapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidlobapp-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1769 +Content-Length: 1857 { "value": { Content-Length: 1769 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Androidlobapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidlobapp-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1889 +Content-Length: 1985 { "value": [ Content-Length: 1889 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Androidlobapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidlobapp-update.md | Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId} Content-type: application/json-Content-length: 1472 +Content-length: 1552 { "@odata.type": "#microsoft.graph.androidLobApp", Content-length: 1472 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1644 +Content-Length: 1724 { "@odata.type": "#microsoft.graph.androidLobApp", Content-Length: 1644 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Androidstoreapp Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidstoreapp-create.md | The following table shows the properties that are required when you create the a |supersedingAppCount|Int32|The total number of apps this app directly or indirectly supersedes. This property is read-only. Inherited from [mobileApp](../resources/intune-shared-mobileapp.md)| |supersededAppCount|Int32|The total number of apps this app is directly or indirectly superseded by. This property is read-only. Inherited from [mobileApp](../resources/intune-shared-mobileapp.md)| |packageId|String|The package identifier. This property is read-only.|-|appIdentifier|String|The Identity Name. This property is read-only.| |appStoreUrl|String|The Android app store URL.| |minimumSupportedOperatingSystem|[androidMinimumOperatingSystem](../resources/intune-apps-androidminimumoperatingsystem.md)|The value for the minimum applicable operating system.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps Content-type: application/json-Content-length: 1327 +Content-length: 1363 { "@odata.type": "#microsoft.graph.androidStoreApp", Content-length: 1327 "supersedingAppCount": 3, "supersededAppCount": 2, "packageId": "Package Id value",- "appIdentifier": "App Identifier value", "appStoreUrl": "https://example.com/appStoreUrl/", "minimumSupportedOperatingSystem": { "@odata.type": "microsoft.graph.androidMinimumOperatingSystem", Content-length: 1327 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 1499 +Content-Length: 1535 { "@odata.type": "#microsoft.graph.androidStoreApp", Content-Length: 1499 "supersedingAppCount": 3, "supersededAppCount": 2, "packageId": "Package Id value",- "appIdentifier": "App Identifier value", "appStoreUrl": "https://example.com/appStoreUrl/", "minimumSupportedOperatingSystem": { "@odata.type": "microsoft.graph.androidMinimumOperatingSystem", Content-Length: 1499 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` |
v1.0 | Intune Apps Androidstoreapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidstoreapp-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1616 +Content-Length: 1658 { "value": { Content-Length: 1616 "supersedingAppCount": 3, "supersededAppCount": 2, "packageId": "Package Id value",- "appIdentifier": "App Identifier value", "appStoreUrl": "https://example.com/appStoreUrl/", "minimumSupportedOperatingSystem": { "@odata.type": "microsoft.graph.androidMinimumOperatingSystem", Content-Length: 1616 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } } |
v1.0 | Intune Apps Androidstoreapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidstoreapp-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1728 +Content-Length: 1776 { "value": [ Content-Length: 1728 "supersedingAppCount": 3, "supersededAppCount": 2, "packageId": "Package Id value",- "appIdentifier": "App Identifier value", "appStoreUrl": "https://example.com/appStoreUrl/", "minimumSupportedOperatingSystem": { "@odata.type": "microsoft.graph.androidMinimumOperatingSystem", Content-Length: 1728 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ] |
v1.0 | Intune Apps Androidstoreapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-androidstoreapp-update.md | The following table shows the properties that are required when you create the [ |supersedingAppCount|Int32|The total number of apps this app directly or indirectly supersedes. This property is read-only. Inherited from [mobileApp](../resources/intune-shared-mobileapp.md)| |supersededAppCount|Int32|The total number of apps this app is directly or indirectly superseded by. This property is read-only. Inherited from [mobileApp](../resources/intune-shared-mobileapp.md)| |packageId|String|The package identifier. This property is read-only.|-|appIdentifier|String|The Identity Name. This property is read-only.| |appStoreUrl|String|The Android app store URL.| |minimumSupportedOperatingSystem|[androidMinimumOperatingSystem](../resources/intune-apps-androidminimumoperatingsystem.md)|The value for the minimum applicable operating system.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId} Content-type: application/json-Content-length: 1327 +Content-length: 1363 { "@odata.type": "#microsoft.graph.androidStoreApp", Content-length: 1327 "supersedingAppCount": 3, "supersededAppCount": 2, "packageId": "Package Id value",- "appIdentifier": "App Identifier value", "appStoreUrl": "https://example.com/appStoreUrl/", "minimumSupportedOperatingSystem": { "@odata.type": "microsoft.graph.androidMinimumOperatingSystem", Content-length: 1327 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1499 +Content-Length: 1535 { "@odata.type": "#microsoft.graph.androidStoreApp", Content-Length: 1499 "supersedingAppCount": 3, "supersededAppCount": 2, "packageId": "Package Id value",- "appIdentifier": "App Identifier value", "appStoreUrl": "https://example.com/appStoreUrl/", "minimumSupportedOperatingSystem": { "@odata.type": "microsoft.graph.androidMinimumOperatingSystem", Content-Length: 1499 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` |
v1.0 | Intune Apps Managedandroidlobapp Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidlobapp-create.md | Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps Content-type: application/json-Content-length: 1550 +Content-length: 1630 { "@odata.type": "#microsoft.graph.managedAndroidLobApp", Content-length: 1550 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 1722 +Content-Length: 1802 { "@odata.type": "#microsoft.graph.managedAndroidLobApp", Content-Length: 1722 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Managedandroidlobapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidlobapp-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1851 +Content-Length: 1939 { "value": { Content-Length: 1851 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Managedandroidlobapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidlobapp-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1975 +Content-Length: 2071 { "value": [ Content-Length: 1975 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Managedandroidlobapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidlobapp-update.md | Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId} Content-type: application/json-Content-length: 1550 +Content-length: 1630 { "@odata.type": "#microsoft.graph.managedAndroidLobApp", Content-length: 1550 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1722 +Content-Length: 1802 { "@odata.type": "#microsoft.graph.managedAndroidLobApp", Content-Length: 1722 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "Version Name value", "versionCode": "Version Code value", |
v1.0 | Intune Apps Managedandroidstoreapp Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidstoreapp-create.md | Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps Content-type: application/json-Content-length: 1361 +Content-length: 1441 { "@odata.type": "#microsoft.graph.managedAndroidStoreApp", Content-length: 1361 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 1533 +Content-Length: 1613 { "@odata.type": "#microsoft.graph.managedAndroidStoreApp", Content-Length: 1533 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` |
v1.0 | Intune Apps Managedandroidstoreapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidstoreapp-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1652 +Content-Length: 1740 { "value": { Content-Length: 1652 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } } |
v1.0 | Intune Apps Managedandroidstoreapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidstoreapp-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1766 +Content-Length: 1862 { "value": [ Content-Length: 1766 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ] |
v1.0 | Intune Apps Managedandroidstoreapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-managedandroidstoreapp-update.md | Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId} Content-type: application/json-Content-length: 1361 +Content-length: 1441 { "@odata.type": "#microsoft.graph.managedAndroidStoreApp", Content-length: 1361 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1533 +Content-Length: 1613 { "@odata.type": "#microsoft.graph.managedAndroidStoreApp", Content-Length: 1533 "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` |
v1.0 | Intune Apps Mobileapp Createcatalogapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileapp-createcatalogapp.md | Here is an example of the request. POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/createCatalogApp Content-type: application/json-Content-length: 2580 +Content-length: 2890 { "mobileApp": { Content-length: 2580 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent" } ], |
v1.0 | Intune Apps Mobileapp Updaterelationships | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileapp-updaterelationships.md | Here is an example of the request. POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/updateRelationships Content-type: application/json-Content-length: 402 +Content-length: 712 { "relationships": [ Content-length: 402 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent" } ] |
v1.0 | Intune Apps Mobileappdependency Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappdependency-create.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+POST /deviceAppManagement/mobileAppRelationships POST /deviceAppManagement/mobileApps/{mobileAppId}/relationships ``` The following table shows the properties that are required when you create the m |Property|Type|Description| |:|:|:|-|id|String|The relationship entity id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetId|String|The target mobile app's app id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayName|String|The target mobile app's display name. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayVersion|String|The target mobile app's display version. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetPublisher|String|The target mobile app's publisher. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target is a parent or child. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`.| -|dependencyType|[mobileAppDependencyType](../resources/intune-apps-mobileappdependencytype.md)|The type of dependency relationship between the parent and child apps. Possible values are: `detect`, `autoInstall`.| -|dependentAppCount|Int32|The total number of apps that directly or indirectly depend on the parent app. This property is read-only.| -|dependsOnAppCount|Int32|The total number of apps the child app directly or indirectly depends on. This property is read-only.| +|id|String|The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetId|String|The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayName|String|The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayVersion|String|The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisher|String|The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisherDisplayName|String|The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceId|String|The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayName|String|The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayVersion|String|The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourcePublisherDisplayName|String|The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`, `unknownFutureValue`.| +|dependencyType|[mobileAppDependencyType](../resources/intune-apps-mobileappdependencytype.md)|The type of dependency relationship between the parent and child apps. Possible values are: detect, autoInstall. Read-Only. Possible values are: `detect`, `autoInstall`, `unknownFutureValue`.| +|dependentAppCount|Int32|The total number of apps that directly or indirectly depend on the parent app. Read-Only. This property is read-only.| +|dependsOnAppCount|Int32|The total number of apps the child app directly or indirectly depends on. Read-Only. This property is read-only.| If successful, this method returns a `201 Created` response code and a [mobileAp ### Request Here is an example of the request. ``` http-POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships +POST https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships Content-type: application/json-Content-length: 372 +Content-length: 662 { "@odata.type": "#microsoft.graph.mobileAppDependency", Content-length: 372 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "dependencyType": "autoInstall", "dependentAppCount": 1, Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 421 +Content-Length: 711 { "@odata.type": "#microsoft.graph.mobileAppDependency", Content-Length: 421 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "dependencyType": "autoInstall", "dependentAppCount": 1, |
v1.0 | Intune Apps Mobileappdependency Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappdependency-delete.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+DELETE /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} DELETE /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} ``` If successful, this method returns a `204 No Content` response code. ### Request Here is an example of the request. ``` http-DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} +DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} ``` ### Response |
v1.0 | Intune Apps Mobileappdependency Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappdependency-get.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} GET /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} ``` If successful, this method returns a `200 OK` response code and [mobileAppDepend ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} +GET https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} ``` ### Response Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 460 +Content-Length: 760 { "value": { Content-Length: 460 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "dependencyType": "autoInstall", "dependentAppCount": 1, |
v1.0 | Intune Apps Mobileappdependency List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappdependency-list.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceAppManagement/mobileAppRelationships GET /deviceAppManagement/mobileApps/{mobileAppId}/relationships ``` If successful, this method returns a `200 OK` response code and a collection of ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships +GET https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships ``` ### Response Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 494 +Content-Length: 804 { "value": [ Content-Length: 494 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "dependencyType": "autoInstall", "dependentAppCount": 1, |
v1.0 | Intune Apps Mobileappdependency Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappdependency-update.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+PATCH /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} PATCH /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} ``` The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:|-|id|String|The relationship entity id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetId|String|The target mobile app's app id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayName|String|The target mobile app's display name. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayVersion|String|The target mobile app's display version. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetPublisher|String|The target mobile app's publisher. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target is a parent or child. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`.| -|dependencyType|[mobileAppDependencyType](../resources/intune-apps-mobileappdependencytype.md)|The type of dependency relationship between the parent and child apps. Possible values are: `detect`, `autoInstall`.| -|dependentAppCount|Int32|The total number of apps that directly or indirectly depend on the parent app. This property is read-only.| -|dependsOnAppCount|Int32|The total number of apps the child app directly or indirectly depends on. This property is read-only.| +|id|String|The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetId|String|The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayName|String|The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayVersion|String|The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisher|String|The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisherDisplayName|String|The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceId|String|The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayName|String|The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayVersion|String|The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourcePublisherDisplayName|String|The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`, `unknownFutureValue`.| +|dependencyType|[mobileAppDependencyType](../resources/intune-apps-mobileappdependencytype.md)|The type of dependency relationship between the parent and child apps. Possible values are: detect, autoInstall. Read-Only. Possible values are: `detect`, `autoInstall`, `unknownFutureValue`.| +|dependentAppCount|Int32|The total number of apps that directly or indirectly depend on the parent app. Read-Only. This property is read-only.| +|dependsOnAppCount|Int32|The total number of apps the child app directly or indirectly depends on. Read-Only. This property is read-only.| If successful, this method returns a `200 OK` response code and an updated [mobi ### Request Here is an example of the request. ``` http-PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} +PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} Content-type: application/json-Content-length: 372 +Content-length: 662 { "@odata.type": "#microsoft.graph.mobileAppDependency", Content-length: 372 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "dependencyType": "autoInstall", "dependentAppCount": 1, Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 421 +Content-Length: 711 { "@odata.type": "#microsoft.graph.mobileAppDependency", Content-Length: 421 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "dependencyType": "autoInstall", "dependentAppCount": 1, |
v1.0 | Intune Apps Mobileapprelationship Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileapprelationship-get.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} GET /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} ``` If successful, this method returns a `200 OK` response code and [mobileAppRelati ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} +GET https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} ``` ### Response Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 366 +Content-Length: 666 { "value": { Content-Length: 366 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent" } } |
v1.0 | Intune Apps Mobileapprelationship List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileapprelationship-list.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceAppManagement/mobileAppRelationships GET /deviceAppManagement/mobileApps/{mobileAppId}/relationships ``` If successful, this method returns a `200 OK` response code and a collection of ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships +GET https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships ``` ### Response Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 394 +Content-Length: 704 { "value": [ Content-Length: 394 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent" } ] |
v1.0 | Intune Apps Mobileappsupersedence Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappsupersedence-create.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+POST /deviceAppManagement/mobileAppRelationships POST /deviceAppManagement/mobileApps/{mobileAppId}/relationships ``` The following table shows the properties that are required when you create the m |Property|Type|Description| |:|:|:|-|id|String|The relationship entity id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetId|String|The target mobile app's app id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayName|String|The target mobile app's display name. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayVersion|String|The target mobile app's display version. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetPublisher|String|The target mobile app's publisher. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target is a parent or child. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`.| -|supersedenceType|[mobileAppSupersedenceType](../resources/intune-apps-mobileappsupersedencetype.md)|The supersedence relationship type between the parent and child apps. Possible values are: `update`, `replace`.| -|supersededAppCount|Int32|The total number of apps directly or indirectly superseded by the child app. This property is read-only.| -|supersedingAppCount|Int32|The total number of apps directly or indirectly superseding the parent app. This property is read-only.| +|id|String|The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetId|String|The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayName|String|The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayVersion|String|The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisher|String|The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisherDisplayName|String|The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceId|String|The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayName|String|The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayVersion|String|The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourcePublisherDisplayName|String|The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`, `unknownFutureValue`.| +|supersedenceType|[mobileAppSupersedenceType](../resources/intune-apps-mobileappsupersedencetype.md)|The supersedence relationship type between the parent and child apps. Possible values are: update, replace. Read-Only. Possible values are: `update`, `replace`, `unknownFutureValue`.| +|supersededAppCount|Int32|The total number of apps directly or indirectly superseded by the child app. Read-Only. This property is read-only.| +|supersedingAppCount|Int32|The total number of apps directly or indirectly superseding the parent app. Read-Only. This property is read-only.| If successful, this method returns a `201 Created` response code and a [mobileAp ### Request Here is an example of the request. ``` http-POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships +POST https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships Content-type: application/json-Content-length: 375 +Content-length: 665 { "@odata.type": "#microsoft.graph.mobileAppSupersedence", Content-length: 375 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "supersedenceType": "replace", "supersededAppCount": 2, Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 424 +Content-Length: 714 { "@odata.type": "#microsoft.graph.mobileAppSupersedence", Content-Length: 424 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "supersedenceType": "replace", "supersededAppCount": 2, |
v1.0 | Intune Apps Mobileappsupersedence Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappsupersedence-delete.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+DELETE /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} DELETE /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} ``` If successful, this method returns a `204 No Content` response code. ### Request Here is an example of the request. ``` http-DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} +DELETE https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} ``` ### Response |
v1.0 | Intune Apps Mobileappsupersedence Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappsupersedence-get.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} GET /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} ``` If successful, this method returns a `200 OK` response code and [mobileAppSupers ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} +GET https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} ``` ### Response Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 463 +Content-Length: 763 { "value": { Content-Length: 463 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "supersedenceType": "replace", "supersededAppCount": 2, |
v1.0 | Intune Apps Mobileappsupersedence List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappsupersedence-list.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceAppManagement/mobileAppRelationships GET /deviceAppManagement/mobileApps/{mobileAppId}/relationships ``` If successful, this method returns a `200 OK` response code and a collection of ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships +GET https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships ``` ### Response Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 497 +Content-Length: 807 { "value": [ Content-Length: 497 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "supersedenceType": "replace", "supersededAppCount": 2, |
v1.0 | Intune Apps Mobileappsupersedence Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-apps-mobileappsupersedence-update.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+PATCH /deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} PATCH /deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} ``` The following table shows the properties that are required when you create the [ |Property|Type|Description| |:|:|:|-|id|String|The relationship entity id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetId|String|The target mobile app's app id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayName|String|The target mobile app's display name. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayVersion|String|The target mobile app's display version. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetPublisher|String|The target mobile app's publisher. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target is a parent or child. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`.| -|supersedenceType|[mobileAppSupersedenceType](../resources/intune-apps-mobileappsupersedencetype.md)|The supersedence relationship type between the parent and child apps. Possible values are: `update`, `replace`.| -|supersededAppCount|Int32|The total number of apps directly or indirectly superseded by the child app. This property is read-only.| -|supersedingAppCount|Int32|The total number of apps directly or indirectly superseding the parent app. This property is read-only.| +|id|String|The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetId|String|The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayName|String|The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayVersion|String|The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisher|String|The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisherDisplayName|String|The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceId|String|The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayName|String|The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayVersion|String|The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourcePublisherDisplayName|String|The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`, `unknownFutureValue`.| +|supersedenceType|[mobileAppSupersedenceType](../resources/intune-apps-mobileappsupersedencetype.md)|The supersedence relationship type between the parent and child apps. Possible values are: update, replace. Read-Only. Possible values are: `update`, `replace`, `unknownFutureValue`.| +|supersededAppCount|Int32|The total number of apps directly or indirectly superseded by the child app. Read-Only. This property is read-only.| +|supersedingAppCount|Int32|The total number of apps directly or indirectly superseding the parent app. Read-Only. This property is read-only.| If successful, this method returns a `200 OK` response code and an updated [mobi ### Request Here is an example of the request. ``` http-PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}/relationships/{mobileAppRelationshipId} +PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileAppRelationships/{mobileAppRelationshipId} Content-type: application/json-Content-length: 375 +Content-length: 665 { "@odata.type": "#microsoft.graph.mobileAppSupersedence", Content-length: 375 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "supersedenceType": "replace", "supersededAppCount": 2, Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 424 +Content-Length: 714 { "@odata.type": "#microsoft.graph.mobileAppSupersedence", Content-Length: 424 "targetDisplayName": "Target Display Name value", "targetDisplayVersion": "Target Display Version value", "targetPublisher": "Target Publisher value",+ "targetPublisherDisplayName": "Target Publisher Display Name value", + "sourceId": "Source Id value", + "sourceDisplayName": "Source Display Name value", + "sourceDisplayVersion": "Source Display Version value", + "sourcePublisherDisplayName": "Source Publisher Display Name value", "targetType": "parent", "supersedenceType": "replace", "supersededAppCount": 2, |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings Connect | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-chromeosonboardingsettings-connect.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-chromeosonboardingsettings-create.md | Namespace: microsoft.graph Create a new [chromeOSOnboardingSettings](../resources/intune-chromebooksync-chromeosonboardingsettings.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-chromeosonboardingsettings-delete.md | Namespace: microsoft.graph Deletes a [chromeOSOnboardingSettings](../resources/intune-chromebooksync-chromeosonboardingsettings.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings Disconnect | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-chromeosonboardingsettings-disconnect.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-chromeosonboardingsettings-get.md | Namespace: microsoft.graph Read properties and relationships of the [chromeOSOnboardingSettings](../resources/intune-chromebooksync-chromeosonboardingsettings.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-chromeosonboardingsettings-list.md | Namespace: microsoft.graph List properties and relationships of the [chromeOSOnboardingSettings](../resources/intune-chromebooksync-chromeosonboardingsettings.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-chromebooksync-chromeosonboardingsettings-update.md | Namespace: microsoft.graph Update the properties of a [chromeOSOnboardingSettings](../resources/intune-chromebooksync-chromeosonboardingsettings.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Changecloudcertificationauthoritystatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-changecloudcertificationauthoritystatus.md | + + Title: "changeCloudCertificationAuthorityStatus action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Changecloudcertificationauthoritystatus Api ." ++ms.localizationpriority: medium ++++# changeCloudCertificationAuthorityStatus action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/changeCloudCertificationAuthorityStatus +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++|Property|Type|Description| +|:|:|:| +|certificationAuthorityStatus|[cloudCertificationAuthorityStatus](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritystatus.md)|The new CloudCertificationAuthorityStatus to set on the cloudCertificationAuthority entity instance.| +|certificationAuthorityVersion|Int32|The CloudCertificationAuthority entity instance version to change status.| ++++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/changeCloudCertificationAuthorityStatus ++Content-type: application/json +Content-length: 88 ++{ + "certificationAuthorityStatus": "active", + "certificationAuthorityVersion": 13 +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2122 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-create.md | + + Title: "Create cloudCertificationAuthority" +description: "Create a new cloudCertificationAuthority object." ++ms.localizationpriority: medium ++++# Create cloudCertificationAuthority ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Create a new [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the cloudCertificationAuthority object. ++The following table shows the properties that are required when you create the cloudCertificationAuthority. ++|Property|Type|Description| +|:|:|:| +|id|String|The certification authority entity instance identifier, which is a globally unique identifier. Read-only. Supports $select.| +|displayName|String|The certification authority display name the Intune admin console. Read/write. Supports $select and $orderby.| +|description|String|The certification authority description displayed in the Intune admin console. Nullable. Read/write. Returns null if not set.| +|scepServerUrl|String|The SCEP server URL for device SCEP connections to request certificates. Read-only.| +|certificateRevocationListUrl|String|The cloud certification authority's Certificate Revocation List URL that can be used to determine revocation status. Read-only.| +|certificateDownloadUrl|String|The URL to download the certification authority certificate. Read-only.| +|certificationAuthorityIssuerUri|String|The URI of the issuing certification authority of a subordinate certification authority. Returns null if a root certification authority. Nullable. Read-only.| +|ocspResponderUri|String|The Online Certificate Status Protocol (OCSP) responder URI that can be used to determine certificate status. Read-only.| +|certificationAuthorityStatus|[cloudCertificationAuthorityStatus](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritystatus.md)|Cloud certification authority current status. Unknown value returned by default if the cloud certification authority status is not known. After cloud certification authorities are created their status is set to active. Cloud certification authorities can be set to paused to stop issuing certificates. Possible values are: unknown, active, paused, signingPending, revoked. Read-only. Supports $filter and $orderby. Possible values are: `unknown`, `active`, `paused`, `revoked`, `signingPending`, `unknownFutureValue`.| +|eTag|String|ETag for optimistic concurrency control. Read/write.| +|lastModifiedDateTime|DateTimeOffset|Last modification date and time of this certification authority entity instance. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read/write.| +|roleScopeTagIds|String collection|List of Scope Tags for this entity instance. Scope tags limit access to an entity instance. Nullable. Read/write.| +|createdDateTime|DateTimeOffset|Creation date of this cloud certification authority entity instance. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only.| +|certificationAuthorityIssuerId|String|Issuer (parent) certification authority identifier. Nullable. Read-only. Supports $orderby and $select.| +|issuerCommonName|String|| +|cloudCertificationAuthorityType|[cloudCertificationAuthorityType](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritytype.md)|The certification authority type. rootCertificationAuthority value indicates root certification authorities that be used to create issuing certification authorities. issuingCertificationAuthority value indicates that a certification authority can be used to issue leaf certificates. Possible values are: rootCertificationAuthority, issuingCertificationAuthority, issuingCertificationAuthorityWithExternalRoot. Read-only. Supports $orderby. Possible values are: `unknown`, `rootCertificationAuthority`, `issuingCertificationAuthority`, `issuingCertificationAuthorityWithExternalRoot`, `unknownFutureValue`.| +|validityPeriodInYears|Int32|The certification authority validity period in years configured by admins.| +|validityStartDateTime|DateTimeOffset|The start date time of the validity period of a certification authority certificate. Certificates cannot be used before this date time as they are not yet valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|validityEndDateTime|DateTimeOffset|The end date time of the validity period of a certification authority certificate. Certificates cannot be used after this date time as they are longer valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|organizationName|String|The organization name that is used as a distinguished name in the subject name of a certification authority certificate in the form "O=<VALUE>". Nullable. Example: Microsoft. Read-only.| +|organizationUnit|String|The organization unit name that is used as a distinguished name in the subject name of a certification authority certificate in the form "OU=<VALUE>". Nullable. Example: Security. Read-only.| +|countryName|String|The country name that is used to compose the subject name of a certification authority certificate in the form "C=<VALUE>". Nullable. Example: US. Read-only.| +|stateName|String|The state or province name that is used to compose the subject name of a certification authority certificate in the form "ST=<VALUE>". Nullable. Example: Washington. Read-only.| +|localityName|String|The locality (town, city, etc.) name that is used to compose the subject name of a certification authority certificate in the form "L=<VALUE>". This is Nullable. Example: Redmond. Read-only.| +|certificateKeySize|[cloudCertificationAuthorityCertificateKeySize](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritycertificatekeysize.md)|The configured cryptography and key size in bits used to generate the certification authority certificate. Possible values are: rsa2048, rsa3072, rsa4096, eCP256, eCP256k, eCP384, eCP521. Read-only. Possible values are: `unknown`, `rsa2048`, `rsa3072`, `rsa4096`, `eCP256`, `eCP256k`, `eCP384`, `eCP521`, `unknownFutureValue`.| +|cloudCertificationAuthorityHashingAlgorithm|[cloudCertificationAuthorityHashingAlgorithm](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityhashingalgorithm.md)|Certification authority certificate hashing algorithm. Possible values are: sha256, sha384, sha512. Read-only. Possible values are: `unknown`, `sha256`, `sha384`, `sha512`, `unknownFutureValue`.| +|thumbprint|String|Secure Hash Algorithm 1 digest of the certificate that can be used to identify it. Read-only. Supports $select.| +|serialNumber|String|The serial number used to uniquely identify a certificate with its issuing certification authority. Read-only. Supports $select.| +|subjectName|String|The subject name of the certificate. The subject is the target or intended beneficiary of the security being provided, such as a company or government entity. Read-only. Supports $orderby and $select.| +|commonName|String|The common name of the certificate subject name, which must be unique. This property is a relative distinguished name used to compose the certificate subject name. Read-only. Supports $select.| +|certificateSigningRequest|String|The certificate signing request used to create an issuing certification authority with a root certification authority external to Microsoft Cloud PKI. The based-64 encoded certificate signing request can be downloaded through this property. After downloading the certificate signing request, it must be signed by the external root certifcation authority. Read-only.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-cloudpkigraphservice-extendedkeyusage.md) collection|The certificate extended key usages, which specify the usage capabilities of the certificate. Read-only.| +|versionNumber|Int32|The certification authority version, which is incremented each time the certification authority is renewed. Read-only.| +|rootCertificateCommonName|String|The common name of the certificate subject name of the certification authority issuer. This property can be used to identify the certification authority that issued the current certification authority. For issuing certification authorities, this is the common name of the certificate subject name of the root certification authority to which it is anchored. For externally signed certification authorities, this is the common name of the certificate subject name of the signing certification authority. For root certification authorities, this is the common name of the certification authority's own certificate subject name. Read-only.| +|keyPlatform|[cloudCertificationAuthorityKeyPlatformType](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritykeyplatformtype.md)|The key platform used to store the certification authority keys. Read-only. Possible values are: `unknown`, `software`, `hardwareSecurityModule`, `unknownFutureValue`.| ++++## Response +If successful, this method returns a `201 Created` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority +Content-type: application/json +Content-length: 1843 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 2015 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-delete.md | + + Title: "Delete cloudCertificationAuthority" +description: "Deletes a cloudCertificationAuthority." ++ms.localizationpriority: medium ++++# Delete cloudCertificationAuthority ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Deletes a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md). +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `204 No Content` response code. ++## Example ++### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-get.md | + + Title: "Get cloudCertificationAuthority" +description: "Read properties and relationships of the cloudCertificationAuthority object." ++ms.localizationpriority: medium ++++# Get cloudCertificationAuthority ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Read properties and relationships of the [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId} +``` ++## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2122 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Getallcloudcertificationauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-getallcloudcertificationauthority.md | + + Title: "getAllCloudCertificationAuthority action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Getallcloudcertificationauthority Api ." ++ms.localizationpriority: medium ++++# getAllCloudCertificationAuthority action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/getAllCloudCertificationAuthority +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) collection in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/getAllCloudCertificationAuthority +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2224 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } + ] +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Getallcloudcertificationauthorityleafcertificates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-getallcloudcertificationauthorityleafcertificates.md | + + Title: "getAllCloudCertificationAuthorityLeafCertificates action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Getallcloudcertificationauthorityleafcertificates Api ." ++ms.localizationpriority: medium ++++# getAllCloudCertificationAuthorityLeafCertificates action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/getAllCloudCertificationAuthorityLeafCertificates +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) collection in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/getAllCloudCertificationAuthorityLeafCertificates +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1206 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] + } + ] +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Getcloudcertificationauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-getcloudcertificationauthority.md | + + Title: "getCloudCertificationAuthority action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Getcloudcertificationauthority Api ." ++ms.localizationpriority: medium ++++# getCloudCertificationAuthority action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/getCloudCertificationAuthority +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/getCloudCertificationAuthority +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2122 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-list.md | + + Title: "List cloudCertificationAuthorities" +description: "List properties and relationships of the cloudCertificationAuthority objects." ++ms.localizationpriority: medium ++++# List cloudCertificationAuthorities ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++List properties and relationships of the [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) objects. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/cloudCertificationAuthority +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and a collection of [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) objects in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2224 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } + ] +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Patchcloudcertificationauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-patchcloudcertificationauthority.md | + + Title: "patchCloudCertificationAuthority action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Patchcloudcertificationauthority Api ." ++ms.localizationpriority: medium ++++# patchCloudCertificationAuthority action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/patchCloudCertificationAuthority +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/patchCloudCertificationAuthority +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2122 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Postcloudcertificationauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-postcloudcertificationauthority.md | + + Title: "postCloudCertificationAuthority action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Postcloudcertificationauthority Api ." ++ms.localizationpriority: medium ++++# postCloudCertificationAuthority action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/postCloudCertificationAuthority +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) collection in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/postCloudCertificationAuthority +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2224 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } + ] +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Revokecloudcertificationauthoritycertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-revokecloudcertificationauthoritycertificate.md | + + Title: "revokeCloudCertificationAuthorityCertificate action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Revokecloudcertificationauthoritycertificate Api ." ++ms.localizationpriority: medium ++++# revokeCloudCertificationAuthorityCertificate action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/revokeCloudCertificationAuthorityCertificate +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++|Property|Type|Description| +|:|:|:| +|certificationAuthorityVersion|Int32|The CloudCertificationAuthority entity instance version of the certificate to revoke.| ++++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/revokeCloudCertificationAuthorityCertificate ++Content-type: application/json +Content-length: 43 ++{ + "certificationAuthorityVersion": 13 +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2122 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Revokeleafcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-revokeleafcertificate.md | + + Title: "revokeLeafCertificate action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Revokeleafcertificate Api ." ++ms.localizationpriority: medium ++++# revokeLeafCertificate action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/revokeLeafCertificate +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++|Property|Type|Description| +|:|:|:| +|leafCertificateId|String|The Cloud Certification Authority Leaf Certificate unique identifier of the certificate to revoke. This id should be issued by respective certification authority.| ++++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/revokeLeafCertificate ++Content-type: application/json +Content-length: 56 ++{ + "leafCertificateId": "Leaf Certificate Id value" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1142 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Revokeleafcertificatebyserialnumber | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-revokeleafcertificatebyserialnumber.md | + + Title: "revokeLeafCertificateBySerialNumber action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Revokeleafcertificatebyserialnumber Api ." ++ms.localizationpriority: medium ++++# revokeLeafCertificateBySerialNumber action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/revokeLeafCertificateBySerialNumber +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++|Property|Type|Description| +|:|:|:| +|certificateSerialNumber|String|| ++++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/revokeLeafCertificateBySerialNumber ++Content-type: application/json +Content-length: 68 ++{ + "certificateSerialNumber": "Certificate Serial Number value" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1142 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Searchcloudcertificationauthorityleafcertificatebyserialnumber | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-searchcloudcertificationauthorityleafcertificatebyserialnumber.md | + + Title: "searchCloudCertificationAuthorityLeafCertificateBySerialNumber action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Searchcloudcertificationauthorityleafcertificatebyserialnumber Api ." ++ms.localizationpriority: medium ++++# searchCloudCertificationAuthorityLeafCertificateBySerialNumber action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/searchCloudCertificationAuthorityLeafCertificateBySerialNumber +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++|Property|Type|Description| +|:|:|:| +|certificateSerialNumber|String|| ++++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/searchCloudCertificationAuthorityLeafCertificateBySerialNumber ++Content-type: application/json +Content-length: 68 ++{ + "certificateSerialNumber": "Certificate Serial Number value" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1142 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-update.md | + + Title: "Update cloudCertificationAuthority" +description: "Update the properties of a cloudCertificationAuthority object." ++ms.localizationpriority: medium ++++# Update cloudCertificationAuthority ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Update the properties of a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object. ++The following table shows the properties that are required when you create the [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md). ++|Property|Type|Description| +|:|:|:| +|id|String|The certification authority entity instance identifier, which is a globally unique identifier. Read-only. Supports $select.| +|displayName|String|The certification authority display name the Intune admin console. Read/write. Supports $select and $orderby.| +|description|String|The certification authority description displayed in the Intune admin console. Nullable. Read/write. Returns null if not set.| +|scepServerUrl|String|The SCEP server URL for device SCEP connections to request certificates. Read-only.| +|certificateRevocationListUrl|String|The cloud certification authority's Certificate Revocation List URL that can be used to determine revocation status. Read-only.| +|certificateDownloadUrl|String|The URL to download the certification authority certificate. Read-only.| +|certificationAuthorityIssuerUri|String|The URI of the issuing certification authority of a subordinate certification authority. Returns null if a root certification authority. Nullable. Read-only.| +|ocspResponderUri|String|The Online Certificate Status Protocol (OCSP) responder URI that can be used to determine certificate status. Read-only.| +|certificationAuthorityStatus|[cloudCertificationAuthorityStatus](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritystatus.md)|Cloud certification authority current status. Unknown value returned by default if the cloud certification authority status is not known. After cloud certification authorities are created their status is set to active. Cloud certification authorities can be set to paused to stop issuing certificates. Possible values are: unknown, active, paused, signingPending, revoked. Read-only. Supports $filter and $orderby. Possible values are: `unknown`, `active`, `paused`, `revoked`, `signingPending`, `unknownFutureValue`.| +|eTag|String|ETag for optimistic concurrency control. Read/write.| +|lastModifiedDateTime|DateTimeOffset|Last modification date and time of this certification authority entity instance. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read/write.| +|roleScopeTagIds|String collection|List of Scope Tags for this entity instance. Scope tags limit access to an entity instance. Nullable. Read/write.| +|createdDateTime|DateTimeOffset|Creation date of this cloud certification authority entity instance. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only.| +|certificationAuthorityIssuerId|String|Issuer (parent) certification authority identifier. Nullable. Read-only. Supports $orderby and $select.| +|issuerCommonName|String|| +|cloudCertificationAuthorityType|[cloudCertificationAuthorityType](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritytype.md)|The certification authority type. rootCertificationAuthority value indicates root certification authorities that be used to create issuing certification authorities. issuingCertificationAuthority value indicates that a certification authority can be used to issue leaf certificates. Possible values are: rootCertificationAuthority, issuingCertificationAuthority, issuingCertificationAuthorityWithExternalRoot. Read-only. Supports $orderby. Possible values are: `unknown`, `rootCertificationAuthority`, `issuingCertificationAuthority`, `issuingCertificationAuthorityWithExternalRoot`, `unknownFutureValue`.| +|validityPeriodInYears|Int32|The certification authority validity period in years configured by admins.| +|validityStartDateTime|DateTimeOffset|The start date time of the validity period of a certification authority certificate. Certificates cannot be used before this date time as they are not yet valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|validityEndDateTime|DateTimeOffset|The end date time of the validity period of a certification authority certificate. Certificates cannot be used after this date time as they are longer valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|organizationName|String|The organization name that is used as a distinguished name in the subject name of a certification authority certificate in the form "O=<VALUE>". Nullable. Example: Microsoft. Read-only.| +|organizationUnit|String|The organization unit name that is used as a distinguished name in the subject name of a certification authority certificate in the form "OU=<VALUE>". Nullable. Example: Security. Read-only.| +|countryName|String|The country name that is used to compose the subject name of a certification authority certificate in the form "C=<VALUE>". Nullable. Example: US. Read-only.| +|stateName|String|The state or province name that is used to compose the subject name of a certification authority certificate in the form "ST=<VALUE>". Nullable. Example: Washington. Read-only.| +|localityName|String|The locality (town, city, etc.) name that is used to compose the subject name of a certification authority certificate in the form "L=<VALUE>". This is Nullable. Example: Redmond. Read-only.| +|certificateKeySize|[cloudCertificationAuthorityCertificateKeySize](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritycertificatekeysize.md)|The configured cryptography and key size in bits used to generate the certification authority certificate. Possible values are: rsa2048, rsa3072, rsa4096, eCP256, eCP256k, eCP384, eCP521. Read-only. Possible values are: `unknown`, `rsa2048`, `rsa3072`, `rsa4096`, `eCP256`, `eCP256k`, `eCP384`, `eCP521`, `unknownFutureValue`.| +|cloudCertificationAuthorityHashingAlgorithm|[cloudCertificationAuthorityHashingAlgorithm](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityhashingalgorithm.md)|Certification authority certificate hashing algorithm. Possible values are: sha256, sha384, sha512. Read-only. Possible values are: `unknown`, `sha256`, `sha384`, `sha512`, `unknownFutureValue`.| +|thumbprint|String|Secure Hash Algorithm 1 digest of the certificate that can be used to identify it. Read-only. Supports $select.| +|serialNumber|String|The serial number used to uniquely identify a certificate with its issuing certification authority. Read-only. Supports $select.| +|subjectName|String|The subject name of the certificate. The subject is the target or intended beneficiary of the security being provided, such as a company or government entity. Read-only. Supports $orderby and $select.| +|commonName|String|The common name of the certificate subject name, which must be unique. This property is a relative distinguished name used to compose the certificate subject name. Read-only. Supports $select.| +|certificateSigningRequest|String|The certificate signing request used to create an issuing certification authority with a root certification authority external to Microsoft Cloud PKI. The based-64 encoded certificate signing request can be downloaded through this property. After downloading the certificate signing request, it must be signed by the external root certifcation authority. Read-only.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-cloudpkigraphservice-extendedkeyusage.md) collection|The certificate extended key usages, which specify the usage capabilities of the certificate. Read-only.| +|versionNumber|Int32|The certification authority version, which is incremented each time the certification authority is renewed. Read-only.| +|rootCertificateCommonName|String|The common name of the certificate subject name of the certification authority issuer. This property can be used to identify the certification authority that issued the current certification authority. For issuing certification authorities, this is the common name of the certificate subject name of the root certification authority to which it is anchored. For externally signed certification authorities, this is the common name of the certificate subject name of the signing certification authority. For root certification authorities, this is the common name of the certification authority's own certificate subject name. Read-only.| +|keyPlatform|[cloudCertificationAuthorityKeyPlatformType](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritykeyplatformtype.md)|The key platform used to store the certification authority keys. Read-only. Possible values are: `unknown`, `software`, `hardwareSecurityModule`, `unknownFutureValue`.| ++++## Response +If successful, this method returns a `200 OK` response code and an updated [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId} +Content-type: application/json +Content-length: 1843 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2015 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority Uploadexternallysignedcertificationauthoritycertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthority-uploadexternallysignedcertificationauthoritycertificate.md | + + Title: "uploadExternallySignedCertificationAuthorityCertificate action" +description: "Intune Cloudpkigraphservice Cloudcertificationauthority Uploadexternallysignedcertificationauthoritycertificate Api ." ++ms.localizationpriority: medium ++++# uploadExternallySignedCertificationAuthorityCertificate action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/uploadExternallySignedCertificationAuthorityCertificate +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++|Property|Type|Description| +|:|:|:| +|signedCertificate|String|| +|trustChainCertificates|[trustChainCertificate](../resources/intune-cloudpkigraphservice-trustchaincertificate.md) collection|| +|certificationAuthorityVersion|Int32|| ++++## Response +If successful, this action returns a `200 OK` response code and a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/uploadExternallySignedCertificationAuthorityCertificate ++Content-type: application/json +Content-length: 295 ++{ + "signedCertificate": "Signed Certificate value", + "trustChainCertificates": [ + { + "@odata.type": "microsoft.graph.trustChainCertificate", + "displayName": "Display Name value", + "certificate": "Certificate value" + } + ], + "certificationAuthorityVersion": 13 +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 2122 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "96c8868d-868d-96c8-8d86-c8968d86c896", + "displayName": "Display Name value", + "description": "Description value", + "scepServerUrl": "https://example.com/scepServerUrl/", + "certificateRevocationListUrl": "https://example.com/certificateRevocationListUrl/", + "certificateDownloadUrl": "https://example.com/certificateDownloadUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "certificationAuthorityStatus": "active", + "eTag": "ETag value", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "certificationAuthorityIssuerId": "Certification Authority Issuer Id value", + "issuerCommonName": "Issuer Common Name value", + "cloudCertificationAuthorityType": "rootCertificationAuthority", + "validityPeriodInYears": 5, + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "organizationName": "Organization Name value", + "organizationUnit": "Organization Unit value", + "countryName": "Country Name value", + "stateName": "State Name value", + "localityName": "Locality Name value", + "certificateKeySize": "rsa2048", + "cloudCertificationAuthorityHashingAlgorithm": "sha256", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "subjectName": "Subject Name value", + "commonName": "Common Name value", + "certificateSigningRequest": "Certificate Signing Request value", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "Name value", + "objectIdentifier": "Object Identifier value" + } + ], + "versionNumber": 13, + "rootCertificateCommonName": "Root Certificate Common Name value", + "keyPlatform": "software" + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityleafcertificate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-create.md | + + Title: "Create cloudCertificationAuthorityLeafCertificate" +description: "Create a new cloudCertificationAuthorityLeafCertificate object." ++ms.localizationpriority: medium ++++# Create cloudCertificationAuthorityLeafCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Create a new [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/cloudCertificationAuthorityLeafCertificate +POST /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/cloudCertificationAuthorityLeafCertificate +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the cloudCertificationAuthorityLeafCertificate object. ++The following table shows the properties that are required when you create the cloudCertificationAuthorityLeafCertificate. ++|Property|Type|Description| +|:|:|:| +|id|String|The leaf certificate entity instance identifier, which is a randomly-generated globally unique identifier. Read-only. Supports $select.| +|subjectName|String|The subject name of the certificate. The subject is the target or intended beneficiary of the security being provided, such as a user or device. Read-only. Supports $select and $orderby.| +|issuerId|String|The globally unique identifier of the certification authority that issued the leaf certificate. Read-only.| +|issuerName|String|The name of the certification authority that issued the leaf certificate. Read-only.| +|certificateStatus|[cloudCertificationAuthorityLeafCertificateStatus](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificatestatus.md)|The current status of a certificate. Active value indicates the is in its validity period and not revoked. Revoked value indicates the certificate has been revoked and is no longer valid. Expired value indicates that the validity period of the certificate has lapsed. Possible values are: active, revoked, expired. Read-only. Supports $filter and $orderby. Possible values are: `unknown`, `active`, `revoked`, `expired`, `unknownFutureValue`.| +|validityStartDateTime|DateTimeOffset|The start date time of the validity period of a certificate. Certificates cannot be used before this date time as they are not yet valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|validityEndDateTime|DateTimeOffset|The end date time of the validity period of a certificate. Certificates cannot be used after this date time as they are longer valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|crlDistributionPointUrl|String|URL to find the relevant Certificate Revocation List for this certificate. Read-only.| +|certificationAuthorityIssuerUri|String|The URI of the certification authority that issued the certificate. Read-only.| +|ocspResponderUri|String|The Online Certificate Status Protocol (OCSP) responder URI that can be used to determine certificate status. Read-only.| +|thumbprint|String|Secure Hash Algorithm 1 digest of the certificate that can be used to identify it. Read-only. Supports $select.| +|serialNumber|String|The serial number used to uniquely identify a certificate with its issuing certification authority. Read-only. Supports $select.| +|revocationDateTime|DateTimeOffset|The date and time a certificate was revoked. If the certificate was not revoked, this will be null. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only.| +|deviceName|String|Name of the device for which the certificate was created. Read-only. Supports $select.| +|userPrincipalName|String|User principal name of the user for which the certificate was created. Null for userless devices. Nullable. Read-only. Supports $select.| +|deviceId|String|The unique identifier of the managed device for which the certificate was created. This ID is assigned at device enrollment time. Read-only. Supports $select.| +|userId|String|The unique identifier of the user for which the certificate was created. Null for userless devices. This is an Intune user ID. Nullable. Read-only. Supports $select.| +|devicePlatform|String|The platform of the device for which the certificate was created. Possible values are: Android, AndroidForWork, iOS, MacOS, WindowsPhone81, Windows81AndLater, Windows10AndLater, AndroidWorkProfile, Unknown, AndroidAOSP, AndroidMobileApplicationManagement, iOSMobileApplicationManagement. Default value: Unknown. Read-only. Supports $select.| +|keyUsages|String collection|Certificate extensions that define the purpose of the public key contained in a certificate. For example possible values are "Key Encipherment" and "Digital Signature". Read-only. Nullable.| +|extendedKeyUsages|String collection|Certificate extensions that further define the purpose of the public key contained in a certificate. Data is formatted as a comma-separated list of object identifiers (OID). For example a possible value is "1.3.6.1.5.5.7.3.2". Read-only. Nullable.| ++++## Response +If successful, this method returns a `201 Created` response code and a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthorityLeafCertificate +Content-type: application/json +Content-length: 1024 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 1073 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityleafcertificate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-delete.md | + + Title: "Delete cloudCertificationAuthorityLeafCertificate" +description: "Deletes a cloudCertificationAuthorityLeafCertificate." ++ms.localizationpriority: medium ++++# Delete cloudCertificationAuthorityLeafCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Deletes a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md). +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /deviceManagement/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +DELETE /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `204 No Content` response code. ++## Example ++### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityleafcertificate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-get.md | + + Title: "Get cloudCertificationAuthorityLeafCertificate" +description: "Read properties and relationships of the cloudCertificationAuthorityLeafCertificate object." ++ms.localizationpriority: medium ++++# Get cloudCertificationAuthorityLeafCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Read properties and relationships of the [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +GET /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +``` ++## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1142 ++{ + "value": { + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] + } +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityleafcertificate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-list.md | + + Title: "List cloudCertificationAuthorityLeafCertificates" +description: "List properties and relationships of the cloudCertificationAuthorityLeafCertificate objects." ++ms.localizationpriority: medium ++++# List cloudCertificationAuthorityLeafCertificates ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++List properties and relationships of the [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) objects. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/cloudCertificationAuthorityLeafCertificate +GET /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/cloudCertificationAuthorityLeafCertificate +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and a collection of [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) objects in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthorityLeafCertificate +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1206 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] + } + ] +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityleafcertificate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-update.md | + + Title: "Update cloudCertificationAuthorityLeafCertificate" +description: "Update the properties of a cloudCertificationAuthorityLeafCertificate object." ++ms.localizationpriority: medium ++++# Update cloudCertificationAuthorityLeafCertificate ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Update the properties of a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /deviceManagement/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +PATCH /deviceManagement/cloudCertificationAuthority/{cloudCertificationAuthorityId}/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object. ++The following table shows the properties that are required when you create the [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md). ++|Property|Type|Description| +|:|:|:| +|id|String|The leaf certificate entity instance identifier, which is a randomly-generated globally unique identifier. Read-only. Supports $select.| +|subjectName|String|The subject name of the certificate. The subject is the target or intended beneficiary of the security being provided, such as a user or device. Read-only. Supports $select and $orderby.| +|issuerId|String|The globally unique identifier of the certification authority that issued the leaf certificate. Read-only.| +|issuerName|String|The name of the certification authority that issued the leaf certificate. Read-only.| +|certificateStatus|[cloudCertificationAuthorityLeafCertificateStatus](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificatestatus.md)|The current status of a certificate. Active value indicates the is in its validity period and not revoked. Revoked value indicates the certificate has been revoked and is no longer valid. Expired value indicates that the validity period of the certificate has lapsed. Possible values are: active, revoked, expired. Read-only. Supports $filter and $orderby. Possible values are: `unknown`, `active`, `revoked`, `expired`, `unknownFutureValue`.| +|validityStartDateTime|DateTimeOffset|The start date time of the validity period of a certificate. Certificates cannot be used before this date time as they are not yet valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|validityEndDateTime|DateTimeOffset|The end date time of the validity period of a certificate. Certificates cannot be used after this date time as they are longer valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|crlDistributionPointUrl|String|URL to find the relevant Certificate Revocation List for this certificate. Read-only.| +|certificationAuthorityIssuerUri|String|The URI of the certification authority that issued the certificate. Read-only.| +|ocspResponderUri|String|The Online Certificate Status Protocol (OCSP) responder URI that can be used to determine certificate status. Read-only.| +|thumbprint|String|Secure Hash Algorithm 1 digest of the certificate that can be used to identify it. Read-only. Supports $select.| +|serialNumber|String|The serial number used to uniquely identify a certificate with its issuing certification authority. Read-only. Supports $select.| +|revocationDateTime|DateTimeOffset|The date and time a certificate was revoked. If the certificate was not revoked, this will be null. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only.| +|deviceName|String|Name of the device for which the certificate was created. Read-only. Supports $select.| +|userPrincipalName|String|User principal name of the user for which the certificate was created. Null for userless devices. Nullable. Read-only. Supports $select.| +|deviceId|String|The unique identifier of the managed device for which the certificate was created. This ID is assigned at device enrollment time. Read-only. Supports $select.| +|userId|String|The unique identifier of the user for which the certificate was created. Null for userless devices. This is an Intune user ID. Nullable. Read-only. Supports $select.| +|devicePlatform|String|The platform of the device for which the certificate was created. Possible values are: Android, AndroidForWork, iOS, MacOS, WindowsPhone81, Windows81AndLater, Windows10AndLater, AndroidWorkProfile, Unknown, AndroidAOSP, AndroidMobileApplicationManagement, iOSMobileApplicationManagement. Default value: Unknown. Read-only. Supports $select.| +|keyUsages|String collection|Certificate extensions that define the purpose of the public key contained in a certificate. For example possible values are "Key Encipherment" and "Digital Signature". Read-only. Nullable.| +|extendedKeyUsages|String collection|Certificate extensions that further define the purpose of the public key contained in a certificate. Data is formatted as a comma-separated list of object identifiers (OID). For example a possible value is "1.3.6.1.5.5.7.3.2". Read-only. Nullable.| ++++## Response +If successful, this method returns a `200 OK` response code and an updated [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/deviceManagement/cloudCertificationAuthorityLeafCertificate/{cloudCertificationAuthorityLeafCertificateId} +Content-type: application/json +Content-length: 1024 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1073 ++{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "976c94f8-94f8-976c-f894-6c97f8946c97", + "subjectName": "Subject Name value", + "issuerId": "Issuer Id value", + "issuerName": "Issuer Name value", + "certificateStatus": "active", + "validityStartDateTime": "2016-12-31T23:59:36.3292251-08:00", + "validityEndDateTime": "2016-12-31T23:57:06.8876616-08:00", + "crlDistributionPointUrl": "https://example.com/crlDistributionPointUrl/", + "certificationAuthorityIssuerUri": "Certification Authority Issuer Uri value", + "ocspResponderUri": "Ocsp Responder Uri value", + "thumbprint": "Thumbprint value", + "serialNumber": "Serial Number value", + "revocationDateTime": "2017-01-01T00:00:26.0037365-08:00", + "deviceName": "Device Name value", + "userPrincipalName": "User Principal Name value", + "deviceId": "Device Id value", + "userId": "User Id value", + "devicePlatform": "Device Platform value", + "keyUsages": [ + "Key Usages value" + ], + "extendedKeyUsages": [ + "Extended Key Usages value" + ] +} +``` |
v1.0 | Intune Deviceconfig Androidenterprisewificonfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidenterprisewificonfiguration-create.md | The following table shows the properties that are required when you create the a |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |
v1.0 | Intune Deviceconfig Androidenterprisewificonfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidenterprisewificonfiguration-update.md | The following table shows the properties that are required when you create the [ |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |
v1.0 | Intune Deviceconfig Androidforworkenterprisewificonfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkenterprisewificonfiguration-create.md | The following table shows the properties that are required when you create the a |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |
v1.0 | Intune Deviceconfig Androidforworkenterprisewificonfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkenterprisewificonfiguration-update.md | The following table shows the properties that are required when you create the [ |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |
v1.0 | Intune Deviceconfig Androidforworkwificonfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkwificonfiguration-create.md | The following table shows the properties that are required when you create the a |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |
v1.0 | Intune Deviceconfig Androidforworkwificonfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidforworkwificonfiguration-update.md | The following table shows the properties that are required when you create the [ |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |
v1.0 | Intune Deviceconfig Androidwificonfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidwificonfiguration-create.md | The following table shows the properties that are required when you create the a |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |
v1.0 | Intune Deviceconfig Androidwificonfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidwificonfiguration-update.md | The following table shows the properties that are required when you create the [ |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |
v1.0 | Intune Deviceconfig Androidworkprofileenterprisewificonfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofileenterprisewificonfiguration-create.md | The following table shows the properties that are required when you create the a |description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)|-|networkName|String|Network Name Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|networkName|String|The name of the Wi-Fi network. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)|-|connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| -|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| -|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|connectAutomatically|Boolean|When set to true, device will connect automatically to the Wi-Fi network when in range, skipping the user prompt. When false, user will need to connect manually through Settings on the Android device. Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. When false, device will not automatically connect to hidden networks. Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|The possible security types for Android Wi-Fi profiles. Default value Open, indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. WpaEnterprise and Wpa2Enterprise options are available for Enterprise Wi-Fi profiles. Wep and WpaPersonal (supports WPA and WPA2) options are available for Basic Wi-Fi profiles. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| +|preSharedKey|String|Specify the pre-shared key for a WEP or WPA personal Wi-Fi network. Restrictions depend on the value set for wiFiSecurityType. If WEP type security is used, then preSharedKey must be a valid passphrase (5 or 13 characters) or a valid HEX key (10 or 26 hexidecimal characters). If WPA security type is used, then preSharedKey can be any string between 8 and 64 characters long. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|preSharedKeyIsSet|Boolean|When set to true, indicates that the pre-shared key is configured. When set to false, indicates that pre-shared key is not configured (any values set for preSharedKey will be ignored). Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| +|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |innerAuthenticationProtocolForEapTtls|[nonEapAuthenticationMethodForEapTtlsType](../resources/intune-deviceconfig-noneapauthenticationmethodforeapttlstype.md)|Non-EAP Method for Authentication (Inner Identity) when EAP Type is EAP-TTLS and Authenticationmethod is Username and Password. Possible values are: `unencryptedPassword`, `challengeHandshakeAuthenticationProtocol`, `microsoftChap`, `microsoftChapVersionTwo`.| |innerAuthenticationProtocolForPeap|[nonEapAuthenticationMethodForPeap](../resources/intune-deviceconfig-noneapauthenticationmethodforpeap.md)|Non-EAP Method for Authentication (Inner Identity) when EAP Type is PEAP and Authenticationmethod is Username and Password. Possible values are: `none`, `microsoftChapVersionTwo`.| |outerIdentityPrivacyTemporaryValue|String|Enable identity privacy (Outer Identity) when EAP Type is configured to EAP-TTLS or PEAP. The String provided here is used to mask the username of individual users when they attempt to connect to Wi-Fi network.|-|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection. Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| -|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations Content-type: application/json-Content-length: 1761 +Content-length: 1834 { "@odata.type": "#microsoft.graph.androidWorkProfileEnterpriseWiFiConfiguration", Content-length: 1761 "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "wpaEnterprise",+ "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/", "eapType": "eapTtls", "trustedServerCertificateNames": [ "Trusted Server Certificate Names value" Content-length: 1761 "authenticationMethod": "usernameAndPassword", "innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol", "innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",- "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value", - "proxySettings": "manual", - "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" + "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value" } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 1933 +Content-Length: 2006 { "@odata.type": "#microsoft.graph.androidWorkProfileEnterpriseWiFiConfiguration", Content-Length: 1933 "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "wpaEnterprise",+ "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/", "eapType": "eapTtls", "trustedServerCertificateNames": [ "Trusted Server Certificate Names value" Content-Length: 1933 "authenticationMethod": "usernameAndPassword", "innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol", "innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",- "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value", - "proxySettings": "manual", - "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" + "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value" } ``` |
v1.0 | Intune Deviceconfig Androidworkprofileenterprisewificonfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofileenterprisewificonfiguration-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 2046 +Content-Length: 2123 { "value": { Content-Length: 2046 "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "wpaEnterprise",+ "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/", "eapType": "eapTtls", "trustedServerCertificateNames": [ "Trusted Server Certificate Names value" Content-Length: 2046 "authenticationMethod": "usernameAndPassword", "innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol", "innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",- "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value", - "proxySettings": "manual", - "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" + "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value" } } ``` |
v1.0 | Intune Deviceconfig Androidworkprofileenterprisewificonfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofileenterprisewificonfiguration-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 2154 +Content-Length: 2235 { "value": [ Content-Length: 2154 "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "wpaEnterprise",+ "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/", "eapType": "eapTtls", "trustedServerCertificateNames": [ "Trusted Server Certificate Names value" Content-Length: 2154 "authenticationMethod": "usernameAndPassword", "innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol", "innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",- "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value", - "proxySettings": "manual", - "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" + "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value" } ] } |
v1.0 | Intune Deviceconfig Androidworkprofileenterprisewificonfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofileenterprisewificonfiguration-update.md | The following table shows the properties that are required when you create the [ |description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)|-|networkName|String|Network Name Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|networkName|String|The name of the Wi-Fi network. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)|-|connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| -|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| -|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|connectAutomatically|Boolean|When set to true, device will connect automatically to the Wi-Fi network when in range, skipping the user prompt. When false, user will need to connect manually through Settings on the Android device. Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. When false, device will not automatically connect to hidden networks. Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|The possible security types for Android Wi-Fi profiles. Default value Open, indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. WpaEnterprise and Wpa2Enterprise options are available for Enterprise Wi-Fi profiles. Wep and WpaPersonal (supports WPA and WPA2) options are available for Basic Wi-Fi profiles. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| +|preSharedKey|String|Specify the pre-shared key for a WEP or WPA personal Wi-Fi network. Restrictions depend on the value set for wiFiSecurityType. If WEP type security is used, then preSharedKey must be a valid passphrase (5 or 13 characters) or a valid HEX key (10 or 26 hexidecimal characters). If WPA security type is used, then preSharedKey can be any string between 8 and 64 characters long. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|preSharedKeyIsSet|Boolean|When set to true, indicates that the pre-shared key is configured. When set to false, indicates that pre-shared key is not configured (any values set for preSharedKey will be ignored). Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| +|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |innerAuthenticationProtocolForEapTtls|[nonEapAuthenticationMethodForEapTtlsType](../resources/intune-deviceconfig-noneapauthenticationmethodforeapttlstype.md)|Non-EAP Method for Authentication (Inner Identity) when EAP Type is EAP-TTLS and Authenticationmethod is Username and Password. Possible values are: `unencryptedPassword`, `challengeHandshakeAuthenticationProtocol`, `microsoftChap`, `microsoftChapVersionTwo`.| |innerAuthenticationProtocolForPeap|[nonEapAuthenticationMethodForPeap](../resources/intune-deviceconfig-noneapauthenticationmethodforpeap.md)|Non-EAP Method for Authentication (Inner Identity) when EAP Type is PEAP and Authenticationmethod is Username and Password. Possible values are: `none`, `microsoftChapVersionTwo`.| |outerIdentityPrivacyTemporaryValue|String|Enable identity privacy (Outer Identity) when EAP Type is configured to EAP-TTLS or PEAP. The String provided here is used to mask the username of individual users when they attempt to connect to Wi-Fi network.|-|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection. Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| -|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} Content-type: application/json-Content-length: 1761 +Content-length: 1834 { "@odata.type": "#microsoft.graph.androidWorkProfileEnterpriseWiFiConfiguration", Content-length: 1761 "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "wpaEnterprise",+ "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/", "eapType": "eapTtls", "trustedServerCertificateNames": [ "Trusted Server Certificate Names value" Content-length: 1761 "authenticationMethod": "usernameAndPassword", "innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol", "innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",- "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value", - "proxySettings": "manual", - "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" + "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value" } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1933 +Content-Length: 2006 { "@odata.type": "#microsoft.graph.androidWorkProfileEnterpriseWiFiConfiguration", Content-Length: 1933 "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "wpaEnterprise",+ "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/", "eapType": "eapTtls", "trustedServerCertificateNames": [ "Trusted Server Certificate Names value" Content-Length: 1933 "authenticationMethod": "usernameAndPassword", "innerAuthenticationProtocolForEapTtls": "challengeHandshakeAuthenticationProtocol", "innerAuthenticationProtocolForPeap": "microsoftChapVersionTwo",- "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value", - "proxySettings": "manual", - "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" + "outerIdentityPrivacyTemporaryValue": "Outer Identity Privacy Temporary Value value" } ``` |
v1.0 | Intune Deviceconfig Androidworkprofilewificonfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilewificonfiguration-create.md | The following table shows the properties that are required when you create the a |description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)|-|networkName|String|Network Name| +|networkName|String|The name of the Wi-Fi network.| |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.|-|connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| -|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.| -|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|connectAutomatically|Boolean|When set to true, device will connect automatically to the Wi-Fi network when in range, skipping the user prompt. When false, user will need to connect manually through Settings on the Android device. Default value is false.| +|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. When false, device will not automatically connect to hidden networks. Default value is false.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|The possible security types for Android Wi-Fi profiles. Default value Open, indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. WpaEnterprise and Wpa2Enterprise options are available for Enterprise Wi-Fi profiles. Wep and WpaPersonal (supports WPA and WPA2) options are available for Basic Wi-Fi profiles. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| +|preSharedKey|String|Specify the pre-shared key for a WEP or WPA personal Wi-Fi network. Restrictions depend on the value set for wiFiSecurityType. If WEP type security is used, then preSharedKey must be a valid passphrase (5 or 13 characters) or a valid HEX key (10 or 26 hexidecimal characters). If WPA security type is used, then preSharedKey can be any string between 8 and 64 characters long.| +|preSharedKeyIsSet|Boolean|When set to true, indicates that the pre-shared key is configured. When set to false, indicates that pre-shared key is not configured (any values set for preSharedKey will be ignored). Default value is false.| +|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection. Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| +|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations Content-type: application/json-Content-length: 1219 +Content-length: 1414 { "@odata.type": "#microsoft.graph.androidWorkProfileWiFiConfiguration", Content-length: 1219 "ssid": "Ssid value", "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true,- "wiFiSecurityType": "wpaEnterprise" + "wiFiSecurityType": "wpaEnterprise", + "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 1391 +Content-Length: 1586 { "@odata.type": "#microsoft.graph.androidWorkProfileWiFiConfiguration", Content-Length: 1391 "ssid": "Ssid value", "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true,- "wiFiSecurityType": "wpaEnterprise" + "wiFiSecurityType": "wpaEnterprise", + "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" } ``` |
v1.0 | Intune Deviceconfig Androidworkprofilewificonfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilewificonfiguration-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1484 +Content-Length: 1687 { "value": { Content-Length: 1484 "ssid": "Ssid value", "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true,- "wiFiSecurityType": "wpaEnterprise" + "wiFiSecurityType": "wpaEnterprise", + "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" } } ``` |
v1.0 | Intune Deviceconfig Androidworkprofilewificonfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilewificonfiguration-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1572 +Content-Length: 1783 { "value": [ Content-Length: 1572 "ssid": "Ssid value", "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true,- "wiFiSecurityType": "wpaEnterprise" + "wiFiSecurityType": "wpaEnterprise", + "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" } ] } |
v1.0 | Intune Deviceconfig Androidworkprofilewificonfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-androidworkprofilewificonfiguration-update.md | The following table shows the properties that are required when you create the [ |description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)|-|networkName|String|Network Name| +|networkName|String|The name of the Wi-Fi network.| |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.|-|connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| -|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.| -|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|connectAutomatically|Boolean|When set to true, device will connect automatically to the Wi-Fi network when in range, skipping the user prompt. When false, user will need to connect manually through Settings on the Android device. Default value is false.| +|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. When false, device will not automatically connect to hidden networks. Default value is false.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|The possible security types for Android Wi-Fi profiles. Default value Open, indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. WpaEnterprise and Wpa2Enterprise options are available for Enterprise Wi-Fi profiles. Wep and WpaPersonal (supports WPA and WPA2) options are available for Basic Wi-Fi profiles. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| +|preSharedKey|String|Specify the pre-shared key for a WEP or WPA personal Wi-Fi network. Restrictions depend on the value set for wiFiSecurityType. If WEP type security is used, then preSharedKey must be a valid passphrase (5 or 13 characters) or a valid HEX key (10 or 26 hexidecimal characters). If WPA security type is used, then preSharedKey can be any string between 8 and 64 characters long.| +|preSharedKeyIsSet|Boolean|When set to true, indicates that the pre-shared key is configured. When set to false, indicates that pre-shared key is not configured (any values set for preSharedKey will be ignored). Default value is false.| +|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection. Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| +|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId} Content-type: application/json-Content-length: 1219 +Content-length: 1414 { "@odata.type": "#microsoft.graph.androidWorkProfileWiFiConfiguration", Content-length: 1219 "ssid": "Ssid value", "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true,- "wiFiSecurityType": "wpaEnterprise" + "wiFiSecurityType": "wpaEnterprise", + "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1391 +Content-Length: 1586 { "@odata.type": "#microsoft.graph.androidWorkProfileWiFiConfiguration", Content-Length: 1391 "ssid": "Ssid value", "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true,- "wiFiSecurityType": "wpaEnterprise" + "wiFiSecurityType": "wpaEnterprise", + "preSharedKey": "Pre Shared Key value", + "preSharedKeyIsSet": true, + "proxySettings": "manual", + "proxyAutomaticConfigurationUrl": "https://example.com/proxyAutomaticConfigurationUrl/" } ``` |
v1.0 | Intune Deviceconfig Devicecompliancepolicysettingstatesummary Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-devicecompliancepolicysettingstatesummary-create.md | The following table shows the properties that are required when you create the d |id|String|Key of the entity.| |setting|String|The setting class name and property name.| |settingName|String|Name of the setting.|-|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Setting platform. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `all`.| +|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Setting platform. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `linux`, `all`.| |unknownDeviceCount|Int32|Number of unknown devices| |notApplicableDeviceCount|Int32|Number of not applicable devices| |compliantDeviceCount|Int32|Number of compliant devices| |
v1.0 | Intune Deviceconfig Devicecompliancepolicysettingstatesummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-devicecompliancepolicysettingstatesummary-update.md | The following table shows the properties that are required when you create the [ |id|String|Key of the entity.| |setting|String|The setting class name and property name.| |settingName|String|Name of the setting.|-|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Setting platform. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `all`.| +|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Setting platform. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `linux`, `all`.| |unknownDeviceCount|Int32|Number of unknown devices| |notApplicableDeviceCount|Int32|Number of not applicable devices| |compliantDeviceCount|Int32|Number of compliant devices| |
v1.0 | Intune Deviceconfig Devicemanagement Retrieveprojectflightingstatuses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-devicemanagement-retrieveprojectflightingstatuses.md | + + Title: "retrieveProjectFlightingStatuses function" +description: "Intune Deviceconfig Devicemanagement Retrieveprojectflightingstatuses Api ." ++ms.localizationpriority: medium ++++# retrieveProjectFlightingStatuses function ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/retrieveProjectFlightingStatuses +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request URL, provide the following query parameters with values. +The following table shows the parameters that can be used with this function. ++|Property|Type|Description| +|:|:|:| +|projectNames|String collection|| ++++## Response +If successful, this function returns a `200 OK` response code and a [managementFeatureProjectDetail](../resources/intune-deviceconfig-managementfeatureprojectdetail.md) collection in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/retrieveProjectFlightingStatuses(projectNames=[ + "Project Names value" +]) +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 375 ++{ + "value": [ + { + "@odata.type": "microsoft.graph.managementFeatureProjectDetail", + "projectName": "Project Name value", + "featureFlights": [ + { + "@odata.type": "microsoft.graph.managementFeatureFlightDetail", + "flightId": "Flight Id value", + "flightValue": "Flight Value value" + } + ] + } + ] +} +``` |
v1.0 | Intune Deviceconfig Restrictedappsviolation Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-restrictedappsviolation-create.md | The following table shows the properties that are required when you create the r |deviceName|String|Device name| |deviceConfigurationId|String|Device configuration profile unique identifier, must be Guid| |deviceConfigurationName|String|Device configuration profile name|-|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Platform type. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `all`.| +|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Platform type. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `linux`, `all`.| |restrictedAppsState|[restrictedAppsState](../resources/intune-deviceconfig-restrictedappsstate.md)|Restricted apps state. Possible values are: `prohibitedApps`, `notApprovedApps`.| |restrictedApps|[managedDeviceReportedApp](../resources/intune-deviceconfig-manageddevicereportedapp.md) collection|List of violated restricted apps| |
v1.0 | Intune Deviceconfig Restrictedappsviolation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-restrictedappsviolation-update.md | The following table shows the properties that are required when you create the [ |deviceName|String|Device name| |deviceConfigurationId|String|Device configuration profile unique identifier, must be Guid| |deviceConfigurationName|String|Device configuration profile name|-|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Platform type. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `all`.| +|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Platform type. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `linux`, `all`.| |restrictedAppsState|[restrictedAppsState](../resources/intune-deviceconfig-restrictedappsstate.md)|Restricted apps state. Possible values are: `prohibitedApps`, `notApprovedApps`.| |restrictedApps|[managedDeviceReportedApp](../resources/intune-deviceconfig-manageddevicereportedapp.md) collection|List of violated restricted apps| |
v1.0 | Intune Deviceconfig Windows10compliancepolicy Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10compliancepolicy-create.md | The following table shows the properties that are required when you create the w |configurationManagerComplianceRequired|Boolean|Require to consider SCCM Compliance state into consideration for Intune Compliance State.| |tpmRequired|Boolean|Require Trusted Platform Module(TPM) to be present.| |deviceCompliancePolicyScript|[deviceCompliancePolicyScript](../resources/intune-deviceconfig-devicecompliancepolicyscript.md)||+|wslDistributions|[wslDistributionConfiguration](../resources/intune-deviceconfig-wsldistributionconfiguration.md) collection|| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/deviceCompliancePolicies Content-type: application/json-Content-length: 2070 +Content-length: 2337 { "@odata.type": "#microsoft.graph.windows10CompliancePolicy", Content-length: 2070 "@odata.type": "microsoft.graph.deviceCompliancePolicyScript", "deviceComplianceScriptId": "Device Compliance Script Id value", "rulesContent": "cnVsZXNDb250ZW50"- } + }, + "wslDistributions": [ + { + "@odata.type": "microsoft.graph.wslDistributionConfiguration", + "distribution": "Distribution value", + "minimumOSVersion": "Minimum OSVersion value", + "maximumOSVersion": "Maximum OSVersion value" + } + ] } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 2242 +Content-Length: 2509 { "@odata.type": "#microsoft.graph.windows10CompliancePolicy", Content-Length: 2242 "@odata.type": "microsoft.graph.deviceCompliancePolicyScript", "deviceComplianceScriptId": "Device Compliance Script Id value", "rulesContent": "cnVsZXNDb250ZW50"- } + }, + "wslDistributions": [ + { + "@odata.type": "microsoft.graph.wslDistributionConfiguration", + "distribution": "Distribution value", + "minimumOSVersion": "Minimum OSVersion value", + "maximumOSVersion": "Maximum OSVersion value" + } + ] } ``` |
v1.0 | Intune Deviceconfig Windows10compliancepolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10compliancepolicy-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 2375 +Content-Length: 2658 { "value": { Content-Length: 2375 "@odata.type": "microsoft.graph.deviceCompliancePolicyScript", "deviceComplianceScriptId": "Device Compliance Script Id value", "rulesContent": "cnVsZXNDb250ZW50"- } + }, + "wslDistributions": [ + { + "@odata.type": "microsoft.graph.wslDistributionConfiguration", + "distribution": "Distribution value", + "minimumOSVersion": "Minimum OSVersion value", + "maximumOSVersion": "Maximum OSVersion value" + } + ] } } ``` |
v1.0 | Intune Deviceconfig Windows10compliancepolicy List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10compliancepolicy-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 2503 +Content-Length: 2802 { "value": [ Content-Length: 2503 "@odata.type": "microsoft.graph.deviceCompliancePolicyScript", "deviceComplianceScriptId": "Device Compliance Script Id value", "rulesContent": "cnVsZXNDb250ZW50"- } + }, + "wslDistributions": [ + { + "@odata.type": "microsoft.graph.wslDistributionConfiguration", + "distribution": "Distribution value", + "minimumOSVersion": "Minimum OSVersion value", + "maximumOSVersion": "Maximum OSVersion value" + } + ] } ] } |
v1.0 | Intune Deviceconfig Windows10compliancepolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10compliancepolicy-update.md | The following table shows the properties that are required when you create the [ |configurationManagerComplianceRequired|Boolean|Require to consider SCCM Compliance state into consideration for Intune Compliance State.| |tpmRequired|Boolean|Require Trusted Platform Module(TPM) to be present.| |deviceCompliancePolicyScript|[deviceCompliancePolicyScript](../resources/intune-deviceconfig-devicecompliancepolicyscript.md)||+|wslDistributions|[wslDistributionConfiguration](../resources/intune-deviceconfig-wsldistributionconfiguration.md) collection|| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/deviceCompliancePolicies/{deviceCompliancePolicyId} Content-type: application/json-Content-length: 2070 +Content-length: 2337 { "@odata.type": "#microsoft.graph.windows10CompliancePolicy", Content-length: 2070 "@odata.type": "microsoft.graph.deviceCompliancePolicyScript", "deviceComplianceScriptId": "Device Compliance Script Id value", "rulesContent": "cnVsZXNDb250ZW50"- } + }, + "wslDistributions": [ + { + "@odata.type": "microsoft.graph.wslDistributionConfiguration", + "distribution": "Distribution value", + "minimumOSVersion": "Minimum OSVersion value", + "maximumOSVersion": "Maximum OSVersion value" + } + ] } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 2242 +Content-Length: 2509 { "@odata.type": "#microsoft.graph.windows10CompliancePolicy", Content-Length: 2242 "@odata.type": "microsoft.graph.deviceCompliancePolicyScript", "deviceComplianceScriptId": "Device Compliance Script Id value", "rulesContent": "cnVsZXNDb250ZW50"- } + }, + "wslDistributions": [ + { + "@odata.type": "microsoft.graph.wslDistributionConfiguration", + "distribution": "Distribution value", + "minimumOSVersion": "Minimum OSVersion value", + "maximumOSVersion": "Maximum OSVersion value" + } + ] } ``` |
v1.0 | Intune Deviceconfig Windows10customconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10customconfiguration-list.md | Content-Length: 1712 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windows10customconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10customconfiguration-update.md | Content-Length: 1511 } ] }-``` +``` |
v1.0 | Intune Deviceconfig Windows10devicefirmwareconfigurationinterface Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10devicefirmwareconfigurationinterface-create.md | Content-Length: 1926 "wakeOnLAN": "enabled", "wakeOnPower": "enabled" }-``` +``` |
v1.0 | Intune Deviceconfig Windows10devicefirmwareconfigurationinterface Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfig-windows10devicefirmwareconfigurationinterface-delete.md | DELETE https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{d Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ``` http HTTP/1.1 204 No Content-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementcompliancepolicy Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementcompliancepolicy-assign.md | - Title: "assign action" -description: "Intune Deviceconfigv2 Devicemanagementcompliancepolicy Assign Api ." ---doc_type: apiPageType ---# assign action --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -----## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/assign -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply JSON representation of the parameters. --The following table shows the parameters that can be used with this action. --|Property|Type|Description| -|:|:|:| -|assignments|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|| ----## Response -If successful, this action returns a `200 OK` response code and a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/assign --Content-type: application/json -Content-length: 610 --{ - "assignments": [ - { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } - ] -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 604 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } - ] -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementcompliancepolicy Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementcompliancepolicy-create.md | The following table shows the properties that are required when you create the d |id|String|Key of the policy document. Automatically generated.| |name|String|Policy name| |description|String|Policy description|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |createdDateTime|DateTimeOffset|Policy creation date and time. This property is read-only.| |lastModifiedDateTime|DateTimeOffset|Policy last modification date and time. This property is read-only.| |settingCount|Int32|Number of settings. This property is read-only.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementcompliancepolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementcompliancepolicy-update.md | The following table shows the properties that are required when you create the [ |id|String|Key of the policy document. Automatically generated.| |name|String|Policy name| |description|String|Policy description|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |createdDateTime|DateTimeOffset|Policy creation date and time. This property is read-only.| |lastModifiedDateTime|DateTimeOffset|Policy last modification date and time. This property is read-only.| |settingCount|Int32|Number of settings. This property is read-only.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcategory Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationcategory-create.md | The following table shows the properties that are required when you create the d |helpText|String|Help text of the category. Give more details of the category.| |name|String|Name of the item| |displayName|String|Name of the category. For example: Device Lock|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms types, which settings in the category have. Possible values are: none. android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies types, which settings in the category have. Possible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms types, which settings in the category have. Possible values are: none. android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies types, which settings in the category have. Possible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicates that the category contains settings that are used for compliance, configuration, or reusable settings. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Read-only. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |parentCategoryId|String|Direct parent id of the category. If the category is the root, the parent id is same as its id.| |rootCategoryId|String|Root id of the category.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcategory Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationcategory-update.md | The following table shows the properties that are required when you create the [ |helpText|String|Help text of the category. Give more details of the category.| |name|String|Name of the item| |displayName|String|Name of the category. For example: Device Lock|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms types, which settings in the category have. Possible values are: none. android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies types, which settings in the category have. Possible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms types, which settings in the category have. Possible values are: none. android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies types, which settings in the category have. Possible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicates that the category contains settings that are used for compliance, configuration, or reusable settings. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Read-only. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |parentCategoryId|String|Direct parent id of the category. If the category is the root, the parent id is same as its id.| |rootCategoryId|String|Root id of the category.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-assign.md | - Title: "assign action" -description: "Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Assign Api ." ---doc_type: apiPageType ---# assign action --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -----## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assign -POST /deviceManagement/reusablePolicySettings/{deviceManagementReusablePolicySettingId}/referencingConfigurationPolicies/{deviceManagementConfigurationPolicyId}/assign -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply JSON representation of the parameters. --The following table shows the parameters that can be used with this action. --|Property|Type|Description| -|:|:|:| -|assignments|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|| ----## Response -If successful, this action returns a `200 OK` response code and a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assign --Content-type: application/json -Content-length: 610 --{ - "assignments": [ - { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } - ] -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 604 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } - ] -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Assignjustintimeconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-assignjustintimeconfiguration.md | - Title: "assignJustInTimeConfiguration action" -description: "Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Assignjustintimeconfiguration Api ." ---doc_type: apiPageType ---# assignJustInTimeConfiguration action --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -----## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assignJustInTimeConfiguration -POST /deviceManagement/reusablePolicySettings/{deviceManagementReusablePolicySettingId}/referencingConfigurationPolicies/{deviceManagementConfigurationPolicyId}/assignJustInTimeConfiguration -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply JSON representation of the parameters. --The following table shows the parameters that can be used with this action. --|Property|Type|Description| -|:|:|:| -|justInTimeAssignments|[deviceManagementConfigurationJustInTimeAssignmentPolicy](../resources/intune-deviceconfigv2-devicemanagementconfigurationjustintimeassignmentpolicy.md)|| ----## Response -If successful, this action returns a `200 OK` response code and a Boolean in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assignJustInTimeConfiguration --Content-type: application/json -Content-length: 221 --{ - "justInTimeAssignments": { - "@odata.type": "microsoft.graph.deviceManagementConfigurationJustInTimeAssignmentPolicy", - "targetType": "entraSecurityGroup", - "target": [ - "Target value" - ] - } -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 21 --{ - "value": true -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-create.md | The following table shows the properties that are required when you create the d |id|String|Key of the policy document. Automatically generated.| |name|String|Policy name| |description|String|Policy description|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |createdDateTime|DateTimeOffset|Policy creation date and time| |lastModifiedDateTime|DateTimeOffset|Policy last modification date and time| |settingCount|Int32|Number of settings| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Retrieveenrollmenttimedevicemembershiptarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-retrieveenrollmenttimedevicemembershiptarget.md | POST /deviceManagement/reusablePolicySettings/{deviceManagementReusablePolicySet Do not supply a request body for this method. ## Response-If successful, this action returns a `200 OK` response code and a [enrollmentTimeDeviceMembershipTargetResult](../resources/intune-deviceconfigv2-enrollmenttimedevicemembershiptargetresult.md) in the response body. +If successful, this action returns a `200 OK` response code and a [enrollmentTimeDeviceMembershipTargetResult](../resources/intune-shared-enrollmenttimedevicemembershiptargetresult.md) in the response body. ## Example |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Retrievejustintimeconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-retrievejustintimeconfiguration.md | - Title: "retrieveJustInTimeConfiguration action" -description: "Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Retrievejustintimeconfiguration Api ." ---doc_type: apiPageType ---# retrieveJustInTimeConfiguration action --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -----## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/retrieveJustInTimeConfiguration -POST /deviceManagement/reusablePolicySettings/{deviceManagementReusablePolicySettingId}/referencingConfigurationPolicies/{deviceManagementConfigurationPolicyId}/retrieveJustInTimeConfiguration -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this action returns a `200 OK` response code and a [deviceManagementConfigurationJustInTimeAssignmentPolicy](../resources/intune-deviceconfigv2-devicemanagementconfigurationjustintimeassignmentpolicy.md) in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/retrieveJustInTimeConfiguration -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 205 --{ - "value": { - "@odata.type": "microsoft.graph.deviceManagementConfigurationJustInTimeAssignmentPolicy", - "targetType": "entraSecurityGroup", - "target": [ - "Target value" - ] - } -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Setenrollmenttimedevicemembershiptarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-setenrollmenttimedevicemembershiptarget.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:|-|enrollmentTimeDeviceMembershipTargets|[enrollmentTimeDeviceMembershipTarget](../resources/intune-deviceconfigv2-enrollmenttimedevicemembershiptarget.md) collection|| +|enrollmentTimeDeviceMembershipTargets|[enrollmentTimeDeviceMembershipTarget](../resources/intune-shared-enrollmenttimedevicemembershiptarget.md) collection|| ## Response-If successful, this action returns a `200 OK` response code and a [enrollmentTimeDeviceMembershipTargetResult](../resources/intune-deviceconfigv2-enrollmenttimedevicemembershiptargetresult.md) in the response body. +If successful, this action returns a `200 OK` response code and a [enrollmentTimeDeviceMembershipTargetResult](../resources/intune-shared-enrollmenttimedevicemembershiptargetresult.md) in the response body. ## Example |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-update.md | The following table shows the properties that are required when you create the [ |id|String|Key of the policy document. Automatically generated.| |name|String|Policy name| |description|String|Policy description|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |createdDateTime|DateTimeOffset|Policy creation date and time| |lastModifiedDateTime|DateTimeOffset|Policy last modification date and time| |settingCount|Int32|Number of settings| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicyassignment Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-create.md | - Title: "Create deviceManagementConfigurationPolicyAssignment" -description: "Create a new deviceManagementConfigurationPolicyAssignment object." ---doc_type: apiPageType ---# Create deviceManagementConfigurationPolicyAssignment --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Create a new [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments -POST /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/assignments -POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assignments -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the deviceManagementConfigurationPolicyAssignment object. --The following table shows the properties that are required when you create the deviceManagementConfigurationPolicyAssignment. --|Property|Type|Description| -|:|:|:| -|id|String|The key of the assignment.| -|target|[deviceAndAppManagementAssignmentTarget](../resources/intune-shared-deviceandappmanagementassignmenttarget.md)|The assignment target for the DeviceManagementConfigurationPolicy.| -|source|[deviceAndAppManagementAssignmentSource](../resources/intune-shared-deviceandappmanagementassignmentsource.md)|The assignment source for the device compliance policy, direct or parcel/policySet. Possible values are: `direct`, `policySets`.| -|sourceId|String|The identifier of the source of the assignment.| ----## Response -If successful, this method returns a `201 Created` response code and a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments -Content-type: application/json -Content-length: 478 --{ - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 527 --{ - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicyassignment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-delete.md | - Title: "Delete deviceManagementConfigurationPolicyAssignment" -description: "Deletes a deviceManagementConfigurationPolicyAssignment." ---doc_type: apiPageType ---# Delete deviceManagementConfigurationPolicyAssignment --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Deletes a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md). ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -DELETE /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -DELETE /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicyassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-get.md | - Title: "Get deviceManagementConfigurationPolicyAssignment" -description: "Read properties and relationships of the deviceManagementConfigurationPolicyAssignment object." ---doc_type: apiPageType ---# Get deviceManagementConfigurationPolicyAssignment --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -GET /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 568 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicyassignment List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-list.md | - Title: "List deviceManagementConfigurationPolicyAssignments" -description: "List properties and relationships of the deviceManagementConfigurationPolicyAssignment objects." ---doc_type: apiPageType ---# List deviceManagementConfigurationPolicyAssignments --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments -GET /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/assignments -GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assignments -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 604 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } - ] -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicyassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment-update.md | - Title: "Update deviceManagementConfigurationPolicyAssignment" -description: "Update the properties of a deviceManagementConfigurationPolicyAssignment object." ---doc_type: apiPageType ---# Update deviceManagementConfigurationPolicyAssignment --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Update the properties of a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -PATCH /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -PATCH /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object. --The following table shows the properties that are required when you create the [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md). --|Property|Type|Description| -|:|:|:| -|id|String|The key of the assignment.| -|target|[deviceAndAppManagementAssignmentTarget](../resources/intune-shared-deviceandappmanagementassignmenttarget.md)|The assignment target for the DeviceManagementConfigurationPolicy.| -|source|[deviceAndAppManagementAssignmentSource](../resources/intune-shared-deviceandappmanagementassignmentsource.md)|The assignment source for the device compliance policy, direct or parcel/policySet. Possible values are: `direct`, `policySets`.| -|sourceId|String|The identifier of the source of the assignment.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assignments/{deviceManagementConfigurationPolicyAssignmentId} -Content-type: application/json -Content-length: 478 --{ - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 527 --{ - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicytemplate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicytemplate-create.md | The following table shows the properties that are required when you create the d |description|String|Template description| |displayVersion|String|Description of template version| |lifecycleState|[deviceManagementTemplateLifecycleState](../resources/intune-deviceconfigv2-devicemanagementtemplatelifecyclestate.md)|Indicate current lifecycle state of template. Possible values are: `invalid`, `draft`, `active`, `superseded`, `deprecated`, `retired`.|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this template. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this template. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this template. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this template. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |templateFamily|[deviceManagementConfigurationTemplateFamily](../resources/intune-deviceconfigv2-devicemanagementconfigurationtemplatefamily.md)|TemplateFamily for this template. Possible values are: `none`, `endpointSecurityAntivirus`, `endpointSecurityDiskEncryption`, `endpointSecurityFirewall`, `endpointSecurityEndpointDetectionAndResponse`, `endpointSecurityAttackSurfaceReduction`, `endpointSecurityAccountProtection`, `endpointSecurityApplicationControl`, `endpointSecurityEndpointPrivilegeManagement`, `enrollmentConfiguration`, `appQuietTime`, `baseline`, `unknownFutureValue`, `deviceConfigurationScripts`, `deviceConfigurationPolicies`, `windowsOsRecoveryPolicies`, `companyPortal`.| |allowUnmanagedSettings|Boolean|Allow unmanaged setting templates| |settingTemplateCount|Int32|Number of setting templates. Valid values 0 to 2147483647. This property is read-only.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicytemplate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationpolicytemplate-update.md | The following table shows the properties that are required when you create the [ |description|String|Template description| |displayVersion|String|Description of template version| |lifecycleState|[deviceManagementTemplateLifecycleState](../resources/intune-deviceconfigv2-devicemanagementtemplatelifecyclestate.md)|Indicate current lifecycle state of template. Possible values are: `invalid`, `draft`, `active`, `superseded`, `deprecated`, `retired`.|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this template. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this template. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this template. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this template. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |templateFamily|[deviceManagementConfigurationTemplateFamily](../resources/intune-deviceconfigv2-devicemanagementconfigurationtemplatefamily.md)|TemplateFamily for this template. Possible values are: `none`, `endpointSecurityAntivirus`, `endpointSecurityDiskEncryption`, `endpointSecurityFirewall`, `endpointSecurityEndpointDetectionAndResponse`, `endpointSecurityAttackSurfaceReduction`, `endpointSecurityAccountProtection`, `endpointSecurityApplicationControl`, `endpointSecurityEndpointPrivilegeManagement`, `enrollmentConfiguration`, `appQuietTime`, `baseline`, `unknownFutureValue`, `deviceConfigurationScripts`, `deviceConfigurationPolicies`, `windowsOsRecoveryPolicies`, `companyPortal`.| |allowUnmanagedSettings|Boolean|Allow unmanaged setting templates| |settingTemplateCount|Int32|Number of setting templates. Valid values 0 to 2147483647. This property is read-only.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsetting Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsetting-create.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+POST /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings POST /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings ``` If successful, this method returns a `201 Created` response code and a [deviceMa ### Request Here is an example of the request. ``` http-POST https://graph.microsoft.com/beta/deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings +POST https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings Content-type: application/json Content-length: 16129 |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsetting Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsetting-delete.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+DELETE /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings/{deviceManagementConfigurationSettingId} DELETE /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings/{deviceManagementConfigurationSettingId} DELETE /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId} ``` If successful, this method returns a `204 No Content` response code. ### Request Here is an example of the request. ``` http-DELETE https://graph.microsoft.com/beta/deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings/{deviceManagementConfigurationSettingId} +DELETE https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings/{deviceManagementConfigurationSettingId} ``` ### Response |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsetting-get.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings/{deviceManagementConfigurationSettingId} GET /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings/{deviceManagementConfigurationSettingId} GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId} ``` If successful, this method returns a `200 OK` response code and [deviceManagemen ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings/{deviceManagementConfigurationSettingId} +GET https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings/{deviceManagementConfigurationSettingId} ``` ### Response |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsetting List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsetting-list.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+GET /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings GET /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings ``` If successful, this method returns a `200 OK` response code and a collection of ### Request Here is an example of the request. ``` http-GET https://graph.microsoft.com/beta/deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings +GET https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings ``` ### Response |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsetting Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsetting-update.md | One of the following permissions is required to call this API. To learn more, in } --> ``` http+PATCH /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings/{deviceManagementConfigurationSettingId} PATCH /deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings/{deviceManagementConfigurationSettingId} PATCH /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId} ``` If successful, this method returns a `200 OK` response code and an updated [devi ### Request Here is an example of the request. ``` http-PATCH https://graph.microsoft.com/beta/deviceManagement/compliancePolicies/{deviceManagementCompliancePolicyId}/settings/{deviceManagementConfigurationSettingId} +PATCH https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/settings/{deviceManagementConfigurationSettingId} Content-type: application/json Content-length: 16129 |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition-create.md | One of the following permissions is required to call this API. To learn more, in --> ``` http POST /deviceManagement/reusableSettings+POST /deviceManagement/inventorySettings POST /deviceManagement/complianceSettings POST /deviceManagement/configurationSettings POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions The following table shows the properties that are required when you create the d |offsetUri|String|Offset CSP Path from Base| |rootDefinitionId|String|Root setting definition id if the setting is a child setting.| |categoryId|String|Specify category in which the setting is under. Support $filters.|-|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`.| +|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |uxBehavior|[deviceManagementConfigurationControlType](../resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md)|Setting control type representation in the UX. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane. Possible values are: `default`, `dropdown`, `smallTextBox`, `largeTextBox`, `toggle`, `multiheaderGrid`, `contextPane`, `unknownFutureValue`.|-|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`.| +|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`, `inventoryCatalog`.| |referredSettingInformationList|[deviceManagementConfigurationReferredSettingInformation](../resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md) collection|List of referred setting information.| |id|String|Identifier for item| |description|String|Description of the setting.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition-delete.md | One of the following permissions is required to call this API. To learn more, in --> ``` http DELETE /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+DELETE /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition-get.md | One of the following permissions is required to call this API. To learn more, in --> ``` http GET /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+GET /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition-list.md | One of the following permissions is required to call this API. To learn more, in --> ``` http GET /deviceManagement/reusableSettings+GET /deviceManagement/inventorySettings GET /deviceManagement/complianceSettings GET /deviceManagement/configurationSettings GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition-update.md | One of the following permissions is required to call this API. To learn more, in --> ``` http PATCH /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+PATCH /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} The following table shows the properties that are required when you create the [ |offsetUri|String|Offset CSP Path from Base| |rootDefinitionId|String|Root setting definition id if the setting is a child setting.| |categoryId|String|Specify category in which the setting is under. Support $filters.|-|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`.| +|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |uxBehavior|[deviceManagementConfigurationControlType](../resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md)|Setting control type representation in the UX. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane. Possible values are: `default`, `dropdown`, `smallTextBox`, `largeTextBox`, `toggle`, `multiheaderGrid`, `contextPane`, `unknownFutureValue`.|-|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`.| +|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`, `inventoryCatalog`.| |referredSettingInformationList|[deviceManagementConfigurationReferredSettingInformation](../resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md) collection|List of referred setting information.| |id|String|Identifier for item| |description|String|Description of the setting.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectiondefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectiondefinition-create.md | One of the following permissions is required to call this API. To learn more, in --> ``` http POST /deviceManagement/reusableSettings+POST /deviceManagement/inventorySettings POST /deviceManagement/complianceSettings POST /deviceManagement/configurationSettings POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions The following table shows the properties that are required when you create the d |offsetUri|String|Offset CSP Path from Base Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |rootDefinitionId|String|Root setting definition id if the setting is a child setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |categoryId|String|Specify category in which the setting is under. Support $filters. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)|-|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`.| +|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |uxBehavior|[deviceManagementConfigurationControlType](../resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md)|Setting control type representation in the UX. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `default`, `dropdown`, `smallTextBox`, `largeTextBox`, `toggle`, `multiheaderGrid`, `contextPane`, `unknownFutureValue`.|-|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`.| +|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`, `inventoryCatalog`.| |referredSettingInformationList|[deviceManagementConfigurationReferredSettingInformation](../resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md) collection|List of referred setting information. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |id|String|Identifier for item Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |description|String|Description of the setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectiondefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectiondefinition-delete.md | One of the following permissions is required to call this API. To learn more, in --> ``` http DELETE /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+DELETE /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectiondefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectiondefinition-get.md | One of the following permissions is required to call this API. To learn more, in --> ``` http GET /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+GET /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectiondefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectiondefinition-list.md | One of the following permissions is required to call this API. To learn more, in --> ``` http GET /deviceManagement/reusableSettings+GET /deviceManagement/inventorySettings GET /deviceManagement/complianceSettings GET /deviceManagement/configurationSettings GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectiondefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectiondefinition-update.md | One of the following permissions is required to call this API. To learn more, in --> ``` http PATCH /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+PATCH /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} The following table shows the properties that are required when you create the [ |offsetUri|String|Offset CSP Path from Base Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |rootDefinitionId|String|Root setting definition id if the setting is a child setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |categoryId|String|Specify category in which the setting is under. Support $filters. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)|-|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`.| +|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |uxBehavior|[deviceManagementConfigurationControlType](../resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md)|Setting control type representation in the UX. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `default`, `dropdown`, `smallTextBox`, `largeTextBox`, `toggle`, `multiheaderGrid`, `contextPane`, `unknownFutureValue`.|-|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`.| +|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`, `inventoryCatalog`.| |referredSettingInformationList|[deviceManagementConfigurationReferredSettingInformation](../resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md) collection|List of referred setting information. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |id|String|Identifier for item Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |description|String|Description of the setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupdefinition Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition-create.md | One of the following permissions is required to call this API. To learn more, in --> ``` http POST /deviceManagement/reusableSettings+POST /deviceManagement/inventorySettings POST /deviceManagement/complianceSettings POST /deviceManagement/configurationSettings POST /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions The following table shows the properties that are required when you create the d |offsetUri|String|Offset CSP Path from Base Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |rootDefinitionId|String|Root setting definition id if the setting is a child setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |categoryId|String|Specify category in which the setting is under. Support $filters. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)|-|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`.| +|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |uxBehavior|[deviceManagementConfigurationControlType](../resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md)|Setting control type representation in the UX. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `default`, `dropdown`, `smallTextBox`, `largeTextBox`, `toggle`, `multiheaderGrid`, `contextPane`, `unknownFutureValue`.|-|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`.| +|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`, `inventoryCatalog`.| |referredSettingInformationList|[deviceManagementConfigurationReferredSettingInformation](../resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md) collection|List of referred setting information. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |id|String|Identifier for item Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |description|String|Description of the setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupdefinition Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition-delete.md | One of the following permissions is required to call this API. To learn more, in --> ``` http DELETE /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+DELETE /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} DELETE /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition-get.md | One of the following permissions is required to call this API. To learn more, in --> ``` http GET /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+GET /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupdefinition List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition-list.md | One of the following permissions is required to call this API. To learn more, in --> ``` http GET /deviceManagement/reusableSettings+GET /deviceManagement/inventorySettings GET /deviceManagement/complianceSettings GET /deviceManagement/configurationSettings GET /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupdefinition Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition-update.md | One of the following permissions is required to call this API. To learn more, in --> ``` http PATCH /deviceManagement/reusableSettings/{deviceManagementConfigurationSettingDefinitionId}+PATCH /deviceManagement/inventorySettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/complianceSettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/configurationSettings/{deviceManagementConfigurationSettingDefinitionId} PATCH /deviceManagement/configurationPolicies/{deviceManagementConfigurationPolicyId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions/{deviceManagementConfigurationSettingDefinitionId} The following table shows the properties that are required when you create the [ |offsetUri|String|Offset CSP Path from Base Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |rootDefinitionId|String|Root setting definition id if the setting is a child setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |categoryId|String|Specify category in which the setting is under. Support $filters. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)|-|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`.| +|settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicate setting type for the setting. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |uxBehavior|[deviceManagementConfigurationControlType](../resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md)|Setting control type representation in the UX. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `default`, `dropdown`, `smallTextBox`, `largeTextBox`, `toggle`, `multiheaderGrid`, `contextPane`, `unknownFutureValue`.|-|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`.| +|visibility|[deviceManagementConfigurationSettingVisibility](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md)|Setting visibility scope to UX. Possible values are: none, settingsCatalog, template. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md). Possible values are: `none`, `settingsCatalog`, `template`, `unknownFutureValue`, `inventoryCatalog`.| |referredSettingInformationList|[deviceManagementConfigurationReferredSettingInformation](../resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md) collection|List of referred setting information. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |id|String|Identifier for item Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |description|String|Description of the setting. Inherited from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md)| |
v1.0 | Intune Deviceconfigv2 Devicemanagementinventorypolicy Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementinventorypolicy-assign.md | - Title: "assign action" -description: "Intune Deviceconfigv2 Devicemanagementinventorypolicy Assign Api ." ---doc_type: apiPageType ---# assign action --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -----## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assign -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply JSON representation of the parameters. --The following table shows the parameters that can be used with this action. --|Property|Type|Description| -|:|:|:| -|assignments|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|| ----## Response -If successful, this action returns a `200 OK` response code and a [deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId}/assign --Content-type: application/json -Content-length: 610 --{ - "assignments": [ - { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } - ] -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 604 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceManagementConfigurationPolicyAssignment", - "id": "1f069921-9921-1f06-2199-061f2199061f", - "target": { - "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", - "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", - "deviceAndAppManagementAssignmentFilterType": "include", - "targetType": "user", - "entraObjectId": "Entra Object Id value" - }, - "source": "policySets", - "sourceId": "Source Id value" - } - ] -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementinventorypolicy Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementinventorypolicy-create.md | - Title: "Create deviceManagementInventoryPolicy" -description: "Create a new deviceManagementInventoryPolicy object." ---doc_type: apiPageType ---# Create deviceManagementInventoryPolicy --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Create a new [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/inventoryPolicies -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the deviceManagementInventoryPolicy object. --The following table shows the properties that are required when you create the deviceManagementInventoryPolicy. --|Property|Type|Description| -|:|:|:| -|id|String|Key of the policy document. Automatically generated.| -|name|String|Policy name| -|description|String|Policy description| -|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| -|createdDateTime|DateTimeOffset|Policy creation date and time. This property is read-only.| -|lastModifiedDateTime|DateTimeOffset|Policy last modification date and time. This property is read-only.| -|settingCount|Int32|Number of settings. This property is read-only.| -|creationSource|String|Policy creation source| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance.| -|isAssigned|Boolean|Policy assignment status. This property is read-only.| -|version|Int32|Version of the Policy. Valid values 0 to 1000. This property is read-only.| ----## Response -If successful, this method returns a `201 Created` response code and a [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies -Content-type: application/json -Content-length: 361 --{ - "@odata.type": "#microsoft.graph.deviceManagementInventoryPolicy", - "name": "Name value", - "description": "Description value", - "platforms": "android", - "technologies": "mdm", - "settingCount": 12, - "creationSource": "Creation Source value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "isAssigned": true, - "version": 7 -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 533 --{ - "@odata.type": "#microsoft.graph.deviceManagementInventoryPolicy", - "id": "e1d940a2-40a2-e1d9-a240-d9e1a240d9e1", - "name": "Name value", - "description": "Description value", - "platforms": "android", - "technologies": "mdm", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "settingCount": 12, - "creationSource": "Creation Source value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "isAssigned": true, - "version": 7 -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementinventorypolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementinventorypolicy-delete.md | - Title: "Delete deviceManagementInventoryPolicy" -description: "Deletes a deviceManagementInventoryPolicy." ---doc_type: apiPageType ---# Delete deviceManagementInventoryPolicy --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Deletes a [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md). ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementinventorypolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementinventorypolicy-get.md | - Title: "Get deviceManagementInventoryPolicy" -description: "Read properties and relationships of the deviceManagementInventoryPolicy object." ---doc_type: apiPageType ---# Get deviceManagementInventoryPolicy --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 582 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceManagementInventoryPolicy", - "id": "e1d940a2-40a2-e1d9-a240-d9e1a240d9e1", - "name": "Name value", - "description": "Description value", - "platforms": "android", - "technologies": "mdm", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "settingCount": 12, - "creationSource": "Creation Source value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "isAssigned": true, - "version": 7 - } -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementinventorypolicy List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementinventorypolicy-list.md | - Title: "List deviceManagementInventoryPolicies" -description: "List properties and relationships of the deviceManagementInventoryPolicy objects." ---doc_type: apiPageType ---# List deviceManagementInventoryPolicies --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/inventoryPolicies -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 626 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceManagementInventoryPolicy", - "id": "e1d940a2-40a2-e1d9-a240-d9e1a240d9e1", - "name": "Name value", - "description": "Description value", - "platforms": "android", - "technologies": "mdm", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "settingCount": 12, - "creationSource": "Creation Source value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "isAssigned": true, - "version": 7 - } - ] -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementinventorypolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-deviceconfigv2-devicemanagementinventorypolicy-update.md | - Title: "Update deviceManagementInventoryPolicy" -description: "Update the properties of a deviceManagementInventoryPolicy object." ---doc_type: apiPageType ---# Update deviceManagementInventoryPolicy --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Update the properties of a [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH /deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object. --The following table shows the properties that are required when you create the [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md). --|Property|Type|Description| -|:|:|:| -|id|String|Key of the policy document. Automatically generated.| -|name|String|Policy name| -|description|String|Policy description| -|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| -|createdDateTime|DateTimeOffset|Policy creation date and time. This property is read-only.| -|lastModifiedDateTime|DateTimeOffset|Policy last modification date and time. This property is read-only.| -|settingCount|Int32|Number of settings. This property is read-only.| -|creationSource|String|Policy creation source| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance.| -|isAssigned|Boolean|Policy assignment status. This property is read-only.| -|version|Int32|Version of the Policy. Valid values 0 to 1000. This property is read-only.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta/deviceManagement/inventoryPolicies/{deviceManagementInventoryPolicyId} -Content-type: application/json -Content-length: 361 --{ - "@odata.type": "#microsoft.graph.deviceManagementInventoryPolicy", - "name": "Name value", - "description": "Description value", - "platforms": "android", - "technologies": "mdm", - "settingCount": 12, - "creationSource": "Creation Source value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "isAssigned": true, - "version": 7 -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 533 --{ - "@odata.type": "#microsoft.graph.deviceManagementInventoryPolicy", - "id": "e1d940a2-40a2-e1d9-a240-d9e1a240d9e1", - "name": "Name value", - "description": "Description value", - "platforms": "android", - "technologies": "mdm", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "settingCount": 12, - "creationSource": "Creation Source value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ], - "isAssigned": true, - "version": 7 -} -``` |
v1.0 | Intune Devices Deviceinventory Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventory-create.md | - Title: "Create deviceInventory" -description: "Create a new deviceInventory object." ---doc_type: apiPageType ---# Create deviceInventory --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Create a new [deviceInventory](../resources/intune-devices-deviceinventory.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the deviceInventory object. --The following table shows the properties that are required when you create the deviceInventory. --|Property|Type|Description| -|:|:|:| -|id|String|The unique catalog id for this inventory entity type| -|displayName|String|The localized display name of the entity. Example: "Disk Drives". This property is read-only.| -|lastSyncDateTime|DateTimeOffset|The date and time that the inventory data was last synced with Intune. The value cannot be modified and is automatically populated when the device performs a sync. The Timestamp type represents date and time information and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only. This property is read-only.| ----## Response -If successful, this method returns a `201 Created` response code and a [deviceInventory](../resources/intune-devices-deviceinventory.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories -Content-type: application/json -Content-length: 157 --{ - "@odata.type": "#microsoft.graph.deviceInventory", - "displayName": "Display Name value", - "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 206 --{ - "@odata.type": "#microsoft.graph.deviceInventory", - "id": "3c0a4e13-4e13-3c0a-134e-0a3c134e0a3c", - "displayName": "Display Name value", - "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" -} -``` |
v1.0 | Intune Devices Deviceinventory Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventory-delete.md | - Title: "Delete deviceInventory" -description: "Deletes a deviceInventory." ---doc_type: apiPageType ---# Delete deviceInventory --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Deletes a [deviceInventory](../resources/intune-devices-deviceinventory.md). ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Devices Deviceinventory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventory-get.md | - Title: "Get deviceInventory" -description: "Read properties and relationships of the deviceInventory object." ---doc_type: apiPageType ---# Get deviceInventory --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceInventory](../resources/intune-devices-deviceinventory.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceInventory](../resources/intune-devices-deviceinventory.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 233 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceInventory", - "id": "3c0a4e13-4e13-3c0a-134e-0a3c134e0a3c", - "displayName": "Display Name value", - "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" - } -} -``` |
v1.0 | Intune Devices Deviceinventory List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventory-list.md | - Title: "List deviceInventories" -description: "List properties and relationships of the deviceInventory objects." ---doc_type: apiPageType ---# List deviceInventories --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceInventory](../resources/intune-devices-deviceinventory.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceInventory](../resources/intune-devices-deviceinventory.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 255 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceInventory", - "id": "3c0a4e13-4e13-3c0a-134e-0a3c134e0a3c", - "displayName": "Display Name value", - "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventory Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventory-update.md | - Title: "Update deviceInventory" -description: "Update the properties of a deviceInventory object." ---doc_type: apiPageType ---# Update deviceInventory --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Update the properties of a [deviceInventory](../resources/intune-devices-deviceinventory.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [deviceInventory](../resources/intune-devices-deviceinventory.md) object. --The following table shows the properties that are required when you create the [deviceInventory](../resources/intune-devices-deviceinventory.md). --|Property|Type|Description| -|:|:|:| -|id|String|The unique catalog id for this inventory entity type| -|displayName|String|The localized display name of the entity. Example: "Disk Drives". This property is read-only.| -|lastSyncDateTime|DateTimeOffset|The date and time that the inventory data was last synced with Intune. The value cannot be modified and is automatically populated when the device performs a sync. The Timestamp type represents date and time information and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only. This property is read-only.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceInventory](../resources/intune-devices-deviceinventory.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId} -Content-type: application/json -Content-length: 157 --{ - "@odata.type": "#microsoft.graph.deviceInventory", - "displayName": "Display Name value", - "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 206 --{ - "@odata.type": "#microsoft.graph.deviceInventory", - "id": "3c0a4e13-4e13-3c0a-134e-0a3c134e0a3c", - "displayName": "Display Name value", - "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" -} -``` |
v1.0 | Intune Devices Deviceinventorycollectionproperty Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorycollectionproperty-create.md | - Title: "Create deviceInventoryCollectionProperty" -description: "Create a new deviceInventoryCollectionProperty object." ---doc_type: apiPageType ---# Create deviceInventoryCollectionProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Create a new [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST ** Collection URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the deviceInventoryCollectionProperty object. --The following table shows the properties that are required when you create the deviceInventoryCollectionProperty. --|Property|Type|Description| -|:|:|:| -|id|String|The catalog id for this inventory property type Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|displayName|String|The localized display name of the property. Example: "Size (MB)". This property is read-only. Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|values|[deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) collection|Collection value of the property. This property is read-only.| ----## Response -If successful, this method returns a `201 Created` response code and a [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta** Collection URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -Content-type: application/json -Content-length: 272 --{ - "@odata.type": "#microsoft.graph.deviceInventoryCollectionProperty", - "displayName": "Display Name value", - "values": [ - { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - ] -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 321 --{ - "@odata.type": "#microsoft.graph.deviceInventoryCollectionProperty", - "id": "407d83d8-83d8-407d-d883-7d40d8837d40", - "displayName": "Display Name value", - "values": [ - { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventorycollectionproperty Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorycollectionproperty-delete.md | - Title: "Delete deviceInventoryCollectionProperty" -description: "Deletes a deviceInventoryCollectionProperty." ---doc_type: apiPageType ---# Delete deviceInventoryCollectionProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Deletes a [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md). ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE ** Entity URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta** Entity URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Devices Deviceinventorycollectionproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorycollectionproperty-get.md | - Title: "Get deviceInventoryCollectionProperty" -description: "Read properties and relationships of the deviceInventoryCollectionProperty object." ---doc_type: apiPageType ---# Get deviceInventoryCollectionProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET ** Entity URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta** Entity URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 358 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceInventoryCollectionProperty", - "id": "407d83d8-83d8-407d-d883-7d40d8837d40", - "displayName": "Display Name value", - "values": [ - { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - ] - } -} -``` |
v1.0 | Intune Devices Deviceinventorycollectionproperty List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorycollectionproperty-list.md | - Title: "List deviceInventoryCollectionProperties" -description: "List properties and relationships of the deviceInventoryCollectionProperty objects." ---doc_type: apiPageType ---# List deviceInventoryCollectionProperties --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET ** Collection URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta** Collection URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 390 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceInventoryCollectionProperty", - "id": "407d83d8-83d8-407d-d883-7d40d8837d40", - "displayName": "Display Name value", - "values": [ - { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - ] - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventorycollectionproperty Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorycollectionproperty-update.md | - Title: "Update deviceInventoryCollectionProperty" -description: "Update the properties of a deviceInventoryCollectionProperty object." ---doc_type: apiPageType ---# Update deviceInventoryCollectionProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Update the properties of a [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH ** Entity URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object. --The following table shows the properties that are required when you create the [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md). --|Property|Type|Description| -|:|:|:| -|id|String|The catalog id for this inventory property type Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|displayName|String|The localized display name of the property. Example: "Size (MB)". This property is read-only. Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|values|[deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) collection|Collection value of the property. This property is read-only.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta** Entity URI for microsoft.management.services.api.deviceInventoryCollectionProperty not found -Content-type: application/json -Content-length: 272 --{ - "@odata.type": "#microsoft.graph.deviceInventoryCollectionProperty", - "displayName": "Display Name value", - "values": [ - { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - ] -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 321 --{ - "@odata.type": "#microsoft.graph.deviceInventoryCollectionProperty", - "id": "407d83d8-83d8-407d-d883-7d40d8837d40", - "displayName": "Display Name value", - "values": [ - { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventoryitem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventoryitem-get.md | - Title: "Get deviceInventoryItem" -description: "Read properties and relationships of the deviceInventoryItem object." ---doc_type: apiPageType ---# Get deviceInventoryItem --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 133 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceInventoryItem", - "id": "60ac46c6-46c6-60ac-c646-ac60c646ac60" - } -} -``` |
v1.0 | Intune Devices Deviceinventoryitem List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventoryitem-list.md | - Title: "List deviceInventoryItems" -description: "List properties and relationships of the deviceInventoryItem objects." ---doc_type: apiPageType ---# List deviceInventoryItems --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 151 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceInventoryItem", - "id": "60ac46c6-46c6-60ac-c646-ac60c646ac60" - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventoryproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventoryproperty-get.md | - Title: "Get deviceInventoryProperty" -description: "Read properties and relationships of the deviceInventoryProperty object." ---doc_type: apiPageType ---# Get deviceInventoryProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET ** Entity URI for microsoft.management.services.api.deviceInventoryProperty not found -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta** Entity URI for microsoft.management.services.api.deviceInventoryProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 179 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceInventoryProperty", - "id": "8267a2c0-a2c0-8267-c0a2-6782c0a26782", - "displayName": "Display Name value" - } -} -``` |
v1.0 | Intune Devices Deviceinventoryproperty List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventoryproperty-list.md | - Title: "List deviceInventoryProperties" -description: "List properties and relationships of the deviceInventoryProperty objects." ---doc_type: apiPageType ---# List deviceInventoryProperties --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET ** Collection URI for microsoft.management.services.api.deviceInventoryProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta** Collection URI for microsoft.management.services.api.deviceInventoryProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 199 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceInventoryProperty", - "id": "8267a2c0-a2c0-8267-c0a2-6782c0a26782", - "displayName": "Display Name value" - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleitem Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleitem-create.md | - Title: "Create deviceInventorySimpleItem" -description: "Create a new deviceInventorySimpleItem object." ---doc_type: apiPageType ---# Create deviceInventorySimpleItem --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Create a new [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the deviceInventorySimpleItem object. --The following table shows the properties that are required when you create the deviceInventorySimpleItem. --|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the inventory data Inherited from [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md)| ----## Response -If successful, this method returns a `201 Created` response code and a [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances -Content-type: application/json -Content-length: 67 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleItem" -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 116 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleItem", - "id": "b70f94fc-94fc-b70f-fc94-0fb7fc940fb7" -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleitem Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleitem-delete.md | - Title: "Delete deviceInventorySimpleItem" -description: "Deletes a deviceInventorySimpleItem." ---doc_type: apiPageType ---# Delete deviceInventorySimpleItem --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Deletes a [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md). ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Devices Deviceinventorysimpleitem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleitem-get.md | - Title: "Get deviceInventorySimpleItem" -description: "Read properties and relationships of the deviceInventorySimpleItem object." ---doc_type: apiPageType ---# Get deviceInventorySimpleItem --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 139 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceInventorySimpleItem", - "id": "b70f94fc-94fc-b70f-fc94-0fb7fc940fb7" - } -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleitem List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleitem-list.md | - Title: "List deviceInventorySimpleItems" -description: "List properties and relationships of the deviceInventorySimpleItem objects." ---doc_type: apiPageType ---# List deviceInventorySimpleItems --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 157 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceInventorySimpleItem", - "id": "b70f94fc-94fc-b70f-fc94-0fb7fc940fb7" - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleitem Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleitem-update.md | - Title: "Update deviceInventorySimpleItem" -description: "Update the properties of a deviceInventorySimpleItem object." ---doc_type: apiPageType ---# Update deviceInventorySimpleItem --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Update the properties of a [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object. --The following table shows the properties that are required when you create the [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md). --|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the inventory data Inherited from [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md)| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/deviceInventories/{deviceInventoryId}/instances/{deviceInventoryItemId} -Content-type: application/json -Content-length: 67 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleItem" -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 116 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleItem", - "id": "b70f94fc-94fc-b70f-fc94-0fb7fc940fb7" -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleproperty Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleproperty-create.md | - Title: "Create deviceInventorySimpleProperty" -description: "Create a new deviceInventorySimpleProperty object." ---doc_type: apiPageType ---# Create deviceInventorySimpleProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Create a new [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST ** Collection URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the deviceInventorySimpleProperty object. --The following table shows the properties that are required when you create the deviceInventorySimpleProperty. --|Property|Type|Description| -|:|:|:| -|id|String|The catalog id for this inventory property type Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|displayName|String|The localized display name of the property. Example: "Size (MB)". This property is read-only. Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|value|[deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md)|Value of the property. This property is read-only.| ----## Response -If successful, this method returns a `201 Created` response code and a [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta** Collection URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -Content-type: application/json -Content-length: 249 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleProperty", - "displayName": "Display Name value", - "value": { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 298 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleProperty", - "id": "13e13882-3882-13e1-8238-e1138238e113", - "displayName": "Display Name value", - "value": { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleproperty Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleproperty-delete.md | - Title: "Delete deviceInventorySimpleProperty" -description: "Deletes a deviceInventorySimpleProperty." ---doc_type: apiPageType ---# Delete deviceInventorySimpleProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Deletes a [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md). ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE ** Entity URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta** Entity URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Devices Deviceinventorysimpleproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleproperty-get.md | - Title: "Get deviceInventorySimpleProperty" -description: "Read properties and relationships of the deviceInventorySimpleProperty object." ---doc_type: apiPageType ---# Get deviceInventorySimpleProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET ** Entity URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta** Entity URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 331 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceInventorySimpleProperty", - "id": "13e13882-3882-13e1-8238-e1138238e113", - "displayName": "Display Name value", - "value": { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - } -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleproperty List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleproperty-list.md | - Title: "List deviceInventorySimpleProperties" -description: "List properties and relationships of the deviceInventorySimpleProperty objects." ---doc_type: apiPageType ---# List deviceInventorySimpleProperties --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET ** Collection URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta** Collection URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 359 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceInventorySimpleProperty", - "id": "13e13882-3882-13e1-8238-e1138238e113", - "displayName": "Display Name value", - "value": { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleproperty Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-deviceinventorysimpleproperty-update.md | - Title: "Update deviceInventorySimpleProperty" -description: "Update the properties of a deviceInventorySimpleProperty object." ---doc_type: apiPageType ---# Update deviceInventorySimpleProperty --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Update the properties of a [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH ** Entity URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object. --The following table shows the properties that are required when you create the [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md). --|Property|Type|Description| -|:|:|:| -|id|String|The catalog id for this inventory property type Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|displayName|String|The localized display name of the property. Example: "Size (MB)". This property is read-only. Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|value|[deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md)|Value of the property. This property is read-only.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta** Entity URI for microsoft.management.services.api.deviceInventorySimpleProperty not found -Content-type: application/json -Content-length: 249 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleProperty", - "displayName": "Display Name value", - "value": { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 298 --{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleProperty", - "id": "13e13882-3882-13e1-8238-e1138238e113", - "displayName": "Display Name value", - "value": { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "2017-01-01T00:02:59.3325615-08:00" - } -} -``` |
v1.0 | Intune Devices Manageddevice Downloadpowerliftappdiagnostic | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddevice-downloadpowerliftappdiagnostic.md | + + Title: "downloadPowerliftAppDiagnostic action" +description: "Intune Devices Manageddevice Downloadpowerliftappdiagnostic Api ." ++ms.localizationpriority: medium ++++# downloadPowerliftAppDiagnostic action ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +POST /deviceManagement/managedDevices/downloadPowerliftAppDiagnostic +POST /deviceManagement/comanagedDevices/downloadPowerliftAppDiagnostic +POST /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/users/{userId}/managedDevices/downloadPowerliftAppDiagnostic +POST /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/detectedApps/{detectedAppId}/managedDevices/downloadPowerliftAppDiagnostic +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply JSON representation of the parameters. ++The following table shows the parameters that can be used with this action. ++|Property|Type|Description| +|:|:|:| +|request|[powerliftAppDiagnosticDownloadRequest](../resources/intune-devices-powerliftappdiagnosticdownloadrequest.md)|| ++++## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/managedDevices/downloadPowerliftAppDiagnostic ++Content-type: application/json +Content-length: 188 ++{ + "request": { + "@odata.type": "microsoft.graph.powerliftAppDiagnosticDownloadRequest", + "powerliftId": "Powerlift Id value", + "files": [ + "Files value" + ] + } +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 99 ++{ + "value": "ZG93bmxvYWRQb3dlcmxpZnRBcHBEaWFnbm9zdGljIEludHVuZSBEb2MgU2FtcGxlIC0xMzI0NDI2NDcw" +} +``` |
v1.0 | Intune Devices Manageddevice Retrievedevicelogsdownloadurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddevice-retrievedevicelogsdownloadurl.md | - Title: "retrieveDeviceLogsDownloadUrl function" -description: "Intune Devices Manageddevice Retrievedevicelogsdownloadurl Api ." ---doc_type: apiPageType ---# retrieveDeviceLogsDownloadUrl function --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -----## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/managedDevices/{managedDeviceId}/retrieveDeviceLogsDownloadUrl -GET /deviceManagement/comanagedDevices/{managedDeviceId}/retrieveDeviceLogsDownloadUrl -GET /deviceManagement/deviceHealthScripts/{deviceHealthScriptId}/deviceRunStates/{deviceHealthScriptDeviceStateId}/managedDevice/retrieveDeviceLogsDownloadUrl -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/retrieveDeviceLogsDownloadUrl -GET /deviceManagement/deviceComplianceScripts/{deviceComplianceScriptId}/deviceRunStates/{deviceComplianceScriptDeviceStateId}/managedDevice/retrieveDeviceLogsDownloadUrl -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/users/{userId}/managedDevices/{managedDeviceId}/retrieveDeviceLogsDownloadUrl -GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/detectedApps/{detectedAppId}/managedDevices/{managedDeviceId}/retrieveDeviceLogsDownloadUrl -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request URL, provide the following query parameters with values. -The following table shows the parameters that can be used with this function. --|Property|Type|Description| -|:|:|:| -|requestId|String|| ----## Response -If successful, this function returns a `200 OK` response code and a String in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/managedDevices/{managedDeviceId}/retrieveDeviceLogsDownloadUrl(requestId='parameterValue') -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 69 --{ - "value": "https://example.com/retrieveDeviceLogsDownloadUrl/" -} -``` |
v1.0 | Intune Devices Manageddevice Retrievepowerliftappdiagnosticsdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-manageddevice-retrievepowerliftappdiagnosticsdetails.md | + + Title: "retrievePowerliftAppDiagnosticsDetails function" +description: "Intune Devices Manageddevice Retrievepowerliftappdiagnosticsdetails Api ." ++ms.localizationpriority: medium ++++# retrievePowerliftAppDiagnosticsDetails function ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/managedDevices/retrievePowerliftAppDiagnosticsDetails +GET /deviceManagement/comanagedDevices/retrievePowerliftAppDiagnosticsDetails +GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/users/{userId}/managedDevices/retrievePowerliftAppDiagnosticsDetails +GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/detectedApps/{detectedAppId}/managedDevices/retrievePowerliftAppDiagnosticsDetails +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request URL, provide the following query parameters with values. +The following table shows the parameters that can be used with this function. ++|Property|Type|Description| +|:|:|:| +|userPrincipalName|String|| ++++## Response +If successful, this function returns a `200 OK` response code and a [powerliftIncidentDetail](../resources/intune-devices-powerliftincidentdetail.md) collection in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/managedDevices/retrievePowerliftAppDiagnosticsDetails(userPrincipalName='parameterValue') +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 519 ++{ + "value": [ + { + "@odata.type": "microsoft.graph.powerliftIncidentDetail", + "powerliftId": "Powerlift Id value", + "easyId": "Easy Id value", + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "platformDisplayName": "Platform Display Name value", + "applicationName": "Application Name value", + "clientApplicationVersion": "Client Application Version value", + "locale": "Locale value", + "fileNames": [ + "File Names value" + ] + } + ] +} +``` |
v1.0 | Intune Devices Remoteactionaudit Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-remoteactionaudit-create.md | The following table shows the properties that are required when you create the r |actionState|[actionState](../resources/intune-shared-actionstate.md)|Action state. Possible values are: `none`, `pending`, `canceled`, `active`, `done`, `failed`, `notSupported`.| |managedDeviceId|String|Action target.| |deviceActionDetails|[keyValuePair_2OfString_String](../resources/intune-devices-keyvaluepair_2ofstring_string.md) collection|DeviceAction details|-|deviceActionCategory|[actionCategory](../resources/intune-devices-actioncategory.md)|DeviceAction category. Possible values are: `single`, `bulk`.| +|deviceActionCategory|[deviceActionCategory](../resources/intune-devices-deviceactioncategory.md)|DeviceAction category. Possible values are: `single`, `bulk`.| |bulkDeviceActionId|String|BulkAction ID| |
v1.0 | Intune Devices Remoteactionaudit Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-remoteactionaudit-update.md | The following table shows the properties that are required when you create the [ |actionState|[actionState](../resources/intune-shared-actionstate.md)|Action state. Possible values are: `none`, `pending`, `canceled`, `active`, `done`, `failed`, `notSupported`.| |managedDeviceId|String|Action target.| |deviceActionDetails|[keyValuePair_2OfString_String](../resources/intune-devices-keyvaluepair_2ofstring_string.md) collection|DeviceAction details|-|deviceActionCategory|[actionCategory](../resources/intune-devices-actioncategory.md)|DeviceAction category. Possible values are: `single`, `bulk`.| +|deviceActionCategory|[deviceActionCategory](../resources/intune-devices-deviceactioncategory.md)|DeviceAction category. Possible values are: `single`, `bulk`.| |bulkDeviceActionId|String|BulkAction ID| |
v1.0 | Intune Devices User Getloggedonmanageddevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-devices-user-getloggedonmanageddevices.md | + + Title: "getLoggedOnManagedDevices function" +description: "Intune Devices User Getloggedonmanageddevices Source_Api ." ++ms.localizationpriority: medium ++++# getLoggedOnManagedDevices function ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/users/{userId}/getLoggedOnManagedDevices +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this function returns a `200 OK` response code and a [managedDevice](../resources/intune-devices-manageddevice.md) collection in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/users/{userId}/getLoggedOnManagedDevices +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 10964 ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.managedDevice", + "id": "705c034c-034c-705c-4c03-5c704c035c70", + "userId": "User Id value", + "deviceName": "Device Name value", + "hardwareInformation": { + "@odata.type": "microsoft.graph.hardwareInformation", + "serialNumber": "Serial Number value", + "totalStorageSpace": 1, + "freeStorageSpace": 0, + "imei": "Imei value", + "meid": "Meid value", + "manufacturer": "Manufacturer value", + "model": "Model value", + "phoneNumber": "Phone Number value", + "subscriberCarrier": "Subscriber Carrier value", + "cellularTechnology": "Cellular Technology value", + "wifiMac": "Wifi Mac value", + "operatingSystemLanguage": "Operating System Language value", + "isSupervised": true, + "isEncrypted": true, + "batterySerialNumber": "Battery Serial Number value", + "batteryHealthPercentage": 7, + "batteryChargeCycles": 3, + "isSharedDevice": true, + "sharedDeviceCachedUsers": [ + { + "@odata.type": "microsoft.graph.sharedAppleDeviceUser", + "userPrincipalName": "User Principal Name value", + "dataToSync": true, + "dataQuota": 9, + "dataUsed": 8 + } + ], + "tpmSpecificationVersion": "Tpm Specification Version value", + "operatingSystemEdition": "Operating System Edition value", + "deviceFullQualifiedDomainName": "Device Full Qualified Domain Name value", + "deviceGuardVirtualizationBasedSecurityHardwareRequirementState": "secureBootRequired", + "deviceGuardVirtualizationBasedSecurityState": "rebootRequired", + "deviceGuardLocalSystemAuthorityCredentialGuardState": "rebootRequired", + "osBuildNumber": "Os Build Number value", + "operatingSystemProductType": 10, + "ipAddressV4": "Ip Address V4 value", + "subnetAddress": "Subnet Address value", + "esimIdentifier": "Esim Identifier value", + "systemManagementBIOSVersion": "System Management BIOSVersion value", + "tpmManufacturer": "Tpm Manufacturer value", + "tpmVersion": "Tpm Version value", + "wiredIPv4Addresses": [ + "Wired IPv4Addresses value" + ], + "batteryLevelPercentage": 7.333333333333333, + "residentUsersCount": 2, + "productName": "Product Name value", + "deviceLicensingStatus": "licenseRefreshPending", + "deviceLicensingLastErrorCode": 12, + "deviceLicensingLastErrorDescription": "Device Licensing Last Error Description value" + }, + "ownerType": "company", + "managedDeviceOwnerType": "company", + "deviceActionResults": [ + { + "@odata.type": "microsoft.graph.deviceActionResult", + "actionName": "Action Name value", + "actionState": "pending", + "startDateTime": "2016-12-31T23:58:46.7156189-08:00", + "lastUpdatedDateTime": "2017-01-01T00:00:56.8321556-08:00" + } + ], + "managementState": "retirePending", + "enrolledDateTime": "2016-12-31T23:59:43.797191-08:00", + "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00", + "chassisType": "desktop", + "operatingSystem": "Operating System value", + "deviceType": "windowsRT", + "complianceState": "compliant", + "jailBroken": "Jail Broken value", + "managementAgent": "mdm", + "osVersion": "Os Version value", + "easActivated": true, + "easDeviceId": "Eas Device Id value", + "easActivationDateTime": "2016-12-31T23:59:43.4878784-08:00", + "aadRegistered": true, + "azureADRegistered": true, + "deviceEnrollmentType": "userEnrollment", + "lostModeState": "enabled", + "activationLockBypassCode": "Activation Lock Bypass Code value", + "emailAddress": "Email Address value", + "azureActiveDirectoryDeviceId": "Azure Active Directory Device Id value", + "azureADDeviceId": "Azure ADDevice Id value", + "deviceRegistrationState": "registered", + "deviceCategoryDisplayName": "Device Category Display Name value", + "isSupervised": true, + "exchangeLastSuccessfulSyncDateTime": "2017-01-01T00:00:45.8803083-08:00", + "exchangeAccessState": "unknown", + "exchangeAccessStateReason": "unknown", + "remoteAssistanceSessionUrl": "https://example.com/remoteAssistanceSessionUrl/", + "remoteAssistanceSessionErrorDetails": "Remote Assistance Session Error Details value", + "isEncrypted": true, + "userPrincipalName": "User Principal Name value", + "enrolledByUserPrincipalName": "Enrolled By User Principal Name value", + "model": "Model value", + "manufacturer": "Manufacturer value", + "imei": "Imei value", + "complianceGracePeriodExpirationDateTime": "2016-12-31T23:56:44.951111-08:00", + "serialNumber": "Serial Number value", + "phoneNumber": "Phone Number value", + "androidSecurityPatchLevel": "Android Security Patch Level value", + "userDisplayName": "User Display Name value", + "configurationManagerClientEnabledFeatures": { + "@odata.type": "microsoft.graph.configurationManagerClientEnabledFeatures", + "inventory": true, + "modernApps": true, + "resourceAccess": true, + "deviceConfiguration": true, + "compliancePolicy": true, + "windowsUpdateForBusiness": true, + "endpointProtection": true, + "officeApps": true + }, + "wiFiMacAddress": "Wi Fi Mac Address value", + "deviceHealthAttestationState": { + "@odata.type": "microsoft.graph.deviceHealthAttestationState", + "lastUpdateDateTime": "Last Update Date Time value", + "contentNamespaceUrl": "https://example.com/contentNamespaceUrl/", + "deviceHealthAttestationStatus": "Device Health Attestation Status value", + "contentVersion": "Content Version value", + "issuedDateTime": "2016-12-31T23:58:22.1231038-08:00", + "attestationIdentityKey": "Attestation Identity Key value", + "resetCount": 10, + "restartCount": 12, + "dataExcutionPolicy": "Data Excution Policy value", + "bitLockerStatus": "Bit Locker Status value", + "bootManagerVersion": "Boot Manager Version value", + "codeIntegrityCheckVersion": "Code Integrity Check Version value", + "secureBoot": "Secure Boot value", + "bootDebugging": "Boot Debugging value", + "operatingSystemKernelDebugging": "Operating System Kernel Debugging value", + "codeIntegrity": "Code Integrity value", + "testSigning": "Test Signing value", + "safeMode": "Safe Mode value", + "windowsPE": "Windows PE value", + "earlyLaunchAntiMalwareDriverProtection": "Early Launch Anti Malware Driver Protection value", + "virtualSecureMode": "Virtual Secure Mode value", + "pcrHashAlgorithm": "Pcr Hash Algorithm value", + "bootAppSecurityVersion": "Boot App Security Version value", + "bootManagerSecurityVersion": "Boot Manager Security Version value", + "tpmVersion": "Tpm Version value", + "pcr0": "Pcr0 value", + "secureBootConfigurationPolicyFingerPrint": "Secure Boot Configuration Policy Finger Print value", + "codeIntegrityPolicy": "Code Integrity Policy value", + "bootRevisionListInfo": "Boot Revision List Info value", + "operatingSystemRevListInfo": "Operating System Rev List Info value", + "healthStatusMismatchInfo": "Health Status Mismatch Info value", + "healthAttestationSupportedStatus": "Health Attestation Supported Status value", + "memoryIntegrityProtection": "enabled", + "memoryAccessProtection": "enabled", + "virtualizationBasedSecurity": "enabled", + "firmwareProtection": "systemGuardSecureLaunch", + "systemManagementMode": "level1", + "securedCorePC": "enabled" + }, + "subscriberCarrier": "Subscriber Carrier value", + "meid": "Meid value", + "totalStorageSpaceInBytes": 8, + "freeStorageSpaceInBytes": 7, + "managedDeviceName": "Managed Device Name value", + "partnerReportedThreatState": "activated", + "retireAfterDateTime": "2016-12-31T23:57:37.576134-08:00", + "usersLoggedOn": [ + { + "@odata.type": "microsoft.graph.loggedOnUser", + "userId": "User Id value", + "lastLogOnDateTime": "2016-12-31T23:58:37.4262708-08:00" + } + ], + "preferMdmOverGroupPolicyAppliedDateTime": "2016-12-31T23:57:34.4649887-08:00", + "autopilotEnrolled": true, + "requireUserEnrollmentApproval": true, + "managementCertificateExpirationDate": "2016-12-31T23:57:59.9789653-08:00", + "iccid": "Iccid value", + "udid": "Udid value", + "roleScopeTagIds": [ + "Role Scope Tag Ids value" + ], + "windowsActiveMalwareCount": 9, + "windowsRemediatedMalwareCount": 13, + "notes": "Notes value", + "configurationManagerClientHealthState": { + "@odata.type": "microsoft.graph.configurationManagerClientHealthState", + "state": "installed", + "errorCode": 9, + "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" + }, + "configurationManagerClientInformation": { + "@odata.type": "microsoft.graph.configurationManagerClientInformation", + "clientIdentifier": "Client Identifier value", + "isBlocked": true, + "clientVersion": "Client Version value" + }, + "ethernetMacAddress": "Ethernet Mac Address value", + "physicalMemoryInBytes": 5, + "processorArchitecture": "x86", + "specificationVersion": "Specification Version value", + "joinType": "azureADJoined", + "skuFamily": "Sku Family value", + "securityPatchLevel": "Security Patch Level value", + "skuNumber": 9, + "managementFeatures": "microsoftManagedDesktop", + "chromeOSDeviceInfo": [ + { + "@odata.type": "microsoft.graph.chromeOSDeviceProperty", + "name": "Name value", + "value": "Value value", + "valueType": "Value Type value", + "updatable": true + } + ], + "supplementalDeviceDetails": [ + { + "@odata.type": "microsoft.graph.supplementalDeviceDetail", + "propertyName": "Property Name value", + "propertyValue": "Property Value value", + "propertyType": "Property Type value" + } + ], + "enrollmentProfileName": "Enrollment Profile Name value", + "bootstrapTokenEscrowed": true, + "deviceFirmwareConfigurationInterfaceManaged": true, + "deviceIdentityAttestationDetail": { + "@odata.type": "microsoft.graph.deviceIdentityAttestationDetail", + "deviceIdentityAttestationStatus": "trusted" + } + } + ] +} +``` |
v1.0 | Intune Grouppolicy Devicemanagementreports Getgrouppolicysettingsdevicesettingsreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-grouppolicy-devicemanagementreports-getgrouppolicysettingsdevicesettingsreport.md | The following table shows the parameters that can be used with this action. |top|Int32|| |sessionId|String|| |filter|String||+|skiptoken|String|| Here is an example of the request. POST https://graph.microsoft.com/beta/deviceManagement/reports/getGroupPolicySettingsDeviceSettingsReport Content-type: application/json-Content-length: 278 +Content-length: 313 { "name": "Name value", Content-length: 278 "skip": 4, "top": 3, "sessionId": "Session Id value",- "filter": "Filter value" + "filter": "Filter value", + "skiptoken": "Skiptoken value" } ``` |
v1.0 | Intune Mam Androidmanagedappprotection Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-androidmanagedappprotection-create.md | The following table shows the properties that are required when you create the a |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `oneDriveForBusiness`, `sharePoint`, `camera`, `photoLibrary`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| The following table shows the properties that are required when you create the a |exemptedAppPackages|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|App packages in this list will be exempt from the policy and will be able to receive data from managed apps.| |minimumWipePatchVersion|String|Android security patch level less than or equal to the specified value will wipe the managed app and the associated company data.| |allowedAndroidDeviceManufacturers|String|Semicolon seperated list of device manufacturers allowed, as a string, for the managed app to work.|-|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfSamsungKnoxAttestationRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines the behavior of a managed app when Samsung Knox Attestation is required. Possible values are null, warn, block & wipe. If the admin does not set this action, the default is null, which indicates this setting is not configured. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfSamsungKnoxAttestationRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines the behavior of a managed app when Samsung Knox Attestation is required. Possible values are null, warn, block & wipe. If the admin does not set this action, the default is null, which indicates this setting is not configured. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetDeviceAttestationType|[androidManagedAppSafetyNetDeviceAttestationType](../resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md)|Defines the Android SafetyNet Device Attestation requirement for a managed app to work. Possible values are: `none`, `basicIntegrity`, `basicIntegrityAndDeviceCertification`.|-|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetAppsVerificationType|[androidManagedAppSafetyNetAppsVerificationType](../resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md)|Defines the Android SafetyNet Apps Verification requirement for a managed app to work. Possible values are: `none`, `enabled`.|-|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customBrowserPackageId|String|Unique identifier of the preferred custom browser to open weblink on Android. When this property is configured, ManagedBrowserToOpenLinksRequired should be true.| |customBrowserDisplayName|String|Friendly name of the preferred custom browser to open weblink on Android. When this property is configured, ManagedBrowserToOpenLinksRequired should be true.| |minimumRequiredCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or app access will be blocked| The following table shows the properties that are required when you create the a |keyboardsRestricted|Boolean|Indicates if keyboard restriction is enabled. If enabled list of approved keyboards must be provided as well.| |approvedKeyboards|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|If Keyboard Restriction is enabled, only keyboards in this approved list will be allowed. A key should be Android package id for a keyboard and value should be a friendly name| |allowedAndroidDeviceModels|String collection|List of device models allowed, as a string, for the managed app to work.|-|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customDialerAppPackageId|String|PackageId of a custom dialer app to click-to-open a phone number on Android.| |customDialerAppDisplayName|String|Friendly name of a custom dialer app to click-to-open a phone number on Android.| |biometricAuthenticationBlocked|Boolean|Indicates whether use of the biometric authentication is allowed in place of a pin if PinRequired is set to True.| The following table shows the properties that are required when you create the a |warnAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the user will receive the warning| |wipeAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the company data on the app will be wiped| |deviceLockRequired|Boolean|Defines if any kind of lock must be required on android device|-|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on android device but is not set. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on android device but is not set. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |connectToVpnOnLaunch|Boolean|Whether the app should connect to the configured VPN on launch.|-|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requireClass3Biometrics|Boolean|Require user to apply Class 3 Biometrics on their Android device.| |requirePinAfterBiometricChange|Boolean|A PIN prompt will override biometric prompts if class 3 biometrics are updated on the device.| |fingerprintAndBiometricEnabled|Boolean|If null, this setting will be ignored. If false both fingerprints and biometrics will not be enabled. If true, both fingerprints and biometrics will be enabled.| |
v1.0 | Intune Mam Androidmanagedappprotection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-androidmanagedappprotection-update.md | The following table shows the properties that are required when you create the [ |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `oneDriveForBusiness`, `sharePoint`, `camera`, `photoLibrary`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| The following table shows the properties that are required when you create the [ |exemptedAppPackages|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|App packages in this list will be exempt from the policy and will be able to receive data from managed apps.| |minimumWipePatchVersion|String|Android security patch level less than or equal to the specified value will wipe the managed app and the associated company data.| |allowedAndroidDeviceManufacturers|String|Semicolon seperated list of device manufacturers allowed, as a string, for the managed app to work.|-|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfSamsungKnoxAttestationRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines the behavior of a managed app when Samsung Knox Attestation is required. Possible values are null, warn, block & wipe. If the admin does not set this action, the default is null, which indicates this setting is not configured. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfSamsungKnoxAttestationRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines the behavior of a managed app when Samsung Knox Attestation is required. Possible values are null, warn, block & wipe. If the admin does not set this action, the default is null, which indicates this setting is not configured. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetDeviceAttestationType|[androidManagedAppSafetyNetDeviceAttestationType](../resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md)|Defines the Android SafetyNet Device Attestation requirement for a managed app to work. Possible values are: `none`, `basicIntegrity`, `basicIntegrityAndDeviceCertification`.|-|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetAppsVerificationType|[androidManagedAppSafetyNetAppsVerificationType](../resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md)|Defines the Android SafetyNet Apps Verification requirement for a managed app to work. Possible values are: `none`, `enabled`.|-|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customBrowserPackageId|String|Unique identifier of the preferred custom browser to open weblink on Android. When this property is configured, ManagedBrowserToOpenLinksRequired should be true.| |customBrowserDisplayName|String|Friendly name of the preferred custom browser to open weblink on Android. When this property is configured, ManagedBrowserToOpenLinksRequired should be true.| |minimumRequiredCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or app access will be blocked| The following table shows the properties that are required when you create the [ |keyboardsRestricted|Boolean|Indicates if keyboard restriction is enabled. If enabled list of approved keyboards must be provided as well.| |approvedKeyboards|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|If Keyboard Restriction is enabled, only keyboards in this approved list will be allowed. A key should be Android package id for a keyboard and value should be a friendly name| |allowedAndroidDeviceModels|String collection|List of device models allowed, as a string, for the managed app to work.|-|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customDialerAppPackageId|String|PackageId of a custom dialer app to click-to-open a phone number on Android.| |customDialerAppDisplayName|String|Friendly name of a custom dialer app to click-to-open a phone number on Android.| |biometricAuthenticationBlocked|Boolean|Indicates whether use of the biometric authentication is allowed in place of a pin if PinRequired is set to True.| The following table shows the properties that are required when you create the [ |warnAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the user will receive the warning| |wipeAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the company data on the app will be wiped| |deviceLockRequired|Boolean|Defines if any kind of lock must be required on android device|-|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on android device but is not set. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on android device but is not set. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |connectToVpnOnLaunch|Boolean|Whether the app should connect to the configured VPN on launch.|-|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requireClass3Biometrics|Boolean|Require user to apply Class 3 Biometrics on their Android device.| |requirePinAfterBiometricChange|Boolean|A PIN prompt will override biometric prompts if class 3 biometrics are updated on the device.| |fingerprintAndBiometricEnabled|Boolean|If null, this setting will be ignored. If false both fingerprints and biometrics will not be enabled. If true, both fingerprints and biometrics will be enabled.| |
v1.0 | Intune Mam Defaultmanagedappprotection Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-defaultmanagedappprotection-create.md | The following table shows the properties that are required when you create the d |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `oneDriveForBusiness`, `sharePoint`, `camera`, `photoLibrary`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| The following table shows the properties that are required when you create the d |minimumWipeSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data.| |minimumWipePatchVersion|String|Android security patch level less than or equal to the specified value will wipe the managed app and the associated company data. (Android only)| |allowedIosDeviceModels|String|Semicolon seperated list of device models allowed, as a string, for the managed app to work. (iOS Only)|-|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (iOS Only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (iOS Only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |allowedAndroidDeviceManufacturers|String|Semicolon seperated list of device manufacturers allowed, as a string, for the managed app to work. (Android only)|-|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. (Android only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. (Android only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |thirdPartyKeyboardsBlocked|Boolean|Defines if third party keyboards are allowed while accessing a managed app. (iOS Only)| |filterOpenInToOnlyManagedApps|Boolean|Defines if open-in operation is supported from the managed app to the filesharing locations selected. This setting only applies when AllowedOutboundDataTransferDestinations is set to ManagedApps and DisableProtectionOfManagedOutboundOpenInData is set to False. (iOS Only)| |disableProtectionOfManagedOutboundOpenInData|Boolean|Disable protection of data transferred to other apps through IOS OpenIn option. This setting is only allowed to be True when AllowedOutboundDataTransferDestinations is set to ManagedApps. (iOS Only)| |protectInboundDataFromUnknownSources|Boolean|Protect incoming data from unknown source. This setting is only allowed to be True when AllowedInboundDataTransferSources is set to AllApps. (iOS Only)| |requiredAndroidSafetyNetDeviceAttestationType|[androidManagedAppSafetyNetDeviceAttestationType](../resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md)|Defines the Android SafetyNet Device Attestation requirement for a managed app to work. Possible values are: `none`, `basicIntegrity`, `basicIntegrityAndDeviceCertification`.|-|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetAppsVerificationType|[androidManagedAppSafetyNetAppsVerificationType](../resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md)|Defines the Android SafetyNet Apps Verification requirement for a managed app to work. Possible values are: `none`, `enabled`.|-|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customBrowserProtocol|String|A custom browser protocol to open weblink on iOS. (iOS only)| |customBrowserPackageId|String|Unique identifier of a custom browser to open weblink on Android. (Android only)| |customBrowserDisplayName|String|Friendly name of the preferred custom browser to open weblink on Android. (Android only)| The following table shows the properties that are required when you create the d |minimumWarningCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or the user will receive a warning| |minimumWipeCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or the company data on the app will be wiped| |allowedAndroidDeviceModels|String collection|List of device models allowed, as a string, for the managed app to work. (Android Only)|-|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (Android Only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (Android Only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customDialerAppProtocol|String|Protocol of a custom dialer app to click-to-open a phone number on iOS, for example, skype:.| |customDialerAppPackageId|String|PackageId of a custom dialer app to click-to-open a phone number on Android.| |customDialerAppDisplayName|String|Friendly name of a custom dialer app to click-to-open a phone number on Android.| The following table shows the properties that are required when you create the d |warnAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the user will receive the warning| |wipeAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the company data on the app will be wiped| |deviceLockRequired|Boolean|Defines if any kind of lock must be required on device. (android only)|-|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on device but is not set. (android only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on device but is not set. (android only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |connectToVpnOnLaunch|Boolean|Whether the app should connect to the configured VPN on launch (Android only).|-|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requireClass3Biometrics|Boolean|Require user to apply Class 3 Biometrics on their Android device.| |requirePinAfterBiometricChange|Boolean|A PIN prompt will override biometric prompts if class 3 biometrics are updated on the device.| |fingerprintAndBiometricEnabled|Boolean|Indicate to the client to enable both biometrics and fingerprints for the app.| |
v1.0 | Intune Mam Defaultmanagedappprotection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-defaultmanagedappprotection-update.md | The following table shows the properties that are required when you create the [ |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `oneDriveForBusiness`, `sharePoint`, `camera`, `photoLibrary`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| The following table shows the properties that are required when you create the [ |minimumWipeSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data.| |minimumWipePatchVersion|String|Android security patch level less than or equal to the specified value will wipe the managed app and the associated company data. (Android only)| |allowedIosDeviceModels|String|Semicolon seperated list of device models allowed, as a string, for the managed app to work. (iOS Only)|-|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (iOS Only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (iOS Only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |allowedAndroidDeviceManufacturers|String|Semicolon seperated list of device manufacturers allowed, as a string, for the managed app to work. (Android only)|-|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. (Android only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. (Android only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |thirdPartyKeyboardsBlocked|Boolean|Defines if third party keyboards are allowed while accessing a managed app. (iOS Only)| |filterOpenInToOnlyManagedApps|Boolean|Defines if open-in operation is supported from the managed app to the filesharing locations selected. This setting only applies when AllowedOutboundDataTransferDestinations is set to ManagedApps and DisableProtectionOfManagedOutboundOpenInData is set to False. (iOS Only)| |disableProtectionOfManagedOutboundOpenInData|Boolean|Disable protection of data transferred to other apps through IOS OpenIn option. This setting is only allowed to be True when AllowedOutboundDataTransferDestinations is set to ManagedApps. (iOS Only)| |protectInboundDataFromUnknownSources|Boolean|Protect incoming data from unknown source. This setting is only allowed to be True when AllowedInboundDataTransferSources is set to AllApps. (iOS Only)| |requiredAndroidSafetyNetDeviceAttestationType|[androidManagedAppSafetyNetDeviceAttestationType](../resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md)|Defines the Android SafetyNet Device Attestation requirement for a managed app to work. Possible values are: `none`, `basicIntegrity`, `basicIntegrityAndDeviceCertification`.|-|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetAppsVerificationType|[androidManagedAppSafetyNetAppsVerificationType](../resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md)|Defines the Android SafetyNet Apps Verification requirement for a managed app to work. Possible values are: `none`, `enabled`.|-|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customBrowserProtocol|String|A custom browser protocol to open weblink on iOS. (iOS only)| |customBrowserPackageId|String|Unique identifier of a custom browser to open weblink on Android. (Android only)| |customBrowserDisplayName|String|Friendly name of the preferred custom browser to open weblink on Android. (Android only)| The following table shows the properties that are required when you create the [ |minimumWarningCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or the user will receive a warning| |minimumWipeCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or the company data on the app will be wiped| |allowedAndroidDeviceModels|String collection|List of device models allowed, as a string, for the managed app to work. (Android Only)|-|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (Android Only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (Android Only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customDialerAppProtocol|String|Protocol of a custom dialer app to click-to-open a phone number on iOS, for example, skype:.| |customDialerAppPackageId|String|PackageId of a custom dialer app to click-to-open a phone number on Android.| |customDialerAppDisplayName|String|Friendly name of a custom dialer app to click-to-open a phone number on Android.| The following table shows the properties that are required when you create the [ |warnAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the user will receive the warning| |wipeAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the company data on the app will be wiped| |deviceLockRequired|Boolean|Defines if any kind of lock must be required on device. (android only)|-|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on device but is not set. (android only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on device but is not set. (android only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |connectToVpnOnLaunch|Boolean|Whether the app should connect to the configured VPN on launch (Android only).|-|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requireClass3Biometrics|Boolean|Require user to apply Class 3 Biometrics on their Android device.| |requirePinAfterBiometricChange|Boolean|A PIN prompt will override biometric prompts if class 3 biometrics are updated on the device.| |fingerprintAndBiometricEnabled|Boolean|Indicate to the client to enable both biometrics and fingerprints for the app.| |
v1.0 | Intune Mam Iosmanagedappprotection Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-iosmanagedappprotection-create.md | The following table shows the properties that are required when you create the i |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `oneDriveForBusiness`, `sharePoint`, `camera`, `photoLibrary`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| The following table shows the properties that are required when you create the i |exemptedAppProtocols|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|Apps in this list will be exempt from the policy and will be able to receive data from managed apps.| |minimumWipeSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data.| |allowedIosDeviceModels|String|Semicolon seperated list of device models allowed, as a string, for the managed app to work.|-|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |thirdPartyKeyboardsBlocked|Boolean|Defines if third party keyboards are allowed while accessing a managed app| |filterOpenInToOnlyManagedApps|Boolean|Defines if open-in operation is supported from the managed app to the filesharing locations selected. This setting only applies when AllowedOutboundDataTransferDestinations is set to ManagedApps and DisableProtectionOfManagedOutboundOpenInData is set to False.| |disableProtectionOfManagedOutboundOpenInData|Boolean|Disable protection of data transferred to other apps through IOS OpenIn option. This setting is only allowed to be True when AllowedOutboundDataTransferDestinations is set to ManagedApps.| |
v1.0 | Intune Mam Iosmanagedappprotection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-iosmanagedappprotection-update.md | The following table shows the properties that are required when you create the [ |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `oneDriveForBusiness`, `sharePoint`, `camera`, `photoLibrary`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| The following table shows the properties that are required when you create the [ |exemptedAppProtocols|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|Apps in this list will be exempt from the policy and will be able to receive data from managed apps.| |minimumWipeSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data.| |allowedIosDeviceModels|String|Semicolon seperated list of device models allowed, as a string, for the managed app to work.|-|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |thirdPartyKeyboardsBlocked|Boolean|Defines if third party keyboards are allowed while accessing a managed app| |filterOpenInToOnlyManagedApps|Boolean|Defines if open-in operation is supported from the managed app to the filesharing locations selected. This setting only applies when AllowedOutboundDataTransferDestinations is set to ManagedApps and DisableProtectionOfManagedOutboundOpenInData is set to False.| |disableProtectionOfManagedOutboundOpenInData|Boolean|Disable protection of data transferred to other apps through IOS OpenIn option. This setting is only allowed to be True when AllowedOutboundDataTransferDestinations is set to ManagedApps.| |
v1.0 | Intune Mam Targetedmanagedappconfiguration Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedappconfiguration-assign.md | Here is an example of the request. POST https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfigurationId}/assign Content-type: application/json-Content-length: 582 +Content-length: 599 { "assignments": [ Content-length: 582 "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "8b68c4a6-c4a6-8b68-a6c4-688ba6c4688b", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" |
v1.0 | Intune Mam Targetedmanagedapppolicyassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedapppolicyassignment-get.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 542 +Content-Length: 557 { "value": { "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "8b68c4a6-c4a6-8b68-a6c4-688ba6c4688b", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" |
v1.0 | Intune Mam Targetedmanagedapppolicyassignment List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedapppolicyassignment-list.md | Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 576 +Content-Length: 593 { "value": [ Content-Length: 576 "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "8b68c4a6-c4a6-8b68-a6c4-688ba6c4688b", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" |
v1.0 | Intune Mam Targetedmanagedapppolicyassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedapppolicyassignment-update.md | Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceAppManagement/iosManagedAppProtections/{iosManagedAppProtectionId}/assignments/{targetedManagedAppPolicyAssignmentId} Content-type: application/json-Content-length: 454 +Content-length: 467 { "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 503 +Content-Length: 516 { "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "8b68c4a6-c4a6-8b68-a6c4-688ba6c4688b", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" |
v1.0 | Intune Mam Targetedmanagedappprotection Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-targetedmanagedappprotection-assign.md | Here is an example of the request. POST https://graph.microsoft.com/beta/deviceAppManagement/managedAppPolicies/{managedAppPolicyId}/assign Content-type: application/json-Content-length: 582 +Content-length: 599 { "assignments": [ Content-length: 582 "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "8b68c4a6-c4a6-8b68-a6c4-688ba6c4688b", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" |
v1.0 | Intune Mam Windowsinformationprotection Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-windowsinformationprotection-assign.md | Here is an example of the request. POST https://graph.microsoft.com/beta/deviceAppManagement/managedAppPolicies/{managedAppPolicyId}/assign Content-type: application/json-Content-length: 582 +Content-length: 599 { "assignments": [ Content-length: 582 "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "8b68c4a6-c4a6-8b68-a6c4-688ba6c4688b", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" |
v1.0 | Intune Mam Windowsmanagedappprotection Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-windowsmanagedappprotection-assign.md | Here is an example of the request. POST https://graph.microsoft.com/beta/deviceAppManagement/windowsManagedAppProtections/{windowsManagedAppProtectionId}/assign Content-type: application/json-Content-length: 582 +Content-length: 599 { "assignments": [ Content-length: 582 "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "8b68c4a6-c4a6-8b68-a6c4-688ba6c4688b", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "Device And App Management Assignment Filter Id value", "deviceAndAppManagementAssignmentFilterType": "include",- "collectionId": "Collection Id value" + "targetType": "user", + "entraObjectId": "Entra Object Id value" }, "source": "policySets", "sourceId": "Source Id value" |
v1.0 | Intune Mam Windowsmanagedappprotection Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-windowsmanagedappprotection-create.md | The following table shows the properties that are required when you create the w |allowedInboundDataTransferSources|[windowsManagedAppDataTransferLevel](../resources/intune-mam-windowsmanagedappdatatransferlevel.md)|Indicates the sources from which data is allowed to be transferred. Some possible values are allApps or none. Possible values are: `allApps`, `none`.| |allowedOutboundClipboardSharingLevel|[windowsManagedAppClipboardSharingLevel](../resources/intune-mam-windowsmanagedappclipboardsharinglevel.md)|Indicates the level to which the clipboard may be shared across org & non-org resources. Some possible values are anyDestinationAnySource or none. Possible values are: `anyDestinationAnySource`, `none`.| |allowedOutboundDataTransferDestinations|[windowsManagedAppDataTransferLevel](../resources/intune-mam-windowsmanagedappdatatransferlevel.md)|Indicates the destinations to which data is allowed to be transferred. Some possible values are allApps or none. Possible values are: `allApps`, `none`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Some possible values are block or wipe. If this property is not set, no action will be taken. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Some possible values are block or wipe. If this property is not set, no action will be taken. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the Mobile Threat Defense app. Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Some possible values are block or wipe. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Some possible values are block or wipe. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |minimumRequiredSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data. For example: '8.1.0' or '13.1.1'.| |minimumWipeSdkVersion|String|Versions less than the specified version will wipe the managed app and the associated company data. For example: '8.1.0' or '13.1.1'.| |minimumRequiredOsVersion|String|Versions less than the specified version will block the managed app from accessing company data. For example: '8.1.0' or '13.1.1'.| |
v1.0 | Intune Mam Windowsmanagedappprotection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mam-windowsmanagedappprotection-update.md | The following table shows the properties that are required when you create the [ |allowedInboundDataTransferSources|[windowsManagedAppDataTransferLevel](../resources/intune-mam-windowsmanagedappdatatransferlevel.md)|Indicates the sources from which data is allowed to be transferred. Some possible values are allApps or none. Possible values are: `allApps`, `none`.| |allowedOutboundClipboardSharingLevel|[windowsManagedAppClipboardSharingLevel](../resources/intune-mam-windowsmanagedappclipboardsharinglevel.md)|Indicates the level to which the clipboard may be shared across org & non-org resources. Some possible values are anyDestinationAnySource or none. Possible values are: `anyDestinationAnySource`, `none`.| |allowedOutboundDataTransferDestinations|[windowsManagedAppDataTransferLevel](../resources/intune-mam-windowsmanagedappdatatransferlevel.md)|Indicates the destinations to which data is allowed to be transferred. Some possible values are allApps or none. Possible values are: `allApps`, `none`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Some possible values are block or wipe. If this property is not set, no action will be taken. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Some possible values are block or wipe. If this property is not set, no action will be taken. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the Mobile Threat Defense app. Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Some possible values are block or wipe. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Some possible values are block or wipe. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |minimumRequiredSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data. For example: '8.1.0' or '13.1.1'.| |minimumWipeSdkVersion|String|Versions less than the specified version will wipe the managed app and the associated company data. For example: '8.1.0' or '13.1.1'.| |minimumRequiredOsVersion|String|Versions less than the specified version will block the managed app from accessing company data. For example: '8.1.0' or '13.1.1'.| |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelconfiguration-create.md | Namespace: microsoft.graph Create a new [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelconfiguration-delete.md | Namespace: microsoft.graph Deletes a [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelconfiguration-get.md | Namespace: microsoft.graph Read properties and relationships of the [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelconfiguration-list.md | Namespace: microsoft.graph List properties and relationships of the [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelconfiguration-update.md | Namespace: microsoft.graph Update the properties of a [microsoftTunnelConfiguration](../resources/intune-mstunnel-microsofttunnelconfiguration.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelhealththreshold-create.md | Namespace: microsoft.graph Create a new [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelhealththreshold-delete.md | Namespace: microsoft.graph Deletes a [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelhealththreshold-get.md | Namespace: microsoft.graph Read properties and relationships of the [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelhealththreshold-list.md | Namespace: microsoft.graph List properties and relationships of the [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelhealththreshold-update.md | Namespace: microsoft.graph Update the properties of a [microsoftTunnelHealthThreshold](../resources/intune-mstunnel-microsofttunnelhealththreshold.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-create.md | Namespace: microsoft.graph Create a new [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Createserverlogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-createserverlogcollectionrequest.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-delete.md | Namespace: microsoft.graph Deletes a [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Generateserverlogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-generateserverlogcollectionrequest.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-get.md | Namespace: microsoft.graph Read properties and relationships of the [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Gethealthmetrics | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-gethealthmetrics.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Gethealthmetrictimeseries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-gethealthmetrictimeseries.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-list.md | Namespace: microsoft.graph List properties and relationships of the [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserver Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserver-update.md | Namespace: microsoft.graph Update the properties of a [microsoftTunnelServer](../resources/intune-mstunnel-microsofttunnelserver.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-create.md | Namespace: microsoft.graph Create a new [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Createdownloadurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-createdownloadurl.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-delete.md | Namespace: microsoft.graph Deletes a [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Generatedownloadurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-generatedownloadurl.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-get.md | Namespace: microsoft.graph Read properties and relationships of the [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-list.md | Namespace: microsoft.graph List properties and relationships of the [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelserverlogcollectionresponse-update.md | Namespace: microsoft.graph Update the properties of a [microsoftTunnelServerLogCollectionResponse](../resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelsite Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelsite-create.md | Namespace: microsoft.graph Create a new [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelsite Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelsite-delete.md | Namespace: microsoft.graph Deletes a [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelsite Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelsite-get.md | Namespace: microsoft.graph Read properties and relationships of the [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelsite List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelsite-list.md | Namespace: microsoft.graph List properties and relationships of the [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelsite Requestupgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelsite-requestupgrade.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Mstunnel Microsofttunnelsite Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-mstunnel-microsofttunnelsite-update.md | Namespace: microsoft.graph Update the properties of a [microsoftTunnelSite](../resources/intune-mstunnel-microsofttunnelsite.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Multidevicepivotservice Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-multidevicepivotservice-devicemanagement-get.md | + + Title: "Get deviceManagement" +description: "Read properties and relationships of the deviceManagement object." ++ms.localizationpriority: medium ++++# Get deviceManagement ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Read properties and relationships of the [deviceManagement](../resources/intune-multidevicepivotservice-devicemanagement.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement +``` ++## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-multidevicepivotservice-devicemanagement.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 79 ++{ + "value": { + "@odata.type": "#microsoft.graph.deviceManagement" + } +} +``` |
v1.0 | Intune Multidevicepivotservice Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-multidevicepivotservice-devicemanagement-update.md | + + Title: "Update deviceManagement" +description: "Update the properties of a deviceManagement object." ++ms.localizationpriority: medium ++++# Update deviceManagement ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Update the properties of a [deviceManagement](../resources/intune-multidevicepivotservice-devicemanagement.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /deviceManagement +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-multidevicepivotservice-devicemanagement.md) object. ++The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-multidevicepivotservice-devicemanagement.md). ++|Property|Type|Description| +|:|:|:| ++++## Response +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-multidevicepivotservice-devicemanagement.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/deviceManagement +Content-type: application/json +Content-length: 58 ++{ + "@odata.type": "#microsoft.graph.deviceManagement" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 58 ++{ + "@odata.type": "#microsoft.graph.deviceManagement" +} +``` |
v1.0 | Intune Odj Devicemanagementdomainjoinconnector Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-odj-devicemanagementdomainjoinconnector-create.md | Namespace: microsoft.graph Create a new [deviceManagementDomainJoinConnector](../resources/intune-odj-devicemanagementdomainjoinconnector.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Odj Devicemanagementdomainjoinconnector Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-odj-devicemanagementdomainjoinconnector-delete.md | Namespace: microsoft.graph Deletes a [deviceManagementDomainJoinConnector](../resources/intune-odj-devicemanagementdomainjoinconnector.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Odj Devicemanagementdomainjoinconnector Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-odj-devicemanagementdomainjoinconnector-get.md | Namespace: microsoft.graph Read properties and relationships of the [deviceManagementDomainJoinConnector](../resources/intune-odj-devicemanagementdomainjoinconnector.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Odj Devicemanagementdomainjoinconnector List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-odj-devicemanagementdomainjoinconnector-list.md | Namespace: microsoft.graph List properties and relationships of the [deviceManagementDomainJoinConnector](../resources/intune-odj-devicemanagementdomainjoinconnector.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Odj Devicemanagementdomainjoinconnector Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-odj-devicemanagementdomainjoinconnector-update.md | Namespace: microsoft.graph Update the properties of a [deviceManagementDomainJoinConnector](../resources/intune-odj-devicemanagementdomainjoinconnector.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage-create.md | Namespace: microsoft.graph Create a new [managedDeviceWindowsOperatingSystemImage](../resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage-delete.md | Namespace: microsoft.graph Deletes a [managedDeviceWindowsOperatingSystemImage](../resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage-get.md | Namespace: microsoft.graph Read properties and relationships of the [managedDeviceWindowsOperatingSystemImage](../resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage Getallmanageddevicewindowsosimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage-getallmanageddevicewindowsosimages.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage-list.md | Namespace: microsoft.graph List properties and relationships of the [managedDeviceWindowsOperatingSystemImage](../resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage-update.md | Namespace: microsoft.graph Update the properties of a [managedDeviceWindowsOperatingSystemImage](../resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Partnerintegration Appvulnerabilitymanageddevice Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymanageddevice-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 269 "displayName": "Display Name value", "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymanageddevice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymanageddevice-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { DELETE https://graph.microsoft.com/beta** Entity URI for microsoft.management.se Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ``` http HTTP/1.1 204 No Content-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymanageddevice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymanageddevice-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 298 "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" } }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymanageddevice List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymanageddevice-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 322 } ] }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymanageddevice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymanageddevice-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 269 "displayName": "Display Name value", "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymobileapp Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymobileapp-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 396 "mobileAppType": "Mobile App Type value", "version": "Version value" }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymobileapp Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymobileapp-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { DELETE https://graph.microsoft.com/beta** Entity URI for microsoft.management.se Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ``` http HTTP/1.1 204 No Content-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymobileapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymobileapp-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 431 "version": "Version value" } }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymobileapp List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymobileapp-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 461 } ] }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitymobileapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitymobileapp-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 396 "mobileAppType": "Mobile App Type value", "version": "Version value" }-``` +``` |
v1.0 | Intune Partnerintegration Appvulnerabilitytask Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitytask-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Appvulnerabilitytask Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitytask-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Appvulnerabilitytask Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitytask-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Appvulnerabilitytask List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitytask-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Appvulnerabilitytask Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-appvulnerabilitytask-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Configmanagercollection Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-configmanagercollection-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Configmanagercollection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-configmanagercollection-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Configmanagercollection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-configmanagercollection-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Configmanagercollection Getpolicysummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-configmanagercollection-getpolicysummary.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 276 "enforcedDeviceCount": 3 } }-``` +``` |
v1.0 | Intune Partnerintegration Configmanagercollection List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-configmanagercollection-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Configmanagercollection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-configmanagercollection-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagement-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagement-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagementtask Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagementtask-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagementtask Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagementtask-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagementtask Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagementtask-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagementtask List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagementtask-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagementtask Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagementtask-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Deviceappmanagementtask Updatestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-deviceappmanagementtask-updatestatus.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-devicemanagement-get.md | + + Title: "Get deviceManagement" +description: "Read properties and relationships of the deviceManagement object." ++ms.localizationpriority: medium ++++# Get deviceManagement ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Read properties and relationships of the [deviceManagement](../resources/intune-partnerintegration-devicemanagement.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement +``` ++## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-partnerintegration-devicemanagement.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 130 ++{ + "value": { + "@odata.type": "#microsoft.graph.deviceManagement", + "id": "0b283420-3420-0b28-2034-280b2034280b" + } +} +``` |
v1.0 | Intune Partnerintegration Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-devicemanagement-update.md | + + Title: "Update deviceManagement" +description: "Update the properties of a deviceManagement object." ++ms.localizationpriority: medium ++++# Update deviceManagement ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Update the properties of a [deviceManagement](../resources/intune-partnerintegration-devicemanagement.md) object. +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementApps.ReadWrite.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /deviceManagement +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-partnerintegration-devicemanagement.md) object. ++The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-partnerintegration-devicemanagement.md). ++|Property|Type|Description| +|:|:|:| +|id|String|Key of the entity.| ++++## Response +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-partnerintegration-devicemanagement.md) object in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/deviceManagement +Content-type: application/json +Content-length: 58 ++{ + "@odata.type": "#microsoft.graph.deviceManagement" +} +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 107 ++{ + "@odata.type": "#microsoft.graph.deviceManagement", + "id": "0b283420-3420-0b28-2034-280b2034280b" +} +``` |
v1.0 | Intune Partnerintegration Securityconfigurationtask Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-securityconfigurationtask-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the s |applicablePlatform|[endpointSecurityConfigurationApplicablePlatform](../resources/intune-partnerintegration-endpointsecurityconfigurationapplicableplatform.md)|The applicable platform. Possible values are: `unknown`, `macOS`, `windows10AndLater`, `windows10AndWindowsServer`.| |endpointSecurityPolicyProfile|[endpointSecurityConfigurationProfileType](../resources/intune-partnerintegration-endpointsecurityconfigurationprofiletype.md)|The endpoint security policy profile. Possible values are: `unknown`, `antivirus`, `windowsSecurity`, `bitLocker`, `fileVault`, `firewall`, `firewallRules`, `endpointDetectionAndResponse`, `deviceControl`, `appAndBrowserIsolation`, `exploitProtection`, `webProtection`, `applicationControl`, `attackSurfaceReductionRules`, `accountProtection`.| |insights|String|Information about the mitigation.|-|managedDeviceCount|Int32|The number of vulnerable devices. Valid values 0 to 65536| +|managedDeviceCount|Int32|The number of vulnerable devices.| |intendedSettings|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|The intended settings and their values.| |
v1.0 | Intune Partnerintegration Securityconfigurationtask Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-securityconfigurationtask-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Securityconfigurationtask Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-securityconfigurationtask-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Securityconfigurationtask List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-securityconfigurationtask-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Securityconfigurationtask Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-securityconfigurationtask-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the [ |applicablePlatform|[endpointSecurityConfigurationApplicablePlatform](../resources/intune-partnerintegration-endpointsecurityconfigurationapplicableplatform.md)|The applicable platform. Possible values are: `unknown`, `macOS`, `windows10AndLater`, `windows10AndWindowsServer`.| |endpointSecurityPolicyProfile|[endpointSecurityConfigurationProfileType](../resources/intune-partnerintegration-endpointsecurityconfigurationprofiletype.md)|The endpoint security policy profile. Possible values are: `unknown`, `antivirus`, `windowsSecurity`, `bitLocker`, `fileVault`, `firewall`, `firewallRules`, `endpointDetectionAndResponse`, `deviceControl`, `appAndBrowserIsolation`, `exploitProtection`, `webProtection`, `applicationControl`, `attackSurfaceReductionRules`, `accountProtection`.| |insights|String|Information about the mitigation.|-|managedDeviceCount|Int32|The number of vulnerable devices. Valid values 0 to 65536| +|managedDeviceCount|Int32|The number of vulnerable devices.| |intendedSettings|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|The intended settings and their values.| |
v1.0 | Intune Partnerintegration Unmanageddevicediscoverytask Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-unmanageddevicediscoverytask-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Unmanageddevicediscoverytask Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-unmanageddevicediscoverytask-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Unmanageddevicediscoverytask Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-unmanageddevicediscoverytask-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Unmanageddevicediscoverytask List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-unmanageddevicediscoverytask-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Unmanageddevicediscoverytask Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-unmanageddevicediscoverytask-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Partnerintegration Vulnerablemanageddevice Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-vulnerablemanageddevice-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 263 "displayName": "Display Name value", "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" }-``` +``` |
v1.0 | Intune Partnerintegration Vulnerablemanageddevice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-vulnerablemanageddevice-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { DELETE https://graph.microsoft.com/beta** Entity URI for microsoft.management.se Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. ``` http HTTP/1.1 204 No Content-``` +``` |
v1.0 | Intune Partnerintegration Vulnerablemanageddevice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-vulnerablemanageddevice-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 292 "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" } }-``` +``` |
v1.0 | Intune Partnerintegration Vulnerablemanageddevice List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-vulnerablemanageddevice-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 316 } ] }-``` +``` |
v1.0 | Intune Partnerintegration Vulnerablemanageddevice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-partnerintegration-vulnerablemanageddevice-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementApps.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All| +|Application|DeviceManagementApps.ReadWrite.All| ## HTTP Request <!-- { Content-Length: 263 "displayName": "Display Name value", "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00" }-``` +``` |
v1.0 | Intune Policylistingservice Deviceconfigurationprofile Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policylistingservice-deviceconfigurationprofile-create.md | - Title: "Create deviceConfigurationProfile" -description: "Create a new deviceConfigurationProfile object." ---doc_type: apiPageType ---# Create deviceConfigurationProfile --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Create a new [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/deviceConfigurationProfiles -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the deviceConfigurationProfile object. --The following table shows the properties that are required when you create the deviceConfigurationProfile. --|Property|Type|Description| -|:|:|:| -|id|String|Profile Id of the object.| -|accountId|String|Account Id.| -|lastModifiedDateTime|DateTimeOffset|The date and time the entity was last modified.| -|createdDateTime|DateTimeOffset|The date and time the object was created.| -|profileName|String|Profile name| -|profileType|[profileType](../resources/intune-policylistingservice-profiletype.md)|Profile Type. Possible values are: `settingsCatalog`, `administrativeTemplates`, `importedADMXTemplates`, `oemAppConfig`, `hardwareConfig`, `dcV1EndpointProtection`, `dcV1DeviceRestrictions`.| -|platformType|[platformType](../resources/intune-policylistingservice-platformtype.md)|Platform Type. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| -|configurationTechnologies|Int32|Configuration Technologies for Settins Catalog Policies| -|templateId|String|TemplateId for Settings Catalog Policies| -|roleScopeTagIds|String collection|The list of scope tags for the configuration.| ----## Response -If successful, this method returns a `201 Created` response code and a [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurationProfiles -Content-type: application/json -Content-length: 354 --{ - "@odata.type": "#microsoft.graph.deviceConfigurationProfile", - "accountId": "Account Id value", - "profileName": "Profile Name value", - "profileType": "administrativeTemplates", - "platformType": "android", - "configurationTechnologies": 9, - "templateId": "Template Id value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 201 Created -Content-Type: application/json -Content-Length: 526 --{ - "@odata.type": "#microsoft.graph.deviceConfigurationProfile", - "id": "1662ad38-ad38-1662-38ad-621638ad6216", - "accountId": "Account Id value", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "profileName": "Profile Name value", - "profileType": "administrativeTemplates", - "platformType": "android", - "configurationTechnologies": 9, - "templateId": "Template Id value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] -} -``` |
v1.0 | Intune Policylistingservice Deviceconfigurationprofile Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policylistingservice-deviceconfigurationprofile-delete.md | - Title: "Delete deviceConfigurationProfile" -description: "Deletes a deviceConfigurationProfile." ---doc_type: apiPageType ---# Delete deviceConfigurationProfile --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Deletes a [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md). ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -DELETE /deviceManagement/deviceConfigurationProfiles/{deviceConfigurationProfileId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `204 No Content` response code. --## Example --### Request -Here is an example of the request. -``` http -DELETE https://graph.microsoft.com/beta/deviceManagement/deviceConfigurationProfiles/{deviceConfigurationProfileId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Intune Policylistingservice Deviceconfigurationprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policylistingservice-deviceconfigurationprofile-get.md | - Title: "Get deviceConfigurationProfile" -description: "Read properties and relationships of the deviceConfigurationProfile object." ---doc_type: apiPageType ---# Get deviceConfigurationProfile --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Read properties and relationships of the [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceConfigurationProfiles/{deviceConfigurationProfileId} -``` --## Optional query parameters -This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurationProfiles/{deviceConfigurationProfileId} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 571 --{ - "value": { - "@odata.type": "#microsoft.graph.deviceConfigurationProfile", - "id": "1662ad38-ad38-1662-38ad-621638ad6216", - "accountId": "Account Id value", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "profileName": "Profile Name value", - "profileType": "administrativeTemplates", - "platformType": "android", - "configurationTechnologies": 9, - "templateId": "Template Id value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] - } -} -``` |
v1.0 | Intune Policylistingservice Deviceconfigurationprofile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policylistingservice-deviceconfigurationprofile-list.md | - Title: "List deviceConfigurationProfiles" -description: "List properties and relationships of the deviceConfigurationProfile objects." ---doc_type: apiPageType ---# List deviceConfigurationProfiles --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --List properties and relationships of the [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) objects. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -GET /deviceManagement/deviceConfigurationProfiles -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -Do not supply a request body for this method. --## Response -If successful, this method returns a `200 OK` response code and a collection of [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) objects in the response body. --## Example --### Request -Here is an example of the request. -``` http -GET https://graph.microsoft.com/beta/deviceManagement/deviceConfigurationProfiles -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 611 --{ - "value": [ - { - "@odata.type": "#microsoft.graph.deviceConfigurationProfile", - "id": "1662ad38-ad38-1662-38ad-621638ad6216", - "accountId": "Account Id value", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "profileName": "Profile Name value", - "profileType": "administrativeTemplates", - "platformType": "android", - "configurationTechnologies": 9, - "templateId": "Template Id value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] - } - ] -} -``` |
v1.0 | Intune Policylistingservice Deviceconfigurationprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-policylistingservice-deviceconfigurationprofile-update.md | - Title: "Update deviceConfigurationProfile" -description: "Update the properties of a deviceConfigurationProfile object." ---doc_type: apiPageType ---# Update deviceConfigurationProfile --Namespace: microsoft.graph --> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Update the properties of a [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object. ---## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). --|Permission type|Permissions (from least to most privileged)| -|:|:| -|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.| -|Application|DeviceManagementConfiguration.ReadWrite.All| --## HTTP Request -<!-- { - "blockType": "ignored" -} >-``` http -PATCH /deviceManagement/deviceConfigurationProfiles/{deviceConfigurationProfileId} -``` --## Request headers -|Header|Value| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| -|Accept|application/json| --## Request body -In the request body, supply a JSON representation for the [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object. --The following table shows the properties that are required when you create the [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md). --|Property|Type|Description| -|:|:|:| -|id|String|Profile Id of the object.| -|accountId|String|Account Id.| -|lastModifiedDateTime|DateTimeOffset|The date and time the entity was last modified.| -|createdDateTime|DateTimeOffset|The date and time the object was created.| -|profileName|String|Profile name| -|profileType|[profileType](../resources/intune-policylistingservice-profiletype.md)|Profile Type. Possible values are: `settingsCatalog`, `administrativeTemplates`, `importedADMXTemplates`, `oemAppConfig`, `hardwareConfig`, `dcV1EndpointProtection`, `dcV1DeviceRestrictions`.| -|platformType|[platformType](../resources/intune-policylistingservice-platformtype.md)|Platform Type. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| -|configurationTechnologies|Int32|Configuration Technologies for Settins Catalog Policies| -|templateId|String|TemplateId for Settings Catalog Policies| -|roleScopeTagIds|String collection|The list of scope tags for the configuration.| ----## Response -If successful, this method returns a `200 OK` response code and an updated [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object in the response body. --## Example --### Request -Here is an example of the request. -``` http -PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurationProfiles/{deviceConfigurationProfileId} -Content-type: application/json -Content-length: 354 --{ - "@odata.type": "#microsoft.graph.deviceConfigurationProfile", - "accountId": "Account Id value", - "profileName": "Profile Name value", - "profileType": "administrativeTemplates", - "platformType": "android", - "configurationTechnologies": 9, - "templateId": "Template Id value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] -} -``` --### Response -Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. -``` http -HTTP/1.1 200 OK -Content-Type: application/json -Content-Length: 526 --{ - "@odata.type": "#microsoft.graph.deviceConfigurationProfile", - "id": "1662ad38-ad38-1662-38ad-621638ad6216", - "accountId": "Account Id value", - "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", - "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", - "profileName": "Profile Name value", - "profileType": "administrativeTemplates", - "platformType": "android", - "configurationTechnologies": 9, - "templateId": "Template Id value", - "roleScopeTagIds": [ - "Role Scope Tag Ids value" - ] -} -``` |
v1.0 | Intune Rbac Devicemanagement Retrieveuserroledetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-rbac-devicemanagement-retrieveuserroledetail.md | + + Title: "retrieveUserRoleDetail function" +description: "Intune Rbac Devicemanagement Retrieveuserroledetail Api ." ++ms.localizationpriority: medium ++++# retrieveUserRoleDetail function ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. +++++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /deviceManagement/retrieveUserRoleDetail +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +In the request URL, provide the following query parameters with values. +The following table shows the parameters that can be used with this function. ++|Property|Type|Description| +|:|:|:| +|userid|String|| ++++## Response +If successful, this function returns a `200 OK` response code and a [deviceAndAppManagementAssignedRoleDetail](../resources/intune-rbac-deviceandappmanagementassignedroledetail.md) in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/retrieveUserRoleDetail(userid='parameterValue') +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 443 ++{ + "value": { + "@odata.type": "microsoft.graph.deviceAndAppManagementAssignedRoleDetail", + "roleDefinitions": [ + { + "@odata.type": "microsoft.graph.deviceAndAppManagementAssignedRoleDefinition", + "roleDefinitionDisplayName": "Role Definition Display Name value", + "permissions": [ + "Permissions value" + ] + } + ], + "permissions": [ + "Permissions value" + ] + } +} +``` |
v1.0 | Intune Reporting Devicemanagementreports Getcachedreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getcachedreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |id|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| Content-length: 209 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3 } |
v1.0 | Intune Reporting Devicemanagementreports Getcompliancepolicynoncompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getcompliancepolicynoncompliancereport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getcompliancepolicynoncompliancesummaryreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getcompliancepolicynoncompliancesummaryreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getcompliancesettingnoncompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getcompliancesettingnoncompliancereport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getconfigurationpolicynoncompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getconfigurationpolicynoncompliancereport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getconfigurationpolicynoncompliancesummaryreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getconfigurationpolicynoncompliancesummaryreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getconfigurationsettingnoncompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getconfigurationsettingnoncompliancereport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicemanagementintentpersettingcontributingprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicemanagementintentpersettingcontributingprofiles.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicemanagementintentsettingsreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicemanagementintentsettingsreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicenoncompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicenoncompliancereport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicepoliciescompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicepoliciescompliancereport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicepolicysettingscompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicepolicysettingscompliancereport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicesstatusbypolicyplatformcompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicesstatusbypolicyplatformcompliancereport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicesstatusbysettingreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicesstatusbysettingreport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicestatusbycompliacepolicyreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicestatusbycompliacepolicyreport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicestatusbycompliancepolicysettingreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicestatusbycompliancepolicysettingreport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicestatussummarybycompliacepolicyreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicestatussummarybycompliacepolicyreport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdevicestatussummarybycompliancepolicysettingsreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdevicestatussummarybycompliancepolicysettingsreport.md | The following table shows the parameters that can be used with this action. |Property|Type|Description| |:|:|:| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 253 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getdeviceswithoutcompliancepolicyreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getdeviceswithoutcompliancepolicyreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Gethistoricalreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-gethistoricalreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |filter|String|| Content-length: 242 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "filter": "Filter value" |
v1.0 | Intune Reporting Devicemanagementreports Getnoncompliantdevicesandsettingsreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getnoncompliantdevicesandsettingsreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getpolicynoncompliancemetadata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getpolicynoncompliancemetadata.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getpolicynoncompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getpolicynoncompliancereport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getpolicynoncompliancesummaryreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getpolicynoncompliancesummaryreport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getreportfilters | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getreportfilters.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Reporting Devicemanagementreports Getsettingnoncompliancereport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-reporting-devicemanagementreports-getsettingnoncompliancereport.md | The following table shows the parameters that can be used with this action. |:|:|:| |name|String|| |select|String collection||-|search|String|| |groupBy|String collection|| |orderBy|String collection||+|search|String|| |skip|Int32|| |top|Int32|| |sessionId|String|| Content-length: 278 "select": [ "Select value" ],- "search": "Search value", "groupBy": [ "Group By value" ], "orderBy": [ "Order By value" ],+ "search": "Search value", "skip": 4, "top": 3, "sessionId": "Session Id value", |
v1.0 | Intune Troubleshooting Applevpptokentroubleshootingevent Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-applevpptokentroubleshootingevent-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Applevpptokentroubleshootingevent Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-applevpptokentroubleshootingevent-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Applevpptokentroubleshootingevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-applevpptokentroubleshootingevent-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Applevpptokentroubleshootingevent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-applevpptokentroubleshootingevent-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Applevpptokentroubleshootingevent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-applevpptokentroubleshootingevent-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Devicemanagement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagement-get.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Read properties and relationships of the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. +Read properties and relationships of the [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { This method supports the [OData Query Parameters](/graph/query-parameters) to he Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting Devicemanagement Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagement-update.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Update the properties of a [deviceManagement](../resources/intune-shared-devicemanagement.md) object. +Update the properties of a [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { PATCH /deviceManagement |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-shared-devicemanagement.md) object. +In the request body, supply a JSON representation for the [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object. -The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-shared-devicemanagement.md). +The following table shows the properties that are required when you create the [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md). |Property|Type|Description| |:|:|:| The following table shows the properties that are required when you create the [ ## Response-If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-shared-devicemanagement.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [deviceManagement](../resources/intune-troubleshooting-devicemanagement.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting Devicemanagementautopilotevent Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementautopilotevent-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the d |:|:|:| |id|String|UUID for the object| |deviceId|String|Device id associated with the object|+|userId|String|UserId id associated with the object| |eventDateTime|DateTimeOffset|Time when the event occurred .| |deviceRegisteredDateTime|DateTimeOffset|Device registration date.| |enrollmentStartDateTime|DateTimeOffset|Device enrollment start date.| The following table shows the properties that are required when you create the d |osVersion|String|Device operating system version.| |deploymentDuration|Duration|Autopilot deployment duration including enrollment.| |deploymentTotalDuration|Duration|Total deployment duration from enrollment to Desktop screen.|-|devicePreparationDuration|Duration|Time spent in device enrollment.| |deviceSetupDuration|Duration|Time spent in device ESP.| |accountSetupDuration|Duration|Time spent in user ESP.| |deploymentStartDateTime|DateTimeOffset|Deployment start time.| |deploymentEndDateTime|DateTimeOffset|Deployment end time.|-|targetedAppCount|Int32|Count of applications targeted.| -|targetedPolicyCount|Int32|Count of policies targeted.| |enrollmentFailureDetails|String|Enrollment failure details.| Here is an example of the request. ``` http POST https://graph.microsoft.com/beta/deviceManagement/autopilotEvents Content-type: application/json-Content-length: 1545 +Content-length: 1468 { "@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent", "deviceId": "Device Id value",+ "userId": "User Id value", "eventDateTime": "2016-12-31T23:59:23.3984029-08:00", "deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00", "enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00", Content-length: 1545 "osVersion": "Os Version value", "deploymentDuration": "PT3M21.5549443S", "deploymentTotalDuration": "PT1M43.5284261S",- "devicePreparationDuration": "-PT1M32.1347897S", "deviceSetupDuration": "-PT2M57.2190107S", "accountSetupDuration": "-PT2M32.0507894S", "deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00", "deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",- "targetedAppCount": 0, - "targetedPolicyCount": 3, "enrollmentFailureDetails": "Enrollment Failure Details value" } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 201 Created Content-Type: application/json-Content-Length: 1594 +Content-Length: 1517 { "@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent", "id": "3e455cab-5cab-3e45-ab5c-453eab5c453e", "deviceId": "Device Id value",+ "userId": "User Id value", "eventDateTime": "2016-12-31T23:59:23.3984029-08:00", "deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00", "enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00", Content-Length: 1594 "osVersion": "Os Version value", "deploymentDuration": "PT3M21.5549443S", "deploymentTotalDuration": "PT1M43.5284261S",- "devicePreparationDuration": "-PT1M32.1347897S", "deviceSetupDuration": "-PT2M57.2190107S", "accountSetupDuration": "-PT2M32.0507894S", "deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00", "deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",- "targetedAppCount": 0, - "targetedPolicyCount": 3, "enrollmentFailureDetails": "Enrollment Failure Details value" } ``` |
v1.0 | Intune Troubleshooting Devicemanagementautopilotevent Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementautopilotevent-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Devicemanagementautopilotevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementautopilotevent-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1669 +Content-Length: 1588 { "value": { "@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent", "id": "3e455cab-5cab-3e45-ab5c-453eab5c453e", "deviceId": "Device Id value",+ "userId": "User Id value", "eventDateTime": "2016-12-31T23:59:23.3984029-08:00", "deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00", "enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00", Content-Length: 1669 "osVersion": "Os Version value", "deploymentDuration": "PT3M21.5549443S", "deploymentTotalDuration": "PT1M43.5284261S",- "devicePreparationDuration": "-PT1M32.1347897S", "deviceSetupDuration": "-PT2M57.2190107S", "accountSetupDuration": "-PT2M32.0507894S", "deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00", "deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",- "targetedAppCount": 0, - "targetedPolicyCount": 3, "enrollmentFailureDetails": "Enrollment Failure Details value" } } |
v1.0 | Intune Troubleshooting Devicemanagementautopilotevent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementautopilotevent-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1739 +Content-Length: 1654 { "value": [ Content-Length: 1739 "@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent", "id": "3e455cab-5cab-3e45-ab5c-453eab5c453e", "deviceId": "Device Id value",+ "userId": "User Id value", "eventDateTime": "2016-12-31T23:59:23.3984029-08:00", "deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00", "enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00", Content-Length: 1739 "osVersion": "Os Version value", "deploymentDuration": "PT3M21.5549443S", "deploymentTotalDuration": "PT1M43.5284261S",- "devicePreparationDuration": "-PT1M32.1347897S", "deviceSetupDuration": "-PT2M57.2190107S", "accountSetupDuration": "-PT2M32.0507894S", "deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00", "deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",- "targetedAppCount": 0, - "targetedPolicyCount": 3, "enrollmentFailureDetails": "Enrollment Failure Details value" } ] |
v1.0 | Intune Troubleshooting Devicemanagementautopilotevent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementautopilotevent-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the [ |:|:|:| |id|String|UUID for the object| |deviceId|String|Device id associated with the object|+|userId|String|UserId id associated with the object| |eventDateTime|DateTimeOffset|Time when the event occurred .| |deviceRegisteredDateTime|DateTimeOffset|Device registration date.| |enrollmentStartDateTime|DateTimeOffset|Device enrollment start date.| The following table shows the properties that are required when you create the [ |osVersion|String|Device operating system version.| |deploymentDuration|Duration|Autopilot deployment duration including enrollment.| |deploymentTotalDuration|Duration|Total deployment duration from enrollment to Desktop screen.|-|devicePreparationDuration|Duration|Time spent in device enrollment.| |deviceSetupDuration|Duration|Time spent in device ESP.| |accountSetupDuration|Duration|Time spent in user ESP.| |deploymentStartDateTime|DateTimeOffset|Deployment start time.| |deploymentEndDateTime|DateTimeOffset|Deployment end time.|-|targetedAppCount|Int32|Count of applications targeted.| -|targetedPolicyCount|Int32|Count of policies targeted.| |enrollmentFailureDetails|String|Enrollment failure details.| Here is an example of the request. ``` http PATCH https://graph.microsoft.com/beta/deviceManagement/autopilotEvents/{deviceManagementAutopilotEventId} Content-type: application/json-Content-length: 1545 +Content-length: 1468 { "@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent", "deviceId": "Device Id value",+ "userId": "User Id value", "eventDateTime": "2016-12-31T23:59:23.3984029-08:00", "deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00", "enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00", Content-length: 1545 "osVersion": "Os Version value", "deploymentDuration": "PT3M21.5549443S", "deploymentTotalDuration": "PT1M43.5284261S",- "devicePreparationDuration": "-PT1M32.1347897S", "deviceSetupDuration": "-PT2M57.2190107S", "accountSetupDuration": "-PT2M32.0507894S", "deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00", "deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",- "targetedAppCount": 0, - "targetedPolicyCount": 3, "enrollmentFailureDetails": "Enrollment Failure Details value" } ``` Here is an example of the response. Note: The response object shown here may be ``` http HTTP/1.1 200 OK Content-Type: application/json-Content-Length: 1594 +Content-Length: 1517 { "@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent", "id": "3e455cab-5cab-3e45-ab5c-453eab5c453e", "deviceId": "Device Id value",+ "userId": "User Id value", "eventDateTime": "2016-12-31T23:59:23.3984029-08:00", "deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00", "enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00", Content-Length: 1594 "osVersion": "Os Version value", "deploymentDuration": "PT3M21.5549443S", "deploymentTotalDuration": "PT1M43.5284261S",- "devicePreparationDuration": "-PT1M32.1347897S", "deviceSetupDuration": "-PT2M57.2190107S", "accountSetupDuration": "-PT2M32.0507894S", "deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00", "deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",- "targetedAppCount": 0, - "targetedPolicyCount": 3, "enrollmentFailureDetails": "Enrollment Failure Details value" } ``` |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingevent Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementtroubleshootingevent-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingevent Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementtroubleshootingevent-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementtroubleshootingevent-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingevent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementtroubleshootingevent-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingevent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-devicemanagementtroubleshootingevent-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Enrollmenttroubleshootingevent Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-enrollmenttroubleshootingevent-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the e |osVersion|String|OS Version.| |userId|String|Identifier for the user that tried to enroll the device.| |deviceId|String|Azure AD device identifier.|-|enrollmentType|[deviceEnrollmentType](../resources/intune-troubleshooting-deviceenrollmenttype.md)|Type of the enrollment. Possible values are: `unknown`, `userEnrollment`, `deviceEnrollmentManager`, `appleBulkWithUser`, `appleBulkWithoutUser`, `windowsAzureADJoin`, `windowsBulkUserless`, `windowsAutoEnrollment`, `windowsBulkAzureDomainJoin`, `windowsCoManagement`, `windowsAzureADJoinUsingDeviceAuth`, `appleUserEnrollment`, `appleUserEnrollmentWithServiceAccount`, `azureAdJoinUsingAzureVmExtension`, `androidEnterpriseDedicatedDevice`, `androidEnterpriseFullyManaged`, `androidEnterpriseCorporateWorkProfile`.| +|enrollmentType|[deviceEnrollmentType](../resources/intune-troubleshooting-deviceenrollmenttype.md)|Type of the enrollment. Possible values are: `unknown`, `userEnrollment`, `deviceEnrollmentManager`, `appleBulkWithUser`, `appleBulkWithoutUser`, `windowsAzureADJoin`, `windowsBulkUserless`, `windowsAutoEnrollment`, `windowsBulkAzureDomainJoin`, `windowsCoManagement`, `windowsAzureADJoinUsingDeviceAuth`, `appleUserEnrollment`, `appleUserEnrollmentWithServiceAccount`, `azureAdJoinUsingAzureVmExtension`, `androidEnterpriseDedicatedDevice`, `androidEnterpriseFullyManaged`, `androidEnterpriseCorporateWorkProfile`, `appleACMEBasicBYOD`, `appleACMEDEPUserless`, `appleACMEDEPUDACompanyPortal`, `appleACMEDEPUDASetupAsstLegacy`, `appleACMEDEPUDAModernAuth`.| |failureCategory|[deviceEnrollmentFailureReason](../resources/intune-troubleshooting-deviceenrollmentfailurereason.md)|Highlevel failure category. Possible values are: `unknown`, `authentication`, `authorization`, `accountValidation`, `userValidation`, `deviceNotSupported`, `inMaintenance`, `badRequest`, `featureNotSupported`, `enrollmentRestrictionsEnforced`, `clientDisconnected`, `userAbandonment`.| |failureReason|String|Detailed failure reason.| |
v1.0 | Intune Troubleshooting Enrollmenttroubleshootingevent Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-enrollmenttroubleshootingevent-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Enrollmenttroubleshootingevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-enrollmenttroubleshootingevent-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Enrollmenttroubleshootingevent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-enrollmenttroubleshootingevent-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Enrollmenttroubleshootingevent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-enrollmenttroubleshootingevent-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the [ |osVersion|String|OS Version.| |userId|String|Identifier for the user that tried to enroll the device.| |deviceId|String|Azure AD device identifier.|-|enrollmentType|[deviceEnrollmentType](../resources/intune-troubleshooting-deviceenrollmenttype.md)|Type of the enrollment. Possible values are: `unknown`, `userEnrollment`, `deviceEnrollmentManager`, `appleBulkWithUser`, `appleBulkWithoutUser`, `windowsAzureADJoin`, `windowsBulkUserless`, `windowsAutoEnrollment`, `windowsBulkAzureDomainJoin`, `windowsCoManagement`, `windowsAzureADJoinUsingDeviceAuth`, `appleUserEnrollment`, `appleUserEnrollmentWithServiceAccount`, `azureAdJoinUsingAzureVmExtension`, `androidEnterpriseDedicatedDevice`, `androidEnterpriseFullyManaged`, `androidEnterpriseCorporateWorkProfile`.| +|enrollmentType|[deviceEnrollmentType](../resources/intune-troubleshooting-deviceenrollmenttype.md)|Type of the enrollment. Possible values are: `unknown`, `userEnrollment`, `deviceEnrollmentManager`, `appleBulkWithUser`, `appleBulkWithoutUser`, `windowsAzureADJoin`, `windowsBulkUserless`, `windowsAutoEnrollment`, `windowsBulkAzureDomainJoin`, `windowsCoManagement`, `windowsAzureADJoinUsingDeviceAuth`, `appleUserEnrollment`, `appleUserEnrollmentWithServiceAccount`, `azureAdJoinUsingAzureVmExtension`, `androidEnterpriseDedicatedDevice`, `androidEnterpriseFullyManaged`, `androidEnterpriseCorporateWorkProfile`, `appleACMEBasicBYOD`, `appleACMEDEPUserless`, `appleACMEDEPUDACompanyPortal`, `appleACMEDEPUDASetupAsstLegacy`, `appleACMEDEPUDAModernAuth`.| |failureCategory|[deviceEnrollmentFailureReason](../resources/intune-troubleshooting-deviceenrollmentfailurereason.md)|Highlevel failure category. Possible values are: `unknown`, `authentication`, `authorization`, `accountValidation`, `userValidation`, `deviceNotSupported`, `inMaintenance`, `badRequest`, `featureNotSupported`, `enrollmentRestrictionsEnforced`, `clientDisconnected`, `userAbandonment`.| |failureReason|String|Detailed failure reason.| |
v1.0 | Intune Troubleshooting Mobileappintentandstate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileappintentandstate-create.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Mobileappintentandstate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileappintentandstate-delete.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Mobileappintentandstate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileappintentandstate-get.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Mobileappintentandstate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileappintentandstate-list.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Mobileappintentandstate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileappintentandstate-update.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingevent Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileapptroubleshootingevent-create.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Create a new [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. +Create a new [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the m ## Response-If successful, this method returns a `201 Created` response code and a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingevent Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileapptroubleshootingevent-delete.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Deletes a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md). +Deletes a [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingevent Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileapptroubleshootingevent-get.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. +Read properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { This method supports the [OData Query Parameters](/graph/query-parameters) to he Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `200 OK` response code and [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingevent List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileapptroubleshootingevent-list.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) objects. +List properties and relationships of the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { GET /users/{usersId}/mobileAppTroubleshootingEvents Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) objects in the response body. ## Example |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingevent Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-mobileapptroubleshootingevent-update.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. +Update the properties of a [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { PATCH /users/{usersId}/mobileAppTroubleshootingEvents/{mobileAppTroubleshootingE |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object. +In the request body, supply a JSON representation for the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object. -The following table shows the properties that are required when you create the [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md). +The following table shows the properties that are required when you create the [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md). |Property|Type|Description| |:|:|:| The following table shows the properties that are required when you create the [ ## Response-If successful, this method returns a `200 OK` response code and an updated [mobileAppTroubleshootingEvent](../resources/intune-shared-mobileapptroubleshootingevent.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [mobileAppTroubleshootingEvent](../resources/intune-troubleshooting-mobileapptroubleshootingevent.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting Reportroot Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-reportroot-get.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Read properties and relationships of the [reportRoot](../resources/intune-shared-reportroot.md) object. +Read properties and relationships of the [reportRoot](../resources/intune-troubleshooting-reportroot.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { This method supports the [OData Query Parameters](/graph/query-parameters) to he Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and [reportRoot](../resources/intune-shared-reportroot.md) object in the response body. +If successful, this method returns a `200 OK` response code and [reportRoot](../resources/intune-troubleshooting-reportroot.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting Reportroot Manageddeviceenrollmentabandonmentdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-reportroot-manageddeviceenrollmentabandonmentdetails.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the parameters that can be used with this function. ## Response-If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-troubleshooting-report.md) in the response body. ## Example Content-Length: 136 "content": "Y29udGVudCBJbnR1bmUgRG9jIFNhbXBsZSAxNTYxOTcwNjY1" } }-``` +``` |
v1.0 | Intune Troubleshooting Reportroot Manageddeviceenrollmentabandonmentsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-reportroot-manageddeviceenrollmentabandonmentsummary.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the parameters that can be used with this function. ## Response-If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-troubleshooting-report.md) in the response body. ## Example Content-Length: 136 "content": "Y29udGVudCBJbnR1bmUgRG9jIFNhbXBsZSAxNTYxOTcwNjY1" } }-``` +``` |
v1.0 | Intune Troubleshooting Reportroot Manageddeviceenrollmentfailuredetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuredetails.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the parameters that can be used with this function. ## Response-If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-troubleshooting-report.md) in the response body. ## Example |
v1.0 | Intune Troubleshooting Reportroot Manageddeviceenrollmentfailuretrends | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-reportroot-manageddeviceenrollmentfailuretrends.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { GET /reports/managedDeviceEnrollmentFailureTrends Do not supply a request body for this method. ## Response-If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-troubleshooting-report.md) in the response body. ## Example |
v1.0 | Intune Troubleshooting Reportroot Manageddeviceenrollmenttopfailures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-reportroot-manageddeviceenrollmenttopfailures.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the parameters that can be used with this function. ## Response-If successful, this function returns a `200 OK` response code and a [report](../resources/intune-shared-report.md) in the response body. +If successful, this function returns a `200 OK` response code and a [report](../resources/intune-troubleshooting-report.md) in the response body. ## Example |
v1.0 | Intune Troubleshooting Reportroot Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-reportroot-update.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Update the properties of a [reportRoot](../resources/intune-shared-reportroot.md) object. +Update the properties of a [reportRoot](../resources/intune-troubleshooting-reportroot.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { PATCH /reports |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [reportRoot](../resources/intune-shared-reportroot.md) object. +In the request body, supply a JSON representation for the [reportRoot](../resources/intune-troubleshooting-reportroot.md) object. -The following table shows the properties that are required when you create the [reportRoot](../resources/intune-shared-reportroot.md). +The following table shows the properties that are required when you create the [reportRoot](../resources/intune-troubleshooting-reportroot.md). |Property|Type|Description| |:|:|:| The following table shows the properties that are required when you create the [ ## Response-If successful, this method returns a `200 OK` response code and an updated [reportRoot](../resources/intune-shared-reportroot.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [reportRoot](../resources/intune-troubleshooting-reportroot.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting User Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-create.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Create a new [user](../resources/intune-shared-user.md) object. +Create a new [user](../resources/intune-troubleshooting-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { The following table shows the properties that are required when you create the u ## Response-If successful, this method returns a `201 Created` response code and a [user](../resources/intune-shared-user.md) object in the response body. +If successful, this method returns a `201 Created` response code and a [user](../resources/intune-troubleshooting-user.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting User Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-delete.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Deletes a [user](../resources/intune-shared-user.md). +Deletes a [user](../resources/intune-troubleshooting-user.md). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-get.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Read properties and relationships of the [user](../resources/intune-shared-user.md) object. +Read properties and relationships of the [user](../resources/intune-troubleshooting-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { This method supports the [OData Query Parameters](/graph/query-parameters) to he Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and [user](../resources/intune-shared-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and [user](../resources/intune-troubleshooting-user.md) object in the response body. ## Example |
v1.0 | Intune Troubleshooting User Getmanageddeviceswithappfailures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-getmanageddeviceswithappfailures.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting User Getmanageddeviceswithfailedorpendingapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-getmanageddeviceswithfailedorpendingapps.md | One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { |
v1.0 | Intune Troubleshooting User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-list.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -List properties and relationships of the [user](../resources/intune-shared-user.md) objects. +List properties and relationships of the [user](../resources/intune-troubleshooting-user.md) objects. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { GET /users Do not supply a request body for this method. ## Response-If successful, this method returns a `200 OK` response code and a collection of [user](../resources/intune-shared-user.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [user](../resources/intune-troubleshooting-user.md) objects in the response body. ## Example |
v1.0 | Intune Troubleshooting User Retrievemanageddeviceswithappinstallationissues | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-retrievemanageddeviceswithappinstallationissues.md | + + Title: "retrieveManagedDevicesWithAppInstallationIssues function" +description: "Retrieves the list of devices with failed or pending apps" ++ms.localizationpriority: medium ++++# retrieveManagedDevicesWithAppInstallationIssues function ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Retrieves the list of devices with failed or pending apps +++## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). ++|Permission type|Permissions (from least to most privileged)| +|:|:| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| ++## HTTP Request +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /users/{usersId}/retrieveManagedDevicesWithAppInstallationIssues +``` ++## Request headers +|Header|Value| +|:|:| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| ++## Request body +Do not supply a request body for this method. ++## Response +If successful, this function returns a `200 OK` response code and a [managedDeviceSummarizedAppState](../resources/intune-troubleshooting-manageddevicesummarizedappstate.md) collection in the response body. ++## Example ++### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/users/{usersId}/retrieveManagedDevicesWithAppInstallationIssues +``` ++### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 187 ++{ + "value": [ + { + "@odata.type": "microsoft.graph.managedDeviceSummarizedAppState", + "summarizedAppState": "success", + "deviceId": "Device Id value" + } + ] +} +``` |
v1.0 | Intune Troubleshooting User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-troubleshooting-user-update.md | Namespace: microsoft.graph > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. -Update the properties of a [user](../resources/intune-shared-user.md) object. +Update the properties of a [user](../resources/intune-troubleshooting-user.md) object. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] One of the following permissions is required to call this API. To learn more, in |Permission type|Permissions (from least to most privileged)| |:|:|-|Delegated (work or school account)|DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (work or school account)|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| |Delegated (personal Microsoft account)|Not supported.|-|Application|DeviceManagementManagedDevices.ReadWrite.All| +|Application|DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All| ## HTTP Request <!-- { PATCH /users/{usersId} |Accept|application/json| ## Request body-In the request body, supply a JSON representation for the [user](../resources/intune-shared-user.md) object. +In the request body, supply a JSON representation for the [user](../resources/intune-troubleshooting-user.md) object. -The following table shows the properties that are required when you create the [user](../resources/intune-shared-user.md). +The following table shows the properties that are required when you create the [user](../resources/intune-troubleshooting-user.md). |Property|Type|Description| |:|:|:| The following table shows the properties that are required when you create the [ ## Response-If successful, this method returns a `200 OK` response code and an updated [user](../resources/intune-shared-user.md) object in the response body. +If successful, this method returns a `200 OK` response code and an updated [user](../resources/intune-troubleshooting-user.md) object in the response body. ## Example |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy Assign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy-assign.md | Namespace: microsoft.graph ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy-create.md | Namespace: microsoft.graph Create a new [windowsDefenderApplicationControlSupplementalPolicy](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy-delete.md | Namespace: microsoft.graph Deletes a [windowsDefenderApplicationControlSupplementalPolicy](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy-get.md | Namespace: microsoft.graph Read properties and relationships of the [windowsDefenderApplicationControlSupplementalPolicy](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy-list.md | Namespace: microsoft.graph List properties and relationships of the [windowsDefenderApplicationControlSupplementalPolicy](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy-update.md | Namespace: microsoft.graph Update the properties of a [windowsDefenderApplicationControlSupplementalPolicy](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicyassignment Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment-create.md | Namespace: microsoft.graph Create a new [windowsDefenderApplicationControlSupplementalPolicyAssignment](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicyassignment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment-delete.md | Namespace: microsoft.graph Deletes a [windowsDefenderApplicationControlSupplementalPolicyAssignment](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicyassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment-get.md | Namespace: microsoft.graph Read properties and relationships of the [windowsDefenderApplicationControlSupplementalPolicyAssignment](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicyassignment List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment-list.md | Namespace: microsoft.graph List properties and relationships of the [windowsDefenderApplicationControlSupplementalPolicyAssignment](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicyassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment-update.md | Namespace: microsoft.graph Update the properties of a [windowsDefenderApplicationControlSupplementalPolicyAssignment](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus-create.md | Namespace: microsoft.graph Create a new [windowsDefenderApplicationControlSupplementalPolicyDeploymentStatus](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus-delete.md | Namespace: microsoft.graph Deletes a [windowsDefenderApplicationControlSupplementalPolicyDeploymentStatus](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus.md). ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus-get.md | Namespace: microsoft.graph Read properties and relationships of the [windowsDefenderApplicationControlSupplementalPolicyDeploymentStatus](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus-list.md | Namespace: microsoft.graph List properties and relationships of the [windowsDefenderApplicationControlSupplementalPolicyDeploymentStatus](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus.md) objects. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus-update.md | Namespace: microsoft.graph Update the properties of a [windowsDefenderApplicationControlSupplementalPolicyDeploymentStatus](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary-get.md | Namespace: microsoft.graph Read properties and relationships of the [windowsDefenderApplicationControlSupplementalPolicyDeploymentSummary](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary-update.md | Namespace: microsoft.graph Update the properties of a [windowsDefenderApplicationControlSupplementalPolicyDeploymentSummary](../resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary.md) object. ## Permissions One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). |
v1.0 | Invitation Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/invitation-post.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new [invitation](../resources/invitation.md) or reset the redemption status for a guest user who already redeemed their invitation. The invitation adds an external user to the organization. +Create a new [invitation](../resources/invitation.md) or reset the redemption status for a guest user who already redeemed their invitation. The invitation adds the external user to the organization as part of B2B collaboration. B2B collaboration is supported in both Microsoft Entra External ID in workforce and external tenants. The following options are available for creating an invitation: Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/invitation-post-permissions.md)] > [!IMPORTANT]-> Application permissions (app-only) do not work if B2B invitations are disabled on the tenant or if B2B invitations are restricted to administrators. --When resetting the redemption status for a guest user, the *User.ReadWrite.All* permission is the least privileged permission for the operation. --For delegated scenarios, the signed-in user must have at least the *Guest Inviter*, *Directory Writers*, or *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). To reset the redemption status, the signed-in user must have at least the *Helpdesk Administrator* or *User Administrator* role. +> +> 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: +> - To invite guests: +> - Both nonadmin member users and guest users can invite guests if the tenant admin hasn't restricted the [default user permissions](/entra/fundamentals/users-default-permissions?toc=%2Fgraph%2Ftoc.json). +> - Guest Inviter, Directory Writers, or User Administrator. +> - To reset the redemption status: Helpdesk Administrator or User Administrator. +> - Application permissions (app-only) don't work if B2B invitations are disabled on the tenant or if B2B invitations are restricted to administrators. +> - When resetting the redemption status for a guest user, the *User.ReadWrite.All* permission is the least privileged permission for the operation. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Ipnamedlocation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/ipnamedlocation-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/ipnamedlocation-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Ipnamedlocation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/ipnamedlocation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "ipnamedlocation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/ipnamedlocation-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Ipnamedlocation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/ipnamedlocation-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/ipnamedlocation-update-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | M365appsinstallationoptions Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/m365appsinstallationoptions-get.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/m365appsinstallationoptions-get-permissions.md)] When calling on behalf of a user, the user needs to belong to the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):-+ Global administrator -+ Global reader -+ Office apps administrator ++ Office apps administrator (recommended)++ Global Reader ## HTTP request |
v1.0 | M365appsinstallationoptions Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/m365appsinstallationoptions-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "m365appsinstallationoptions_update" } --> [!INCLUDE [permissions-table](../includes/permissions/m365appsinstallationoptions-update-permissions.md)] -When calling on behalf of a user, the user needs to belong to the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --+ Global administrator -+ Office apps administrator +When calling on behalf of a user, the user needs to belong to the Office apps administrator role. ## HTTP request |
v1.0 | Mailboxprotectionunitsbulkadditionjobs Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mailboxprotectionunitsbulkadditionjobs-get.md | + + Title: "Get mailboxProtectionUnitsBulkAdditionJob" +description: "Get a mailboxProtectionUnitsBulkAdditionJob in an Exchange protection policy." ++ms.localizationpriority: medium ++++# Get mailboxProtectionUnitsBulkAdditionJob ++Namespace: microsoft.graph +++Get a [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) object by the ID 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": "mailboxprotectionunitsbulkadditionjobs_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/backupRestore/exchangeProtectionPolicies/{mailboxProtectionPolicyId}/mailboxProtectionUnitsBulkAdditionJobs/{mailboxProtectionUnitsBulkAdditionJobId} +``` ++## 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 [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "mailboxprotectionunitsbulkadditionjobs_get" +} +--> ++``` http +GET https://graph.microsoft.com/beta/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxProtectionUnitsBulkAdditionJobs/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.mailboxProtectionUnitsBulkAdditionJob" +} +--> +``` http +HTTP/1.1 200 OK +Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxProtectionUnitsBulkAdditionJobs/61633878-8321-4950-bfaf-ed285bdd1461 ++{ + "@odata.type": "#microsoft.graph.mailboxProtectionUnitsBulkAdditionJob", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "mailboxes-I", + "mailboxes" : ["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 | Mailboxprotectionunitsbulkadditionjobs Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mailboxprotectionunitsbulkadditionjobs-post.md | + + Title: "Create mailboxProtectionUnitsBulkAdditionJob" +description: "Create mailboxProtectionUnitsBulkAdditionJob for an Exchange protection policy." ++ms.localizationpriority: medium ++++# Create mailboxProtectionUnitsBulkAdditionJob ++Namespace: microsoft.graph +++Create a [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) object associated with an [exchangeProtectionPolicy](../resources/exchangeprotectionpolicy.md). ++The initial status upon creation of the job is `active`. When all the `mailboxes` and `directoryObjectIds` are added into the corresponding Exchange protection policy, the status of job is `completed`. ++If any failures occur, the status of the job 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": "mailboxprotectionunitsbulkadditionjobs_post" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/backupRestore/exchangeProtectionPolicies/{exchangeProtectionPolicyId}/mailboxProtectionUnitsBulkAdditionJobs +``` ++## 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 [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) object. ++## Response ++If successful, this method returns a `201 Created` response code and a [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "mailboxprotectionunitsbulkadditionjobs_post" +} +--> ++```http +POST https://graph.microsoft.com/beta/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxProtectionUnitsBulkAdditionJobs +Content-Type: application/json ++{ + "displayName" : "mailboxes-I", + "mailboxes" : ["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.mailboxProtectionUnitsBulkAdditionJob" +} +--> +``` http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.mailboxProtectionUnitsBulkAdditionJob", + "id" :"71633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "mailboxes-I", + "status" : "active", + "mailboxes" : ["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 | Mailfolder Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mailfolder-permanentdelete.md | + + Title: "mailFolder: permanentDelete" +description: "Permanently delete a mail folder and remove its items from the user's mailbox." ++ms.localizationpriority: high ++++# mailFolder: permanentDelete ++Namespace: microsoft.graph +++Permanently delete a mail 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": "mailfolder_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/mailFolders/{mailFolderId}/permanentDelete +POST /users/{usersId}/mailFolders/{mailFolderId}/childFolders/{mailFolderId}/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": "mailfolderthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/mailFolders/{mailFolderId}/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 | Mailsearchfolder Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mailsearchfolder-permanentdelete.md | + + Title: "mailSearchFolder: permanentDelete" +description: "Permanently delete a mail search folder and remove its items from the user's mailbox." ++ms.localizationpriority: high ++++# mailSearchFolder: permanentDelete ++Namespace: microsoft.graph +++Permanently delete a mail search 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": "mailsearchfolder_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /me/mailFolders/{id}/permanentDelete +POST /users/{id | userPrincipalName}/mailFolders/{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": "mailsearchfolderthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/betEzM/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 | Manageddevice Bulksetcloudpcreviewstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/manageddevice-bulksetcloudpcreviewstatus.md | Title: "managedDevice: bulkSetCloudPcReviewStatus" + Title: "managedDevice: bulkSetCloudPcReviewStatus (deprecated)" description: "Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices."-+ ms.localizationpriority: medium doc_type: apiPageType -# managedDevice: bulkSetCloudPcReviewStatus +# managedDevice: bulkSetCloudPcReviewStatus (deprecated) Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices. +> [!CAUTION] +> This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the [cloudPcBulkSetReviewStatus](../resources/cloudpcbulksetreviewstatus.md) resource and its supported APIs. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:| |managedDeviceIds|String collection|The managed device IDs of the Cloud PC devices.|-|reviewStatus|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|The new review status of the Cloud PC devices. | +|reviewStatus|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|The new review status of the Cloud PC devices.| ## Response |
v1.0 | Manageddevice Reprovisioncloudpc | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/manageddevice-reprovisioncloudpc.md | - Title: "managedDevice: reprovisionCloudPc (deprecated)" -description: "Reprovision Cloud PC with an Intune managed device ID. " ---doc_type: apiPageType ---# managedDevice: reprovisionCloudPc (deprecated) --Namespace: microsoft.graph ---> [!CAUTION] -> This API is deprecated and will stop returning data on September 30, 2023. Going forward, use the [reprovision](../api/cloudpc-reprovision.md) API. --Reprovision a Cloud PC with an Intune [managed device](../resources/cloudpc.md) ID. ---## 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": "manageddevice_reprovisioncloudpc" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >--``` http -POST /deviceManagement/managedDevices/{managedDeviceId}/reprovisionCloudPc -``` --## 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 `204 No Content` response code. --## Examples --### Request --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "managedDevice_reprovisionCloudPc" -} >--``` http -POST https://graph.microsoft.com/beta/deviceManagement/managedDevices/{managedDeviceId}/reprovisionCloudPc -``` --# [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 --<!-- { - "blockType": "response", - "truncated": true -} >--``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Manageddevice Resizecloudpc | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/manageddevice-resizecloudpc.md | - Title: "managedDevice: resizeCloudPc (deprecated)" -description: "Upgrade or downgrade an existing Cloud PC to another configuration with a new virtual CPU (vCPU) and storage size." ---doc_type: apiPageType ---# managedDevice: resizeCloudPc (deprecated) --Namespace: microsoft.graph ---> [!CAUTION] -> This API is deprecated and stopped returning data on October 30, 2023. Going forward, use the [cloudPC: resize](../api/cloudpc-resize.md) API. --Upgrade or downgrade an existing Cloud PC to another configuration with a new virtual CPU (vCPU) and storage size. ---## 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": "manageddevice_resizecloudpc" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >--``` http -POST /deviceManagement/managedDevices/{managedDeviceId}/resizeCloudPc -``` --## Request headers --|Name|Description| -|:|:| -|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| --## Request body --In the request body, supply JSON representation of the parameters. --The following table shows the parameters that can be used with this action. --|Parameter|Type|Description| -|:|:|:| -|targetServicePlanId|String|The target service plan ID of the resize configuration with new vCPU and storage size.| --## Response --If successful, this method returns a `204 No Content` response code. --## Examples --### Request ---# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "managedDevice_resizeCloudPc" -} >--``` http -POST https://graph.microsoft.com/beta/deviceManagement/managedDevices/{managedDeviceId}/resizeCloudPc -Content-Type: application/json --{ - "targetServicePlanId": "30d0e128-de93-41dc-89ec-33d84bb662a0" -} -``` --# [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 --<!-- { - "blockType": "response", - "truncated": true -} >--``` http -HTTP/1.1 204 No Content -``` |
v1.0 | Manageddevice Restorecloudpc | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/manageddevice-restorecloudpc.md | - Title: "managedDevice: restoreCloudPc (deprecated)" -description: "Restore a Cloud PC device to a previous state with an Intune managed device ID." ---doc_type: apiPageType ---# managedDevice: restoreCloudPc (deprecated) --Namespace: microsoft.graph ---> [!CAUTION] -> This API is deprecated and will stop returning data on September 30, 2023. Going forward, use the [restore](../api/cloudpc-restore.md) API. --Restore a Cloud PC device to a previous state with an Intune [managed device](../resources/cloudpc.md) ID. ---## 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": "manageddevice_restorecloudpc" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >-``` http -POST /deviceManagement/managedDevices/{managedDeviceId}/restoreCloudPc -``` --## 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| -|:|:|:| -|cloudPcSnapshotId|String|The unique identifier for the snapshot of the Cloud PC device at a specific point in time.| ----## Response --If successful, this action returns a `204 No Content` response code. --## Examples --### Request -The following example shows a request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "manageddevicethis.restorecloudpc" -} >-``` http -POST https://graph.microsoft.com/beta/deviceManagement/managedDevices/5e1387aa-d960-4916-ae7c-293b977e49bf/restoreCloudPc -Content-Type: application/json -Content-length: 37 --{ - "cloudPcSnapshotId": "A00009UV000_93aff428-61f2-467f-a879-1102af6fd4a8" -} -``` --# [C#](#tab/csharp) --# [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 | Meetingattendancereport List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingattendancereport-list.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of [meetingAttendanceReport](../resources/meetingAttendanceReport.md) objects for an [onlineMeeting](../resources/onlinemeeting.md) or a [virtualEvent](../resources/virtualevent.md). Each time an online meeting or a virtual event ends, an attendance report is generated for that session. +Get a list of [meetingAttendanceReport](../resources/meetingattendancereport.md) objects for an [onlineMeeting](../resources/onlinemeeting.md) or a [virtualEvent](../resources/virtualevent.md). Each time an online meeting or a virtual event ends, an attendance report is generated for that session. > [!WARNING] >-> This method doesn't support channel meetings, and only returns up to 50 of the most recent reports. +>- This method only returns up to 50 of the most recent reports. +>- When you use this method to list attendance reports for a channel meeting, the API returns attendance reports for every meeting in the channel, rather than just the attendance reports for the specified meeting, which is the expected behavior for scheduled meetings. This behavior is the same regardless of where the channel meeting was created. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Meetingregistrant Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingregistrant-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The 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 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/). Cancel an [onlineMeeting](../resources/onlinemeeting.md) registration for a [meetingRegistrant](../resources/meetingregistrant.md) on behalf of the registrant. |
v1.0 | Meetingregistration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingregistration-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The 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 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 [meetingRegistration](../resources/meetingregistration.md) of an [onlineMeeting](../resources/onlinemeeting.md) on behalf of the organizer. |
v1.0 | Meetingregistration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingregistration-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The 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 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 [meetingRegistration](../resources/meetingregistration.md) details associated with an [onlineMeeting](../resources/onlinemeeting.md) on behalf of the organizer. |
v1.0 | Meetingregistration List Registrants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingregistration-list-registrants.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The 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 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 [meetingRegistrants](../resources/meetingregistrant.md) of an [onlineMeeting](../resources/onlinemeeting.md) on behalf of the organizer. |
v1.0 | Meetingregistration Post Registrants | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingregistration-post-registrants.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The 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 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 a [meeting registrant](../resources/meetingregistrant.md) in an online meeting that has [meeting registration](../resources/meetingregistration.md) enabled on behalf of the registrant. This operation has two scenarios: |
v1.0 | Meetingregistration Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingregistration-post.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The 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 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/). Create and enable registration for an [onlineMeeting](../resources/onlinemeeting.md) on behalf of the organizer. An online meeting can only have one registration enabled. |
v1.0 | Meetingregistration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/meetingregistration-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] > [!CAUTION]-> The 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 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/). Update the details of a [meetingRegistration](../resources/meetingregistration.md) object assciated with an [onlineMeeting](../resources/onlinemeeting.md) on behalf of the organizer. |
v1.0 | Message Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/message-permanentdelete.md | + + Title: "message: permanentDelete" +description: "Permanently delete a message and place it in the Purges folder in the user's mailbox." ++ms.localizationpriority: high ++++# message: permanentDelete ++Namespace: microsoft.graph +++Permanently delete a message 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": "message_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/messages/{messageId}/permanentDelete +POST /users/{usersId}/mailFolders/{mailFolderId}/messages/{messageId}/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": "messagethis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/messages/{messageId}/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 | Mobileappmanagementpolicies Delete Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-delete-includedgroups.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobileappmanagementpolicies_delete_includedgroups" } --> [!INCLUDE [permissions-table](../includes/permissions/mobileappmanagementpolicies-delete-includedgroups-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobileappmanagementpolicies Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobileappmanagementpolicies_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/mobileappmanagementpolicies-delete-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobileappmanagementpolicies Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobileappmanagementpolicies_get" } --> [!INCLUDE [permissions-table](../includes/permissions/mobileappmanagementpolicies-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobileappmanagementpolicies List Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-list-includedgroups.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobileappmanagementpolicies_list_includedgroups" } --> [!INCLUDE [permissions-table](../includes/permissions/mobileappmanagementpolicies-list-includedgroups-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobileappmanagementpolicies List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobileappmanagementpolicies_list" } --> [!INCLUDE [permissions-table](../includes/permissions/mobileappmanagementpolicies-list-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobileappmanagementpolicies Post Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-post-includedgroups.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobileappmanagementpolicies_post_includedgroups" } --> [!INCLUDE [permissions-table](../includes/permissions/mobileappmanagementpolicies-post-includedgroups-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobileappmanagementpolicies Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobileappmanagementpolicies-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobileappmanagementpolicies_update" } --> [!INCLUDE [permissions-table](../includes/permissions/mobileappmanagementpolicies-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobiledevicemanagementpolicies Delete Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-delete-includedgroups.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobiledevicemanagementpolicies_delete_includedgroups" } --> [!INCLUDE [permissions-table](../includes/permissions/mobiledevicemanagementpolicies-delete-includedgroups-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobiledevicemanagementpolicies Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobiledevicemanagementpolicies_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/mobiledevicemanagementpolicies-delete-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobiledevicemanagementpolicies Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobiledevicemanagementpolicies_get" } --> [!INCLUDE [permissions-table](../includes/permissions/mobiledevicemanagementpolicies-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobiledevicemanagementpolicies List Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-list-includedgroups.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobiledevicemanagementpolicies_list_includedgroups" } --> [!INCLUDE [permissions-table](../includes/permissions/mobiledevicemanagementpolicies-list-includedgroups-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobiledevicemanagementpolicies List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobiledevicemanagementpolicies_list" } --> [!INCLUDE [permissions-table](../includes/permissions/mobiledevicemanagementpolicies-list-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobiledevicemanagementpolicies Post Includedgroups | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-post-includedgroups.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobiledevicemanagementpolicies_post_includedgroups" } --> [!INCLUDE [permissions-table](../includes/permissions/mobiledevicemanagementpolicies-post-includedgroups-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Mobiledevicemanagementpolicies Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/mobiledevicemanagementpolicies-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "mobiledevicemanagementpolicies_update" } --> [!INCLUDE [permissions-table](../includes/permissions/mobiledevicemanagementpolicies-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Namedlocation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/namedlocation-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/namedlocation-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Namedlocation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/namedlocation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "namedlocation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/namedlocation-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Namepronunciationsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/namepronunciationsettings-get.md | + + Title: "Get namePronunciationSettings" +description: "Read the properties and relationships of a namePronunciationSettings object." ++ms.localizationpriority: medium ++++# Get namePronunciationSettings ++Namespace: microsoft.graph +++Read the properties and relationships of a [namePronunciationSettings](../resources/namepronunciationsettings.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": "namepronunciationsettings_get" } --> ++<!-- { + "blockType": "request" +}--> ++## HTTP request ++``` http +GET /admin/people/namePronunciation +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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 [namePronunciationSettings](../resources/namepronunciationsettings.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "get_namepronunciationsettings" +} +--> +``` http +GET https://graph.microsoft.com/beta/admin/people/namePronunciation +``` +++### 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.namePronunciationSettings" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.namePronunciationSettings", + "id": "5a5ec63c-48e0-993a-788a-d4e9fb4f479e", + "isEnabledInOrganization": true + } +} +``` + |
v1.0 | Namepronunciationsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/namepronunciationsettings-update.md | + + Title: "Update namePronunciationSettings" +description: "Update the properties of a **namePronunciationSettings** object." ++ms.localizationpriority: medium ++++# Update namePronunciationSettings ++Namespace: microsoft.graph +++Update the properties of a [namePronunciationSettings](../resources/namepronunciationsettings.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": "namepronunciationsettings_update" } --> ++<!-- { + "blockType": "request" +}--> ++## HTTP request ++``` http +PATCH /admin/people/namePronunciation +``` ++## 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| +|:|:|:| +|isEnabledInOrganization|Boolean|`true` to enable name pronunciation in the organization; otherwise, `false`. The default value is `false`. Required.| ++++## Response ++If successful, this method returns a `200 OK` response code and an updated [namePronunciationSettings](../resources/namepronunciationsettings.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "update_namepronunciationsettings" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/admin/people/namePronunciation +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.namePronunciationSettings", + "isEnabledInOrganization": true +} +``` +++### 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.namePronunciationSettings" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.namePronunciationSettings", + "id": "5a5ec63c-48e0-993a-788a-d4e9fb4f479e", + "isEnabledInOrganization": true +} +``` + |
v1.0 | Networkaccess Branchconnectivityconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchconnectivityconfiguration-get.md | GET https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{branch [!INCLUDE [sample-code](../includes/snippets/php/get-branchconnectivityconfiguration-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-branchconnectivityconfiguration-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Branchsite Delete Devicelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-delete-devicelinks.md | DELETE https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{bra [!INCLUDE [sample-code](../includes/snippets/php/delete-devicelink-deprecated-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/delete-devicelink-deprecated-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Branchsite Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-delete.md | DELETE https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{bra [!INCLUDE [sample-code](../includes/snippets/php/delete-branchsite-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/delete-branchsite-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Branchsite Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-get.md | GET https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{branch [!INCLUDE [sample-code](../includes/snippets/php/get-branchsite-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-branchsite-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Branchsite List Devicelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-list-devicelinks.md | GET https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{branch [!INCLUDE [sample-code](../includes/snippets/php/list-devicelink-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/list-devicelink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Branchsite List Forwardingprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-list-forwardingprofiles.md | GET https://graph.microsoft.com/beta/networkAccess/connectivity/branches/{branch [!INCLUDE [sample-code](../includes/snippets/php/list-forwardingprofiles-branchsite-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/list-forwardingprofiles-branchsite-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Branchsite Post Devicelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-post-devicelinks.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-devicelink-from--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/create-devicelink-from--python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Branchsite Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-branchsite-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-branchsite-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/update-branchsite-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Conditionalaccesssettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-conditionalaccesssettings-get.md | GET https://graph.microsoft.com/beta/networkAccess/settings/conditionalAccess [!INCLUDE [sample-code](../includes/snippets/php/get-conditionalaccesssettings-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-conditionalaccesssettings-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Conditionalaccesssettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-conditionalaccesssettings-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-conditionalaccesssettings-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/update-conditionalaccesssettings-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Connectivity List Branches | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-connectivity-list-branches.md | GET https://graph.microsoft.com/beta/networkAccess/connectivity/branches [!INCLUDE [sample-code](../includes/snippets/php/list-branchsite-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/list-branchsite-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Connectivity Post Branches | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-connectivity-post-branches.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-branchsite-from--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/create-branchsite-from--python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Connectivity Post Remotenetworks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-connectivity-post-remotenetworks.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-remotenetwork-basic-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/create-remotenetwork-basic-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-remotenetwork-with-forwardingprofile-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/create-remotenetwork-with-forwardingprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-remotenetwork-with-forwardingprofile-devicelink-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/create-remotenetwork-with-forwardingprofile-devicelink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Crosstenantaccesssettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-crosstenantaccesssettings-get.md | GET https://graph.microsoft.com/beta/networkAccess/settings/crossTenantAccess [!INCLUDE [sample-code](../includes/snippets/php/get-crosstenantaccesssettings-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-crosstenantaccesssettings-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Crosstenantaccesssettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-crosstenantaccesssettings-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-crosstenantaccesssettings-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/update-crosstenantaccesssettings-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Devicelink Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-devicelink-delete.md | DELETE https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetwork [!INCLUDE [sample-code](../includes/snippets/php/delete-devicelink-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/delete-devicelink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Devicelink Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-devicelink-get.md | GET https://graph.microsoft.com/beta/networkAccess/connectivity/remoteNetworks/d [!INCLUDE [sample-code](../includes/snippets/php/get-devicelink-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-devicelink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Devicelink Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-devicelink-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-devicelink-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/update-devicelink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Enrichedauditlogs Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-enrichedauditlogs-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-enrichedauditlogs-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/update-enrichedauditlogs-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringpolicy-get.md | GET https://graph.microsoft.com/beta/networkAccess/filteringPolicies/161760b2-70 [!INCLUDE [sample-code](../includes/snippets/php/get-filteringpolicy-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-filteringpolicy-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringpolicy Post Policyrules | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringpolicy-post-policyrules.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-policyrule-from--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/create-policyrule-from--python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringpolicylink Delete Policy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringpolicylink-delete-policy.md | DELETE https://graph.microsoft.com/beta/networkaccess/filteringPolicies/d0187e08 [!INCLUDE [sample-code](../includes/snippets/php/delete-policy-from-filteringpolicylink-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/delete-policy-from-filteringpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringpolicylink Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringpolicylink-delete.md | DELETE https://graph.microsoft.com/beta/networkaccess/FilteringProfiles/c308a3af [!INCLUDE [sample-code](../includes/snippets/php/delete-filteringpolicylink-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/delete-filteringpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringpolicylink Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringpolicylink-get.md | GET https://graph.microsoft.com/beta/networkaccess/filteringPolicies/bb4e13cd-65 [!INCLUDE [sample-code](../includes/snippets/php/get-filteringpolicylink-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-filteringpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringpolicylink List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringpolicylink-list.md | GET https://graph.microsoft.com/beta/networkaccess/filteringProfiles/519085fd-ef [!INCLUDE [sample-code](../includes/snippets/php/list-filteringpolicylink-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/list-filteringpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringpolicylink Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringpolicylink-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-filteringpolicylink-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/update-filteringpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringprofile Delete Policies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringprofile-delete-policies.md | DELETE https://graph.microsoft.com/beta/networkaccess/FilteringProfiles/9020f79d [!INCLUDE [sample-code](../includes/snippets/php/delete-policylink-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/delete-policylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringprofile-get.md | GET https://graph.microsoft.com/beta/networkaccess/filteringProfiles/9020f79d-71 [!INCLUDE [sample-code](../includes/snippets/php/get-filteringprofile-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-filteringprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringprofile List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringprofile-list.md | GET https://graph.microsoft.com/beta/networkAccess/filteringProfiles [!INCLUDE [sample-code](../includes/snippets/php/list-filteringprofile-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/list-filteringprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringprofile-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-filteringprofile-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/update-filteringprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringrule Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringrule-delete.md | DELETE https://graph.microsoft.com/beta/networkaccess/filteringPolicies/bb1d249e [!INCLUDE [sample-code](../includes/snippets/php/delete-filteringrule-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/delete-filteringrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringrule Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringrule-get.md | GET https://graph.microsoft.com/beta/networkaccess/filteringPolicies/ac253559-37 [!INCLUDE [sample-code](../includes/snippets/php/get-filteringrule-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-filteringrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringrule List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringrule-list.md | GET https://graph.microsoft.com/beta/networkaccess/filteringPolicies/d0187e08-04 [!INCLUDE [sample-code](../includes/snippets/php/list-filteringrule-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/list-filteringrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringrule Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringrule-post.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-filteringrule-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/create-filteringrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Filteringrule Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-filteringrule-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-filteringrule-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/update-filteringrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingoptions Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingoptions-get.md | GET https://graph.microsoft.com/beta/networkAccess/settings/forwardingOptions [!INCLUDE [sample-code](../includes/snippets/php/get-forwardingoptions-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-forwardingoptions-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingoptions Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingoptions-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-forwardingoptions-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/update-forwardingoptions-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingpolicy-get.md | GET https://graph.microsoft.com/beta/networkAccess/forwardingPolicies/{forwardin [!INCLUDE [sample-code](../includes/snippets/php/get-forwardingpolicy-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-forwardingpolicy-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingpolicylink Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingpolicylink-delete.md | DELETE https://graph.microsoft.com/beta/networkaccess/forwardingProfiles/{forwar [!INCLUDE [sample-code](../includes/snippets/php/delete-forwardingpolicylink-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/delete-forwardingpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingpolicylink Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingpolicylink-get.md | GET https://graph.microsoft.com/beta/networkAccess/forwardingProfiles/{profileId [!INCLUDE [sample-code](../includes/snippets/php/get-forwardingpolicylink-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-forwardingpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingpolicylink Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingpolicylink-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-forwardingpolicylink-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/update-forwardingpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingprofile-get.md | GET https://graph.microsoft.com/beta/networkAccess/forwardingProfiles/{forwardin [!INCLUDE [sample-code](../includes/snippets/php/get-forwardingprofile-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-forwardingprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingprofile List Policies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingprofile-list-policies.md | GET https://graph.microsoft.com/beta/networkAccess/forwardingProfiles/{forwardin [!INCLUDE [sample-code](../includes/snippets/php/list-forwardingpolicylink-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/list-forwardingpolicylink-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Forwardingprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-forwardingprofile-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-forwardingprofile-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/update-forwardingprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Logs List Traffic | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-logs-list-traffic.md | GET https://graph.microsoft.com/beta/networkAccess/logs/traffic [!INCLUDE [sample-code](../includes/snippets/php/list-networkaccesstraffic-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/list-networkaccesstraffic-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Networkaccessroot List Filteringpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-networkaccessroot-list-filteringpolicies.md | GET https://graph.microsoft.com/beta/networkAccess/filteringPolicies [!INCLUDE [sample-code](../includes/snippets/php/list-filteringpolicy-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/list-filteringpolicy-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Networkaccessroot List Forwardingprofiles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-networkaccessroot-list-forwardingprofiles.md | GET https://graph.microsoft.com/beta/networkAccess/forwardingProfiles [!INCLUDE [sample-code](../includes/snippets/php/list-forwardingprofile-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/list-forwardingprofile-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Networkaccessroot Onboard | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-networkaccessroot-onboard.md | POST https://graph.microsoft.com/beta/networkAccess/microsoft.graph.networkacces [!INCLUDE [sample-code](../includes/snippets/php/create-tenantstatus-from--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/create-tenantstatus-from--python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Policy List Policyrules | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-policy-list-policyrules.md | GET https://graph.microsoft.com/beta/networkaccess/forwardingPolicies/{forwardin [!INCLUDE [sample-code](../includes/snippets/php/list-policyrule-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/list-policyrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Policylink List Policy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-policylink-list-policy.md | GET https://graph.microsoft.com/beta/networkaccess/filteringProfiles/78858adc-db [!INCLUDE [sample-code](../includes/snippets/php/list-policy-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/list-policy-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Policyrule Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-policyrule-get.md | GET https://graph.microsoft.com/beta/networkaccess/forwardingPolicies/{forwardin [!INCLUDE [sample-code](../includes/snippets/php/get-policyrule-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-policyrule-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Reports Entitiessummaries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-reports-entitiessummaries.md | GET https://graph.microsoft.com/beta/networkAccess/reports/entitiesSummaries(sta [!INCLUDE [sample-code](../includes/snippets/php/reportsthisentitiessummaries-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/reportsthisentitiessummaries-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Settings List Enrichedauditlogs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-settings-list-enrichedauditlogs.md | GET https://graph.microsoft.com/beta/networkaccess/settings/enrichedAuditLogs [!INCLUDE [sample-code](../includes/snippets/php/list-enrichedauditlogs-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/list-enrichedauditlogs-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Networkaccess Tenantstatus Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/networkaccess-tenantstatus-get.md | GET https://graph.microsoft.com/beta/networkAccess/tenantStatus [!INCLUDE [sample-code](../includes/snippets/php/get-tenantstatus-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-tenantstatus-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Notebook Getrecentnotebooks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/notebook-getrecentnotebooks.md | The `{id | userPrincipalName}` for the user must match the user encoded in the a ## 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 | Oauth2permissiongrant Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/oauth2permissiongrant-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted **oauth2permissiongrant** objects without performing a full read of the entire resource collection. For details, see [Using delta query](/graph/delta-query-overview). +Get newly created, updated, or deleted **oauth2permissiongrant** objects 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)] |
v1.0 | Onattributecollectionexternalusersselfservicesignup Delete Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md | Namespace: microsoft.graph Remove an attribute from an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. You can add both custom and built-in attributes to a user flow. -After this step, [PATCH the user flow](../api/authenticationeventsflow-update.md) to remove the attribute from the attribute collection step. +The attribute is removed from both the **attributes** and **views** collections of the **attributeCollectionPage** object in the user flow. ++This API operation fails when you attempt to remove the last remaining attribute on the user flow. ## 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). Don't supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. +If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. Attempting to remove the last remaining attribute results in a `400 Bad Request` error code. ## Examples #### Request-The following example shows a request that removes city as an attribute from the attribute collection step of an external identities self-service sign-up user flow. After executing this step, [update the attributes collected in the userflow](../api/authenticationeventsflow-update.md). +The following example shows a request that removes city as an attribute from the attribute collection step of an external identities self-service sign-up user flow. + # [HTTP](#tab/http) <!-- { "blockType": "request", |
v1.0 | Onattributecollectionexternalusersselfservicesignup Post Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onattributecollectionexternalusersselfservicesignup-post-attributes.md | Namespace: microsoft.graph Add an attribute to an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. You can add both custom and built-in attributes to a user flow. -Prior to this step, [PATCH the user flow](../api/authenticationeventsflow-update.md) to add the attribute to the attribute collection step (to determine how it will be displayed). +The attribute is added to both the **attributeCollection**> **attributes** and **attributeCollection**> **attributeCollectionPage** > **views** collections on the user flow. In the **views** collection, the attribute is assigned the default settings. You can [PATCH the user flow](../api/authenticationeventsflow-update.md) to customize the settings of the attribute on the **views** object, for example, marking it as required or updating the allowed input types. ## 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). If successful, this method returns a `204 No Content` response code. If unsucce #### Request -The following example shows a request that adds city as an attribute for attribute collection step of an external identities self-service sign-up user flow. Before you can add an attribute to the attribute collection step, you must first [add it among the attributes to be collected in the user flow](../api/authenticationeventsflow-update.md). +The following example shows a request that adds city as an attribute for attribute collection step of an external identities self-service sign-up user flow. If the request is successful, the attribute is added to both the **attributeCollection**> **attributes** and **attributeCollection**> **attributeCollectionPage** > **views** collections on the user flow. After adding the attribute to the user flow, you can [PATCH the user flow](../api/authenticationeventsflow-update.md) to customize the settings of the attribute on the **views** object, that is, customize the page layout. # [HTTP](#tab/http) <!-- { |
v1.0 | Onedriveforbusinessprotectionpolicy List Driveprotectionunitsbulkadditionjobs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onedriveforbusinessprotectionpolicy-list-driveprotectionunitsbulkadditionjobs.md | + + Title: "List driveProtectionUnitsBulkAdditionJobs" +description: "List driveProtectionUnitsBulkAdditionJobs in a OneDrive protection policy." ++ms.localizationpriority: medium ++++# List driveProtectionUnitsBulkAdditionJobs ++Namespace: microsoft.graph +++Get a list of [driveProtectionUnitsBulkAdditionJobs](../resources/driveprotectionunitsbulkadditionjob.md) objects 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": "onedriveforbusinessprotectionpolicy_list_driveprotectionunitsbulkadditionjobs" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/backupRestore/oneDriveForBusinessProtectionPolicies/{oneDriveForBusinessProtectionPolicyId}/driveProtectionUnitsBulkAdditionJobs +``` ++## 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 [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) objects in the response body. +The `drives` 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": "onedriveforbusinessprotectionpolicy_list_driveprotectionunitsbulkadditionjobs" +} +--> ++``` http +GET https://graph.microsoft.com/beta/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveProtectionUnitsBulkAdditionJobs +``` ++# [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.driveProtectionUnitsBulkAdditionJob)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveProtectionUnitsBulkAdditionJobs ++{ + "@odata.type": "#collection(microsoft.graph.driveProtectionUnitsBulkAdditionJob)", + "@odata.context": "/solutions/backupRestore/oneDriveForBusinessProtectionPolicies('71633878-8321-4950-bfaf-ed285bdd1461')/driveProtectionUnitsBulkAdditionJobs", + "@odata.nextLink": "/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveProtectionUnitsBulkAdditionJobs?$top=3&$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", + "value": + [ + { + "@odata.type": "#microsoft.graph.driveProtectionUnitsBulkAdditionJob", + "displayName" : "drive-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.driveProtectionUnitsBulkAdditionJob", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "drive-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 | Onedriveforbusinessprotectionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onedriveforbusinessprotectionpolicy-update.md | To remove a **driveProtectionUnit** from the policy, specify the `@removed` anno If successful, this method returns a `200 OK` response code and an updated [oneDriveForBusinessProtectionPolicy](../resources/onedriveforbusinessprotectionpolicy.md) 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 | Onedriveforbusinessrestoresession List Driverestoreartifacts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onedriveforbusinessrestoresession-list-driverestoreartifacts.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [driveRestoreArtifact](../resources/driverestoreartifact.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 | Onedriveforbusinessrestoresession Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onedriveforbusinessrestoresession-update.md | To remove a drive restore artifact, specify the `@removed` annotation in the req If successful, this method returns a `200 OK` response code and an updated [oneDriveForBusinessRestoreSession](../resources/driverestoreartifact.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 | Onlinemeeting Getallrecordings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-getallrecordings.md | Get all recordings from scheduled [onlineMeeting](../resources/onlinemeeting.md) You can apply the [delta](callrecording-delta.md) function on **getAllRecordings** to synchronize and get [callRecording](../resources/callrecording.md) resources as they're added for **onlineMeeting** instances organized by the specified user. -The delta query supports both full synchronization and incremental synchronization. Full synchronization gets all the recordings for online meetings organized by the user. Incremental synchronization gets recordings that are added since the last synchronization. Typically, you would do an initial full synchronization, and then get incremental changes to that recording view periodically. +The delta query supports both full synchronization and incremental synchronization. Full synchronization gets all the recordings for online meetings organized by the user. Incremental synchronization gets recordings that are added since the last synchronization. Typically, you do an initial full synchronization, and then get incremental changes to that recording view periodically. Find more information in the [delta query](/graph/delta-query-overview) documentation. For more examples, see [callRecording: delta](callrecording-delta.md). To learn more about using the Microsoft Teams export APIs to export content, see 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). - [Recordings aren't exported for meetings that don't have transcription turned on](https://developer.microsoft.com/en-us/graph/known-issues/?search=22933). ## Permissions Choose the permission or permissions marked as least privileged for this API. Us ``` http GET /users/{usersId}/onlineMeetings/getAllRecordings(meetingOrganizerUserId='{userId}',startDateTime={startDateTime},endDateTime={endDateTime}) ```->**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**. ## Function parameters In the request URL, provide the following query parameters with values. |Parameter|Type|Description| |:|:|:|+|endDateTime|DateTimeOffset|Optional parameter to filter for artifacts created before the given end date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |meetingOrganizerUserId|String|The user identifier of the meeting organizer to filter for artifacts for meetings organized by the given user identifier.|-|startDateTime|DateTimeOffset|Optional parameter to filter for artifacts created after the given start date.| -|endDateTime|DateTimeOffset|Optional parameter to filter for artifacts created before the given end date.| +|startDateTime|DateTimeOffset|Optional parameter to filter for artifacts created after the given start date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| -## Supported query patterns +## Optional query parameters -| Pattern | Supported | Syntax | Notes | -| - | :-: | - | | -| Page size | Γ£ô | `top` | Allows caller to specify max number of objects per page. | +This method supports the following OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++| Name | Description | +| :- | :-- | +| `$top` | Allows the caller to specify the max number of objects per page as the page size. | ## Request headers In the request URL, provide the following query parameters with values. ## Response -If successful, this method returns a `200 OK` response code and a list of [callRecording](../resources/callrecording.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [callRecording](../resources/callrecording.md) objects in the response body. ## Examples The following example shows a request to get all the recordings of a given meeti #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/ -- #### Response +The following example shows the response. + >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, "name": "get_allrecordings",- "@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: Get all recordings of a given meeting organizer with date range filter +### Example 2: Get all recordings of a given meeting organizer using a date range filter The following example shows a request to get all recordings of a given meeting organizer, that are created between a given start date and an end date. #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/ -- #### Response +The following example shows the response. + >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, "name": "get_allrecordings_with_dates",- "@odata.type": "microsoft.graph.callRecording", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callRecording)" } --> ```http HTTP/1.1 200 OK Content-type: application/json ## Related content -[Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) --[Delta query overview](/graph/delta-query-overview) --[Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content) +- [Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) +- [Delta query overview](/graph/delta-query-overview) +- [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content) |
v1.0 | Onlinemeeting Getalltranscripts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-getalltranscripts.md | Get all transcripts from scheduled [onlineMeeting](../resources/onlinemeeting.md You can apply the [delta](calltranscript-delta.md) function on **getAllTranscripts** to synchronize and get [callTranscript](../resources/calltranscript.md) resources as they're added for **onlineMeeting** instances organized by the specified user. -Delta query supports both full synchronization and incremental synchronization. Full synchronization gets all the transcripts for online meetings organized by the user. Incremental synchronization gets transcripts that are 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 and incremental synchronization. Full synchronization gets all the transcripts for online meetings organized by the user. Incremental synchronization gets transcripts that are added since the last synchronization. Typically, you do an initial full synchronization, and then get incremental changes to that recording view periodically. For more information, see [delta query](/graph/delta-query-overview). For more examples, see [callTranscript: delta](calltranscript-delta.md). To learn more about using the Microsoft Teams export APIs to export content, see 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). ## Permissions Choose the permission or permissions marked as least privileged for this API. Us ``` http GET /users/{usersId}/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='{userId}',startDateTime={startDateTime},endDateTime={endDateTime}) ```->**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**. ## Function parameters In the request URL, provide the following query parameters with values. |Parameter|Type|Description| |:|:|:|-|meetingOrganizerUserId|String|The user identifier of the meeting organizer. To filter for artifacts for meetings organized by the given user identifier.| -|startDateTime|DateTimeOffset|Optional parameter to filter for artifacts created after the given start date.| -|endDateTime|DateTimeOffset|Optional parameter to filter for artifacts created before the given end date.| +|endDateTime|DateTimeOffset|Optional parameter to filter for artifacts created before the given end date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|meetingOrganizerUserId|String|The user identifier of the meeting organizer that is used to filter artifacts for meetings organized by that specific user.| +|startDateTime|DateTimeOffset|Optional parameter to filter for artifacts created after the given start date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| -## Supported query patterns --| Pattern | Supported | Syntax | Notes | -| - | :-: | - | | -| Page size | Γ£ô | `top` | Allows the caller to specify the maximum number of objects per page. | +This method supports the following OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). +| Name | Description | +| :- | :-- | +| `$top` | Allows the caller to specify the max number of objects per page as the page size. | ## Request headers In the request URL, provide the following query parameters with values. ## Response -If successful, this method returns a `200 OK` response code and a list of [callTranscript](../resources/calltranscript.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [callTranscript](../resources/calltranscript.md) objects in the response body. ## Examples The following example shows a request to get all the transcripts of a given meet #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/ -- #### Response +The following example shows the response. + >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, "name": "get_alltranscripts",- "@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: Get all transcripts of a given meeting organizer with date range filter +### Example 2: Get all transcripts of a given meeting organizer using a date range filter The following example shows a request to get all transcripts of a given meeting organizer, that are created between a given start date and an end date. #### Request +The following example shows a request. + # [HTTP](#tab/http) <!-- { "blockType": "request", GET https://graph.microsoft.com/beta/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/ -- #### Response +The following example shows the response. + >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, "name": "get_alltranscripts_with_dates",- "@odata.type": "microsoft.graph.callTranscript", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.callTranscript)" } --> ```http HTTP/1.1 200 OK Content-type: application/json ## Related content -[Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) -[Delta query overview](/graph/delta-query-overview) -[Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content) +- [Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) +- [Delta query overview](/graph/delta-query-overview) +- [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content) |
v1.0 | Onlinemeeting Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onlinemeeting-update.md | Namespace: microsoft.graph Update the properties of the specified [onlineMeeting](../resources/onlinemeeting.md) object. -Please see [Request body](#request-body) section for the list of properties that support updating. +For the list of properties that support updating, see the [Request body](#request-body) section. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] PATCH /users/{userId}/onlineMeetings/{meetingId} > [!NOTE] >-> - **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more details, see [application access policy](/graph/cloud-communication-online-meeting-application-access-policy). +> - **userId** is the object ID of a user in [Microsoft Entra admin center > user management page](https://entra.microsoft.com/#blade/Microsoft_AAD_IAM/UsersManagementMenuBlade). For more information, see [application access policy](/graph/cloud-communication-online-meeting-application-access-policy). > - `meetingId` is the **id** of an [onlineMeeting](../resources/onlinemeeting.md) object. ## Request headers PATCH /users/{userId}/onlineMeetings/{meetingId} ## Request body -The following table lists the properties that can be updated. In the request body, include only the properties that need updating, with the following exceptions: +The following table lists the properties that can be updated. In the request body, supply *only* the values for properties that should be updated, with the following exceptions: -- Updating the start or end date/time of an online meeting always requires both **startDateTime** and **endDateTime** properties in the request body.-- The **organizer** field of the **participants** property cannot be updated. The organizer of the meeting cannot be modified after the meeting is created.-- Updating the **attendees** field of the **participants** property, such as adding or removing an attendee to the meeting, always requires the full list of attendees in the request body.+- If you update the start or end date/time of an online meeting, you must always include both **startDateTime** and **endDateTime** properties in the request body. +- The **organizer** field of the **participants** property can't be updated. The organizer of the meeting can't be modified after the meeting is created. +- If you update the **attendees** field of the **participants** property, such as adding or removing an attendee to the meeting, you must always include the full list of attendees in the request body. -The last column indicates whether updating this property will take effect for an in-progress meeting. +The last column indicates whether updating this property takes effect for an in-progress meeting. | Property | Type | Description | Applies to in-progress meetings? |-|--||-|| -| startDateTime | DateTime | The meeting start time in UTC. | No | -| endDateTime | DateTime | The meeting end time in UTC. | No | -| subject | String | The subject of the online meeting. | No | -| participants | [meetingParticipants](../resources/meetingparticipants.md) | The participants associated with the online meeting. Only attendees can be updated. | No | -| isEntryExitAnnounced | Boolean | Whether or not to announce when callers join or leave. | Yes | -| lobbyBypassSettings | [lobbyBypassSettings](../resources/lobbyBypassSettings.md) | Specifies which participants can bypass the meeting lobby. | Yes | -| allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. | Yes | -| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. | Yes | -| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. | Yes | -| allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. | Yes | -| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. | Yes | -| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. | No | +|--||-| | +| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. | Yes | +| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. | Yes | +| allowBreakoutRooms | Boolean | Indicates whether breakout rooms are enabled for the meeting. | No | +| allowedLobbyAdmitters | [allowedLobbyAdmitterRoles](../resources/onlinemeetingbase.md#allowedlobbyadmitterroles-values) | Specifies the users who can admit from the lobby. Possible values are: `organizerAndCoOrganizersAndPresenters`, `organizerAndCoOrganizers`, `unknownFutureValue`. | Yes | +| allowedPresenters | onlineMeetingPresenters | Specifies who can be a presenter in a meeting. | Yes | +| allowLiveShare | Boolean | Indicates whether live share is enabled for the meeting. | No | +| allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. | Yes | +| allowPowerPointSharing | Boolean | Indicates whether PowerPoint live is enabled for the meeting. | No | +| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. | Yes | +| allowWhiteboard | Boolean | Indicates whether whiteboard is enabled for the meeting. | No | +| endDateTime | DateTime | The meeting end time in UTC. | No | +| isEntryExitAnnounced | Boolean | Whether or not to announce when callers join or leave. | Yes | +| lobbyBypassSettings | [lobbyBypassSettings](../resources/lobbybypasssettings.md) | Specifies which participants can bypass the meeting lobby. | Yes | +| participants | [meetingParticipants](../resources/meetingparticipants.md) | The participants associated with the online meeting. Only attendees can be updated. | No | +| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. | No | +| startDateTime | DateTime | The meeting start time in UTC. | No | +| subject | String | The subject of the online meeting. | No | > [!NOTE] > |
v1.0 | Onpremisesdirectorysynchronization Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onpremisesdirectorysynchronization-get.md | Title: "Get onPremisesDirectorySynchronization" description: "Read the properties and relationships of an onPremisesDirectorySynchronization object."-++ ms.localizationpriority: medium doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "onpremisesdirectorysynchronization_get" } --> [!INCLUDE [permissions-table](../includes/permissions/onpremisesdirectorysynchronization-get-permissions.md)] -For delegated scenarios, the user needs to be assigned the *Global Administrator* [role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). +> [!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 Administrator* is the only role supported for this operation. ## HTTP request |
v1.0 | Onpremisesdirectorysynchronization Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/onpremisesdirectorysynchronization-update.md | Title: "Update onPremisesDirectorySynchronization" description: "Update the properties of an onPremisesDirectorySynchronization object."-++ ms.localizationpriority: medium doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "onpremisesdirectorysynchronization_update" } --> [!INCLUDE [permissions-table](../includes/permissions/onpremisesdirectorysynchronization-update-permissions.md)] -For delegated scenarios, the user needs to be assigned the *Global Administrator* [role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). +> [!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 Administrator* is the only role supported for this operation. ## HTTP request |
v1.0 | Orgcontact Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted organizational contacts without having to perform a full read of the entire collection. See [change tracking](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted organizational contacts without having to perform a full read of the entire 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": "orgcontact_delta" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-delta-permissions.md)] + ## HTTP request To begin tracking changes, you make a request by including the delta function on the contacts 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 organization contact 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 organization contact collection. | |
v1.0 | Orgcontact Get Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-get-manager.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_get_manager" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-get-manager-permissions.md)] + [!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request |
v1.0 | Orgcontact Get Transitivereports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-get-transitivereports.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_get_transitivereports" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-get-transitivereports-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Orgcontact Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_get" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Orgcontact List Directreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-list-directreports.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_list_directreports" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-list-directreports-permissions.md)] + [!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request |
v1.0 | Orgcontact List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-list-memberof.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_list_memberof" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-list-memberof-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 +> - Directory Writers +> - Intune Administrator +> - User Administrator + [!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request |
v1.0 | Orgcontact List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-list-transitivememberof.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/orgcontact-list-transitivememberof-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 +> - Directory Writers +> - Intune Administrator +> - User Administrator ++ ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Orgcontact List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_list" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Orgcontact Retryserviceprovisioning | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/orgcontact-retryserviceprovisioning.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_retryserviceprovisioning" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-retryserviceprovisioning-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 Writers +> - Intune Administrator +> - User Administrator + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Outlooktask Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlooktask-permanentdelete.md | + + Title: "outlookTask: permanentDelete" +description: "Permanently delete an Outlook task and place it in the Purges folder in the user's mailbox." ++ms.localizationpriority: high ++++# outlookTask: permanentDelete ++Namespace: microsoft.graph +++Permanently delete an Outlook task 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": "outlooktask_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/outlook/tasks/{outlookTaskId}/permanentDelete +POST /users/{usersId}/outlook/taskGroups/{outlookTaskGroupId}/taskFolders/{outlookTaskFolderId}/tasks/{outlookTaskId}/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": "outlooktaskthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/outlook/tasks/{outlookTaskId}/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 +``` +<!-- +{ + "type": "#page.annotation", + "description": "Update checklistItem", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: microsoft.graph.microsoft.graph/users: + /users/{var}/outlook/tasks/{var}/permanentDelete + Uri path requires navigating into unknown object hierarchy: missing property 'tasks' on 'outlookUser'. Possible issues: + 1) Doc bug where 'tasks' isn't defined on the resource. + 2) Doc bug where 'tasks' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation. + 3) Doc bug where 'outlookUser' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation." + ] +} +--> |
v1.0 | Outlooktaskfolder Permanentdelete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/outlooktaskfolder-permanentdelete.md | + + Title: "outlookTaskFolder: permanentDelete" +description: "Permanently delete an outlook task folder and remove its items from the user's mailbox." ++ms.localizationpriority: high ++++# outlookTaskFolder: permanentDelete ++Namespace: microsoft.graph +++Permanently delete an outlook task 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": "outlooktaskfolder_permanentdelete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{usersId}/outlook/taskFolders/{outlookTaskFolderId}/permanentDelete +POST /users/{usersId}/outlook/taskGroups/{outlookTaskGroupId}/taskFolders/{outlookTaskFolderId}/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": "outlooktaskfolderthis.permanentdelete" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/{usersId}/outlook/taskFolders/{outlookTaskFolderId}/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 +``` ++<!-- +{ + "type": "#page.annotation", + "description": "Update checklistItem", + "keywords": "", + "section": "documentation", + "tocPath": "", + "suppressions": [ + "Error: microsoft.graph.microsoft.graph/users: + /users/{var}/outlook/taskFolders/{var}/permanentDelete + Uri path requires navigating into unknown object hierarchy: missing property 'taskFolders' on 'outlookUser'. Possible issues: + 1) Doc bug where 'taskFolders' isn't defined on the resource. + 2) Doc bug where 'taskFolders' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation. + 3) Doc bug where 'outlookUser' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation." + ] +} +--> |
v1.0 | Pagetemplate Create | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pagetemplate-create.md | ++ +description: "Create a new page template in the templates folder in a site." + Title: Create pageTemplate +ms.localizationpriority: medium ++++# Create pageTemplate ++Namespace: microsoft.graph +++Create a new [pageTemplate](../resources/pageTemplate.md) in the templates folder in a [site](../resources/site.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": "pageTemplate_create" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +POST /sites/{site-id}/pageTemplates/microsoft.graph.pageTemplate +``` +## 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 [pageTemplate](../resources/pageTemplate.md) resource to create. ++> **Notes:** : +> - You must include `@odata.type=#microsoft.graph.pageTemplate` in the request body. The `@odata.type=#microsoft.graph.pageTemplate` is a property in the HTTP request body for the Microsoft Graph API that specifies the page template type for SharePoint. +> - If you're using the response from the [Get pageTemplate](../api/pageTemplate-get.md) operation to create a **page template**, we recommend that you add the HTTP header `Accept: application/json;odata.metadata=none` to remove all OData metadata from the response. You can also manually remove all OData metadata. ++## Response ++If successful, this method returns a `201 Created` HTTP response and the created [pageTemplate](../resources/pageTemplate.md) object. ++## Example ++The following example shows how to create a new page template. ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "create-pageTemplate", "scopes": "sites.readwrite.all" } --> +++```http +POST /sites/dd00d52e-0db7-4d5f-8269-90060ac688d1/pageTemplates/microsoft.graph.pageTemplate +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.pageTemplate", + "name": "test.aspx", + "title": "test", + "pageLayout": "article", + "showComments": true, + "showRecommendedPages": false, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://media.contoso.odsp.cdn.office.net/sitepagethumbnail.png", + "layout": "colorBlock", + "showAuthor": true, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "TEXT ABOVE TITLE", + "textAlignment": "left", + "imageSourceType": 2, + "title": "sample1" + }, + "canvasLayout": { + "horizontalSections": [ + { + "layout": "oneThirdRightColumn", + "id": "1", + "emphasis": "none", + "columns": [ + { + "id": "1", + "width": 8, + "webparts": [ + { + "id": "6f9230af-2a98-4952-b205-9ede4f9ef548", + "innerHtml": "<p><b>Hello!</b></p>" + } + ] + }, + { + "id": "2", + "width": 4, + "webparts": [ + { + "id": "73d07dde-3474-4545-badb-f28ba239e0e1", + "webPartType": "d1d91016-032f-456d-98a4-721247c305e8", + "data": { + "dataVersion": "1.9", + "description": "Show an image on your page", + "title": "Image", + "properties": { + "imageSourceType": 2, + "altText": "", + "overlayText": "", + "siteid": "0264cabe-6b92-450a-b162-b0c3d54fe5e8", + "webid": "f3989670-cd37-4514-8ccb-0f7c2cbe5314", + "listid": "bdb41041-eb06-474e-ac29-87093386bb14", + "uniqueid": "d9f94b40-78ba-48d0-a39f-3cb23c2fe7eb", + "imgWidth": 4288, + "imgHeight": 2848, + "fixAspectRatio": false, + "captionText": "", + "alignment": "Center" + }, + "serverProcessedContent": { + "imageSources": [ + { + "key": "imageSource", + "value": "/_LAYOUTS/IMAGES/VISUALTEMPLATEIMAGE1.JPG" + } + ], + "customMetadata": [ + { + "key": "imageSource", + "value": { + "siteid": "0264cabe-6b92-450a-b162-b0c3d54fe5e8", + "webid": "f3989670-cd37-4514-8ccb-0f7c2cbe5314", + "listid": "bdb41041-eb06-474e-ac29-87093386bb14", + "uniqueid": "d9f94b40-78ba-48d0-a39f-3cb23c2fe7eb", + "width": "4288", + "height": "2848" + } + } + ] + } + } + } + ] + } + ] + } + ] + } +} +``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response that contains a [pageTemplate](../resources/pagetemplate.md) object for the created page template. ++> **Note:** The response might be shortened for readability. ++<!-- { "blockType": "response", "@odata.type": "microsoft.graph.pageTemplate", "truncated": true } --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.type": "microsoft.graph.pageTemplate", + "id": "0dd6ddd6-45bd-4acd-b683-de0e6e726371", + "name": "test.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Templates/test.aspx", + "title": "test", + "pageLayout": "article", + "showComments": true, + "showRecommendedPages": false, + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "publishingState": { + "level": "checkout", + "versionId": "0.1", + "checkedOutBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + } + }, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.contoso.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", + "layout": "colorBlock", + "showAuthor": true, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "TEXT ABOVE TITLE", + "textAlignment": "left", + "title": "sample4", + "imageSourceType": 2 + } +} +``` +++<!-- +{ + "type": "#pageTemplate.annotation", + "description": "Create a page template in the templates folder in a site.", + "keywords": "", + "section": "documentation", + "tocPath": "PageTemplates/Create", + "suppressions": [] +} +--> |
v1.0 | Pagetemplate Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pagetemplate-delete.md | ++ +description: "Delete a page template from the templates folder in a site." + Title: "Delete pageTemplate" +ms.localizationpriority: medium +++# Delete pageTemplate ++Namespace: microsoft.graph +++Delete a [pageTemplate](../resources/pagetemplate.md) from the templates folder in a [site](../resources/site.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": "pageTemplate_delete" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +DELETE /sites/{site-id}/pageTemplates/{pageTemplate-id}/microsoft.graph.pageTemplate +``` ++## Request headers ++| Name | Description +|:--|:- +|Authorization|Bearer {token} Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +| _if-match_ | etag. If this request header is included and the eTag provided doesn't match the current tag on the item, a `412 Precondition Failed` response is returned and the item isn't deleted.| ++## Request body ++Don't supply a request body with this method. ++## Response ++If successful, this method returns a `204 No Content` HTTP response. It doesn't return anything in the response body. ++## Example ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "delete-pageTemplate", "scopes": "files.readwrite sites.readwrite.all" } --> ++```http +DELETE https://graph.microsoft.com/beta/sites/dd00d52e-0db7-4d5f-8269-90060ac688d1/pageTemplates/7bf14f9b-8764-4e54-bc5a-ee7d83dd09f7/microsoft.graph.pageTemplate +``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response. ++<!-- { "blockType": "response" } --> ++```http +HTTP/1.1 204 No Content +``` ++<!-- +{ + "type": "#pageTemplate.annotation", + "description": "Delete a page template in the templates folder in a site.", + "keywords": "", + "section": "documentation", + "tocPath": "PageTemplates/Delete", + "suppressions": [] +} +--> |
v1.0 | Pagetemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pagetemplate-get.md | ++ +description: "Return the metadata for a page template in the templates folder in a site." + Title: Get pageTemplate +ms.localizationpriority: medium ++++# Get pageTemplate ++Namespace: microsoft.graph +++Return the metadata for a [pageTemplate](../resources/pagetemplate.md) in the templates folder in a [site](../resources/site.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": "pageTemplate_get" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/{site-id}/pageTemplates/{page-template-id}/microsoft.graph.pageTemplate +``` ++## 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). ++You can use the `$expand=canvasLayout` query parameter to include the content of an item when you retrieve its metadata if the item has a **canvasLayout** relationship. +++## Request headers ++| Name | Description | +|:|:--| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +| Content-Type | application/json. Required. | +| Accept |application/json;odata.metadata=none. Optional. Removes all OData metadata from the response. We recommend including this header when the response is used in another request. | ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200 OK` and a [pageTemplate](../resources/pagetemplate.md) object in the response body. +++## Examples ++### Example 1: Get a page template in the templates folder of a site ++The following example shows how to get a page template in the templates folder of a SharePoint site. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "get-pageTemplate_1", "scopes": "sites.read.all", "tags": "service.sharepoint" } --> ++```msgraph-interactive +GET https://graph.microsoft.com/beta/sites/dd00d52e-0db7-4d5f-8269-90060ac688d1/pageTemplates/f6ed8c43-9923-4c6c-ba09-9c32b8f10aeb/microsoft.graph.pageTemplate +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. ++<!-- { "blockType": "response", "@odata.type": "microsoft.graph.pageTemplate", "truncated": true } --> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.type": "microsoft.graph.pageTemplate", + "description": "Here's the page description", + "id": "65e59907-59d5-44ff-a038-7c0bf3034567", + "name": "Home.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Templates/Home.aspx", + "title": "Organization Home", + "thumbnailWebUrl": "https://cdn.contoso.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", + "promotionKind": "page", + "pageLayout": "home", + "showComments": true, + "showRecommendedPages": false, + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "publishingState": { + "level": "published", + "versionId": "1.0" + }, + "reactions": { + "commentCount": 1 + } +} +``` ++### Example 2: Get a page template using $select ++The following example shows how to use the `$select` query parameter to retrieve specific properties of a page template. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_pageTemplate_2" +} +--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pageTemplates/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.pageTemplate?$select=id,name +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.pageTemplate", + "truncated": true +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.etag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"", + "id": "f45354cb-d634-45df-8b88-2b4e96a1dc45", + "name": "Electronic Convertible.aspx" +} +``` ++### Example 3: Get a page template with canvas content using $expand ++The following example shows how to use the `$expand` query parameter to access the page template and its content with `?$expand=canvasLayout`. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_pageTemplate_3" +} +--> +```msgraph-interactive +GET https://graph.microsoft.com/beta/sites/7f50f45e-714a-4264-9c59-3bf43ea4db8f/pageTemplates/df69e386-6c58-4df2-afc0-ab6327d5b202/microsoft.graph.pageTemplate?$expand=canvasLayout +``` ++# [JavaScript](#tab/javascript) ++++#### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.pageTemplate", + "truncated": true +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "description": "Reiciendis placeat dolores.", + "eTag": "\"{F45354CB-D634-45DF-8B88-2B4E96A1DC45},8\"", + "id": "f45354cb-d634-45df-8b88-2b4e96a1dc45", + "lastModifiedDateTime": "2023-04-16T10:01:41Z", + "name": "autotest Electronic Convertible.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Templates/Home.aspx", + "title": "autotest Electronic Convertible", + "pageLayout": "article", + "thumbnailWebUrl": "https://media.contoso.odsp.cdn.office.net/sitepagethumbnail.png", + "promotionKind": "page", + "showComments": false, + "showRecommendedPages": true, + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "parentReference": { + "listId": "468fc883-e278-4773-ba09-91351a1e42ed", + "siteId": "45bb2a3b-0a4e-46f4-8c68-749c3fea75d3" + }, + "contentType": { + "id": "0x0101009D1CB255DA76424F860D91F20E6C4118009E6554A5E299E84FB2E07731DD6C6D4A", + "name": "Site Page" + }, + "publishingState": { + "level": "draft", + "versionId": "0.4" + }, + "reactions": {}, + "canvasLayout": { + "horizontalSections": [ + { + "layout": "threeColumns", + "id": "1", + "emphasis": "neutral", + "columns": [ + { + "id": "1", + "width": 4, + "webparts": [ + { + "@odata.type": "#oneDrive.textWebPart", + "id": "f6d0ef70-c977-45e4-ae4b-4676a30d5aab", + "innerHtml": "<h1>sample content</h1>" + } + ] + }, + { + "id": "2", + "width": 4, + "webparts": [ + { + "@odata.type": "#oneDrive.textWebPart", + "id": "99f59f91-c853-433e-9e75-ad7a32e46106", + "innerHtml": "<h1>sample content</h1>" + } + ] + }, + { + "id": "3", + "width": 4, + "webparts": [ + { + "@odata.type": "#oneDrive.textWebPart", + "id": "48998492-9633-48b8-a7e9-d293533b4fa6", + "innerHtml": "<h1>sample content</h1>" + } + ] + } + ] + } + ] + } +} +``` ++<!-- +{ + "type": "#pageTemplate.annotation", + "description": "Get a page template in a site", + "keywords": "", + "section": "documentation", + "tocPath": "pageTemplates/Get", + "suppressions": [ + ] +} +--> |
v1.0 | Pagetemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pagetemplate-list.md | ++ +description: "Get the collection of pageTemplate objects from the page templates in a site. All page templates in the site are returned." + Title: List pageTemplate +ms.localizationpriority: medium ++++# List pageTemplate ++Namespace: microsoft.graph +++Get the collection of [pageTemplate](../resources/pagetemplate.md) objects in a site [site](../resources/site.md). All page templates in the site are returned (with pagination), sorted alphabetically by `name` in ascending order. ++## 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": "pagetemplate_list" } --> +## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +GET /sites/{site-id}/pageTemplates/microsoft.graph.pageTemplate +``` ++## Optional query parameters ++This method supports the `$count`, `$expand`, `$filter`, `$orderby`, `$select`, and `$top` [OData query parameters](/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).| +|Content-Type|application/json. Required.| ++## Request body ++Don't supply a request body for this method. ++## Response ++If successful, this method returns a `200` and a list of [pageTemplate](../resources/pagetemplate.md) object in the response body. ++## Example ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!--{ + "blockType": "request", + "name": "get-pageTemplates", + "scopes": "sites.read.all", + "tags": "service.sharepoint" +} +--> ++```msgraph-interactive +GET /sites/dd00d52e-0db7-4d5f-8269-90060ac688d1/pageTemplates/microsoft.graph.pageTemplate +``` ++# [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", + "@odata.type": "microsoft.graph.pageTemplate", + "truncated": true, + "isCollection":true +} +--> ++```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "value": [ + { + "id": "08f48aa6-02e3-407c-bbcb-ff61cec653fa", + "name": "sample.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Templates/sample.aspx", + "title": "sample", + "pageLayout": "article", + "showComments": true, + "showRecommendedPages": false, + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "publishingState": { + "level": "checkout", + "versionId": "1.1", + "checkedOutBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + } + }, + "reactions": { + "commentCount": 4, + "likeCount": 2 + }, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.contoso.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", + "layout": "imageAndTitle", + "showAuthor": false, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "", + "textAlignment": "left", + "imageSourceType": 2, + "title": "sample" + } + }, + { + "id": "7d87eee1-7c77-46b5-b2c4-ad6e4e432a8e", + "name": "Home.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Templates/Home.aspx", + "title": "Home", + "pageLayout": "home", + "showComments": true, + "showRecommendedPages": false, + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "publishingState": { + "level": "checkout", + "versionId": "1.1", + "checkedOutBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + } + }, + "reactions": { + "commentCount": 1 + }, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.contoso.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", + "layout": "imageAndTitle", + "showAuthor": true, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "Text Above Title", + "textAlignment": "left", + "imageSourceType": 2, + "title": "Home", + "hasTitleBeenCommitted": true + } + } + ] +} +``` ++<!-- +{ + "type": "#pageTemplate.annotation", + "description": "Enumerate the list of page templates in a site", + "keywords": "", + "section": "documentation", + "tocPath": "PageTemplates/Enumerate", + "suppressions": [ + ] +} +--> |
v1.0 | Pagetemplate Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pagetemplate-update.md | + + Title: "Update pageTemplate" +description: "Update the properties of a pageTemplate object." ++ms.localizationpriority: medium ++++# Update pageTemplate ++Namespace: microsoft.graph +++Update the properties of a [pageTemplate](../resources/pagetemplate.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": "pageTemplate_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++```http +PATCH /sites/{site-id}/pageTemplates/{page-template-id}/microsoft.graph.pageTemplate +``` ++## 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 ++> **Note:**: You must include `@odata.type=#microsoft.graph.pageTemplate` in the request body. The `@odata.type=#microsoft.graph.pageTemplate` is a property in the HTTP request body for the Microsoft Graph API that specifies the page template type for SharePoint. +++|Property|Type|Description| +|:-|:|:-| +|description|String|The description of the page template. Optional.| +|thumbnailWebUrl|String|The URL of the page template's thumbnail image. Optional.| +|title|String|The title of the page template. Optional.| +|titleArea|[titleArea](../resources/titlearea.md)|The title area on the page template. Optional.| +|canvasLayout|[canvasLayout](../resources/canvaslayout.md)|The layout of the content in a page template, including horizontal sections and vertical section. The content of the entire page layout must be provided, because the update function doesn't support partial updates. Optional.| ++## Response ++If successful, this method returns a `200 OK` response code and an updated [pageTemplate](../resources/pagetemplate.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_pageTemplate" +} +--> ++```http +PATCH https://graph.microsoft.com/beta/sites/dd00d52e-0db7-4d5f-8269-90060ac688d1/pageTemplates/8fbff3f5-0e5d-49e7-89c7-2b042b3bfaa6/microsoft.graph.pageTemplate +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.pageTemplate", + "title": "sample", + "showRecommendedPages": false +} +``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response. ++> **Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.pageTemplate", + "truncated": true +} +--> ++```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.pageTemplate", + "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7", + "name": "sample.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Templates/sample.aspx", + "title": "sample", + "pageLayout": "article", + "showComments": true, + "showRecommendedPages": false, + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "publishingState": { + "level": "checkout", + "versionId": "0.1", + "checkedOutBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + } + }, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.contoso.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", + "layout": "colorBlock", + "showAuthor": true, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "TEXT ABOVE TITLE", + "textAlignment": "left", + "title": "sample", + "imageSourceType": 2 + } +} +``` + |
v1.0 | Partner Security Partnersecurityscore Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-partnersecurityscore-get.md | + + Title: "Get partnerSecurityScore" +description: "Read the properties and relationships of a partnerSecurityScore object." ++ms.localizationpriority: medium ++++# Get partnerSecurityScore ++Namespace: microsoft.graph.partner.security +++Read the properties and relationships of a [partnerSecurityScore](../resources/partner-security-partnersecurityscore.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": "partner_security_partnersecurityscore_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityScore +``` ++## Optional query parameters ++This method supports OData query parameters to customize the response. For example, the `$expand` parameter is useful to retrieve optional properties like **requirements** or **history**. For more information and examples, 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.partner.security.partnerSecurityScore](../resources/partner-security-partnersecurityscore.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_partnersecurityscore" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityScore +``` ++# [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": "microsoft.graph.partner.security.partnerSecurityScore" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.partner.security.partnerSecurityScore", + "id": "9021efeb-af08-e3dd-9c11-ac69f92e43b8", + "updatedDateTime": "2024-01-17T00:00:00Z", + "lastRefreshDateTime":"2024-02-28T00:00:00Z", + "currentScore": 14.29, + "maxScore": 100.0 + } +} +``` + |
v1.0 | Partner Security Partnersecurityscore List Customerinsights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-partnersecurityscore-list-customerinsights.md | + + Title: "List customerInsights" +description: "Get a list of the customerInsight data and their properties." ++ms.localizationpriority: medium ++++# List customerInsights ++Namespace: microsoft.graph.partner.security +++Get a list of the [customerInsight](../resources/partner-security-customerinsight.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": "partner_security_partnersecurityscore_list_customerinsights" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityScore/customerInsights +``` ++## Optional query parameters ++This method supports OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++Server-side pagination is supported by following the `nextLink` provided in the API response when you use the `$skipToken` OData query parameter. Using client-side pagination with `$skip` and `$top` isn't supported. ++## 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.partner.security.customerInsight](../resources/partner-security-customerinsight.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_customerinsight" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityScore/customerInsights +``` ++# [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.partner.security.customerInsight)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.partner.security.customerInsight", + "tenantId": "d90cb160-123d-0608-3fd6-c53551dcc20c", + "mfa": { + "@odata.type": "microsoft.graph.partner.security.customerMfaInsight", + "compliantAdminsCount": 1, + "compliantNonAdminsCount": 2, + "totalUsersCount": 5, + "securityDefaultsStatus": "enabled", + "mfaConditionalAccessPolicyStatus": "disabled", + "legacyPerUserMfaStatus": "disabled" + } + } + ] +} +``` + |
v1.0 | Partner Security Partnersecurityscore List History | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-partnersecurityscore-list-history.md | + + Title: "List securityScoreHistory" +description: "Lists the history of security score changes for the partner." ++ms.localizationpriority: medium ++++# List securityScoreHistory ++Namespace: microsoft.graph.partner.security +++Get a list of [securityScoreHistory](../resources/partner-security-securityscorehistory.md) entries. +++## 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": "partner_security_partnersecurityscore_list_history" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityScore/history +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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.partner.security.securityScoreHistory](../resources/partner-security-securityscorehistory.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_securityscorehistory" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityScore/history +``` ++# [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.partner.security.securityScoreHistory)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.partner.security.securityScoreHistory", + "id": "a368fa06-ba31-2d7e-3b0c-2ded0b0c093e", + "createdDateTime": "2024-01-17T00:00:00Z", + "score": 14.29, + "compliantRequirementsCount": 4, + "totalRequirementsCount": 5 + } + ] +} +``` + |
v1.0 | Partner Security Partnersecurityscore List Requirements | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-partnersecurityscore-list-requirements.md | + + Title: "List requirements" +description: "Get a list of the security requirements to understand if the requirement is compliant and how to improve the score." ++ms.localizationpriority: medium ++++# List requirements ++Namespace: microsoft.graph.partner.security +++Get a list of [securityRequirement](../resources/partner-security-securityrequirement.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": "partner-security-partnersecurityscore-list-requirements" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityScore/requirements +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_securityrequirement" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityScore/requirements +``` ++# [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.partner.security.securityRequirement)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.partner.security.securityRequirement", + "id": "adc3e54c-8dde-f1cb-b92e-ffb989948282", + "requirementType": "securityContactProvided", + "complianceStatus": "compliant", + "actionUrl": "https://aka.ms/partner-center-security-contact", + "helpUrl": "https://aka.ms/partner-center-security-dashboard-security-contact", + "score": 20, + "maxScore": 20, + "state": "active", + "updatedDateTime": "2023-09-26T04:04:01.4261872Z" + } + ] +} +``` + |
v1.0 | Partner Security Securityrequirement Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-securityrequirement-get.md | + + Title: "Get securityRequirement" +description: "Read the properties and relationships of a ecurityRequirement object." ++ms.localizationpriority: medium ++++# Get securityRequirement ++Namespace: microsoft.graph.partner.security +++Read the properties and relationships of a [securityRequirement](../resources/partner-security-securityrequirement.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": "partner-security-securityrequirement-get" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityScore/requirements/{securityRequirementId} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_securityrequirement" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityScore/requirements/{securityRequirementId} +``` ++# [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": "microsoft.graph.partner.security.securityRequirement" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.partner.security.securityRequirement", + "id": "adc3e54c-8dde-f1cb-b92e-ffb989948282", + "requirementType": "securityContactProvided", + "complianceStatus": "compliant", + "actionUrl": "https://aka.ms/partner-center-security-contact", + "helpUrl": "https://aka.ms/partner-center-security-dashboard-security-contact", + "score": "20", + "maxScore": "20", + "state": "active", + "updatedDateTime": "2023-09-26T04:04:01.4261872Z" + } +} +``` + |
v1.0 | Partner Security Securityscorehistory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/partner-security-securityscorehistory-get.md | + + Title: "Get securityScoreHistory" +description: "Read the properties and relationships of a securityScoreHistory object." ++ms.localizationpriority: medium ++++# Get securityScoreHistory ++Namespace: microsoft.graph.partner.security +++Read the properties and relationships of a [securityScoreHistory](../resources/partner-security-securityscorehistory.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": "partner_security_securityscorehistory_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/partner/securityScore/history/{securityScoreHistoryId} +``` ++## Optional query parameters ++This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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.partner.security.securityScoreHistory](../resources/partner-security-securityscorehistory.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_securityscorehistory" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/partner/securityScore/history/{securityScoreHistoryId} +``` ++# [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": "microsoft.graph.partner.security.securityScoreHistory" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.partner.security.securityScoreHistory", + "id": "a368fa06-ba31-2d7e-3b0c-2ded0b0c093e", + "createdDateTime": "2024-01-17T00:00:00Z", + "score": 80.0, + "compliantRequirementsCount": 4, + "totalRequirementsCount": 5 + } +} +``` + |
v1.0 | Payload Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/payload-get.md | Choose the permission or permissions marked as least privileged for this API. Us --> ``` http GET /security/attackSimulation/payloads/{payloadId}+GET /security/attackSimulation/simulations/{simulationId}/payload ``` ## Optional query parameters |
v1.0 | Pendingexternaluserprofile Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pendingexternaluserprofile-get.md | Retrieve the properties of a specific [pendingExternalUserProfile](../resources/ 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": "pendingexternaluserprofile-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "pendingexternaluserprofile_get" } --> [!INCLUDE [permissions-table](../includes/permissions/pendingexternaluserprofile-get-permissions.md)] [!INCLUDE [rbac-externaluserprofiles-apis-read](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-read.md)] |
v1.0 | Pendingexternaluserprofile Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/pendingexternaluserprofile-update.md | Update the properties of a [pendingExternalUserProfile](../resources/pendingexte 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": "pendingexternaluserprofile-update-permissions" -} >+<!-- { "blockType": "permissions", "name": "pendingexternaluserprofile_update" } --> [!INCLUDE [permissions-table](../includes/permissions/pendingexternaluserprofile-update-permissions.md)] [!INCLUDE [rbac-externaluserprofiles-apis-write](../includes/rbac-for-apis/rbac-externaluserprofiles-apis-write.md)] |
v1.0 | Peopleadminsettings Delete Photoupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/peopleadminsettings-delete-photoupdatesettings.md | Delete a [photoUpdateSettings](../resources/photoupdatesettings.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": "peopleadminsettings-delete-photoupdatesettings-permissions" -} >+<!-- { "blockType": "permissions", "name": "peopleadminsettings_delete_photoupdatesettings" } --> [!INCLUDE [permissions-table](../includes/permissions/peopleadminsettings-delete-photoupdatesettings-permissions.md)] ## HTTP request |
v1.0 | Peopleadminsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/peopleadminsettings-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "peopleadminsettings_get" } --> [!INCLUDE [permissions-table](../includes/permissions/peopleadminsettings-get-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Peopleadminsettings List Photoupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/peopleadminsettings-list-photoupdatesettings.md | Get a list of the [photoUpdateSettings](../resources/photoupdatesettings.md) obj 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": "peopleadminsettings-list-photoupdatesettings-permissions" -} >+<!-- { "blockType": "permissions", "name": "peopleadminsettings_list_photoupdatesettings" } --> ## HTTP request Content-Type: application/json } ] }-``` +``` |
v1.0 | Peopleadminsettings List Profilecardproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/peopleadminsettings-list-profilecardproperties.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "peopleadminsettings_list_profilecardproperties" } --> [!INCLUDE [permissions-table](../includes/permissions/peopleadminsettings-list-profilecardproperties-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Peopleadminsettings Post Profilecardproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/peopleadminsettings-post-profilecardproperties.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "peopleadminsettings_post_profilecardproperties" } --> [!INCLUDE [permissions-table](../includes/permissions/peopleadminsettings-post-profilecardproperties-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Photoupdatesettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/photoupdatesettings-get.md | Read the properties and relationships of a [photoUpdateSettings](../resources/ph 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": "photoupdatesettings-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "photoupdatesettings_get" } --> [!INCLUDE [permissions-table](../includes/permissions/photoupdatesettings-get-permissions.md)] ## HTTP request |
v1.0 | Photoupdatesettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/photoupdatesettings-update.md | Update the properties of a [photoUpdateSettings](../resources/photoupdatesetting 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": "photoupdatesettings-update-permissions" -} >+<!-- { "blockType": "permissions", "name": "photoupdatesettings_update" } --> [!INCLUDE [permissions-table](../includes/permissions/photoupdatesettings-update-permissions.md)] ## HTTP request |
v1.0 | Plannerplanconfiguration Delete Localizations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/plannerplanconfiguration-delete-localizations.md | - Title: "Delete plannerPlanConfigurationLocalization" -description: "Delete a plannerPlanConfigurationLocalization object." ---doc_type: apiPageType ---# Delete plannerPlanConfigurationLocalization --Namespace: microsoft.graph ---Delete a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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": "plannerplanconfiguration_delete_localizations" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >--For a specific localization based on a business scenario ID and a localization ID: --``` http -DELETE /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} -``` --For a specific localization based on the unique name of a business scenario and a localization ID: --``` http -DELETE /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} -``` --## 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 `204 No Content` response code. --## Examples --### Request --The following example shows a request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "delete_plannerplanconfigurationlocalization", - "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "en-us"] -} >-``` http -DELETE https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us -``` --# [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 | Plannerplanconfiguration Post Localizations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/plannerplanconfiguration-post-localizations.md | - Title: "Create plannerPlanConfigurationLocalization" -description: "Create a new plannerPlanConfigurationLocalization object." ---doc_type: apiPageType ---# Create plannerPlanConfigurationLocalization --Namespace: microsoft.graph ---Create a new [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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": "plannerplanconfiguration_post_localizations" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >--For a specific localization based on a business scenario ID: --``` http -POST /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations -``` --For a specific localization based on the unique name of a business scenario: --``` http -POST /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations -``` --## 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 [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object. --You can specify the following properties when you create a **plannerPlanConfigurationLocalization**. --|Property|Type|Description| -|:|:|:| -|buckets|[plannerPlanConfigurationBucketLocalization](../resources/plannerplanconfigurationbucketlocalization.md) collection|Localizations for buckets specified in the [plannerPlanConfiguration](../resources/plannerplanconfiguration.md). Required.| -|languageTag|String|The code for the language the localized data is intended for. Required.| -|planTitle|String|Localized title of the plan. Required.| --## Response --If successful, this method returns a `201 Created` response code and a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object in the response body. --## Examples --### Request --The following example shows a request. ---# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "create_plannerplanconfigurationlocalization_from_", - "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d"] -} >-``` http -POST https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", - "languageTag": "en-us", - "planTitle": "Order Tracking", - "buckets": [ - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "deliveryBucket", - "name": "Deliveries" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "storePickupBucket", - "name": "Pickup" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "specialOrdersBucket", - "name": "Special Orders" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "returnProcessingBucket", - "name": "Customer Returns" - } - ] -} -``` --# [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": "microsoft.graph.plannerPlanConfigurationLocalization" -} >-``` http -HTTP/1.1 201 Created -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", - "id": "en-us", - "languageTag": "en-us", - "planTitle": "Order Tracking", - "buckets": [ - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "deliveryBucket", - "name": "Deliveries" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "storePickupBucket", - "name": "Pickup" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "specialOrdersBucket", - "name": "Special Orders" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "returnProcessingBucket", - "name": "Customer Returns" - } - ] -} -``` |
v1.0 | Plannerplanconfiguration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/plannerplanconfiguration-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the properties of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object for a [businessScenario](../resources/businessscenario.md). +Update the properties of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object and its [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) collection for a [businessScenario](../resources/businessscenario.md). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] PATCH /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfig |Property|Type|Description| |:|:|:|-|defaultLanguage|String|The language that should be used for creating plans when no language has been specified. Required.| -|buckets|[plannerPlanConfigurationBucketDefinition](../resources/plannerplanconfigurationbucketdefinition.md) collection|Buckets that will be available in the plan. Required.| +|defaultLanguage|String|The language that should be used for creating plans when no language has been specified.| +|buckets|[plannerPlanConfigurationBucketDefinition](../resources/plannerplanconfigurationbucketdefinition.md) collection|Buckets available in the plan.| +|localizations|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) collection|Localized names for the plan configuration.| ## Response PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864 Content-Type: application/json {- "@odata.type": "#microsoft.graph.plannerPlanConfiguration", "defaultLanguage": "en-us", "buckets": [ { Content-Type: application/json { "externalBucketId": "returnProcessingBucket" }+ ], + "localizations": [ + { + "id": "en-us", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] + }, + { + "id": "es-es", + "languageTag": "es-es", + "planTitle": "Seguimiento de pedidos", + "buckets": [ + { + "externalBucketId": "deliveryBucket", + "name": "Entregas" + }, + { + "externalBucketId": "storePickupBucket", + "name": "Recogida" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Pedidos especiales" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Devoluciones de clientes" + } + ] + } ] } ``` Content-Type: application/json { "externalBucketId": "returnProcessingBucket" }+ ], + "localizations": [ + { + "id": "en-us", + "languageTag": "en-us", + "planTitle": "Order Tracking", + "buckets": [ + { + "externalBucketId": "deliveryBucket", + "name": "Deliveries" + }, + { + "externalBucketId": "storePickupBucket", + "name": "Pickup" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Special Orders" + }, + { + "externalBucketId": "returnProcessingBucket", + "name": "Customer Returns" + } + ] + }, + { + "id": "es-es", + "languageTag": "es-es", + "planTitle": "Seguimiento de pedidos", + "buckets": [ + { + "externalBucketId": "deliveryBucket", + "name": "Entregas" + }, + { + "externalBucketId": "storePickupBucket", + "name": "Recogida" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Pedidos especiales" + }, + { + "externalBucketId": "specialOrdersBucket", + "name": "Devoluciones de clientes" + } + ] + } ] } ``` |
v1.0 | Plannerplanconfigurationlocalization Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/plannerplanconfigurationlocalization-get.md | - Title: "Get plannerPlanConfigurationLocalization" -description: "Read the properties and relationships of a plannerPlanConfigurationLocalization object." ---doc_type: apiPageType ---# Get plannerPlanConfigurationLocalization --Namespace: microsoft.graph ---Read the properties and relationships of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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": "plannerplanconfigurationlocalization_get" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >--For a specific localization based on a business scenario ID and a localization ID: --``` http -GET /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} -``` --For a specific localization based on the unique name of a business scenario and a localization ID: --``` http -GET /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} -``` --## Optional query parameters --This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). --## Request headers --|Name|Description| -|:|:| -|Authorization|Bearer {token}. Required. 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 [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object in the response body. --## Examples --### Request --The following example shows a request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "get_plannerplanconfigurationlocalization", - "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "en-us"] -} >-``` http -GET https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us -``` --# [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": "microsoft.graph.plannerPlanConfigurationLocalization" -} >-``` http -HTTP/1.1 200 OK -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", - "id": "en-us", - "languageTag": "en-us", - "planTitle": "Order Tracking", - "buckets": [ - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "deliveryBucket", - "name": "Deliveries" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "storePickupBucket", - "name": "Pickup" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "specialOrdersBucket", - "name": "Special Orders" - }, - { - "@odata.type": "microsoft.graph.plannerPlanConfigurationBucketLocalization", - "externalBucketId": "returnProcessingBucket", - "name": "Customer Returns" - } - ] -} -``` |
v1.0 | Plannerplanconfigurationlocalization Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/plannerplanconfigurationlocalization-update.md | - Title: "Update plannerPlanConfigurationLocalization" -description: "Update the properties of a plannerPlanConfigurationLocalization object." ---doc_type: apiPageType ---# Update plannerPlanConfigurationLocalization --Namespace: microsoft.graph ---Update the properties of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.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": "plannerplanconfigurationlocalization_update" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >--For a specific localization based on a business scenario ID and a localization ID: --``` http -PATCH /solutions/businessScenarios/{businessScenarioId}/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} -``` --For a specific localization based on the unique name of a business scenario and a localization ID: --``` http -PATCH /solutions/businessScenarios(uniqueName='{uniqueName}')/planner/planConfiguration/localizations/{plannerPlanConfigurationLocalizationId} -``` --## 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| -|:|:|:| -|buckets|[plannerPlanConfigurationBucketLocalization](../resources/plannerplanconfigurationbucketlocalization.md) collection|Localizations for buckets specified in the [plannerPlanConfiguration](../resources/plannerplanconfiguration.md). Optional.| -|planTitle|String|Localized title of the plan. Optional.| --## Response --If successful, this method returns a `200 OK` response code and an updated [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object in the response body. --## Examples --### Request --The following example shows a request. --# [HTTP](#tab/http) -<!-- { - "blockType": "request", - "name": "update_plannerplanconfigurationlocalization", - "sampleKeys": ["c5d514e6c6864911ac46c720affb6e4d", "en-us"] -} >-``` http -PATCH https://graph.microsoft.com/beta/solutions/businessScenarios/c5d514e6c6864911ac46c720affb6e4d/planner/planConfiguration/localizations/en-us -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", - "planTitle": "Order Tracking", - "buckets": [ - { - "externalBucketId": "deliveryBucket", - "name": "Deliveries" - }, - { - "externalBucketId": "storePickupBucket", - "name": "Pickup" - }, - { - "externalBucketId": "specialOrdersBucket", - "name": "Special Orders" - }, - { - "externalBucketId": "returnProcessingBucket", - "name": "Customer Returns" - } - ] -} -``` --# [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": "microsoft.graph.plannerPlanConfigurationLocalization" -} >-``` http -HTTP/1.1 200 OK -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.plannerPlanConfigurationLocalization", - "id": "en-us", - "languageTag": "en-us", - "planTitle": "Order Tracking", - "buckets": [ - { - "externalBucketId": "deliveryBucket", - "name": "Deliveries" - }, - { - "externalBucketId": "storePickupBucket", - "name": "Pickup" - }, - { - "externalBucketId": "specialOrdersBucket", - "name": "Special Orders" - }, - { - "externalBucketId": "returnProcessingBucket", - "name": "Customer Returns" - } - ] -} -``` |
v1.0 | Printjob Cancel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/printjob-cancel.md | Cancel a print job. Print jobs can be canceled only on behalf of a user, using d ## 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). +> **Note:** For an app with delegated permissions to cancel other users' jobs, the signed-in user must be a member of the Printer Administrator role. + <!-- { "blockType": "permissions", "name": "printjob_cancel" } --> [!INCLUDE [permissions-table](../includes/permissions/printjob-cancel-permissions.md)] -For an app with delegated permissions to cancel other users' jobs, the signed-in user must be a member of one of the following administrator roles: -- Global Administrator-- Printer Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Printjob Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/printjob-get.md | Retrieve the properties and relationships of a print job. ## 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": "printjob_get" } --> --For an app with delegated permissions to retrieve other users' jobs, the signed-in user must be a member of one of the following administrator roles: -- Global Administrator-- Printer Administrator+> **Note:** For an app with delegated permissions to cancel other users' jobs, the signed-in user must be a member of the Printer Administrator role. For an app with application permissions to retrieve users' jobs, the app needs a permission that grants [Get printer](printer-get.md) access along with one of the application permissions described in the [Permissions](#permissions) table. +<!-- { "blockType": "permissions", "name": "printjob_get" } --> + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Profile Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/profile-delete.md | Title: "Delete profile" -description: "Delete profile." +description: "Delete a profile object from a user's account." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Deletes a [profile](../resources/profile.md) object from a user's account. +Delete a [profile](../resources/profile.md) object from a user's account. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Profilecardproperty Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/profilecardproperty-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "profilecardproperty_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/profilecardproperty-delete-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Profilecardproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/profilecardproperty-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "profilecardproperty_get" } --> [!INCLUDE [permissions-table](../includes/permissions/profilecardproperty-get-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Profilecardproperty Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/profilecardproperty-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "profilecardproperty_update" } --> [!INCLUDE [permissions-table](../includes/permissions/profilecardproperty-update-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Profilephoto Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/profilephoto-update.md | You can use either PATCH or PUT for this operation. > [!NOTE] > > - Permissions marked with * are supported only for backward compatibility. Please update your solutions to use an alternative permission and avoid using these permissions going forward.-> - Global admin and User admin can update the photo of any user in the organization by using delegated permissions. This operation is also supported with application permissions. Updating the photo of any user in the organization requires *ProfilePhoto.ReadWrite.All* or *User.ReadWrite.All* permission. Updating the photo of the signed-in user only requires *User.ReadWrite* permission. +> - Users with admin roles such as User admins can update the photo of any user in the organization by using delegated permissions. This operation is also supported with application permissions. Updating the photo of any user in the organization requires *ProfilePhoto.ReadWrite.All* or *User.ReadWrite.All* permission. Updating the photo of the signed-in user only requires *User.ReadWrite* permission. > - Updating a user's photo using the Microsoft Graph API is currently not supported in Azure AD B2C tenants. ## HTTP request |
v1.0 | Protectionpolicybase Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/protectionpolicybase-activate.md | Namespace: microsoft.graph Activate a [protectionPolicyBase](../resources/protectionpolicybase.md). +Currently, only one active backup policy per underlying service is supported (that is, one for OneDrive accounts, one for SharePoint sites, and one for Exchange Online users). You can add or remove artifacts (sites or user accounts) to or from each active policy. + [!INCLUDE [national-cloud-support](../../includes/global-only.md)] ## Permissions Don't supply a request body for this method. If successful, this action returns a `202 Accepted` response code and a [protectionPolicyBase](../resources/protectionpolicybase.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 : Activate an inactive protection policy +### Example 1: Activate an inactive protection policy -Activate an inactive protection policy. +The following example shows a request to activate an inactive protection policy. #### Request Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/prote } ``` -### Example 2 : Activate an active protection policy +### Example 2: Activate an active protection policy -Activate an already active protection policy. +The following example shows a request to activate a protection policy that's already active. This request results in an error. #### Request |
v1.0 | Protectionpolicybase Deactivate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/protectionpolicybase-deactivate.md | Don't supply a request body for this method. If successful, this action returns a `202 Accepted` response code and a [protectionPolicyBase](../resources/protectionpolicybase.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: Deactivate an active protection policy |
v1.0 | Protectionpolicybase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/protectionpolicybase-delete.md | Don't supply a request body for this method. If successful, this method returns a `204 No Content` response code. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Protectionpolicybase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/protectionpolicybase-get.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [protectionPolicyBase](../resources/protectionpolicybase.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 | Protectionrulebase Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/protectionrulebase-post.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new [protection rule](../resources/protectionrulebase.md) associated with a [protection policy](../resources/protectionpolicybase.md). You can use this method to create a [mailbox](../resources/mailboxprotectionrule.md), [driveProtectionRule](../resources/driveprotectionrule.md), or [siteIProtectionRule](../resources/siteprotectionrule.md). +Create a new [protection rule](../resources/protectionrulebase.md) associated with a [protection policy](../resources/protectionpolicybase.md). You can use this method to create a [mailboxProtectionRule](../resources/mailboxprotectionrule.md), [driveProtectionRule](../resources/driveprotectionrule.md), or [siteProtectionRule](../resources/siteprotectionrule.md). An inclusion rule indicates that a protection policy should contain protection units that match the specified rule criteria. The initial status of a protection rule upon creation is `active`. After the rule is applied, the state is either `completed` or `completedWithErrors`. You can specify the following properties when you create a **mailboxInclusionRul If successful, this method returns a `201 Created` response code and a [protectionRuleBase](../resources/protectionRuleBase.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 a new siteInclusionRule associated with a SharePoint protection policy |
v1.0 | Protectionunitbase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/protectionunitbase-get.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [protectionUnitBase](../resources/protectionunitbase.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 | Provisioningobjectsummary List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/provisioningobjectsummary-list.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/provisioningobjectsummary-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: +> - Reports Reader +> - Security Reader +> - Security Administrator +> - Global Reader +> - Security Administrator +> - Security Operator +> - Application Administrator +> - Cloud Application Administrator + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Range Boundingrect | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-boundingrect.md | Title: "Range: BoundingRect" -description: "." + Title: "range: boundingRect" +description: "Get the smallest range object that encompasses the given ranges." ms.localizationpriority: medium doc_type: apiPageType -# Range: BoundingRect +# range: boundingRect Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16". +Get the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of *B2:C5* and *D10:E15* is *B2:E16*. + ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body In the request body, provide a JSON object with the following parameters. |
v1.0 | Range Clear | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-clear.md | Namespace: microsoft.graph Clear range values such as format, fill, and border. + ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_clear" 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 The following example shows the response. <!-- { |
v1.0 | Range Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-delete.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Deletes the cells associated with the range.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_delete" 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 The following example shows the response. <!-- { |
v1.0 | Range Entirecolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-entirecolumn.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Gets an object that represents the entire column of the range.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_entirecolumn" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/EntireColumn ``` +# [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. <!-- { |
v1.0 | Range Entirerow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-entirerow.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Gets an object that represents the entire row of the range.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_entirerow" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/EntireRow ``` +# [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. <!-- { |
v1.0 | Range Insert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-insert.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_insert" 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 The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Range Lastcell | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-lastcell.md | Title: "Range: LastCell" -description: "." + Title: "range: lastCell" +description: "Get the last cell within the range." ms.localizationpriority: medium doc_type: apiPageType -# Range: LastCell +# range: lastCell Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". +Get the last cell within the range. For example, the last cell of *B2:D5* is *D5*. ++ ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_lastcell" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/LastCell ``` +# [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. <!-- { |
v1.0 | Range Lastcolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-lastcolumn.md | Title: "Range: LastColumn" -description: "." + Title: "range: lastColumn" +description: "Get the last column within the range." ms.localizationpriority: medium doc_type: apiPageType -# Range: LastColumn +# range: lastColumn Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". +Gets the last column within the range. For example, the last column of *B2:D5* is *D2:D5*. ++ ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_lastcolumn" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/LastColumn ``` +# [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. <!-- { |
v1.0 | Range Lastrow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-lastrow.md | Title: "Range: LastRow" -description: "." + Title: "range: lastRow" +description: "Get the last row within the range." ms.localizationpriority: medium doc_type: apiPageType -# Range: LastRow +# range: lastRow Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". +Get the last row within the range. For example, the last row of *B2:D5* is *B5:D5*. ++ ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_lastrow" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/LastRow ``` +# [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. <!-- { |
v1.0 | Range Merge | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-merge.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Merge the range cells into one region in the worksheet.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_merge" 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 The following example shows the response. <!-- { |
v1.0 | Range Unmerge | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-unmerge.md | Namespace: microsoft.graph Unmerge the range cells into separate cells. + ## 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). If successful, this method returns a `204 No Content` response code. It doesn't ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_unmerge" The following example shows a request. POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/unmerge ``` +# [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 | Range Usedrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/range-usedrange.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Returns the used range of the given range 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_usedrange" 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 The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeborder Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeborder-get.md | If successful, this method returns a `200 OK` response code and [workbookRangeBo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangeborder" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/borders/{sideIndex} ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeborder List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeborder-list.md | If successful, this method returns a `200 OK` response code and collection of [w ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangebordercollection" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/borders ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeborder Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeborder-update.md | If successful, this method returns a `200 OK` response code and updated [workboo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeborder" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangebordercollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangebordercollection-itemat.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangebordercollection_itemat" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/borders/ItemAt(index=8) ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefill Clear | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefill-clear.md | Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangefill_clear" The following example shows a request. POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/fill/clear ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Rangefill Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefill-get.md | If successful, this method returns a `200 OK` response code and [workbookRangeFi ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangefill" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/fill ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefill Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefill-update.md | If successful, this method returns a `200 OK` response code and updated [workboo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangefill" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefont Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefont-get.md | If successful, this method returns a `200 OK` response code and [workbookRangeFo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangefont" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/font ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefont Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangefont-update.md | If successful, this method returns a `200 OK` response code and updated [workboo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangefont" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeformat Autofitcolumns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-autofitcolumns.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangeformat_autofitcolumns" The following example shows a request. POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/autofitColumns ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Rangeformat Autofitrows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-autofitrows.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangeformat_autofitrows" The following example shows a request. POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/autofitRows ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Rangeformat Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Retrieve the properties and relationships of rangeformat 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). If successful, this method returns a `200 OK` response code and [workbookRangeFo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangeformat" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format ``` +# [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. <!-- { |
v1.0 | Rangeformat List Borders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-list-borders.md | If successful, this method returns a `200 OK` response code and collection of [w ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_borders" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/borders ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeformat Post Borders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-post-borders.md | If successful, this method returns `201 Created` response code and [workbookRang ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_rangeborder_from_rangeformat" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ In the request body, supply a JSON representation of [workbookRangeBorder](../resources/workbookrangeborder.md) object. ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. |
v1.0 | Rangeformat Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangeformat-update.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Update the properties of rangeformat 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). The result of this set of requests is a table with three cells formatted like th This request updates the vertical alignment, row height, and column height of the first cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the font style, size, and color of the first cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_font", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the background color of the first cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_fill", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the vertical alignment, horizontal alignment, row height, and column height of the second cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_two", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the font style and size of the second cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_font_two", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the background color of the second cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_fill_two", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the horizontal alignment, vertical alignment, row height, and column height of the third cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_three", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the font style, size, and color of the third cell. The underline property takes **Single** or **Double** as values. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_font_three", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the background color of the third cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_fill_three", Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangesort Apply | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rangesort-apply.md | Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangesort_apply" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Rbacapplicationmultiple List Resourcenamespaces | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/rbacapplicationmultiple-list-resourcenamespaces.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "rbacapplicationmultiple_list_resourcenamespaces" } --> [!INCLUDE [permissions-table](../includes/permissions/rbacapplicationmultiple-list-resourcenamespaces-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Reflectcheckinresponse Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reflectcheckinresponse-get.md | Namespace: microsoft.graph Read the properties and relationships of a [reflectCheckInResponse](../resources/reflectcheckinresponse.md) object. This method gets the responses to a [Microsoft Reflect](https://reflect.microsoft.com/) check-in. + ## 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": "reflectcheckinresponse-get-permissions" -} >+<!-- { "blockType": "permissions", "name": "reflectcheckinresponse_get" } --> [!INCLUDE [permissions-table](../includes/permissions/reflectcheckinresponse-get-permissions.md)] ## HTTP request |
v1.0 | Reportroot Getazureadapplicationsigninsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getazureadapplicationsigninsummary.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "reportroot_getazureadapplicationsigninsummary" } --> [!INCLUDE [permissions-table](../includes/permissions/reportroot-getazureadapplicationsigninsummary-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ``` http |
v1.0 | Reportroot Getmicrosoft365copilotusageuserdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getmicrosoft365copilotusageuserdetail.md | + + Title: "reportRoot: getMicrosoft365CopilotUsageUserDetail" +description: "Get the most recent activity data for enabled users of Microsoft 365 Copilot apps." ++ms.localizationpriority: medium ++++# reportRoot: getMicrosoft365CopilotUsageUserDetail ++Namespace: microsoft.graph +++Get the most recent activity data for enabled users of Microsoft 365 Copilot apps. +++## 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": "reportroot_getmicrosoft365copilotusageuserdetail" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/getMicrosoft365CopilotUsageUserDetail(period='{period_value}') +``` ++## Function parameters +In the request URL, provide the following query parameters with values. ++|Parameter|Type|Description| +|:|:|:| +|period|String|The number of previous days over which to report aggregated usage. The supported values are: `D7`, `D30`, `D90`, `D180`, `ALL`. The first four values follow the format Dn where n represents the number of previous days over which to aggregate data. `ALL` indicates to report usage for 7, 30, 90, and 180 days.| ++## Optional query parameters ++This method supports the `$format` [OData query parameter](/graph/query-parameters) to customize the response. The default output type is `application/json`. However, if you want to specify the output type, you can use the OData `$format` query parameter to set the default output to `text/csv` or `application/json`. ++## 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 ++### CSV ++If successful, this method returns a `302 Found` response that redirects to a preauthenticated download URL for the report. That URL can be found in the `Location` header in the response. ++Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header. ++The CSV file has the following headers for columns. ++- Report Refresh Date +- Report Period +- User Principal Name +- Display Name +- Last Activity Date +- Microsoft Teams Copilot Last Activity Date +- Word Copilot Last Activity Date +- Excel Copilot Last Activity Date +- PowerPoint Copilot Last Activity Date +- Outlook Copilot Last Activity Date +- OneNote Copilot Last Activity Date +- Loop Copilot Last Activity Date +- Copilot Chat Last Activity Date ++### JSON ++If successful, this method returns a `200 OK` response code and a JSON object in the response body. ++## Examples ++### Example 1: CSV output ++The following example returns a URL for a CSV file. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "reportroot_getmicrosoft365copilotusageuserdetail_csv" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUsageUserDetail(period='D7')?$format=text/csv +``` ++# [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 302 Found +Content-Type: text/plain +Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe +``` ++The CSV file in the `Location` header of the 302 response has the following schema. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Edm.Stream" +} +--> +```http +HTTP/1.1 200 OK +Content-Type: application/octet-stream ++Report Refresh Date,Report Period,User Principal Name,Display Name,Last Activity Date,Microsoft Teams Copilot Last Activity Date,Word Copilot Last Activity Date,Excel Copilot Last Activity Date,PowerPoint Copilot Last Activity Date,Outlook Copilot Last Activity Date,OneNote Copilot Last Activity Date,Loop Copilot Last Activity Date,Copilot Chat Last Activity Date +``` ++### Example 2: JSON output ++The following example returns JSON data. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "reportroot_getmicrosoft365copilotusageuserdetail_json" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUsageUserDetail(period='D7')?$format=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. +>**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/json +Content-Length: 10747 ++{ + "@odata.nextLink": "https://graph.microsoft.com/betoyOg", + "value": [ + { + "reportRefreshDate": "2024-08-20", + "userPrincipalName": "DC8C64D6EC3A3AA17481D7E5EB5B68A6", + "displayName": "C65E8D8AFA0DAB9639EDFAAEA94AFE66", + "lastActivityDate": "2024-08-20", + "copilotChatLastActivityDate": "2024-08-16", + "microsoftTeamsCopilotLastActivityDate": "2024-08-20", + "wordCopilotLastActivityDate": "2024-08-06", + "excelCopilotLastActivityDate": "", + "powerPointCopilotLastActivityDate": "2024-03-26", + "outlookCopilotLastActivityDate": "", + "oneNoteCopilotLastActivityDate": "", + "loopCopilotLastActivityDate": "", + "copilotActivityUserDetailsByPeriod": [ + { + "reportPeriod": 7 + } + ] + } + ] +} +``` |
v1.0 | Reportroot Getmicrosoft365copilotusercountsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getmicrosoft365copilotusercountsummary.md | + + Title: "reportRoot: getMicrosoft365CopilotUserCountSummary" +description: "Get the aggregated number of active and enabled users of Microsoft 365 Copilot for a specified time period." ++ms.localizationpriority: medium ++++# reportRoot: getMicrosoft365CopilotUserCountSummary ++Namespace: microsoft.graph +++Get the aggregated number of active and enabled users of Microsoft 365 Copilot for a specified time period. +++## 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": "reportroot_getmicrosoft365copilotusercountsummary" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/getMicrosoft365CopilotUserCountSummary(period='{period_value}') +``` ++## Function parameters +In the request URL, provide the following query parameters with values. ++|Parameter|Type|Description| +|:|:|:| +|period|String|The number of previous days over which to report aggregated usage. The supported values are: `D7`, `D30`, `D90`, `D180`, `ALL`. The first four values follow the format Dn where n represents the number of days over which to aggregate data. `ALL` indicates to report usage for 7, 30, 90, and 180 days.| ++## Optional query parameters ++This method supports the `$format` [OData query parameter](/graph/query-parameters) to customize the response. The default output type is `application/json`. However, if you want to specify the output type, you can use the OData `$format` query parameter to set the default output to `text/csv` or `application/json`. ++## 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 ++### CSV ++If successful, this method returns a `302 Found` response that redirects to a preauthenticated download URL for the report. That URL can be found in the `Location` header in the response. ++Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header. ++The CSV file has the following headers for columns. ++- Report Refresh Date +- Report Period +- Any App Enabled Users +- Any App Active Users +- Microsoft Teams Enabled Users +- Microsoft Teams Active Users +- Word Enabled Users +- Word Active Users +- PowerPoint Enabled Users +- PowerPoint Active Users +- Outlook Enabled Users +- Outlook Active Users +- Excel Enabled Users +- Excel Active Users +- OneNote Enabled Users +- OneNote Active Users +- Loop Enabled Users +- Loop Active Users +- Copilot Chat Enabled Users +- Copilot Chat Active Users ++### JSON ++If successful, this method returns a `200 OK` response code and a JSON object in the response body. ++## Examples ++### Example 1: CSV output ++The following example outputs a URL for a CSV file. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "reportroot_getmicrosoft365copilotusercountsummary_csv" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUserCountSummary(period='D7')?$format=text/csv +``` ++# [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 302 Found +Content-Type: text/plain +Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe +``` ++The CSV file in the `Location` header of the 302 response has the following schema. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Edm.Stream" +} +--> +```http +HTTP/1.1 200 OK +Content-Type: application/octet-stream ++Report Refresh Date,Report Period,Any App Enabled Users,Any App Active Users,Microsoft Teams Enabled Users,Microsoft Teams Active Users ,Word Enabled Users,Word Active Users,PowerPoint Enabled Users,PowerPoint Active Users,Outlook Enabled Users,Outlook Active Users,Excel Enabled Users,Excel Active Users,OneNote Enabled Users,OneNote Active Users,Loop Enabled Users,Loop Active Users,Copilot Chat Enabled Users,Copilot Chat Active Users +``` ++### Example 2: JSON output ++The following example returns JSON data. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "reportroot_getmicrosoft365copilotusercountsummary_json" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUserCountSummary(period='D7')?$format=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. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Edm.Stream" +} +--> +```http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 537 ++{ + "value": [ + { + "reportRefreshDate": "2024-08-20", + "adoptionByProduct": [ + { + "reportPeriod": 7, + "anyAppEnabledUsers": 359229, + "anyAppActiveUsers": 165115, + "microsoftTeamsEnabledUsers": 359096, + "microsoftTeamsActiveUsers": 123341, + "wordEnabledUsers": 359096, + "wordActiveUsers": 21459, + "powerPointEnabledUsers": 359096, + "powerPointActiveUsers": 8530, + "outlookEnabledUsers": 359096, + "outlookActiveUsers": 37270, + "excelEnabledUsers": 359096, + "excelActiveUsers": 6709, + "oneNoteEnabledUsers": 359096, + "oneNoteActiveUsers": 1660, + "loopEnabledUsers": 359096, + "loopActiveUsers": 1345, + "copilotChatEnabledUsers": 359096, + "copilotChatActiveUsers": 65480 + } + ] + } + ] +} +``` |
v1.0 | Reportroot Getmicrosoft365copilotusercounttrend | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getmicrosoft365copilotusercounttrend.md | + + Title: "reportRoot: getMicrosoft365CopilotUserCountTrend" +description: "Get the trend in the daily number of active and enabled users of Microsoft 365 Copilot for a specified time period." ++ms.localizationpriority: medium ++++# reportRoot: getMicrosoft365CopilotUserCountTrend ++Namespace: microsoft.graph +++Get the trend in the daily number of active and enabled users of Microsoft 365 Copilot for a specified time period. +++## 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": "reportroot_getmicrosoft365copilotusercounttrend" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /reports/getMicrosoft365CopilotUserCountTrend(period='{period_value}') +``` ++## Function parameters +In the request URL, provide the following query parameters with values. ++|Parameter|Type|Description| +|:|:|:| +|period|String|The number of previous days over which to report aggregated usage. The supported values are: `D7`, `D30`, `D90`, `D180`, `ALL`. The first four values follow the format Dn where n represents the number of days over which to aggregate data. `ALL` indicates to report usage for 7, 30, 90, and 180 days.| ++## Optional query parameters ++This method supports the `$format` [OData query parameter](/graph/query-parameters) to customize the response. The default output type is `application/json`. However, if you want to specify the output type, you can use the OData `$format` query parameter to set the default output to `text/csv` or `application/json`. ++## 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 ++### CSV ++If successful, this method returns a `302 Found` response that redirects to a preauthenticated download URL for the report. That URL can be found in the `Location` header in the response. ++Preauthenticated download URLs are only valid for a short period of time (a few minutes) and don't require an `Authorization` header. ++The CSV file has the following headers for columns. ++- Report Refresh Date +- Report Period +- Report Date +- Any App Enabled Users +- Any App Active Users +- Microsoft Teams Enabled Users +- Microsoft Teams Active Users +- Word Enabled Users +- Word Active Users +- PowerPoint Enabled Users +- PowerPoint Active Users +- Outlook Enabled Users +- Outlook Active Users +- Excel Enabled Users +- Excel Active Users +- OneNote Enabled Users +- OneNote Active Users +- Loop Enabled Users +- Loop Active Users +- Copilot Chat Enabled Users +- Copilot Chat Active Users ++### JSON ++If successful, this method returns a `200 OK` response code and a JSON object in the response body. ++## Examples ++### Example 1: CSV output ++The following example outputs a URL to a CSV file. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "reportroot_getmicrosoft365copilotusercounttrend_csv" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUserCountTrend(period='D7')?$format=text/csv +``` ++# [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 302 Found +Content-Type: text/plain +Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe +``` ++The CSV file in the `Location` header of the 302 response has the following schema. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Edm.Stream" +} +--> +```http +HTTP/1.1 200 OK +Content-Type: application/octet-stream ++Report Refresh Date,Report Period,Report Date,Any App Enabled Users,Any App Active Users,Microsoft Teams Enabled Users,Microsoft Teams Active Users,Word Enabled Users,Word Active Users,PowerPoint Enabled Users,PowerPoint Active Users,Outlook Enabled Users,Outlook Active Users,Excel Enabled Users,Excel Active Users,OneNote Enabled Users,OneNote Active Users,Loop Enabled Users,Loop Active Users,Copilot Chat Enabled Users,Copilot Chat Active Users +``` ++### Example 2: JSON output ++The following example returns JSON data. ++#### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "reportroot_getmicrosoft365copilotusercounttrend_json" +} +--> +``` http +GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUserCountTrend(period='D7')?$format=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. +>**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/json +Content-Length: 10747 ++{ + "value": [ + { + "reportRefreshDate": "2024-08-20", + "reportPeriod": 7, + "adoptionByDate": [ + { + "reportDate": "2024-08-20", + "anyAppEnabledUsers": 357584, + "anyAppActiveUsers": 94745, + "microsoftTeamsEnabledUsers": 357451, + "microsoftTeamsActiveUsers": 72272, + "wordEnabledUsers": 357451, + "wordActiveUsers": 6602, + "powerPointEnabledUsers": 357451, + "powerPointActiveUsers": 2231, + "outlookEnabledUsers": 357451, + "outlookActiveUsers": 11786, + "excelEnabledUsers": 357451, + "excelActiveUsers": 1712, + "oneNoteEnabledUsers": 357451, + "oneNoteActiveUsers": 492, + "loopEnabledUsers": 357451, + "loopActiveUsers": 340, + "copilotChatEnabledUsers": 357451, + "copilotChatActiveUsers": 26609 + }, + ] + } + ] +} +``` |
v1.0 | Reportroot Getonedriveactivityuserdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getonedriveactivityuserdetail.md | Namespace: microsoft.graph Get details about OneDrive activity by user. -> **Note:** For details about different report views and names, see [Microsoft 365 reports - OneDrive for Business activity](https://support.office.com/client/OneDrive-for-Business-user-activity-8bbe4bf8-221b-46d6-99a5-2fb3c8ef9353). +> **Note:** For details about different report views and names, see [Microsoft 365 reports - OneDrive for Business activity](https://learn.microsoft.com/en-us/microsoft-365/admin/activity-reports/onedrive-for-business-activity-ww?view=o365-worldwide). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Reportroot Getrelyingpartydetailedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-getrelyingpartydetailedsummary.md | Choose the permission or permissions marked as least privileged for this API. Us --> [!INCLUDE [permissions-table](../includes/permissions/reportroot-getrelyingpartydetailedsummary-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Reportroot List Appcredentialsigninactivities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-list-appcredentialsigninactivities.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "reportroot_list_appcredentialsigninactivities" } --> [!INCLUDE [permissions-table](../includes/permissions/reportroot-list-appcredentialsigninactivities-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Reportroot List Applicationsignindetailedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/reportroot-list-applicationsignindetailedsummary.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "reportroot_list_applicationsignindetailedsummary" } --> [!INCLUDE [permissions-table](../includes/permissions/reportroot-list-applicationsignindetailedsummary-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Restorepoint Search | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/restorepoint-search.md | Title: "restorePoint: search" -description: "Search restore points for protection units." +description: "Search for the restorePoint objects associated with a protectionUnit." ms.localizationpriority: medium In the request body, supply a JSON representation of the following parameters. |:|:|:| |artifactQuery|[artifactQuery](../resources/artifactquery.md)|Contains an expression that specifies the criteria for search. Optional.| |protectionUnitIds|String collection|The ID of the protection units. Required.|-|protectionTimePeriod|[timePeriod](../resources/timeperiod.md)|The start and end date time of the protection period. Required.| +|protectionTimePeriod|[timePeriod](../resources/timeperiod.md)|The start and end date time of the protection period. Required.| |restorePointPreference|[restorePointPreference](../api/restorepoint-search.md#restorepointpreference-values)|Indicates which restore point to return. The possible values are `oldest`, `latest`. Optional.| |tags|[restorePointTags](../resources/restorepoint.md#restorepointtags-values)|The type of the restore point. The possible values are `None`, `FastRestore`, `UnknownFutureValue`. Optional.| In the request body, supply a JSON representation of the following parameters. If successful, this action returns a `200 OK` response code and a [restorePointSearchResponse](../resources/restorepointsearchresponse.md) object in the response body. +> [!NOTE] +> - Calls return a maximum of five restore points. +> - You can include a maximum of 20 protection units in a single request, and the response isn't paginated. +> - When you provide an expression for the **artifactQuery** property, you must provide only one protection unit ID in the **protectionUnitIds** property. ++For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Example 1: Search request Content-Type: application/json The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "restorepoint_search_artifactquery" Content-Type: application/json { "artifactQuery": {- "queryExpression": "((subject -contains ΓÇÿFinanceΓÇÖ) -or (subject -contains ΓÇÿLegalΓÇÖ)) -and (sender -eq 'alex@contoso.com') -and (recipient -eq 'carol@contoso.com') -and hasAttachment -eq true", + "queryExpression": "(Sender -eq 'abc@contoso.com') -and (Subject -like '*Check email*' -or Subject -like ' Important') -and (HasAttachment -eq 'true') -and (PitrDumpsterActionTriggeredTime -gt '{2024-09-21T08:20:00.0000000Z}')", "artifactType": "message" }, "protectionUnitIds": ["23014d8c-71fe-4d00-a01a-31850bc5b42a"], 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 | Restoresessionbase Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/restoresessionbase-activate.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Activate a draft [restoreSessionBase](../resources/restoresessionbase.md) object. +Activate a draft [restoreSessionBase](../resources/restoresessionbase.md) object to restore a [protection unit](../resources/protectionunitbase.md). ++The following points apply to restoring a protection unit: ++- The SharePoint sites and OneDrive accounts being restored aren't locked in a ready-only state. +- For SharePoint and OneDrive sites restored to new URLs, users don't have the same permissions they had to the original site. Only the global admin or SharePoint admin has permission to the restored site. However, for in-place or restores to the same URL, the permissions from the original site at the time of restoration are preserved. +- Restoration of SharePoint site and OneDrive user content that was removed from the recycle bin isn't supported. +- Mailboxes, OneDrive accounts, and SharePoint sites that are under legal or in-place holds can't be restored unless the legal hold is removed. To restore a SharePoint site under legal hold, you need to restore the site to a new URL. +- Mailbox draft items aren't backed up and can't be restored. +- A restore isn't performed if the current state of the mailbox is the same as the point in time you're trying to restore it to. +- SharePoint sites and OneDrive accounts that are restored to a new URL have a read-only lock on that new URL until the restore completes. The global admin can still download documents or remove the read-only lock manually. +- When a restore to a new location is performed, populating the property details of the new location can take more than 15 minutes. +- The global admin, SharePoint admin, or Exchange admin can initiate a restore of up to 1,000 SharePoint sites, 1,000 OneDrive users, and 1,000 mailboxes queued in parallel at a time. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] Don't supply a request body for this method. If successful, this action returns a `200 OK` response code and a [restoreSessionBase](../resources/restoresessionbase.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 | Restoresessionbase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/restoresessionbase-delete.md | Don't supply a request body for this method. If successful, this method returns a `204 No Content` response code. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request |
v1.0 | Restoresessionbase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/restoresessionbase-get.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [restoreSessionBase](../resources/restoresessionbase.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 | Riskdetection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskdetection-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskdetection_get" } --> [!INCLUDE [permissions-table](../includes/permissions/riskdetection-get-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Riskdetection List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskdetection-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskdetection_list" } --> [!INCLUDE [permissions-table](../includes/permissions/riskdetection-list-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Riskyserviceprincipal Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyserviceprincipal-confirmcompromised.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyserviceprincipal_confirmcompromised" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyserviceprincipal-confirmcompromised-permissions.md)] ## HTTP request |
v1.0 | Riskyserviceprincipal Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyserviceprincipal-dismiss.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyserviceprincipal_dismiss" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyserviceprincipal-dismiss-permissions.md)] ## HTTP request |
v1.0 | Riskyserviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyserviceprincipal-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyserviceprincipal_get" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyserviceprincipal-get-permissions.md)] ## HTTP request |
v1.0 | Riskyserviceprincipal List History | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyserviceprincipal-list-history.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyserviceprincipal_list_history" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyserviceprincipal-list-history-permissions.md)] ## HTTP request |
v1.0 | Riskyuser List History | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyuser-list-history.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyuser_list_history" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyuser-list-history-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Riskyuserhistoryitem Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyuserhistoryitem-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyuserhistoryitem_get" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyuserhistoryitem-get-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Riskyusers Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyusers-confirmcompromised.md | Title: "riskyUser: confirmCompromised" -description: Confirm a riskyUser object as compromised. +description: "Confirm one or more riskyUser objects as compromised." ms.localizationpriority: medium Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyusers_confirmcompromised" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyusers-confirmcompromised-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Riskyusers Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyusers-dismiss.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyusers_dismiss" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyusers-dismiss-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Riskyusers Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyusers-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyusers_get" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyusers-get-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Riskyusers List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/riskyusers-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyusers_list" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyusers-list-permissions.md)] ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Schedule List Timeoffreasons | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schedule-list-timeoffreasons.md | Get the list of [timeOffReasons](../resources/timeoffreason.md) in a [schedule]( 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "schedule_list_timeoffreasons" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-list-timeoffreasons-permissions.md)] |
v1.0 | Schedule List Timesoff | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schedule-list-timesoff.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "schedule_list_timesoff" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-list-timesoff-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Schedule Post Timeoffreasons | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schedule-post-timeoffreasons.md | Create a new [timeOffReason](../resources/timeoffreason.md). One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). -This API supports admin permissions. Global admins can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. |Permission type | Permissions (from least to most privileged) | |:--|:| |
v1.0 | Schedule Post Timesoff | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/schedule-post-timesoff.md | Create a new [timeOff](../resources/timeoff.md) instance in a [schedule](../reso 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "schedule_post_timesoff" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-post-timesoff-permissions.md)] |
v1.0 | Security Alert Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-alert-get.md | Content-type: application/json "firstSeenDateTime": "2020-09-12T07:28:32.4321753Z", "mdeDeviceId": "73e7e2de709dff64ef64b1d0c30e67fab63279db", "azureAdDeviceId": null,- "deviceDnsName": "tempDns", + "deviceDnsName": "yonif-lap3.middleeast.corp.microsoft.com", + "hostName": "yonif-lap3", + "ntDomain": null, + "dnsDomain": "middleeast.corp.microsoft.com", "osPlatform": "Windows10", "osBuild": 22424, "version": "Other", |
v1.0 | Security Auditcoreroot List Auditlogqueries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-auditcoreroot-list-auditlogqueries.md | Auditing data can be accessed through Microsoft Purview Audit Search API via the "blockType": "ignored" } -->-|Microsoft 365 service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application +|Microsoft 365 service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application| |:|:|:|:| |Microsoft OneDrive|AuditLogsQuery-OneDrive.Read.All|Not supported|AuditLogsQuery-OneDrive.Read.All| |Microsoft Exchange|AuditLogsQuery-Exchange.Read.All|Not supported|AuditLogsQuery-Exchange.Read.All| |Microsoft SharePoint|AuditLogsQuery-SharePoint.Read.All|Not supported|AuditLogsQuery-SharePoint.Read.All|-|Microsoft Intune|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| +|Data Loss Protection for Endpoint|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| |Microsoft Dynamics CRM|AuditLogsQuery-CRM.Read.All|Not supported|AuditLogsQuery-CRM.Read.All| |Microsoft Entra|AuditLogsQuery-Entra.Read.All|Not supported|AuditLogsQuery-Entra.Read.All| |All Audit Logs|AuditLogsQuery.Read.All|Not supported|AuditLogsQuery.Read.All| GET https://graph.microsoft.com/beta/security/auditLog/queries [!INCLUDE [sample-code](../includes/snippets/php/list-auditlogquery-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/list-auditlogquery-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Auditcoreroot Post Auditlogqueries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-auditcoreroot-post-auditlogqueries.md | Auditing data can be accessed through Microsoft Purview Audit Search API via the } --> -|Microsoft 365 service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application +|Microsoft 365 service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application| |:|:|:|:| |Microsoft OneDrive|AuditLogsQuery-OneDrive.Read.All|Not supported|AuditLogsQuery-OneDrive.Read.All| |Microsoft Exchange|AuditLogsQuery-Exchange.Read.All|Not supported|AuditLogsQuery-Exchange.Read.All| |Microsoft SharePoint|AuditLogsQuery-SharePoint.Read.All|Not supported|AuditLogsQuery-SharePoint.Read.All|-|Microsoft Intune|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| +|Data Loss Protection for Endpoint|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| |Microsoft Dynamics CRM|AuditLogsQuery-CRM.Read.All|Not supported|AuditLogsQuery-CRM.Read.All| |Microsoft Entra|AuditLogsQuery-Entra.Read.All|Not supported|AuditLogsQuery-Entra.Read.All| |All Audit Logs|AuditLogsQuery.Read.All|Not supported|AuditLogsQuery.Read.All| You can specify the following properties when creating a **auditLogQuery**. |filterEndDateTime|DateTimeOffset|End date of the date range in the query. Optional.| |recordTypeFilters|Collection(string) of microsoft.graph.security.auditLogRecordType|The operation type or types indicated by the record. The possible values are: `exchangeAdmin`, `exchangeItem`, `exchangeItemGroup`, `sharePoint`, `syntheticProbe`, `sharePointFileOperation`, `oneDrive`, `azureActiveDirectory`, `azureActiveDirectoryAccountLogon`, `dataCenterSecurityCmdlet`, `complianceDLPSharePoint`, `sway`, `complianceDLPExchange`, `sharePointSharingOperation`, `azureActiveDirectoryStsLogon`, `skypeForBusinessPSTNUsage`, `skypeForBusinessUsersBlocked`, `securityComplianceCenterEOPCmdlet`, `exchangeAggregatedOperation`, `powerBIAudit`, `crm`, `yammer`, `skypeForBusinessCmdlets`, `discovery`, `microsoftTeams`, `threatIntelligence`, `mailSubmission`, `microsoftFlow`, `aeD`, `microsoftStream`, `complianceDLPSharePointClassification`, `threatFinder`, `project`, `sharePointListOperation`, `sharePointCommentOperation`, `dataGovernance`, `kaizala`, `securityComplianceAlerts`, `threatIntelligenceUrl`, `securityComplianceInsights`, `mipLabel`, `workplaceAnalytics`, `powerAppsApp`, `powerAppsPlan`, `threatIntelligenceAtpContent`, `labelContentExplorer`, `teamsHealthcare`, `exchangeItemAggregated`, `hygieneEvent`, `dataInsightsRestApiAudit`, `informationBarrierPolicyApplication`, `sharePointListItemOperation`, `sharePointContentTypeOperation`, `sharePointFieldOperation`, `microsoftTeamsAdmin`, `hrSignal`, `microsoftTeamsDevice`, `microsoftTeamsAnalytics`, `informationWorkerProtection`, `campaign`, `dlpEndpoint`, `airInvestigation`, `quarantine`, `microsoftForms`, `applicationAudit`, `complianceSupervisionExchange`, `customerKeyServiceEncryption`, `officeNative`, `mipAutoLabelSharePointItem`, `mipAutoLabelSharePointPolicyLocation`, `microsoftTeamsShifts`, `secureScore`, `mipAutoLabelExchangeItem`, `cortanaBriefing`, `search`, `wdatpAlerts`, `powerPlatformAdminDlp`, `powerPlatformAdminEnvironment`, `mdatpAudit`, `sensitivityLabelPolicyMatch`, `sensitivityLabelAction`, `sensitivityLabeledFileAction`, `attackSim`, `airManualInvestigation`, `securityComplianceRBAC`, `userTraining`, `airAdminActionInvestigation`, `mstic`, `physicalBadgingSignal`, `teamsEasyApprovals`, `aipDiscover`, `aipSensitivityLabelAction`, `aipProtectionAction`, `aipFileDeleted`, `aipHeartBeat`, `mcasAlerts`, `onPremisesFileShareScannerDlp`, `onPremisesSharePointScannerDlp`, `exchangeSearch`, `sharePointSearch`, `privacyDataMinimization`, `labelAnalyticsAggregate`, `myAnalyticsSettings`, `securityComplianceUserChange`, `complianceDLPExchangeClassification`, `complianceDLPEndpoint`, `mipExactDataMatch`, `msdeResponseActions`, `msdeGeneralSettings`, `msdeIndicatorsSettings`, `ms365DCustomDetection`, `msdeRolesSettings`, `mapgAlerts`, `mapgPolicy`, `mapgRemediation`, `privacyRemediationAction`, `privacyDigestEmail`, `mipAutoLabelSimulationProgress`, `mipAutoLabelSimulationCompletion`, `mipAutoLabelProgressFeedback`, `dlpSensitiveInformationType`, `mipAutoLabelSimulationStatistics`, `largeContentMetadata`, `microsoft365Group`, `cdpMlInferencingResult`, `filteringMailMetadata`, `cdpClassificationMailItem`, `cdpClassificationDocument`, `officeScriptsRunAction`, `filteringPostMailDeliveryAction`, `cdpUnifiedFeedback`, `tenantAllowBlockList`, `consumptionResource`, `healthcareSignal`, `dlpImportResult`, `cdpCompliancePolicyExecution`, `multiStageDisposition`, `privacyDataMatch`, `filteringDocMetadata`, `filteringEmailFeatures`, `powerBIDlp`, `filteringUrlInfo`, `filteringAttachmentInfo`, `coreReportingSettings`, `complianceConnector`, `powerPlatformLockboxResourceAccessRequest`, `powerPlatformLockboxResourceCommand`, `cdpPredictiveCodingLabel`, `cdpCompliancePolicyUserFeedback`, `webpageActivityEndpoint`, `omePortal`, `cmImprovementActionChange`, `filteringUrlClick`, `mipLabelAnalyticsAuditRecord`, `filteringEntityEvent`, `filteringRuleHits`, `filteringMailSubmission`, `labelExplorer`, `microsoftManagedServicePlatform`, `powerPlatformServiceActivity`, `scorePlatformGenericAuditRecord`, `filteringTimeTravelDocMetadata`, `alert`, `alertStatus`, `alertIncident`, `incidentStatus`, `case`, `caseInvestigation`, `recordsManagement`, `privacyRemediation`, `dataShareOperation`, `cdpDlpSensitive`, `ehrConnector`, `filteringMailGradingResult`, `publicFolder`, `privacyTenantAuditHistoryRecord`, `aipScannerDiscoverEvent`, `eduDataLakeDownloadOperation`, `m365ComplianceConnector`, `microsoftGraphDataConnectOperation`, `microsoftPurview`, `filteringEmailContentFeatures`, `powerPagesSite`, `powerAppsResource`, `plannerPlan`, `plannerCopyPlan`, `plannerTask`, `plannerRoster`, `plannerPlanList`, `plannerTaskList`, `plannerTenantSettings`, `projectForTheWebProject`, `projectForTheWebTask`, `projectForTheWebRoadmap`, `projectForTheWebRoadmapItem`, `projectForTheWebProjectSettings`, `projectForTheWebRoadmapSettings`, `quarantineMetadata`, `microsoftTodoAudit`, `timeTravelFilteringDocMetadata`, `teamsQuarantineMetadata`, `sharePointAppPermissionOperation`, `microsoftTeamsSensitivityLabelAction`, `filteringTeamsMetadata`, `filteringTeamsUrlInfo`, `filteringTeamsPostDeliveryAction`, `mdcAssessments`, `mdcRegulatoryComplianceStandards`, `mdcRegulatoryComplianceControls`, `mdcRegulatoryComplianceAssessments`, `mdcSecurityConnectors`, `mdaDataSecuritySignal`, `vivaGoals`, `filteringRuntimeInfo`, `attackSimAdmin`, `microsoftGraphDataConnectConsent`, `filteringAtpDetonationInfo`, `privacyPortal`, `managedTenants`, `unifiedSimulationMatchedItem`, `unifiedSimulationSummary`, `updateQuarantineMetadata`, `ms365DSuppressionRule`, `purviewDataMapOperation`, `filteringUrlPostClickAction`, `irmUserDefinedDetectionSignal`, `teamsUpdates`, `plannerRosterSensitivityLabel`, `ms365DIncident`, `filteringDelistingMetadata`, `complianceDLPSharePointClassificationExtended`, `microsoftDefenderForIdentityAudit`, `supervisoryReviewDayXInsight`, `defenderExpertsforXDRAdmin`, `cdpEdgeBlockedMessage`, `hostedRpa`, `cdpContentExplorerAggregateRecord`, `cdpHygieneAttachmentInfo`, `cdpHygieneSummary`, `cdpPostMailDeliveryAction`, `cdpEmailFeatures`, `cdpHygieneUrlInfo`, `cdpUrlClick`, `cdpPackageManagerHygieneEvent`, `filteringDocScan`, `timeTravelFilteringDocScan`, `mapgOnboard`, `unknownFutureValue`. Optional.| |keywordFilter|String|Free text field to search non-indexed properties of the audit log. Optional.|-|serviceFilter|String|The Office 365 service where the activity occurred. Optional.| +|serviceFilter|String|Refers to the workload property in the audit record. This is the Microsoft service where the activity occurred. Optional.| |operationFilters|String collection|The name of the user or admin activity. For a description of the most common operations/activities, see [Search the audit log in the Office 365 Protection Center](https://go.microsoft.com/fwlink/p/?LinkId=708432). Optional.| |userPrincipalNameFilters|String collection|The UPN (user principal name) of the user who performed the action (specified in the operation property) that resulted in the record being logged; for example, _my_name@my_domain_name_. Optional.| |ipAddressFilters|String collection|The IP address of the device that was used when the activity was logged. Optional.| |
v1.0 | Security Auditlogquery Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-auditlogquery-get.md | Auditing data can be accessed through Microsoft Purview Audit Search API via the } --> -|Microsoft 365 Service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application +|Microsoft 365 Service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application| |:|:|:|:| |Microsoft OneDrive|AuditLogsQuery-OneDrive.Read.All|Not supported|AuditLogsQuery-OneDrive.Read.All| |Microsoft Exchange|AuditLogsQuery-Exchange.Read.All|Not supported|AuditLogsQuery-Exchange.Read.All| |Microsoft SharePoint|AuditLogsQuery-SharePoint.Read.All|Not supported|AuditLogsQuery-SharePoint.Read.All|-|Microsoft Intune|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| +|Data Loss Protection for Endpoint|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| |Microsoft Dynamics CRM|AuditLogsQuery-CRM.Read.All|Not supported|AuditLogsQuery-CRM.Read.All| |Microsoft Entra|AuditLogsQuery-Entra.Read.All|Not supported|AuditLogsQuery-Entra.Read.All| |All Audit Logs|AuditLogsQuery.Read.All|Not supported|AuditLogsQuery.Read.All| GET https://graph.microsoft.com/beta/security/auditLog/queries/{auditLogQueryId} [!INCLUDE [sample-code](../includes/snippets/php/get-auditlogquery-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-auditlogquery-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Auditlogquery List Records | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-auditlogquery-list-records.md | Auditing data can be accessed through Microsoft Purview Audit Search API via the } --> -|Microsoft 365 Service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application +|Microsoft 365 Service|Delegated (work or school account)|Delegated (personal Microsoft account)|Application| |:|:|:|:| |Microsoft OneDrive|AuditLogsQuery-OneDrive.Read.All|Not supported|AuditLogsQuery-OneDrive.Read.All| |Microsoft Exchange|AuditLogsQuery-Exchange.Read.All|Not supported|AuditLogsQuery-Exchange.Read.All| |Microsoft SharePoint|AuditLogsQuery-SharePoint.Read.All|Not supported|AuditLogsQuery-SharePoint.Read.All|-|Microsoft Intune|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| +|Data Loss Protection for Endpoint|AuditLogsQuery-Endpoint.Read.All|Not supported|AuditLogsQuery-Endpoint.Read.All| |Microsoft Dynamics CRM|AuditLogsQuery-CRM.Read.All|Not supported|AuditLogsQuery-CRM.Read.All| |Microsoft Entra|AuditLogsQuery-Entra.Read.All|Not supported|AuditLogsQuery-Entra.Read.All| |All Audit Logs|AuditLogsQuery.Read.All|Not supported|AuditLogsQuery.Read.All| GET https://graph.microsoft.com/beta/security/auditLog/queries/{auditLogQueryId} [!INCLUDE [sample-code](../includes/snippets/php/list-auditlogrecord-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/list-auditlogrecord-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Ediscoverycase Post Legalholds | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverycase-post-legalholds.md | You can specify the following properties when you create an **ediscoveryHoldPoli |:|:|:| |displayName|String|The display name of the legal hold policy. Required.| |description|String|The description of the legal hold policy. Optional.|+|contentQuery|String|KQL query that specifies content to be held in the specified locations. Optional. | ## Response Content-Type: application/json { "displayName": "My legalHold with sources", "description": "Created from Graph API",- "userSources@odata.bind": [ - { - "@odata.type": "microsoft.graph.security.userSource", - "email": "SalesTeam@contoso.com" - } - ], - "siteSources@odata.bind": [ - { - "@odata.type": "microsoft.graph.security.siteSource", - "site": { - "webUrl": "https://m365x809305.sharepoint.com/sites/Design-topsecret" - } - } - ] + "contentQuery": "KQL content query", } ``` Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/cli/create-ediscoveryholdpolicy-from--cli-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [Go](#tab/go) + # [Java](#tab/java) [!INCLUDE [sample-code](../includes/snippets/jav)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Security Ediscoverycustodian List Sitesources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverycustodian-list-sitesources.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of the [siteSource](../resources/security-sitesource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md). +Get a list of the [siteSource](../resources/security-sitesource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md) or [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md). [!INCLUDE [national-cloud-support](../../includes/global-us.md)] Choose the permission or permissions marked as least privileged for this API. Us --> ``` http GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians/{custodianId}/siteSources+GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}/userSources ``` ## Optional query parameters |
v1.0 | Security Ediscoverycustodian List Usersources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverycustodian-list-usersources.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a list of the [userSource](../resources/security-usersource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md). +Get a list of the [userSource](../resources/security-usersource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md) or [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md). [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Security Ediscoveryholdpolicy Post Sitesources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoveryholdpolicy-post-sitesources.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new siteSource object. +Create a new [siteSource](../resources/security-sitesource.md) object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Security Ediscoveryholdpolicy Post Usersources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoveryholdpolicy-post-usersources.md | Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Create a new userSource object. +Create a new [userSource](../resources/security-usersource.md) object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] You can specify the following properties when you create a **userSource**. |Property|Type|Description| |:|:|:| |email|String|SMTP address of the user.|-|includedSources|microsoft.graph.security.sourceType|Specifies which sources are included in this group. Possible values are: `mailbox`, `site`.| +|includedSources|microsoft.graph.security.sourceType|Specifies which sources are included in this group. Possible values are: `mailbox`, `site`. Only `mailbox` is applicable for user sources.| ## Response Content-Type: application/json { "email": "admin@contoso.com",- "includedSources": "mailbox, site" + "includedSources": "mailbox" } ``` |
v1.0 | Security Ediscoverysearch Exportreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverysearch-exportreport.md | The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportReport +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport Content-Type: application/json { Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06 ### Example 2: Export a report of items with search hits and partially indexed items in all targeted locations, without additional options -The following examples shows how to export a report of items with search hits and partially indexed items in all targeted locations, with no additional options selected. +The following example shows how to export a report of items with search hits and partially indexed items in all targeted locations, with no additional options selected. #### Request The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportReport +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport Content-Type: application/json { The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportReport +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport Content-Type: application/json { The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportReport +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport Content-Type: application/json { The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportReport +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport Content-Type: application/json { |
v1.0 | Security Ediscoverysearch Exportresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverysearch-exportresult.md | POST /security/cases/ediscoveryCases('{ediscoveryCaseId}')/searches('{ediscovery In the request body, supply a JSON representation of the parameters. -The following table lists the parameters that you can be use with this action. +The following table lists the parameters that you can use with this action. | Parameter | Type | Description | |:|:|:| The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportResult +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult Content-Type: application/json { The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportResult +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult Content-Type: application/json { The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportResult +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult Content-Type: application/json { The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportResult +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult Content-Type: application/json { The following example shows a request. } --> ``` http-POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/'dbc06feb-a6a5-46a2-8e4e-534353b071e4'/searches/'6c2ab774-2d2a-46b9-a601-3130f518757b'/exportResult +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult Content-Type: application/json { |
v1.0 | Security Ediscoverysearch Purgedata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-ediscoverysearch-purgedata.md | Title: "ediscoverySearch: purgeData" -description: "Use the purge data method to delete Teams messages in a eDiscovery search." +description: "Delete Exchange mailbox items or Microsoft Teams messages contained in an eDiscovery search." ms.localizationpriority: medium doc_type: "apiPageType" - # ediscoverySearch: purgeData+ Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Delete Microsoft Teams messages contained in a [eDiscovery search](../resources/security-ediscoverysearch.md). +Delete Exchange mailbox items or Microsoft Teams messages contained in an [eDiscovery search](../resources/security-ediscoverysearch.md). ->**Note:** This request purges Teams data only. It does not purge other types of data such as mailbox items. +>**Note:** This request purges a maximum of 100 items per location only. You can collect and purge the following categories of Teams content: - **Teams 1:1 chats** - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called *conversations*. POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySear ## 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. +The following table shows the parameters that you can use with this action. |Parameter|Type|Description| |:|:|:|-|purgeType|microsoft.graph.security.purgeType| Options that control whether the action is soft delete or hard delete. Possible values are `recoverable`, `permanentlydeleted`, `unknownFutureValue`. | |purgeAreas|microsoft.graph.security.purgeAreas| Options to define the locations to be in scope of the purge action. Possible values are: `mailboxes`, `teamsMessages`, `unknownFutureValue`. |-+|purgeType|microsoft.graph.security.purgeType| Options that control whether the action is soft delete or hard delete. Possible values are `recoverable`, `unknownFutureValue`, `permanentlyDelete`. | ## Response If successful, this action returns a `202 Accepted` response code. -If the purge data operation is started successfully, this action returns a `202 Accepted` response code. The response will also contain a `Location` header, which contains the location of the [Purge data operation](../resources/security-ediscoverypurgedataoperation.md) that was created to commit the purge. -To check the status of the purge data operation, make a GET request to the location URL. -+If the purge data operation is started successfully, this action returns a `202 Accepted` response code. The response also contains a `Location` header, which contains the location of the [purge data operation](../resources/security-ediscoverypurgedataoperation.md) that was created to commit the purge. To check the status of the purge data operation, make a GET request to the location URL. ## Examples ### Request The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request", The following example shows a request. POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/searches/c61a5860-d634-4d14-aea7-d82b6f4eb7af/purgeData {-+ "purgeType": "recoverable", + "purgeAreas": "teamsMessages" } ``` |
v1.0 | Security Filethreatsubmission Post Filethreats | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-filethreatsubmission-post-filethreats.md | If successful, this method returns a `201 Created` response code and a [fileThre ### Request The following example shows a request.+# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_filethreatsubmission_from_filethreats" } --> ``` http-POST https://graph.microsoft.com/beta/security/threatSubmission/fileThreatSubmissions +POST https://graph.microsoft.com/beta/security/threatSubmission/fileThreats 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) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) ++ ### Response The following example shows the response. |
v1.0 | Security Healthissue Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-healthissue-get.md | Choose the permission or permissions marked as least privileged for this API. Us GET /security/identities/healthIssues/{healthIssueId} ``` +## 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 Content-Type: application/json { "@odata.type": "#microsoft.graph.security.healthIssue",- "ID": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", - "displayName": "Directory Services Object Auditing is not configured as required", + "additionalInformation": ["Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)"], + "createdDateTime": "2022-07-15T12:19:27.7211305Z", + "description": "Directory Services Object Auditing isn't configured as required on domain1.contoso.com", + "displayName": "Directory Services Object Auditing isn't configured as required", + "domainNames": ["domain1.contoso.com", "domain2.contoso.com"], "healthIssueType": "Global",+ "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", "issueTypeId": "1031",- "severity": "medium", - "status": "open", - "createdDateTime": "2022-07-15T12:19:27.7211305Z", "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z",- "domainNames": [ - "domain1.contoso.com", - "domain2.contoso.com" - ], - "sensorDNSNames": [ - "DC1.domain1.contoso.com", - "DC2.domain2.contoso.com" - ], - "description": "Directory Services Object Auditing is not configured as required on domain1.contoso.com", - "recommendations": [ - "Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing" - ], - "recommendedActionCommands": [ - "Import-Module DefenderForIdentity", - "Set-MDIConfiguration -Configuration DomainObjectAuditing -Mode Domain -Force" - ], - "additionalInformation": [ - "Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)", - "Descendant Group Objects (Schema-Id-Guid: bf967a9c-0de6-11d0-a285-00aa003049e2)", - "Descendant Computer Objects (Schema-Id-Guid: bf967a86-0de6-11d0-a285-00aa003049e2)", - "Descendant msDS-GroupManagedServiceAccount Objects (Schema-Id-Guid: 7b8b558a-93a5-4af7-adca-c017e67f1057)", - "Descendant msDS-ManagedServiceAccount Objects (Schema-Id-Guid: ce206244-5827-4a86-ba1c-1c0c386c1b64)" - ] + "recommendations": ["Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"], + "recommendedActionCommands": ["Import-Module DefenderForIdentity"], + "sensorDNSNames": ["DC1.domain1.contoso.com", "DC2.domain2.contoso.com"], + "severity": "medium", + "status": "open" } ``` |
v1.0 | Security Identitycontainer List Healthissues | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-identitycontainer-list-healthissues.md | GET /security/identities/healthIssues ## Optional query parameters -This method supports the following OData query parameters to help customize the response: `$count`, `$filter`, `$skip`, `$top`. For general information, see [OData query parameters](/graph/query-parameters). +This method supports the `$count`, `$filter`, `$skip`, `$top`, and `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). The following examples show how to use optional query parameters. GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq ' GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq 'low' ``` -See open global health alerts that domain name \ sensor DNS name ends with spesific value (name=contoso.com) +### Get open global health alerts where the domain name or sensor DNS name ends with a specific value ++The following example shows how to get global health alerts where the domain name or sensor DNS name ends with a specific value, for example, `contoso.com`. + <!-- { "blockType": "ignored" } Don't supply a request body for this method. ## Response -If successful, this method returns a `200 OK` response code and a collection of [healthIssue](../resources/security-healthissue.md) objects in the response body. +If successful, this method returns a `200 OK` response code and a collection of [microsoft.graph.security.healthIssue](../resources/security-healthissue.md) objects in the response body. ## Examples Content-Type: application/json "value": [ { "@odata.type": "#microsoft.graph.security.healthIssue",- "ID": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", - "displayName": "Directory Services Object Auditing is not configured as required", + "additionalInformation": ["Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)"], + "createdDateTime": "2022-07-15T12:19:27.7211305Z", + "description": "Directory Services Object Auditing isn't configured as required on domain1.contoso.com", + "displayName": "Directory Services Object Auditing isn't configured as required", + "domainNames": ["domain1.contoso.com", "domain2.contoso.com"], "healthIssueType": "Global",+ "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", "issueTypeId": "1031",- "severity": "medium", - "status": "open", - "createdDateTime": "2022-07-15T12:19:27.7211305Z", "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z",- "domainNames": [ - "domain1.contoso.com", - "domain2.contoso.com" - ], - "sensorDNSNames": [ - "DC1.domain1.contoso.com", - "DC2.domain2.contoso.com" - ], - "description": "Directory Services Object Auditing is not configured as required on domain1.contoso.com", - "recommendations": [ - "Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing" - ], - "recommendedActionCommands": [ - "Import-Module DefenderForIdentity", - "Set-MDIConfiguration -Configuration DomainObjectAuditing -Mode Domain -Force" - ], - "additionalInformation": [ - "Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)", - "Descendant Group Objects (Schema-Id-Guid: bf967a9c-0de6-11d0-a285-00aa003049e2)", - "Descendant Computer Objects (Schema-Id-Guid: bf967a86-0de6-11d0-a285-00aa003049e2)", - "Descendant msDS-GroupManagedServiceAccount Objects (Schema-Id-Guid: 7b8b558a-93a5-4af7-adca-c017e67f1057)", - "Descendant msDS-ManagedServiceAccount Objects (Schema-Id-Guid: ce206244-5827-4a86-ba1c-1c0c386c1b64)" - ] + "recommendations": ["Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"], + "recommendedActionCommands": ["Import-Module DefenderForIdentity"], + "sensorDNSNames": ["DC1.domain1.contoso.com", "DC2.domain2.contoso.com"], + "severity": "medium", + "status": "open" } ] } |
v1.0 | Security Identitycontainer List Sensors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-identitycontainer-list-sensors.md | + + Title: "List sensors" +description: "Get a list of sensor objects and their properties." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# List sensors ++Namespace: microsoft.graph.security +++Get a list of [sensor](../resources/security-sensor.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": "security_identitycontainer_list_sensors" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors +``` ++## Optional query parameters ++This method supports the `$count`, `$filter`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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.security.sensor](../resources/security-sensor.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_sensor" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/identities/sensors +``` ++# [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.security.sensor)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.sensor", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "displayName": "DC1", + "sensorType": "domainControllerIntegrated", + "version": "2.239.18124.58593", + "deploymentStatus": "upToDate", + "createdDateTime": "2023-11-16T09:41:24.2585071Z", + "domainName": "domain1.test.local", + "healthStatus": "healthy", + "openHealthIssuesCount": 0, + "settings": { + "@odata.type": "microsoft.graph.security.sensorSettings", + "description": "dc1 settings", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": true + } + } + ] +} +``` |
v1.0 | Security Incident Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-incident-update.md | PATCH /security/incidents/{incidentId} |assignedTo|String|Owner of the incident, or null if no owner is assigned. Free editable text.| |classification|microsoft.graph.security.alertClassification|The specification for the incident. Possible values are: `unknown`, `falsePositive`, `truePositive`, `informationalExpectedActivity`, `unknownFutureValue`.| |customTags|String collection|Array of custom tags associated with an incident.|-|determination|microsoft.graph.security.alertDetermination|Specifies the determination of the incident. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedUser`, `phishing`, `maliciousUserActivity`, `notMalicious`, `notEnoughDataToValidate`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| +|determination|microsoft.graph.security.alertDetermination|Specifies the determination of the incident. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedAccount`, `phishing`, `maliciousUserActivity`, `notMalicious`, `notEnoughDataToValidate`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| |status|microsoft.graph.security.incidentStatus|The status of the incident. Possible values are: `active`, `resolved`, `redirected`, `unknownFutureValue`.| |summary|String|The overview of an attack. When applicable, the summary contains details of what occurred, impacted assets, and the type of attack.| |
v1.0 | Security List Alerts_V2 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-list-alerts_v2.md | The following example shows a response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.alert", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.security.alert)" } --> ``` http Content-type: application/json "firstSeenDateTime": "2020-09-12T07:28:32.4321753Z", "mdeDeviceId": "73e7e2de709dff64ef64b1d0c30e67fab63279db", "azureAdDeviceId": null,- "deviceDnsName": "tempDns", + "deviceDnsName": "yonif-lap3.middleeast.corp.microsoft.com", + "hostName": "yonif-lap3", + "ntDomain": null, + "dnsDomain": "middleeast.corp.microsoft.com", "osPlatform": "Windows10", "osBuild": 22424, "version": "Other", |
v1.0 | Security List Incidents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-list-incidents.md | Title: "List incidents" description: "Get a list of the incident objects and their properties." Previously updated : 09/09/2021 ms.localizationpriority: medium The following example shows the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.incident", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.security.incident)" } --> The following example shows the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.incident", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.security.incident)" } --> ``` http Content-Type: application/json "firstSeenDateTime": "2020-09-12T07:28:32.4321753Z", "mdeDeviceId": "73e7e2de709dff64ef64b1d0c30e67fab63279db", "azureAdDeviceId": null,- "deviceDnsName": "tempDns", + "deviceDnsName": "yonif-lap3.middleeast.corp.microsoft.com", + "hostName": "yonif-lap3", + "ntDomain": null, + "dnsDomain": "middleeast.corp.microsoft.com", "osPlatform": "Windows10", "osBuild": 22424, "version": "Other", |
v1.0 | Security Sensor Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-sensor-delete.md | + + Title: "Delete sensor" +description: "Delete a sensor object." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# Delete sensor ++Namespace: microsoft.graph.security +++Delete a [sensor](../resources/security-sensor.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": "security_sensor_delete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/identities/sensors/{sensorId} +``` ++## 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 `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["d31dd827-92cd-4cd6-b269-c151a0eec55d"], + "name": "delete_sensor" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d +``` ++# [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 | Security Sensor Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-sensor-get.md | + + Title: "Get sensor" +description: "Read the properties and relationships of a sensor object." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# Get sensor ++Namespace: microsoft.graph.security +++Read the properties and relationships of a [sensor](../resources/security-sensor.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": "security_sensor_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors/{sensorId} +``` ++## 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). ++## 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.security.sensor](../resources/security-sensor.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["d31dd827-92cd-4cd6-b269-c151a0eec55d"], + "name": "get_sensor" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d +``` ++# [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": "microsoft.graph.security.sensor" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.sensor", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "displayName": "DC1", + "sensorType": "domainControllerIntegrated", + "version": "2.239.18124.58593", + "deploymentStatus": "upToDate", + "createdDateTime": "2023-11-16T09:41:24.2585071Z", + "domainName": "domain1.test.local", + "healthStatus": "healthy", + "openHealthIssuesCount": 0, + "settings": { + "@odata.type": "microsoft.graph.security.sensorSettings", + "description": "dc1 settings", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": true + } +} +``` |
v1.0 | Security Sensor Getdeploymentaccesskey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-sensor-getdeploymentaccesskey.md | + + Title: "sensor: getDeploymentAccessKey" +description: "Get the deployment access key associated with the workspace." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# sensor: getDeploymentAccessKey ++Namespace: microsoft.graph.security +++Get the deployment access key associated with a Microsoft Defender for Identity, needed to install sensors associated with the workspace. +++## 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": "security_sensor_getdeploymentaccesskey" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors/getDeploymentAccessKey +``` ++## 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 [microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md) in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "sensorthis.getdeploymentaccesskey" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/identities/sensors/getDeploymentAccessKey +``` ++# [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": "microsoft.graph.security.deploymentAccessKeyType" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "microsoft.graph.security.deploymentAccessKeyType", + "sensorDeploymentAccessKey": "<Deployment access key (Secret)>" + } +} +``` |
v1.0 | Security Sensor Getdeploymentpackageuri | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-sensor-getdeploymentpackageuri.md | + + Title: "sensor: getDeploymentPackageUri" +description: "Get the sensor deployment package URL and version." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# sensor: getDeploymentPackageUri ++Namespace: microsoft.graph.security +++Get the [sensor](../resources/security-sensor.md) deployment package URL and version. You can use this URL to download the installer to install the sensor on a server. +++## 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": "security_sensor_getdeploymentpackageuri" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors/getDeploymentPackageUri +``` ++## 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 [microsoft.graph.security.sensorDeploymentPackage](../resources/security-sensordeploymentpackage.md) in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "sensorthis.getdeploymentpackageuri" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/identities/sensors/getDeploymentPackageUri +``` ++# [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": "microsoft.graph.security.sensorDeploymentPackage" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "microsoft.graph.security.sensorDeploymentPackage", + "downloadUrl": "<Download URL string>", + "version": "2.239.18124.58593" + } +} +``` |
v1.0 | Security Sensor Regeneratedeploymentaccesskey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-sensor-regeneratedeploymentaccesskey.md | + + Title: "sensor: regenerateDeploymentAccessKey" +description: "Generate a new deployment access key that can be used to install sensors associated with the workspace." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# sensor: regenerateDeploymentAccessKey ++Namespace: microsoft.graph.security +++Generate a new deployment access key that can be used to install a [sensor](../resources/security-sensor.md) associated with the workspace. +++## 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": "security_sensor_regeneratedeploymentaccesskey" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/identities/sensors/regenerateDeploymentAccessKey +``` ++## 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 `200 OK` response code and a [microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md) in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "sensorthis.regeneratedeploymentaccesskey" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/identities/sensors/regenerateDeploymentAccessKey +``` ++# [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": "microsoft.graph.security.deploymentAccessKeyType" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "microsoft.graph.security.deploymentAccessKeyType", + "sensorDeploymentAccessKey": "<Deployment access key (Secret)>" + } +} +``` |
v1.0 | Security Sensor Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/security-sensor-update.md | + + Title: "Update sensor" +description: "Update the properties of a sensor object." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# Update sensor ++Namespace: microsoft.graph.security +++Update the properties of a [sensor](../resources/security-sensor.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": "security_sensor_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/identities/sensors/{sensorId} +``` ++## 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| +|:|:|:| +|settings|[microsoft.graph.security.sensorSettings](../resources/security-sensorsettings.md)|Sensor settings information. The **description** property can be updated for all sensor types. The **isDelayedUpdateEnabled** property can be updated for all sensors with version < 3.X. The **domainControllerDnsNames** property can be updated for all sensors with version < 3.X except for domain controller sensors. | ++++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.sensor](../resources/security-sensor.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["d31dd827-92cd-4cd6-b269-c151a0eec55d"], + "name": "update_sensor" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d +Content-Type: application/json ++{ + "settings": { + "description": "dc1 settings new description", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": false + } +} +``` ++# [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", + "@odata.type": "microsoft.graph.security.sensor", + "truncated": true, + "name": "update_sensor" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.sensor", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "displayName": "DC1", + "sensorType": "domainControllerIntegrated", + "version": "2.239.18124.58593", + "deploymentStatus": "upToDate", + "createdDateTime": "2023-11-16T09:41:24.2585071Z", + "domainName": "domain1.test.local", + "healthStatus": "healthy", + "openHealthIssuesCount": 0, + "settings": { + "@odata.type": "microsoft.graph.security.sensorSettings", + "description": "dc1 settings new description", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": false + } +} +``` |
v1.0 | Securityaction Cancelsecurityaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securityaction-cancelsecurityaction.md | POST /security/securityActions/{id}/cancelSecurityAction | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Securityaction Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securityaction-get.md | This method supports some of the OData query parameters to help customize the re | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Securityactions List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securityactions-list.md | This method supports some of the OData query parameters to help customize the re | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Securityactions Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/securityactions-post.md | POST /security/securityActions | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Serviceactivity Getmetricsforconditionalaccesscompliantdevicessigninsuccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceactivity-getmetricsforconditionalaccesscompliantdevicessigninsuccess.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceactivity_getmetricsforconditionalaccesscompliantdevicessigninsuccess" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceactivity-getmetricsforconditionalaccesscompliantdevicessigninsuccess-permissions.md)] -In addition to the delegated permissions, the signed-in user who is accessing the data 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), which allow them to read sign-in reports: --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader ## HTTP request |
v1.0 | Serviceactivity Getmetricsforconditionalaccessmanageddevicessigninsuccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceactivity-getmetricsforconditionalaccessmanageddevicessigninsuccess.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceactivity_getmetricsforconditionalaccessmanageddevicessigninsuccess" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceactivity-getmetricsforconditionalaccessmanageddevicessigninsuccess-permissions.md)] -In addition to the delegated permissions, the signed-in user who is accessing the data 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), which allow them to read sign-in reports: --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader ## HTTP request |
v1.0 | Serviceactivity Getmetricsformfasigninfailure | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceactivity-getmetricsformfasigninfailure.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceactivity_getmetricsformfasigninfailure" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceactivity-getmetricsformfasigninfailure-permissions.md)] -In addition to the delegated permissions, the signed-in user who is accessing the data 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), which allow them to read sign-in reports: --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader ## HTTP request |
v1.0 | Serviceactivity Getmetricsformfasigninsuccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceactivity-getmetricsformfasigninsuccess.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceactivity_getmetricsformfasigninsuccess" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceactivity-getmetricsformfasigninsuccess-permissions.md)] -In addition to the delegated permissions, the signed-in user who is accessing the data 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), which allow them to read sign-in reports: --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader ## HTTP request |
v1.0 | Serviceactivity Getmetricsforsamlsigninsuccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceactivity-getmetricsforsamlsigninsuccess.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceactivity_getmetricsforsamlsigninsuccess" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceactivity-getmetricsforsamlsigninsuccess-permissions.md)] -In addition to the delegated permissions, the signed-in user who is accessing the data 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), which allow them to read sign-in reports: --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader ## HTTP request |
v1.0 | Serviceapp Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceapp-activate.md | You can specify the following properties you activate a **serviceApp**. If successful, this action returns a `202 Accepted` response code and a [serviceApp](../resources/serviceapp.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 | Serviceprincipal Createpasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-createpasswordsinglesignoncredentials.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_createpasswordsinglesignoncredentials" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-createpasswordsinglesignoncredentials-permissions.md)] -> [!NOTE] -> Users can create credentials for themselves. Service principal owners and admins with the following roles can create credentials for any user or group: GlobalAdministrator, ApplicationAdministrator, CloudApplicationAdministrator. To learn more, see [Directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). ## HTTP request |
v1.0 | Serviceprincipal Deletepasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-deletepasswordsinglesignoncredentials.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_deletepasswordsinglesignoncredentials" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-deletepasswordsinglesignoncredentials-permissions.md)] -> [!NOTE] -> Users can create credentials for themselves. Service principal owners and admins with the following roles can create credentials for any user or group: GlobalAdministrator, ApplicationAdministrator, CloudApplicationAdministrator. To learn more, see [Directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). ## HTTP request |
v1.0 | Serviceprincipal Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted service principals without having to perform a full read of the entire resource collection. +Get newly created, updated, or deleted service principals 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 | Serviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-get.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-get-permissions.md)] > [!NOTE]-> A service principal can retrieve its own application and service principal details without being granted any application permissions. -> The *Application.ReadWrite.OwnedBy* permission allows an app to call `GET /applications` and `GET /servicePrincipals` to list all applications and service principals in the tenant. This scope of access has been allowed for the permission. +> - A service principal can retrieve its own application and service principal details without being granted any application permissions. +> - The *Application.ReadWrite.OwnedBy* permission allows an app to call `GET /applications` and `GET /servicePrincipals` to list all applications and service principals in the tenant. This scope of access has been allowed for the permission. +> - To read the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.Read.All* delegated permission. +> - In app-only scenarios using Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.Reade.All* application permission. ## HTTP request |
v1.0 | Serviceprincipal Getpasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-getpasswordsinglesignoncredentials.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_getpasswordsinglesignoncredentials" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-getpasswordsinglesignoncredentials-permissions.md)] -> [!NOTE] -> Users can create credentials for themselves. Service principal owners and admins with the following roles can create credentials for any user or group: GlobalAdministrator, ApplicationAdministrator, CloudApplicationAdministrator. To learn more, see [Directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). ## HTTP request |
v1.0 | Serviceprincipal List Approleassignedto | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-approleassignedto.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_list_approleassignedto" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-list-approleassignedto-permissions.md)] ## HTTP request |
v1.0 | Serviceprincipal List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-approleassignments.md | Choose the permission or permissions marked as least privileged for this API. Us ## HTTP request |
v1.0 | Serviceprincipal List Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-list-owners.md | Title: "servicePrincipals: List owners" + Title: "List owners of a service principal" description: "Retrieve a list of owners of the servicePrincipal." ms.localizationpriority: high doc_type: apiPageType-# servicePrincipals: List owners +# List owners of a service principal Namespace: microsoft.graph 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 GET /servicePrincipals/{id}/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 | 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": "serviceprincipal_get_owners" }--> ```msgraph-interactive-GET https://graph.microsoft.com/beta/servicePrincipals/{id}/owners +GET https://graph.microsoft.com/beta/serviceprincipals(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. 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 servicePrincipals(appId=<key>)/owners?$select=deletedDateTime", + "value": [ + { + "@odata.type": "#microsoft.graph.user", + "id": "ce4770b3-70b2-4a38-a242-76631e9f7408", + "accountEnabled": null, + "city": null, + "createdDateTime": null, + "displayName": null, + "mail": null, + "mailNickname": null, + "otherMails": [], + "proxyAddresses": [], + "surname": null, + "userPrincipalName": null, + "userType": 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 | Serviceprincipal Put Claimspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-put-claimspolicy.md | Namespace: microsoft.graph Create a new [customClaimsPolicy](../resources/customclaimspolicy.md) object if it doesn't exist, or replace an existing one. + ## 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). Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) + # [JavaScript](#tab/javascript) [!INCLUDE [sample-code](../includes/snippets/javascript/create-customclaimspolicy-from--javascript-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] +# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) + ### Response |
v1.0 | Serviceprincipal Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_update" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-update-permissions.md)] +> [!NOTE] +> - To update the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* delegated permission. +> - In app-only scenarios using Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* application permission. + ## HTTP request You can address the service principal 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. <!-- { "blockType": "ignored" } --> In the request body, supply the values for relevant fields that should be update |alternativeNames|String collection| Used to retrieve service principals by subscription, identify resource group and full resource ids for [managed identities](/azure/active-directory/managed-identities-azure-resources/overview).| |appRoleAssignmentRequired|Boolean|Specifies whether an **appRoleAssignment** to a user or group is required before Microsoft Entra ID will issue a user or access token to the application. Not nullable. | |appRoles|[appRole](../resources/approle.md) collection|The application roles exposed by the associated application. For more information, see the **appRoles** property definition on the [application](../resources/application.md) resource. Not nullable. |-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><br/>To update this property, the calling principal must be assigned the Attribute Assignment Administrator role and must be granted the *CustomSecAttributeAssignment.ReadWrite.All* permission.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><li>To update this property in delegated scenarios, the calling principal must be assigned the Attribute Assignment Administrator role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* delegated permission.<li>To update this property in app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* application permission. | |displayName|String|The display name for the service principal.| |homepage|String|Home page or landing page of the application.| |keyCredentials|[keyCredential](../resources/keycredential.md) collection|The collection of key credentials associated with the service principal. Not nullable. | In the request body, supply the values for relevant fields that should be update |publisherName|String|The display name of the tenant in which the associated application is specified.| |replyUrls|String collection|The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. | |samlSingleSignOnSettings|[samlSingleSignOnSettings](../resources/samlsinglesignonsettings.md)|The collection for settings related to saml single sign-on.|-|servicePrincipalNames|String collection|Contains the list of **identifiersUris**, copied over from the associated [application](../resources/application.md). Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,<ul><li>Client apps requesting permissions to this resource can use these URIs to specify needed permissions in the **requiredResourceAccess** property of their application manifest, or in the "API permissions" blade on the App registrations experience.</li><li>Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the ΓÇ£audΓÇ¥ claim.</li></ul><br>The any operator is required for filter expressions on multi-valued properties. Not nullable.| +|servicePrincipalNames|String collection|Contains the list of **identifiersUris**, copied over from the associated [application](../resources/application.md). Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,<ul><li>Client apps requesting permissions to this resource can use these URIs to specify needed permissions in the **requiredResourceAccess** property of their application manifest, or in the "API permissions" blade on the App registrations experience.</li><li>Client apps can specify a resource URI that is based on the values of this property to acquire an access token, which is the URI returned in the "aud" claim.</li></ul><br>The any operator is required for filter expressions on multi-valued properties. Not nullable.| |tags|String collection| Not nullable. | |tokenEncryptionKeyId|String|Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.| |
v1.0 | Serviceprincipal Updatepasswordsinglesignoncredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipal-updatepasswordsinglesignoncredentials.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_updatepasswordsinglesignoncredentials" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-updatepasswordsinglesignoncredentials-permissions.md)] -> [!NOTE] -> Users can create credentials for themselves. Service principal owners and admins with the following roles can create credentials for any user or group: GlobalAdministrator, ApplicationAdministrator, CloudApplicationAdministrator. To learn more, see [Directory roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). ## HTTP request |
v1.0 | Serviceprincipalriskdetection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipalriskdetection-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipalriskdetection_get" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipalriskdetection-get-permissions.md)] ## HTTP request |
v1.0 | Serviceprincipalsigninactivity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/serviceprincipalsigninactivity-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipalsigninactivity_get" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipalsigninactivity-get-permissions.md)] + ## HTTP request |
v1.0 | Sharedwithchannelteaminfo Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharedwithchannelteaminfo-delete.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-delete-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharedwithchannelteaminfo Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharedwithchannelteaminfo-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "sharedwithchannelteaminfo_get" } --> [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharedwithchannelteaminfo List Allowedmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharedwithchannelteaminfo-list-allowedmembers.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-list-allowedmembers-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharedwithchannelteaminfo List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharedwithchannelteaminfo-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "sharedwithchannelteaminfo_list" } --> [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-list-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharepointprotectionpolicy List Siteprotectionunitsbulkadditionjobs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharepointprotectionpolicy-list-siteprotectionunitsbulkadditionjobs.md | + + Title: "List siteProtectionUnitsBulkAdditionJobs" +description: "List siteProtectionUnitsBulkAdditionJobs in a SharePoint protection policy." ++ms.localizationpriority: medium ++++# List siteProtectionUnitsBulkAdditionJobs ++Namespace: microsoft.graph +++Get a list of [siteProtectionUnitsBulkAdditionJobs](../resources/siteprotectionunitsbulkadditionjob.md) objects associated with a [sharePointProtectionPolicy](../resources/sharepointprotectionpolicy.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": "sharepointprotectionpolicy_list_siteprotectionunitsbulkadditionjobs" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/backupRestore/sharePointProtectionPolicies/{sharePointProtectionPolicyId}/siteProtectionUnitsBulkAdditionJobs +``` ++## 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 [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) object in the response body. +The `siteWebUrls` and `siteIds` values 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": "sharepointprotectionpolicy_list_siteprotectionunitsbulkadditionjobs" +} +--> ++``` http +GET https://graph.microsoft.com/beta/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteProtectionUnitsBulkAdditionJobs +``` ++# [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.siteProtectionUnitsBulkAdditionJob)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteProtectionUnitsBulkAdditionJobs ++{ + "@odata.type": "#collection(microsoft.graph.siteProtectionUnitsBulkAdditionJob)", + "@odata.context": "/solutions/backupRestore/sharePointProtectionPolicies('71633878-8321-4950-bfaf-ed285bdd1461')/siteProtectionUnitsBulkAdditionJobs", + "@odata.nextLink": "/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteProtectionUnitsBulkAdditionJobs?$top=2&$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", + "value": + [ + { + "@odata.type": "#microsoft.graph.siteProtectionUnitsBulkAdditionJob", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "Sites-I", + "status" : "active", + "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.siteProtectionUnitsBulkAdditionJob", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "Sites-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": "SiteUrlNotFound", + "message": "Site Url 'https://testSite1.sharepoint.com' could not be resolved", + "target" : "https://testSite1.sharepoint.com" + }, + { + "code": "SiteUrlNotFound", + "message": "Site Url 'https://testSite2.sharepoint.com' could not be resolved", + "target" : "https://testSite2.sharepoint.com" + }, + { + "code": "SiteUrlNotFound", + "message": "Site Url 'https://testSite3.sharepoint.com' could not be resolved", + "target" : "https://testSite3.sharepoint.com" + } + ] + } + } + ] +} +``` |
v1.0 | Sharepointprotectionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharepointprotectionpolicy-update.md | To remove a **siteProtectionUnit** from the policy, specify the `@removed` annot If successful, this method returns a `200 OK` response code and an updated [sharePointProtectionPolicy](../resources/sharepointprotectionpolicy.md) 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 | Sharepointrestoresession List Siterestoreartifacts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharepointrestoresession-list-siterestoreartifacts.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [siteRestoreArtifact](../resources/siterestoreartifact.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 | Sharepointrestoresession Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharepointrestoresession-update.md | PATCH /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessi If successful, this method returns a `200 OK` response code and an updated [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 The following example shows a request. To remove a **siteRestoreArtifact** from a site restore session, specify the @removed annotation in the request body for the respective restore point artifact together with the ID of the [siteRestoreArtifact](../resources/siterestoreartifact.md). -# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "sharepointrestoresession_update" Content-Type: application/json } ``` -# [C#](#tab/csharp) --# [CLI](#tab/cli) --# [Java](#tab/java) --# [JavaScript](#tab/javascript) --# [PHP](#tab/php) --# [PowerShell](#tab/powershell) --# [Python](#tab/python) --- ### Response The following example shows the response. |
v1.0 | Sharepointsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharepointsettings-get.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/sharepointsettings-get-permissions.md)] When calling on behalf of a user, the user needs to belong to one of the following admin roles. To learn more about admin roles, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles):-* Global Administrator * Global Reader * SharePoint Administrator |
v1.0 | Sharepointsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sharepointsettings-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "sharepointsettings_update" } --> [!INCLUDE [permissions-table](../includes/permissions/sharepointsettings-update-permissions.md)] -When calling on behalf of a user, the user needs to belong to one of the following admin roles. To learn more about admin roles, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles): -* Global Administrator -* SharePoint Administrator +When calling on behalf of a user, the user needs to belong to the SharePoint Administrator role. To learn more about admin roles, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles). ## HTTP request |
v1.0 | Signin Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/signin-confirmcompromised.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Allow admins to mark an event in the Microsoft Entra sign-in logs as risky. Events marked as risky by an admin are immediately flagged as high risk in Microsoft Entra ID Protection, overriding previous risk states. Admins can confirm that events flagged as risky by Microsoft Entra ID Protection are in fact risky. +Allow admins to mark an event in the Microsoft Entra [sign-in](../resources/signin.md) logs as risky. Events marked as risky by an admin are immediately flagged as high risk in Microsoft Entra ID Protection, overriding previous risk states. Admins can confirm that events flagged as risky by Microsoft Entra ID Protection are in fact risky. For details about investigating Identity Protection risks, see [How to investigate risk](/azure/active-directory/identity-protection/howto-identity-protection-investigate-risk). Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "signin_confirmcompromised" } --> [!INCLUDE [permissions-table](../includes/permissions/signin-confirmcompromised-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Signin Confirmsafe | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/signin-confirmsafe.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Allow admins to mark an event in Microsoft Entra sign-in logs as safe. Admins can either mark the events flagged as risky by Microsoft Entra ID Protection as safe, or they can mark unflagged events as safe. For details about investigating Identity Protection risks, see [How to investigate risk](/azure/active-directory/identity-protection/howto-identity-protection-investigate-risk). +Allow admins to mark an event in Microsoft Entra [sign-in](../resources/signin.md) logs as safe. Admins can either mark the events flagged as risky by Microsoft Entra ID Protection as safe, or they can mark unflagged events as safe. For details about investigating Identity Protection risks, see [How to investigate risk](/azure/active-directory/identity-protection/howto-identity-protection-investigate-risk). [!INCLUDE [national-cloud-support](../../includes/global-us.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "signin_confirmsafe" } --> [!INCLUDE [permissions-table](../includes/permissions/signin-confirmsafe-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Signin Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/signin-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get a [signIn](../resources/signin.md) object that contains a specific user sign-in event for your tenant that includes sign-ins where a user is asked to enter a username or password, and session tokens. +Retrieve a specific Microsoft Entra user [sign-in](../resources/signin.md) event for your tenant. Sign-ins that are interactive in nature (where a username/password is passed as part of auth token) and successful federated sign-ins are currently included in the sign-in logs. [!INCLUDE [GDPR-related-guidance](../../includes/gdpr-msgraph-export-note.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/signin-get-permissions.md)] -Apps must be [properly registered](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to Microsoft Entra ID. --In addition to the delegated permissions, the signed-in user 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) that allow them to read sign-in reports. --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader - ## HTTP request |
v1.0 | Signin List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/signin-list.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/signin-list-permissions.md)] -Apps must be [properly registered](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to Microsoft Entra ID. --In addition to the delegated permissions, the signed-in user 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) that allow them to read sign-in reports. --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader --### Viewing applied conditional access (CA) policies in sign-ins - ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Site Post Permissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/site-post-permissions.md | Create a new [permission](../resources/permission.md) object on a site. ## 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": "site_post_permissions" } --> +<!-- { "blockType": "ignored", "name": "site_post_permissions" } --> +|Permission type|Least privileged permissions|Higher privileged permissions| +|:|:|:| +|Delegated (work or school account)|Not supported.|Not supported.| +|Delegated (work or school account)|Site.FullControl.All|Not available.| +|Delegated (personal Microsoft account)|Not supported.|Not supported.| +|Application|Sites.FullControl.All|Not available.| ++> **Note:** In delegated workflows, the user must have an administrator role, such as SharePoint Administrator or higher. ## HTTP request |
v1.0 | Sitepage Createfromtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-createfromtemplate.md | ++ +description: "Create a new page from a page template." + Title: "sitePage: createFromTemplate" +ms.localizationpriority: medium +++ +# sitePage: createFromTemplate + +Namespace: microsoft.graph + + +Create a new [sitePage](../resources/sitepage.md) from a [pageTemplate](../resources/pagetemplate.md) in a [site](../resources/site.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": "sitepage_createFromTemplate" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +POST /sites/{site-id}/pages/microsoft.graph.sitePage/createFromTemplate +``` +## 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 [crateFromPageTemplateRequest](../resources/createfromtemplate.md) to use in the request payload. ++## Response ++If successful, this method returns a `201 Created` and the created [sitePage](../resources/baseSitePage.md) object. ++## Example ++The following example shows how to create a new page from the page template. ++### Request ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "createFromTemplate", "scopes": "sites.readwrite.all" } --> ++```http +POST /sites/dd00d52e-0db7-4d5f-8269-90060ac688d1/pages/microsoft.graph.sitePage/createFromTemplate +Content-Type: application/json ++{ + "title": "Sample", + "name": "Sample.aspx", + "templateId": "f6ed8c43-9923-4c6c-ba09-9c32b8f10aeb" +} ++``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response. ++> **Note:** The response object might be shortened for readability. ++<!-- { "blockType": "response", "@odata.type": "microsoft.graph.sitePage", "truncated": true } --> ++```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.type": "microsoft.graph.sitePage", + "id": "0dd6ddd6-45bd-4acd-b683-de0e6e7231b7", + "name": "Sample.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Sample.aspx", + "title": "Sample", + "pageLayout": "article", + "showComments": true, + "showRecommendedPages": false, + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "publishingState": { + "level": "checkout", + "versionId": "0.1", + "checkedOutBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + } + }, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.contoso.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", + "layout": "colorBlock", + "showAuthor": true, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "TEXT ABOVE TITLE", + "textAlignment": "left", + "imageSourceType": 2 + } +} ++``` ++<!-- +{ + "type": "#sitePage.annotation", + "description": "Create a new page form a page template.", + "keywords": "", + "section": "documentation", + "tocPath": "SitePages/CreateFromTemplate", + "suppressions": [] +} +--> |
v1.0 | Sitepage Saveastemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/sitepage-saveastemplate.md | ++ +description: "Save the current page as a template." + Title: "sitePage: saveAsTemplate" +ms.localizationpriority: medium ++++# sitePage: saveAsTemplate ++Namespace: microsoft.graph +++Save a [sitePage](../resources/sitepage.md) as a [pageTemplate](../resources/pagetemplate.md) in a [site](../resources/site.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": "sitepage_saveAsTemplate" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> ++```http +POST /sites/{siteId}/pages/{pageId}/microsoft.graph.sitePage/saveAsTemplate +``` ++## Request headers +|Name|Description| +|:|:| +|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 the [saveAsTemplate](../resources/saveastemplate.md) to use in the request payload. ++## Response ++If successful, this method returns a `201 Created` HTTP response and the created [pageTemplate](../resources/pagetemplate.md) object. ++## Example ++The following example shows how to save a site page as a template page. ++### Request ++# [HTTP](#tab/http) +<!-- { "blockType": "request", "name": "saveAsTemplate", "scopes": "sites.readwrite.all" } --> ++```http +POST /sites/dd00d52e-0db7-4d5f-8269-90060ac688d1/pages/f6ed8c43-9923-4c6c-ba09-9c32b8f10aeb/microsoft.graph.sitePage/saveAsTemplate +Content-Type: application/json ++{ + "title": "SampleTitle", + "name": "SampleTemplate.aspx" +} ++``` ++# [JavaScript](#tab/javascript) ++++### Response ++The following example shows the response. ++> **Note:** The response object might be shortened for readability. + +<!-- { "blockType": "response", "@odata.type": "microsoft.graph.pageTemplate", "truncated": true } --> + +```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.type": "microsoft.graph.pageTemplate", + "id": "0dd6ddd6-45bd-4acd-b683-de0e6e726371", + "name": "SampleTemplate.aspx", + "webUrl": "https://contoso.sharepoint.com/SitePages/Templates/Sample.aspx", + "title": "SampleTitle", + "pageLayout": "article", + "createdBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "lastModifiedBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + }, + "publishingState": { + "level": "checkout", + "versionId": "0.1", + "checkedOutBy": { + "user": { + "displayName": "Rahul Mittal", + "email": "rahmit@contoso.com" + } + } + }, + "titleArea": { + "enableGradientEffect": true, + "imageWebUrl": "https://cdn.contoso.osi.office.net/m365content/publish/005292d6-9dcc-4fc5-b50b-b2d0383a411b/image.jpg", + "layout": "colorBlock", + "showAuthor": true, + "showPublishedDate": false, + "showTextBlockAboveTitle": false, + "textAboveTitle": "TEXT ABOVE TITLE", + "textAlignment": "left", + "imageSourceType": 2 + } +} +``` ++<!-- +{ + "type": "#pageTemplate.annotation", + "description": "Create a page template in the templates folder in a site.", + "keywords": "", + "section": "documentation", + "tocPath": "PageTemplates/Create", + "suppressions": [] +} +--> |
v1.0 | Siteprotectionunitsbulkadditionjobs Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/siteprotectionunitsbulkadditionjobs-get.md | + + Title: "Get siteProtectionUnitsBulkAdditionJob" +description: "Get a siteProtectionUnitsBulkAdditionJob in a SharePoint protection policy." ++ms.localizationpriority: medium ++++# Get siteProtectionUnitsBulkAdditionJob ++Namespace: microsoft.graph +++Get a [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) object by the ID associated with a [sharePointProtectionPolicy](../resources/sharepointprotectionpolicy.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": "siteprotectionunitsbulkadditionjobs_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/backupRestore/sharePointProtectionPolicies/{sharePointProtectionPolicyId}/siteProtectionUnitsBulkAdditionJobs/{siteProtectionUnitsBulkAdditionJobId} +``` ++## 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 [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "siteprotectionunitsbulkadditionjobs_get" +} +--> ++``` http +GET https://graph.microsoft.com/beta/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteProtectionUnitsBulkAdditionJobs/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.siteProtectionUnitsBulkAdditionJob" +} +--> ++``` http +HTTP/1.1 200 OK +Content-Location: https://graph.microsoft.com/beta/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteProtectionUnitsBulkAdditionJobs/61633878-8321-4950-bfaf-ed285bdd1461 ++{ + "@odata.type": "#microsoft.graph.siteProtectionUnitsBulkAdditionJob", + "id":"61633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "Sites-I", + "status" : "completedWithErrors", + "siteWebUrls": [ "https://contoso1@sharepoint.com", "https://contoso2@sharepoint.com", "https://contoso3@sharepoint.com", "https://contoso4@sharepoint.com", "https://testSite1.sharepoint.com", "https://testSite2.sharepoint.com", "https://testSite3.sharepoint.com" ], + "siteIds" : [ "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee4532", "contoso.sharepoint.com,ab60e844-ba1d-49bc-b4d4-d5e36bae9019,832a596e-90a1-49e3-9b48-bfa80bee4532"], + "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":{ + "details": + [ + { + "code": "SiteUrlNotFound", + "message": "Site Url 'https://testSite1.sharepoint.com' could not be resolved" + }, + { + "code": "SiteUrlNotFound", + "message": "Site Url 'https://testSite2.sharepoint.com' could not be resolved" + }, + { + "code": "SiteUrlNotFound", + "message": "Site Url 'https://testSite3.sharepoint.com' could not be resolved" + } + ] + } +} +``` |
v1.0 | Siteprotectionunitsbulkadditionjobs Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/siteprotectionunitsbulkadditionjobs-post.md | + + Title: "Create siteProtectionUnitsBulkAdditionJob" +description: "Create siteProtectionUnitsBulkAdditionJob for a SharePoint protection policy." ++ms.localizationpriority: medium ++++# Create siteProtectionUnitsBulkAdditionJob ++Namespace: microsoft.graph +++Create a [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) object associated with a [sharePointProtectionPolicy](../resources/sharepointprotectionpolicy.md). ++The initial status upon creation of the job is `active`. When all the `siteUrls` and `siteIds` are added into the corresponding SharePoint protection policy, the status of job is `completed`. ++If any failures occur, the status of the job 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": "siteprotectionunitsbulkadditionjobs_post" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /solutions/backupRestore/sharePointProtectionPolicies/{sharePointProtectionPolicyId}/siteProtectionUnitsBulkAdditionJobs +``` ++## 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 [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) object. ++## Response ++If successful, this method returns a `201 Created` response code and a [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "siteprotectionunitsbulkadditionjobs_post" +} +--> ++```http +POST https://graph.microsoft.com/beta/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteProtectionUnitsBulkAdditionJobs +Content-Type: application/json ++{ + "displayName" : "Sites-I", + "siteWebUrls" : [ "https://contoso.sharepoint.com/test1", "https://contoso.sharepoint.com/test2", "https://contoso.sharepoint.com/test4", "https://contoso.sharepoint.com/test5" ], + "siteIds" : [ "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee4532", "contoso.sharepoint.com,ab60e844-ba1d-49bc-b4d4-d5e36bae9019,832a596e-90a1-49e3-9b48-bfa80bee4532"] +} +``` ++# [JavaScript](#tab/javascript) ++++++### Response ++The following example shows the response. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.siteProtectionUnitsBulkAdditionJob" +} +--> +``` http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.type": "#microsoft.graph.siteProtectionUnitsBulkAdditionJob", + "id" :"71633878-8321-4950-bfaf-ed285bdd1461", + "displayName" : "Sites-I", + "status" : "active", + "siteWebUrls" : [ "https://contoso.sharepoint.com/test1", "https://contoso.sharepoint.com/test2", "https://contoso.sharepoint.com/test4", "https://contoso.sharepoint.com/test5" ], + "siteIds" : [ "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee4532", "contoso.sharepoint.com,ab60e844-ba1d-49bc-b4d4-d5e36bae9019,832a596e-90a1-49e3-9b48-bfa80bee4532"], + "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 | Subscribedsku Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscribedsku-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "subscribedsku_get" } --> [!INCLUDE [permissions-table](../includes/permissions/subscribedsku-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Subscribedsku List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/subscribedsku-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "subscribedsku_list" } --> [!INCLUDE [permissions-table](../includes/permissions/subscribedsku-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Synchronization Serviceprincipal Put Synchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/synchronization-serviceprincipal-put-synchronization.md | PUT /servicePrincipals/{id}/synchronization/secrets ## 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. |
v1.0 | Synchronization Synchronizationjob Validatecredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/synchronization-synchronizationjob-validatecredentials.md | POST /servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials ## 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. |
v1.0 | Synchronization Synchronizationschema Parseexpression | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/synchronization-synchronizationschema-parseexpression.md | POST /servicePrincipals/{id}/synchronization/templates/{id}/schema/parseExpressi ## 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. |
v1.0 | Synchronization Synchronizationschema Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/synchronization-synchronizationschema-update.md | In the request body, supply the [synchronizationSchema](../resources/synchroniza If successful, returns a `204 No Content` response code. It doesn't return anything in the response body. -## Example +## Examples -### Example 1: Update the directories and synchronizationRules of a synchronization schema +### Example 1: Update schema #### Request The following example shows a request. +>**Note:** The request object shown here is shortened for readability. Supply all the properties in an actual call. + # [HTTP](#tab/http) <!-- { "blockType": "request", Content-type: application/json { "source": {}, "targetAttributeName": "userName"- }, + } ]- }, + } ]- }, + } ] }- ``` # [JavaScript](#tab/javascript) The following example shows the response. HTTP/1.1 204 No Content ``` -### Example 2: Update the directories and synchronizationRules of a synchronization schema and configure the containers +### Example 2: Add attribute "CustomAttribute" to the target system schema #### Request-The following example shows a request. +The following example shows a request. It assumes that the attribute "CustomAttribute" doesn't exist in the target directory schema. If it does exist, the attribute is updated. ++>**Note:** The request object shown here is shortened for readability. Supply all the properties in an actual call. # [HTTP](#tab/http) <!-- { "blockType": "request",- "name": "update_synchronizationschema_containerFilter" + "name": "update_synchronizationschema_customattribute" }--> ```http PUT https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema Content-type: application/json {- "directories": [ - { - "name": "Azure Active Directory", - "objects": [ - { - "name": "User", - "attributes": [ - { - "name": "userPrincipalName", - "type": "string" - } - ] - } - ] - }, - { - "name": "Active Directory" - } - ], - "synchronizationRules": [ - { - "containerFilter": { - "includedContainers": [ - "OU=In-Scope OU 1,DC=contoso,DC=com", - "OU=In-Scope OU 2,DC=contoso,DC=com", - ] - }, - "groupFilter": { - "includedGroups": [] - }, - "name": "AD2AADProvisioning", - "sourceDirectoryName": "Active Directory", - "targetDirectoryName": "Azure Active Directory", - "objectMappings": [ - { - "name": "Provision Active Directory users", - "sourceObjectName": "user", - "targetObjectName": "User", - "attributeMappings": [ - { - "source": {}, - "targetAttributeName": "DisplayName" - } - ] - } - ] - } - ] + "directories":[ + { + "id":"09760868-cafb-47ac-9031-0a3262300427", + "name":"customappsso", + "objects":[ + { + "name":"User", + "attributes":[ + { + "anchor":false, + "caseExact":false, + "defaultValue":null, + "flowNullValues":false, + "multivalued":false, + "mutability":"ReadWrite", + "name":"urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User:CustomAttribute", + "required":false, + "type":"String", + "apiExpressions":[], + "metadata":[], + "referencedObjects":[] + } + ] + } + ] + } + ] } ``` # [JavaScript](#tab/javascript)++++#### Response +The following example shows the response. +<!-- { + "blockType": "response" +} --> +```http +HTTP/1.1 204 No Content +``` +++### Example 3: Add a new attribute mapping to the synchronization rules ++#### Request +The following example shows a request. The synchornizationSchema has a one-to-many relationship between **targetAttributeName** and **source** attributes. If your schema doesn't have "timezone" as a target attribute, the service adds a new mapping for extensionAttribute11 --> timezone. If your application has timezone as a target attribute in the schema, the service throws an error because an attribute can only be mapped as a target once. In addition, the attribute must exist in the schema before it can be added to the mappings. ++>**Note:** The request object shown here is shortened for readability. Supply all the properties in an actual call. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_synchronizationschema_newattributemapping" +}--> +```http +PUT https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema +Content-type: application/json ++{ + "@odata.type":"#microsoft.graph.synchronizationSchema", + "synchronizationRules":[ + { + "defaultValue":"", + "exportMissingReferences":false, + "flowBehavior":"FlowWhenChanged", + "flowType":"Always", + "matchingPriority":0, + "source":{ + "expression":"[extensionAttribute11]", + "name":"extensionAttribute11", + "parameters":[], + "type":"Attribute" + }, + "targetAttributeName":"timezone" + } + ] +} +++``` ++# [JavaScript](#tab/javascript) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] HTTP/1.1 204 No Content "section": "documentation", "tocPath": "", "suppressions": [- "Error: microsoft.graph.microsoft.graph/servicePrincipals: - /servicePrincipals/{var}/synchronization/jobs/{var}/schema - Uri path requires navigating into unknown object hierarchy: missing property 'jobs' on 'synchronization'. Possible issues: - 1) Doc bug where 'jobs' isn't defined on the resource. - 2) Doc bug where 'jobs' is an example key and should instead be replaced with a placeholder like {item-id} or declared in the sampleKeys annotation. - 3) Doc bug where 'synchronization' is supposed to be an entity type, but is being treated as a complex because it (and its ancestors) are missing the keyProperty annotation." ] } -->-- |
v1.0 | Team Archive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-archive.md | Title: "Archive team" description: "Archive the specified team. "-+ ms.localizationpriority: medium doc_type: apiPageType To restore a team from its archived state, use the API to [unarchive](team-unarc ## 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": "team_archive" } --> [!INCLUDE [permissions-table](../includes/permissions/team-archive-permissions.md)] |
v1.0 | Team Clone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-clone.md | Title: "team: clone" description: "Create a copy of a team. This operation also creates a copy of the corresponding group."-+ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Team Delete Incomingchannels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-delete-incomingchannels.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/team-delete-incomingchannels-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Team Delete Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-delete-members.md | Title: "Remove member from team" description: "Remove a conversationMember from a team."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | Team Get Primarychannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-get-primarychannel.md | Title: "Get primaryChannel" description: "Retrieve the navigation property of a team that allows access to its default General channel."-+ ms.localizationpriority: high doc_type: apiPageType Get the default [channel](../resources/channel.md), **General**, of a [team](../ ## 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "team_get_primarychannel" } --> [!INCLUDE [permissions-table](../includes/permissions/team-get-primarychannel-permissions.md)] |
v1.0 | Team Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-get.md | Title: "Get team" description: "Retrieve the properties and relationships of the specified team."-+ ms.localizationpriority: high doc_type: apiPageType Retrieve the properties and relationships of the specified [team](../resources/t ## 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": "team_get" } --> [!INCLUDE [permissions-table](../includes/permissions/team-get-permissions.md)] |
v1.0 | Team List Allchannels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-list-allchannels.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/team-list-allchannels-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Team List Incomingchannels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-list-incomingchannels.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "team_list_incomingchannels" } --> [!INCLUDE [permissions-table](../includes/permissions/team-list-incomingchannels-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Team Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-post-members.md | Title: "Add member to team" description: "Add a new member to a team."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | Team Put Teams | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-put-teams.md | Title: "Create team from group" description: "Create a new team from a group."-+ ms.localizationpriority: high doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "team_put_teams" } --> [!INCLUDE [permissions-table](../includes/permissions/team-put-teams-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access groups that they are not a member of. ## HTTP request |
v1.0 | Team Unarchive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-unarchive.md | Title: "Unarchive team" description: "Restore an archived team and restores users' ability to send messages and edit the team, abiding by tenant and team settings. Teams are archived using the archive API." ms.localizationpriority: medium-+ doc_type: apiPageType Unarchiving is an async operation. A team is unarchived once the async operation ## 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": "team_unarchive" } --> [!INCLUDE [permissions-table](../includes/permissions/team-unarchive-permissions.md)] |
v1.0 | Team Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/team-update.md | Title: "Update team" description: "Update the properties of the specified team."-+ ms.localizationpriority: medium doc_type: apiPageType Update the properties of the specified [team](../resources/team.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": "team_update" } --> [!INCLUDE [permissions-table](../includes/permissions/team-update-permissions.md)] |
v1.0 | Teamsapp Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/teamsapp-delete.md | Title: "Delete teamsApp" description: "Delete an app from an organization's app catalog (the tenant app catalog)." ms.localizationpriority: medium-+ doc_type: apiPageType You can also use this API to remove a submitted app from the review process. ## 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). ->**Note:** Only global administrators can call this API. +> [!NOTE] +> - The Directory.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission and avoid using this permissions going forward. +> - You can only use the AppCatalog.Submit permission to delete app definitions in review. +> - Only Teams Service admins or a higher privileged role can call this API. ++Permissions for the following HTTP request: ++<!-- { "blockType": "ignored" } --> +```http +DELETE /appCatalogs/teamsApps/{id} +``` -<!-- { "blockType": "permissions", "name": "teamsapp_delete" } --> +<!-- { + "blockType": "permissions", + "name": "teamsapp_delete", + "requestUrls": ["DELETE /appCatalogs/teamsApps/{id}"] + } --> [!INCLUDE [permissions-table](../includes/permissions/teamsapp-delete-permissions.md)] -> [!NOTE] -> - The Directory.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. -> - You can only use the AppCatalog.Submit permission to delete app definitions in review. +Permissions for the following HTTP request: ++<!-- { "blockType": "ignored" } --> +```http +DELETE /appCatalogs/teamsApps/{appId}/appDefinitions/{appDefinitionId} +``` +<!-- { + "blockType": "permissions", + "name": "teamsapp_delete_2", + "requestUrls": ["DELETE /appCatalogs/teamsApps/{appId}/appDefinitions/{appDefinitionId}"] + } --> + ## HTTP request |
v1.0 | Teamsapp Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/teamsapp-publish.md | Title: "Publish teamsApp" description: "Publish an app to the Microsoft Teams app catalog."-+ ms.localizationpriority: medium doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/teamsapp-publish-permissions.md)] > [!NOTE]-> The Directory.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> +> * The `Directory.ReadWrite.All` permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> * The `AppCatalog.Submit` permission allows you to submit apps for review only, not to publish them to the catalog. ## HTTP request Each app in the app catalog must have a unique manifest ID. If successful, this method returns a `200 OK` response code and a [teamsApp](../resources/teamsapp.md) object. If the app manifest has any validation errors, the request returns an error response with details about the schema errors. +### Error response ++If you send a request to upload an app manifest that contains missing information or errors, you receive an error message that includes the inner error code `UnableToParseTeamsAppManifest`. The **details** property of the inner error contains the error code and the error message. The following table describes the error codes that you might encounter. ++<br> +<details><summary>Error response</summary> ++| Error code | Error message | Description | +| :- | :- | :- | +| `ActivityGroupIdFromActivitiesTypeValidation` | ActivityGroupId field in ActivityType must be a subset of ID field in ActivityGroup. | The ActivityGroupId field in ActivityType isn't a subset of the Id field in ActivityGroup in the app manifest. | +| `ActivityTypesMustExistWithActivitiesGroupValidation` | Manifest shouldn't contain Activity Group when Activity Types is missing. | The ActivityGroup property is available, but the ActivityType property is missing in the app manifest. | +| `ApiBasedComposeExtensionApiResponseRenderingTemplateFileNullOrEmpty` | API-based compose extension must have apiResponseRenderingTemplateFile defined on manifest. | The API-based compose extension doesn't have the apiResponseRenderingTemplateFile defined in the app manifest. | +| `ApiBasedComposeExtensionApiSpecificationFileNullOrEmpty` | API-based compose extension must have apiSpecificationFile defined on manifest. | The API-based compose extension doesn't have the apiSpecificationFile defined in the app manifest. | +| `ApiBasedComposeExtensionManifestCommandIdsNotIncludedInOperationIdsOnApiSpecficationFile` | Command Ids on manifest aren't included in Operation Ids on API specification file.| The error that occurs when the Command Ids in the app manifest aren't included in Operation Ids on API specification file. | +| `ApiBasedComposeExtensionWithBotId` | API-based compose extension can't have botId defined. | The API-based compose extension has botId defined in the app manifest. | +| `ApiBasedComposeExtensionWithCanUpdateConfiguration` | API-based compose extension can't have canUpdateConfiguration defined on manifest. | The API-based compose extension has canUpdateConfiguration defined in the app manifest. | +| `ApiBasedComposeExtensionWithNoParameter`| API-based compose extension must have command parameters defined on manifest. | The API-based compose extension doesn't have any command parameters defined in the app manifest. | +| `ApiSecretServiceAuthTypeComposeExtensionContainsMsftEntraConfiguration` | API-based compose extension with apiSecretServiceAuth authType have microsoftEntraConfiguration defined. | The API-based compose extension has microsoftEntraConfiguration defined in the app manifest. | +| `ApiSecretServiceAuthTypeComposeExtensionContainsNoApiSecretRegistrationId` | API-based compose extension with apiSecretServiceAuth authType have no apiSecretRegistrationId defined. | The API-based compose extension with apiSecretServiceAuth authType without apiSecretRegistrationId defined in the app manifest. | +| `ApiSecretServiceAuthTypeComposeExtensionContainsNoApiSecretServiceAuthConfiguration` | API-based compose extension with apiSecretServiceAuth authType have no apiSecretServiceConfiguration. | The API-based compose extension doesn't set supportsSingleSignOn to true in the app manifest.| +| `ApiSpecificationFileContainUnsupportedHttpMethod`| API-based compose extension have server urls that have unsupported http method defined on apiSpecificationFile. Currently only GET and POST are supported. | The API-based compose extension has an unsupported http method defined in the apiSpecificationFile. | +| `ApiSpecificationFileParameterContainUnsupportedSchemaType` | API-based compose extension have unsupported parameter schema type defined on apiSpecificationFile.Arrays aren't supported. | The API-based compose extension has an unsupported parameter schema type defined in the apiSpecificationFile. | +| `ApiSpecificationFileRequestBodyContainUnsupportedMediaType` | API-based compose extension have unsupported media type defined in request body on apiSpecificationFile. Currently only application/json is supported.| The API-based compose extension has an unsupported media type defined in request body in the apiSpecificationFile. | +| `ApiSpecificationFileRequestBodyContainUnsupportedSchemaType` | API-based compose extension have unsupported schema type defined in request body on apiSpecificationFile. Currently arrays aren't supported. | The API-based compose extension has an unsupported schema type defined in request body in the apiSpecificationFile. | +| `ApiSpecificationFileRequestBodySchemaContainKeywords` | API-based compose extension have keywords. | The API-based compose extension has keywords defined in request body in the apiSpecificationFile. | +| `ApiSpecificationFileRequiredParameterContainUnsupportedLocation` | API-based compose extension have unsupported parameter location defined on apiSpecificationFile for {0}. Currently only path and query supported. | The API-based compose extension has an unsupported parameter location defined in the apiSpecificationFile. | +| `ApiSpecificationFileRequiredParameterOrPropertyNotDefinedOnManifest` | API-based compose extension have required parameters or properties {0} not defined on manifest. | The API-based compose extension has a required parameter, which isn't defined in the app manifest. | +| `ApiSpecificationFileResponseContainUnsupportedMediaType` | API-based compose extension have unsupported media type defined in response on apiSpecificationFile. Currently only application/json supported. | The API-based compose extension has an unsupported media type defined in response in the apiSpecificationFile. | +| `ApiSpecificationFileServerUrlsContainHttp` | API-based compose extension have server urls that have http protocol defined on apiSpecificationFile. | The API-based compose extension has server urls that contain http protocol in the apiSpecificationFile.| +| `ApiSpecificationFileServerUrlsContainInvalidUrl` | API-based compose extension have server urls that are invalid URL defined on apiSpecificationFile. | The API-based compose extension has an invalid URL defined in the apiSpecificationFile. | +| `BotBasedComposeExtensionApiResponseRenderingTemplateFileExists`| Bot based compose extension can't have apiResponseRenderingTemplateFile defined. | The bot-based compose extension has an apiResponseRenderingTemplateFile property defined in the app manifest. | +| `BotBasedComposeExtensionApiSpecificationFileExists` | Bot based compose extension can't have apiSpecificationFile defined. | The bot-based compose extension has an API specification file defined in the app manifest. | +| `BotBasedComposeExtensionBotIdNotGuid` | Bot based compose extension must have GUID botId. | The bot-based compose extension botId isn't GUID. | +| `BotIdIsNotGuid` | BotId isn't a Guid value. | The BotId value in the app manifest isn't a GUID. | +| `CommonAppIdIsNotGuid` | Field 'ID' isn't a Guid in the manifest.| The appId isn't GUID. | +| `CommonAppIdIsRequiredField` | Required field 'ID' is missing in the manifest. | The appId isn't provided. | +| `CommonManifestVersionIsRequiredField` | The required field in manifest 'manifest Version' is missing. | The manifest version isn't provided. | +| `CommonSchemaUrlIsRequiredField` | Schema URL must be present. | The schema isn't provided. | +| `DashboardCardBothIconNameAndUrlPresent` | Dashboard cards icon shouldn't contain both icon name and URL. | Dashboard cards icon mustn't contain both icon name and URL. | +| `DashboardCardEntityIdsAreNotUnique` | Dashboard card entity IDs should be unique. | The returned entity Id for a dashboard card isn't unique within the manifest.| +| `DeveloperNameIsRequiredField` | Required field 'developer name' is missing in the manifest. | The developer name isn't provided. | +| `DeveloperNameLengthCheck` | Maximum character length must not exceed 32 chars. | The developer name is more than 32 characters long. | +| `DeveloperPrivacyUrlIsRequiredField` | Required field 'privacyUrl' is missing in the manifest. | The privacyUrl is missing in the app manifest. | +| `DeveloperPrivacyUrlMustBeHttps` | Privacy URL must be secured Support URL (HTTPS).| The developer privacy URL didn't use HTTPS. | +| `DeveloperTermsOfUseUrlIsRequiredField` | Required field 'termsOfUseUrl' is missing in the manifest. | The termsOfUseUrl is missing from the manifest. | +| `DeveloperTermsOfUseUrlMustBeHttps` | Terms Of Use URL must be secured Support URL (HTTPS). | The developer terms of use URL didn't use HTTPS. | +| `DeveloperWebsiteUrlIsRequiredField` | Required field 'websiteUrl' is missing in the manifest. | The developer website URL is missing. | +| `DeveloperWebsiteUrlMustBeHttps` | Website URL must be secured Support URL (HTTPS).| The developer website URL didn't use HTTPS. | +| `FullDescriptionCannotBeEmpty` | Full Description can't be empty. | The full description is empty. | +| `FullDescriptionLengthCheck` | Maximum character length for long description must not exceed 4,000 chars.| The full description length is more than 4,000 characters. | +| `GroupChatForBotsLessThanV13` | Please upgrade the version of manifest to V1.3 as group chat bot is supported in manifest v1.3 onwards. | The groupChat scope for bots isn't supported in the app manifest version 1.3 and below. | +| `GroupChatForConfigurableTabsLessThanV13`| Please upgrade the version of manifest to V1.3 as group chat configurable tabs is supported in manifest v1.3 onwards. | The groupChat scope for configurable tabs isn't supported in the app manifest version 1.3 and below. | +| `InvalidColor32x32IconHeightAndWidth` | Color 32x32 icon should be 32x32 with only white and transparent. | The color 32x32 icon doesn't have the correct dimensions. | +| `InvalidColorIconHeightAndWidth` | Color Icon isn't as per the required dimension. | The dimensions of the color icon are incorrect. | +| `InvalidOutlineIconHeightAndWidth` | Small icon should be 32x32 with only white and transparent. | The dimensions of the outline icon are incorrect. | +| `InvalidOutlineIconTransparency` | Outline icon isn't transparent. It's Alpha. | The outline icon contains pixels that are neither transparent nor white, with Alpha, R, G, B values of {0}, {1}, {2}, and {3}. | +| `MsftEntraAuthTypeComposeExtensionContainsApiSecretServiceConfiguration` | API-based compose extension with microsoftEntra authType have apiSecretServiceConfiguration defined. | The API-based compose extension has apiSecretServiceConfiguration defined in the manifest. | +| `MsftEntraAuthTypeComposeExtensionContainsNoMsftEntraConfiguration` | API-based compose extension with microsoftEntra authType have no microsoftEntraConfiguration defined. | The API-based compose extension doesn't have microsoftEntraConfiguration defined in the app manifest. | +| `MsftEntraAuthTypeComposeExtensionResourceURLNotMatchServerURLOnApiSpec` | API-based compose extension with microsoftEntra authType resource URL on manifest doesn't match server URL on API specification file. | The API-based compose extension with microsoftEntra authType resource URL in the app manifest doesn't match server URL in the API specification file. | +| `MsftEntraAuthTypeComposeExtensionSupportsSingleSignOnFalse` | API-based compose extension with microsoftEntra authType doesn't set supportsSingleSignOn to true. | The API-based compose extension doesn't set **supportsSingleSignOn** to `true` in the app manifest. | +| `MsftEntraAuthTypeComposeExtensionWebApplicationInfoOrResourceNotDefined` | API-based compose extension with microsoftEntra authType have no webApplicationInfo or resource defined on manifest. | The API-based compose extension with microsoftEntra authType doesn't have webApplicationInfo or resource defined in the app manifest. | +| `NoAuthTypeComposeExtensionContainsAuthConfiguration` | API-based compose extension with none authType have auth-related configuration defined. | The API-based compose extension with authType microsoftEntraConfiguration or apiSecretServiceConfiguration isn't defined in the app manifest. | +| `ParameterOnManifestNotDefinedOnApiSpecFile` | API-based compose extension have parameters {0} on manifest not defined on API specification file. | The API-based compose extension parameters in the app manifest aren't defined in the API specification file. | +| `ReservedActivitiesValidation` | Manifest shouldn't contain reserved Activity Type 'systemDefault'. | The systemDefault activity type is defined in the app manifest. | +| `ReservedStaticTabNameShouldBeNull` | Reserved tab "Name" property shouldn't be specified. | The reserved staticTabs name property was specified. | +| `SchemaError_AdditionalItems` | The schema doesn't allow additional items. | The app manifest file failed the additionalItems validation of the schema. | +| `SchemaError_AdditionalProperties` | Property {0} hasn't been defined and the schema doesn't allow additional properties. | The app manifest file failed the additionalProperties validation of the schema. Here, {0} represents the additional property. | +| `SchemaError_AllOf` | JSON doesn't match all schemas from "allOf". | The app manifest file failed the allOf validation of the schema. | +| `SchemaError_AnyOf` | JSON doesn't match any schemas from "anyOf". | The app manifest file failed the anyOf validation of the schema. | +| `SchemaError_Const` | Value {0} doesn't match constant {1}. | The app manifest file failed the const validation of the schema. Here, {0} represents the value that failed and {1} represents the correct value. | +| `SchemaError_Contains` | Array doesn't contain a required item. | The app manifest file failed the contains validation of the schema. | +| `SchemaError_ContentEncoding` | String {0} doesn't validate against content encoding {1}. | The app manifest file failed the contentEncoding validation of the schema. Here, {0} represents the string that doesn't match content encoding and {1} represents the expected content encoding. | +| `SchemaError_Dependencies` | Dependencies for property {0} failed. Missing required keys.| The app manifest file failed the dependencies validation of the schema. Here, {0} represents the property that failed. | +| `SchemaError_Else` | JSON doesn't match schema from "else". | The app manifest file failed the else validation of the schema. | +| `SchemaError_Enum` | Value {0} isn't defined in the enum. | The app manifest file failed the enum validation of the schema. Here, {0} represents the value that isn't in the enum. | +| `SchemaError_Format` | String {0} doesn't validate against format {1}. | The app manifest file failed the format validation of the schema. Here, {0} represents the string that isn't in the expected format and {1} represents the expected format. | +| `SchemaError_Id` | Duplicate schema ID {0} encountered. | The app manifest file failed the id validation of the schema. Here, {0} represents the id of the schema. | +| `SchemaError_Maximum` | Integer {0} exceeds maximum value of {1}. | The app manifest file failed the maximum validation of the schema. Here, {0} represents the value that exceeds the maximum limit and {1} represents the maximum limit. | +| `SchemaError_MaximumItems` | Array item count {0} exceeds maximum count of {1}. | The app manifest file failed the maximumItems validation of the schema. Here, {0} represents the number of elements in the array and {1} represents the maximum allowed. | +| `SchemaError_MaximumLength`| String {0} exceeds maximum length of {1}. | The app manifest file failed the maximumLength validation of the schema. Here, {0} represents the string that exceeds the maximum length and {1} represents the maximum length. | +| `SchemaError_MaximumProperties` | Object property count {0} exceeds maximum count of {1}. | The app manifest file failed the maximumProperties validation of the schema. Here, {0} represents the number of properties provided and {1} represents the maximum allowed properties. | +| `SchemaError_Minimum` | Integer {0} is less than minimum value of {1}. | The app manifest file failed the minimum validation of the schema. Here, {0} represents the value that exceeds the minimum limit and {1} represents the minimum limit. | +| `SchemaError_MinimumItems` | Array item count {0} is less than minimum count of {1}. | The app manifest file failed the minimumItems validation of the schema. Here, {0} represents the number of elements in the array and {1} represents the minimum allowed. | +| `SchemaError_MinimumLength`| String {0} is less than minimum length of {1}. | The app manifest file failed the minimumLength validation of the schema. Here, {0} represents the string that is less than the minimum length and {1} represents the minimum. | +| `SchemaError_MinimumProperties` | Object property count {0} is less than minimum count of {1}.| The app manifest file failed the minimumProperties validation of the schema. Here, {0} represents the number of properties provided and {1} represents the minimum allowed properties. | +| `SchemaError_MultipleOf` | Integer {0} isn't a multiple of {1}. | The app manifest file failed the multipleOf validation of the schema. Here, {0} represents the integer value and {1} indicates the required multiple. | +| `SchemaError_Not` | JSON is valid against schema from "not".| The app manifest file failed the not validation of the schema. | +| `SchemaError_OneOf` | JSON is valid against more than one schema from "oneOf". | The app manifest file failed the oneOf validation of the schema. | +| `SchemaError_Other` | The value doesn't conform to the schema for this property. | The app manifest file failed other unhandled validations of the schema. | +| `SchemaError_Pattern` | String {0} doesn't match regex pattern "{1}". | The app manifest file failed the pattern validation of the schema. Here, {0} represents the value that doesn't match the pattern and {1} represents the expected pattern. | +| `SchemaError_PatternProperties` | Couldn't test property names with regex pattern "{0}". | The app manifest file failed the patternProperties validation of the schema. Here, {0} represents the pattern for the properties. | +| `SchemaError_Required` | Required properties are missing from object: {0}. | The app manifest file failed the required validation of the schema. Here, {0} represents the required properties. | +| `SchemaError_Then` | JSON doesn't match schema from "then". | The app manifest file failed the then validation of the schema. | +| `SchemaError_Type` | Value {0} isn't of the expected type {1}. | The app manifest file failed the type validation of the schema. Here, {0} represents the string that isn't in the expected type and {1} represents the expected type.| +| `SchemaError_UniqueItems` | Array contains items that aren't unique.| The app manifest file failed the uniqueItems validation of the schema. | +| `SchemaError_Valid` | Schema always fails validation. | The app manifest file failed the valid validation of the schema. | +| `Serialization_FileMissing`| The file {0} couldn't be found in the app package. | The expected file is missing in the app package. | +| `Serialization_FileNotValidJson` | The file couldn't be parsed as a JSON object. | The submitted file didn't comply with a valid JSON format. | +| `Serialization_ManifestVersionPropertyMissing` | The file doesn't contain the "{0}" property. | The **manifestVersion** property is missing in the app manifest file. Here, {0} represents the string for the **manifestVersion** property. | +| `Serialization_TrailingCommaInManifestJsonFile` | Manifest json file contains trailing comma. | The app manifest file contains a trailing comma. | +| `ServerUrlsMissingOnApiSpecificationFile`| API-based compose extension have no server urls defined on apiSpecificationFile. | The error that occurs The API-based compose extension has no server urls defined in the apiSpecificationFile. | +| `ShortDescriptionCannotBeEmpty` | Short Description canΓÇÖt be empty | The short description was empty. | +| `ShortDescriptionLengthCheck` | Maximum character length for short description must not exceed 80 chars. | The short description is more than 80 characters long. | +| `ShortNameEqualsReservedName` | Short name of the app can't be reserved name. | The short name is a reserved name. | +| `ShortNameIsRequiredField` | Short name of the app can't be empty. | The short name is empty. | +| `ShortNameLengthCheck` | Maximum character length for Short Name must not exceed 30 chars. | The short name exceeds 30 characters. | +| `StaticTabNameCouldNotBeEmpty` | Non-reserved staticTabs "Name" property can't be empty. | The staticTabs name property is empty. | +| `UniqueActivityTypeInActivitiesValidation` | Manifest shouldn't contain duplicate Activity Type. | The activity type isn't unique in the app manifest. | +| `UniqueIdInActivitiesGroupValidation` | Manifest shouldn't contain duplicate ID in Activity Groups. | The activity group ID isn't unique in the app manifest.| +| `VersionCannotBeEmpty` | Required field "version" is missing in the manifest. | The app package version is missing. | +| `VersionContainsOnlyNumbersDotSeparated` | App version supports only numbers in the '#.#.#' format. | The version in the app package isn't matched by the pattern, #.#.#. | +| `VersionHasMajorLessThan1` | App version shouldn't start with '0'. For example, 0.0.1 or 0.1 aren't valid app versions and 1.0 / 1.5.1 / 1.0.0 / 2.5.0 are valid app versions. In case of new update in manifest to an existing app in store. | The app version is less than 1.0. You need to upgrade your app version. For example, if the current version of your app in the store is 1.0 and youΓÇÖre submitting an update for validation, the app version must be higher than 1.0. | ++</details> + ## Examples ### Example 1: Publish an app to the app catalog |
v1.0 | Teamsapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/teamsapp-update.md | Title: "Update teamsApp" description: "Update an app previously published to the Microsoft Teams app catalog."-+ ms.localizationpriority: medium doc_type: apiPageType This API specifically updates an app published to your organization's app catalo 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). -Only Global Administrators can call this API. +- Only Teams Service admins or a higher privileged role can call this API. <!-- { "blockType": "permissions", "name": "teamsapp_update" } --> [!INCLUDE [permissions-table](../includes/permissions/teamsapp-update-permissions.md)] |
v1.0 | Tenantappmanagementpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tenantappmanagementpolicy-get.md | Content-type: application/json "isEnabled": false, "applicationRestrictions": { "passwordCredentials": [],- "keyCredentials":[] + "keyCredentials":[], + "identifierUris": { + "nonDefaultUriAddition": null + } }, "servicePrincipalRestrictions": { "passwordCredentials": [], |
v1.0 | Tenantappmanagementpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tenantappmanagementpolicy-update.md | In the request body, supply the values for relevant fields from the [tenantAppMa | Property | Type | Description | | : | :-- | :-- |-| applicationRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all application objects in the tenant. | +| applicationRestrictions | [appManagementApplicationConfiguration](../resources/appmanagementapplicationconfiguration.md) | Restrictions that apply as default to all application objects in the tenant. | | displayName | String | The display name of the default policy. Inherited from [policyBase](../resources/policybase.md). | | description | String | The description of the default policy. Inherited from [policyBase](../resources/policybase.md). | | isEnabled | Boolean | Denotes if the policy is enabled. Default value is false. | Content-Type: application/json "restrictForAppsCreatedAfterDateTime": "2015-01-01T10:37:00Z" } ],- "keyCredentials":[ + "keyCredentials": [ { "restrictionType": "asymmetricKeyLifetime", "maxLifetime": "P30D", Content-Type: application/json ], "maxLifetime": null }- ] + ], + "identifierUris": { + "nonDefaultUriAddition": { + "restrictForAppsCreatedAfterDateTime": "2024-01-01T10:37:00Z", + "excludeAppsReceivingV2Tokens": true, + "excludeSaml": true + } + } } } ``` |
v1.0 | Tenantrelationship Findtenantinformationbydomainname | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tenantrelationship-findtenantinformationbydomainname.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "tenantrelationship_findtenantinformationbydomainname" } --> [!INCLUDE [permissions-table](../includes/permissions/tenantrelationship-findtenantinformationbydomainname-permissions.md)] +> [!IMPORTANT] +> This API operation doesn't require the calling user to be assigned any [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). + ## HTTP request <!-- { |
v1.0 | Tenantrelationship Findtenantinformationbytenantid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tenantrelationship-findtenantinformationbytenantid.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "tenantrelationship_findtenantinformationbytenantid" } --> [!INCLUDE [permissions-table](../includes/permissions/tenantrelationship-findtenantinformationbytenantid-permissions.md)] +> [!IMPORTANT] +> This API operation doesn't require the calling user to be assigned any [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). + ## HTTP request <!-- { |
v1.0 | Tiindicator Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicator-delete.md | DELETE /security/tiIndicators/{id} | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Tiindicator Deletetiindicators | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicator-deletetiindicators.md | POST /security/tiIndicators/deleteTiIndicators | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Tiindicator Deletetiindicatorsbyexternalid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicator-deletetiindicatorsbyexternalid.md | POST /security/tiIndicators/deleteTiIndicatorsByExternalId | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Tiindicator Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicator-get.md | This method supports some of the OData query parameters to help customize the re | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Tiindicator Submittiindicators | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicator-submittiindicators.md | POST /security/tiIndicators/submitTiIndicators | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Tiindicator Updatetiindicators | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicator-updatetiindicators.md | POST /security/tiIndicators/updateTiIndicators | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Tiindicators List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicators-list.md | This method supports some of the OData query parameters to help customize the re | Name |Description| |:-|:-|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Tiindicators Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/tiindicators-post.md | POST /security/tiIndicators | Name | Description | |:--|:--|-| Authorization | Bearer {code} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Timeoff Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoff-delete.md | Delete a [timeOff](../resources/timeoff.md) instance from a [schedule](../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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "timeoff_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoff-delete-permissions.md)] |
v1.0 | Timeoff Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoff-get.md | Retrieve the properties and relationships of a [timeOff](../resources/timeoff.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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "timeoff_get" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoff-get-permissions.md)] |
v1.0 | Timeoff Put | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoff-put.md | If the specified [timeOff](../resources/timeoff.md) doesn't exist, this method r 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "timeoff_put" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoff-put-permissions.md)] |
v1.0 | Timeoffreason Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffreason-delete.md | This method doesn't remove the specified **timeOffReason** instance. [timeOffIte 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "timeoffreason_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffreason-delete-permissions.md)] |
v1.0 | Timeoffreason Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffreason-get.md | Retrieve the properties and relationships of a [timeOffReason](../resources/time 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "timeoffreason_get" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffreason-get-permissions.md)] |
v1.0 | Timeoffreason Put | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffreason-put.md | If the specified [timeOffReason](../resources/timeoffreason.md) doesn't exist, t 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "timeoffreason_put" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffreason-put-permissions.md)] |
v1.0 | Timeoffrequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/timeoffrequest-list.md | Retrieve a list of [timeoffrequest](../resources/timeoffrequest.md) objects in t 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "timeoffrequest_list" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffrequest-list-permissions.md)] |
v1.0 | Trustframework List Keysets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframework-list-keysets.md | Title: "List keySets" description: "Retrieve a list of trustframeworkkeyset objects." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframework_list_keysets" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframework-list-keysets-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Trustframework List Trustframeworkpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframework-list-trustframeworkpolicies.md | Title: "List trustFrameworkPolicies" description: "This operation lists all trustFrameworkPolicy objects in an Azure AD B2C tenant." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframework_list_trustframeworkpolicies" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframework-list-trustframeworkpolicies-permissions.md)] -The work or school account must have at least the *B2C IEF Keyset Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Trustframework Post Keysets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframework-post-keysets.md | Title: "Create trustFrameworkKeySet" description: "Create a new **trustFrameworkKeySet** object." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframework_post_keysets" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframework-post-keysets-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Trustframework Post Trustframeworkpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframework-post-trustframeworkpolicy.md | Title: "Create trustFrameworkPolicy" description: "This operation creates a new trustFrameworkPolicy object in an Azure AD B2C tenant." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframework_post_trustframeworkpolicy" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframework-post-trustframeworkpolicy-permissions.md)] -The work or school account must have at least the *B2C IEF Keyset Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Trustframework Put Trustframeworkpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframework-put-trustframeworkpolicy.md | Title: "Update trustFrameworkPolicy" description: "This operation updates an existing trustFrameworkPolicy object, or if one doesn't exist, it creates one. " ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframework_put_trustframeworkpolicy" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframework-put-trustframeworkpolicy-permissions.md)] -The work or school account must have at least the *B2C IEF Keyset Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Trustframeworkkey_V2 Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkey_v2-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkey_v2_get" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkey_v2-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Trustframeworkkey_V2 Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkey_v2-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkey_v2_update" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkey_v2-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Trustframeworkkeyset Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-delete.md | Title: "Delete trustFrameworkKeySet" description: "Delete a **trustFrameworkKeySet** object." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Trustframeworkkeyset Generatekey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-generatekey.md | Title: "trustFrameworkKeySet: generateKey" description: "Generate a key and a secret automatically in the keyset." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_generatekey" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-generatekey-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Trustframeworkkeyset Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-get.md | Title: "Get trustFrameworkKeySet" description: "Retrieve the properties and relationships of trustframeworkkeyset object." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_get" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Trustframeworkkeyset Getactivekey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-getactivekey.md | Title: "trustFrameworkKeySet: getActiveKey" description: "Get the active key in the keyset." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_getactivekey" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-getactivekey-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Trustframeworkkeyset Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-update.md | Title: "Update trustFrameworkKeySet" description: "Update the properties of a **trustFrameworkKeySet** object." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_update" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-update-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Trustframeworkkeyset Uploadcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-uploadcertificate.md | Title: "trustFrameworkKeySet: uploadCertificate" description: "Upload a certificate to a keyset." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_uploadcertificate" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-uploadcertificate-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> HTTP/1.1 200 OK Content-type: application/json {- "kid": "kid-value", - "use": "sig", - "kty": "oct", - "nbf": 1508969811, - "exp": 1508973711 + "kid": "kid-value", + "use": "sig", + "kty": "oct", + "nbf": 1508969811, + "exp": 1508973711 } ``` |
v1.0 | Trustframeworkkeyset Uploadpkcs12 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-uploadpkcs12.md | Title: "trustFrameworkKeySet: uploadPkcs12" description: "Upload a PKCS 12 format key (PFX) to a keyset." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_uploadpkcs12" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-uploadpkcs12-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> HTTP/1.1 200 OK Content-type: application/json {- "kid": "kid-value", - "use": "sig", - "kty": "OCT", - "nbf": 1508969811, - "exp": 1508973711 + "kid": "kid-value", + "use": "sig", + "kty": "OCT", + "nbf": 1508969811, + "exp": 1508973711 } ``` |
v1.0 | Trustframeworkkeyset Uploadsecret | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkkeyset-uploadsecret.md | Title: "trustFrameworkKeySet: uploadSecret" description: "Upload a secret to a keyset." ms.localizationpriority: medium-+ doc_type: "apiPageType" Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkkeyset_uploadsecret" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkkeyset-uploadsecret-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> HTTP/1.1 200 OK Content-type: application/json {- "kid": "kid-value", - "use": "use-value", - "kty": "OCT", - "nbf": 1508969811, - "exp": 1508973711 + "kid": "kid-value", + "use": "use-value", + "kty": "OCT", + "nbf": 1508969811, + "exp": 1508973711 } ``` |
v1.0 | Trustframeworkpolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkpolicy-delete.md | Title: "Delete trustFrameworkPolicy" description: "This operation deletes an existing trustFrameworkPolicy object from an Azure AD B2C tenant." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkpolicy_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkpolicy-delete-permissions.md)] -The work or school account must have at least the *B2C IEF Keyset Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Trustframeworkpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/trustframeworkpolicy-get.md | Title: "Get trustFrameworkPolicy" description: "This operation retrieves an existing trustFrameworkPolicy content from an Azure AD B2C tenant." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "trustframeworkpolicy_get" } --> [!INCLUDE [permissions-table](../includes/permissions/trustframeworkpolicy-get-permissions.md)] -The work or school account must have at least the *B2C IEF Keyset Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Unifiedrbacresourceaction Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unifiedrbacresourceaction-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "unifiedrbacresourceaction_get" } --> [!INCLUDE [permissions-table](../includes/permissions/unifiedrbacresourceaction-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Unifiedrbacresourcenamespace Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unifiedrbacresourcenamespace-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "unifiedrbacresourcenamespace_get" } --> [!INCLUDE [permissions-table](../includes/permissions/unifiedrbacresourcenamespace-get-permissions.md)] ++ ## HTTP request <!-- { |
v1.0 | Unifiedrbacresourcenamespace List Resourceactions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/unifiedrbacresourcenamespace-list-resourceactions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "unifiedrbacresourcenamespace_list_resourceactions" } --> [!INCLUDE [permissions-table](../includes/permissions/unifiedrbacresourcenamespace-list-resourceactions-permissions.md)] + ## HTTP request <!-- { |
v1.0 | User Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-assignlicense.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Add or remove licenses for the user to enable or disable their use of Microsoft cloud offerings that the company has licenses to. For example, an organization can have a Microsoft 365 Enterprise E3 subscription with 100 licenses, and this request assigns one of those licenses to a specific user. You can also enable and disable specific plans associated with a subscription. +Add or remove licenses for the user to enable or disable their use of Microsoft cloud offerings that the company has licenses to. For example, an organization can have a Microsoft 365 Enterprise E3 subscription with 100 licenses, and this request assigns one of those licenses to a specific user. You can also enable and disable specific plans associated with a subscription. Direct user licensing is an alternative to [group-based licensing](../api/group-assignlicense.md). 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": "user_assignlicense" } --> [!INCLUDE [permissions-table](../includes/permissions/user-assignlicense-permissions.md)] -For delegated scenarios, the calling user needs at least one of the following [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). --- Directory Writers-- License Administrator-- User 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 the `microsoft.directory/users/assignLicense` role permission. The following least privileged roles are supported for this operation: +> - Directory Writers +> - License Administrator +> - User Administrator ## HTTP request <!-- { "blockType": "ignored" } --> 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 |
v1.0 | User Changepassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-changepassword.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Enable the user to update their password. Any user can update their password without belonging to any administrator role. +Update the signed-in [user's](../resources/user.md) password. Any user can update their password without belonging to any administrator role. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | User Convertexternaltointernalmemberuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-convertexternaltointernalmemberuser.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_convertexternaltointernalmemberuser" } --> [!INCLUDE [permissions-table](../includes/permissions/user-convertexternaltointernalmemberuser-permissions.md)] -In delegated scenarios, the calling user must have at least the *User Administrator* [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 a supported role permission. *User Administrator* is the least privileged role supported for this operation. ## HTTP request |
v1.0 | User Delete Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delete-approleassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_delete_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/user-delete-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Delete Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delete-sponsors.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_delete_sponsors" } --> [!INCLUDE [permissions-table](../includes/permissions/user-delete-sponsors-permissions.md)] + ## HTTP request <!-- { |
v1.0 | User Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-delta.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get newly created, updated, or deleted users without having to perform a full read of the entire user collection. See [change tracking](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted users without having to perform a full read of the entire [user](../resources/user.md) collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. > [!NOTE] > Changes to the **licenseAssignmentStates** property are currently not tracked. You only need to specify any desired query parameters once upfront. In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response, as that URL already includes the encoded, desired 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 user 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 user collection. | |
v1.0 | User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-get.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the properties and relationships of user object. +Retrieve the properties and relationships of [user](../resources/user.md) object. This operation returns by default only a subset of the more commonly used properties for each user. These _default_ properties are noted in the [Properties](../resources/user.md#properties) section. To get properties that are _not_ returned by default, do a [GET operation](user-get.md) for the user and specify the properties in a `$select` OData query option. Because the **user** resource supports [extensions](/graph/extensibility-overview), you can also use the `GET` operation to get custom properties and extension data in a **user** instance. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored", "name": "user_get" } --> [!INCLUDE [permissions-table](../includes/permissions/user-get-permissions.md)] -> [!TIP] -> 1. Calling the `/me` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when using the `/me` endpoint. ->2. The `User.Read` permission allows the app to read the profile, and discover relationships such as the group membership, reports and manager of the signed-in user only. +>[!NOTE] +> - Calling the `/me` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when using the `/me` endpoint. +> - The `User.Read` permission allows the app to read the profile, and discover relationships such as the group membership, reports and manager of the signed-in user only. +> - To read the **employeeLeaveDateTime** property: +> - In delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator* (least privilege), *Global Reader*; the app must be granted the *User-LifeCycleInfo.Read.All* delegated permission. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *User-LifeCycleInfo.Read.All* permission. +> - To read the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.Read.All* permission. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.Read.All* permission. ## HTTP request |
v1.0 | User Invalidateallrefreshtokens | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-invalidateallrefreshtokens.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Invalidates all of the user's refresh tokens issued to applications (as well as session cookies in a user's browser), by resetting the **refreshTokensValidFromDateTime** user property to the current date-time. Typically, this operation is performed (by the user or an administrator) if the user has a lost or stolen device. This operation would prevent access to any of the organization's data accessed through applications on the device without the user first being required to sign in again. In fact, this operation would force the user to sign in again for all applications that they have previously consented to, independent of device. +Invalidates all of the user's refresh tokens issued to applications and session cookies in a user's browser, by resetting the **refreshTokensValidFromDateTime** user property to the current date-time. Typically, this operation is performed (by the user or an administrator) if the user has a lost or stolen device. This operation would prevent access to any of the organization's data accessed through applications on the device without the user first being required to sign in again. In fact, this operation would force the user to sign in again for all applications that they have previously consented to, independent of device. -For developers, if the application attempts to redeem a delegated access token for this user by using an invalidated refresh token, the application will get an error. If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint, which will force the user to sign in. +For developers, if the application attempts to redeem a delegated access token for this user by using an invalidated refresh token, the application receives an error. If this happens, the application needs to acquire a new refresh token by making a request to the OAuth 2.0 `/authorize` endpoint, which forces the user to sign in. +> [!IMPORTANT] +> This API won't be promoted to general availability status. We recommend that you use the [user: revokeSignInSessions](../api/user-revokesigninsessions.md) API instead. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_invalidateallrefreshtokens" } --> [!INCLUDE [permissions-table](../includes/permissions/user-invalidateallrefreshtokens-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 Writers +> - Helpdesk Administrator +> - Authentication Administrator +> - Privileged Authentication Administrator +> - User Administrator + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | User List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-approleassignments.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Retrieve the list of [appRoleAssignments](../resources/approleassignment.md) that a user has been granted. This operation also returns app role assignments granted to groups that the user is a direct member of. +Retrieve the list of [appRoleAssignments](../resources/approleassignment.md) that a [user](../resources/user.md) has been granted. This operation also returns app role assignments granted to groups that the user is a direct member of. > [!IMPORTANT] > To ensure complete results for users with many indirect app role assignments, use the **ConsistencyLevel** header set to `eventual` and `$count`, as described in [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries#group-properties). For an example, see [Example 1](#example-1-list-approleassignments-granted-to-a-user). Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_list_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/user-list-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User List Joinedteams | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-joinedteams.md | Title: "List joinedTeams" description: "Get the teams in Microsoft Teams that the user is a direct member of."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | User List Licensedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-licensedetails.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_list_licensedetails" } --> [!INCLUDE [permissions-table](../includes/permissions/user-list-licensedetails-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 the `microsoft.directory/users/licenseDetails/read` role permission. The following least privileged roles are supported for this operation: +> - Guest Inviter +> - Directory Readers +> - Directory Writers +> - License Administrator +> - User Administrator + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | User List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-memberof.md | Choose the permission or permissions marked as least privileged for this API. Us ### Permissions for the signed-in user's direct memberships -<!-- { "blockType": "permissions", "name": "user_list_memberof_1" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> ### Permissions for another user's direct memberships -<!-- { "blockType": "permissions", "name": "user_list_memberof_2" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/user-list-memberof-2-permissions.md)] [!INCLUDE [limited-info](../../includes/limited-info.md)] |
v1.0 | User List Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-sponsors.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] + ## HTTP request Get sponsors. |
v1.0 | User List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list-transitivememberof.md | Choose the permission or permissions marked as least privileged for this API. Us ### Permissions for the signed-in user's memberships -<!-- { "blockType": "permissions", "name": "user_list_transitivememberof_1" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> ### Permissions for another user's memberships -<!-- { "blockType": "permissions", "name": "user_list_transitivememberof_2" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/user-list-transitivememberof-2-permissions.md)] [!INCLUDE [limited-info](../../includes/limited-info.md)] |
v1.0 | User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-list.md | Content-type: application/json #### Request -The following example shows a request. Details for the **signInActivity** property require a Microsoft Entra ID P1 or P2 license and the *AuditLog.Read.All* permission. +The following example shows a request. ++> [!Note] +> Details for the **signInActivity** property require a Microsoft Entra ID P1 or P2 license and the `AuditLog.Read.All` permission. # [HTTP](#tab/http) <!-- { Content-type: application/json #### Request -The following example shows a request. Details for the **signInActivity** property require a Microsoft Entra ID P1 or P2 license and the *AuditLog.Read.All* permission. +The following example shows a request. ++> [!Note] +> Details for the **signInActivity** property require a Microsoft Entra ID P1 or P2 license and the `AuditLog.Read.All` permission. <!-- { "blockType": "ignored", |
v1.0 | User Post Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-approleassignments.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Use this API to assign an app role to a user. To grant an app role assignment to a user, you need three identifiers: +Use this API to assign an [app role](../resources/approle.md) to a [user](../resources/user.md), creating an [appRoleAssignment](../resources/approleassignment.md) object. To grant an app role assignment to a user, you need three identifiers: - `principalId`: The `id` of the user to whom you are assigning the app role. - `resourceId`: The `id` of the resource `servicePrincipal` that has defined the app role. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_post_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/user-post-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Post Messages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-messages.md | POST /me/mailFolders/{id}/messages POST /users/{id | userPrincipalName}/mailFolders/{id}/messages ``` ## Request headers-| Name | Type | Description| -|:|:--|:-| -| Authorization | string | Bearer {token}.| -| Content-Type | string | Nature of the data in the body of an entity. Required. <br/> Use `application/json` for a JSON object and `text/plain` for MIME content | +| Name | Description| +|:-|:-| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +| Content-Type | The nature of the data in the body of an entity. Required. <br/> Use `application/json` for a JSON object and `text/plain` for MIME content | ## Request body When using JSON format, provide a JSON representation of the [message](../resources/message.md) object. |
v1.0 | User Post Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-sponsors.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_post_sponsors" } --> [!INCLUDE [permissions-table](../includes/permissions/user-post-sponsors-permissions.md)] + ## HTTP request <!-- { |
v1.0 | User Post Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-post-users.md | The request body contains the user to create. At a minimum, you must specify the This operation returns by default only a subset of the properties for each user. These default properties are noted in the [Properties](../resources/user.md#properties) section. To get properties that are not returned by default, do a [GET operation](user-get.md) and specify the properties in a `$select` OData query option. >[!NOTE]->To create external users, use the [invitation API](invitation-post.md). +>To create external users as part of B2B collaboration with your organization, use the [invitation API](invitation-post.md). To create a customer, citizen, or business partner in Microsoft Entra External ID in external tenants, see [Example 3: Create a customer account](#example-3-create-a-customer-account-in-external-tenants). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Content-type: application/json } ``` -### Example 2: Create a user with social and local account identities +### Example 2: Create a user with social and local account identities in Azure AD B2C -Create a new user, with a local account identity with a sign-in name, an email address as sign-in, and with a social identity. This example is typically used for migration scenarios in B2C tenants. +Create a new user, with a local account identity with a sign-in name, an email address as sign-in, and with a social identity. This example is typically used for migration scenarios in Azure AD B2C tenants. >[!NOTE] >For local account identities, password expirations must be disabled, and force change password at next sign-in must also be disabled. Content-type: application/json } ``` +### Example 3: Create a customer account in external tenants ++This example shows how to create a customer account in Microsoft Entra External ID in external tenants. ++>[!NOTE] +>For local account identities, password expirations must be disabled, and force change password at next sign-in must also be disabled. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_user_customer_external_tenant" +}--> ++```http +POST https://graph.microsoft.com/beta/users +Content-type: application/json ++{ + "displayName": "Test User", + "identities": [ + { + "signInType": "emailAddress", + "issuer": "contoso.onmicrosoft.com", + "issuerAssignedId": "adelev@adatum.com" + } + ], + "mail": "adelev@adatum.com", + "passwordProfile": { + "password": "passwordValue", + "forceChangePasswordNextSignIn": false + }, + "passwordPolicies": "DisablePasswordExpiration" +} +``` ++# [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": "microsoft.graph.user", +} --> +```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#users/$entity", + "id": "daabd280-3978-4d29-acce-d677b9cf2e4d", + "businessPhones": [], + "displayName": "Test User", + "givenName": null, + "jobTitle": null, + "mail": "adelev@adatum.com", + "mobilePhone": null, + "officeLocation": null, + "preferredLanguage": null, + "surname": null, + "userPrincipalName": "daabd280-3978-4d29-acce-d677b9cf2e4d@contoso.onmicrosoft.com" +} +``` + ## Related content - [Add custom data to resources using extensions](/graph/extensibility-overview) |
v1.0 | User Reprocesslicenseassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-reprocesslicenseassignment.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_reprocesslicenseassignment" } --> [!INCLUDE [permissions-table](../includes/permissions/user-reprocesslicenseassignment-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). --- Directory Writers-- License Administrator-- User 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 the `microsoft.directory/users/reprocessLicenseAssignment` role permission. The following least privileged roles are supported for this operation: +> - Directory Writers +> - License Administrator +> - User Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-update.md | Choose the permission or permissions marked as least privileged for this API. Us > - In app-only scenarios, the app must be assigned a higher privileged administrator role as indicated in [Who can perform sensitive actions](../resources/users.md#who-can-perform-sensitive-actions). > - Your personal Microsoft account must be tied to a Microsoft Entra tenant to update your profile with the *User.ReadWrite* delegated permission on a personal Microsoft account. > - Updating the **identities** property requires the *User.ManageIdentities.All* permission. Also, adding a [B2C local account](../resources/objectidentity.md) to an existing **user** object is not allowed, unless the **user** object already contains a local account identity.+> - To update the **employeeLeaveDateTime** property: +> - In delegated scenarios, the admin needs the *Global Administrator* role; the app must be granted the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* delegated permissions. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* permissions. +> - To update the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* permission. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* permission. ## HTTP request <!-- { "blockType": "ignored" } --> PATCH /users/{id | userPrincipalName} | Property | Type |Description| |:|:--|:-| |aboutMe|String|A freeform text entry field for the user to describe themselves.|-|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. This property is required when a user is created. Apart from a global administrator, a privileged authentication administrator assigned the _Directory.AccessAsUser.All_ delegated permission can update the **accountEnabled** status of all administrators in the tenant.| +|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. This property is required when a user is created. A Privileged Authentication Administrator assigned the _Directory.AccessAsUser.All_ delegated permission is the least privileged role that's allowed to update the **accountEnabled** status of all administrators in the tenant.| | ageGroup | [ageGroup](../resources/user.md#agegroup-values) | Sets the age group of the user. Allowed values: `null`, `Minor`, `NotAdult` and `Adult`. Refer to the [legal age group property definitions](../resources/user.md#legal-age-group-property-definitions) for further information. | |assignedLicenses|[assignedLicense](../resources/assignedlicense.md) collection|The licenses that are assigned to the user. Not nullable. | |birthday|DateTimeOffset|The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| PATCH /users/{id | userPrincipalName} | companyName | String | The name of the company that the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters. | | consentProvidedForMinor | [consentProvidedForMinor](../resources/user.md#consentprovidedforminor-values) | Sets whether consent has been obtained for minors. Allowed values: `null`, `Granted`, `Denied`, and `NotRequired`. Refer to the [legal age group property definitions](../resources/user.md#legal-age-group-property-definitions) for further information. | |country|String|The country/region in which the user is located; for example, `US` or `UK`.|-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><br/>To update this property, the calling principal must be assigned the Attribute Assignment Administrator role and must be granted the *CustomSecAttributeAssignment.ReadWrite.All* permission.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><li>To update this property in delegated scenarios, the calling principal must be assigned the Attribute Assignment Administrator role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* delegated permission.<li>To update this property in app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* application permission. | |department|String|The name for the department in which the user works.| |displayName|String|The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it can't be cleared during updates.| |employeeId|String|The employee identifier assigned to the user by the organization. The maximum length is 16 characters.| | employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`.| |givenName|String|The given name (first name) of the user.| |employeeHireDate|DateTimeOffset|The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|-|employeeLeaveDateTime|DateTimeOffset|The date and time when the user left or will leave the organization. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.<br><br> For delegated scenarios, the calling user must have the Global Administrator role and the calling app assigned the _User.Read.All_ and _User-LifeCycleInfo.ReadWrite.All_ delegated permissions. | +|employeeLeaveDateTime|DateTimeOffset|The date and time when the user left or will leave the organization. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.<br><br> For delegated scenarios, the calling user must have the *Global Administrator* role and the calling app assigned the _User.Read.All_ and _User-LifeCycleInfo.ReadWrite.All_ delegated permissions. | |employeeOrgData|[employeeOrgData](../resources/employeeorgdata.md) |Represents organization data (for example, division and costCenter) associated with a user. | |identities|[objectIdentity](../resources/objectidentity.md) collection| Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft, by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. Any update to **identities** replaces the entire collection and you must supply the userPrincipalName **signInType** identity in the collection.| |interests|String collection|A list for the user to describe their interests.| PATCH /users/{id | userPrincipalName} |onPremisesImmutableId|String|This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's **userPrincipalName** (UPN) property. **Important:** The **$** and **_** characters can't be used when specifying this property. | |otherMails|String collection|A list of additional email addresses for the user; for example: `["bob@contoso.com", "Robert@fabrikam.com"]`.| |passwordPolicies|String|Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two can be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`.|-|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. This can't be used for federated users. <br><br> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. In application-only access, the calling app must be assigned the *User.ReadWrite.All* application permission and at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).| +|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. This can't be used for federated users. <br><li> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. <li> In application-only access, the calling app must be assigned the *User.ReadWrite.All* (least privilege) or *Directory.ReadWrite.All* (higher privilege) application permission *and* at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).| |pastProjects|String collection|A list for the user to enumerate their past projects.| |postalCode|String|The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.| |preferredLanguage|String|The preferred language for the user. Should follow ISO 639-1 Code; for example, `en-US`.| HTTP/1.1 204 No Content The following example shows a request that resets the password of another user. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. + #### Request |
v1.0 | User Validatepassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/user-validatepassword.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_validatepassword" } --> [!INCLUDE [permissions-table](../includes/permissions/user-validatepassword-permissions.md)] +>[!IMPORTANT] +>This API operation doesn't require the calling user to be assigned any Microsoft Entra admin roles. + ## HTTP request <!-- { |
v1.0 | Uxsetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/uxsetting-get.md | + + Title: "Get uxSetting" +description: "Get the properties and relationships of a uxSetting object." ++ms.localizationpriority: medium ++++# Get uxSetting ++Namespace: microsoft.graph +++Get the properties and relationships of a [uxSetting](../resources/uxsetting.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": "uxsetting-get-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /admin/entra/uxSetting +``` ++## 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 [uxSetting](../resources/uxsetting.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_uxsetting" +} +--> +``` http +GET https://graph.microsoft.com/beta/admin/entra/uxSetting +``` ++# [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.uxSetting" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/entra/uxSetting/$entity", + "restrictNonAdminAccess": "false", + "id": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee" +} +``` |
v1.0 | Uxsetting Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/uxsetting-update.md | + + Title: "Update uxSetting" +description: "Update the properties of a uxSetting object." ++ms.localizationpriority: medium ++++# Update uxSetting ++Namespace: microsoft.graph +++Update the properties of a [uxSetting](../resources/uxsetting.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": "uxsetting-update-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /admin/entra/uxSetting +``` ++## 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| +|:|:|:| +|restrictNonAdminAccess|nonAdminSetting|If set to `true`, nonadministrators can't browse the Microsoft Entra admin center. Nonadministrators who are owners of groups or applications are unable to use the Azure portal to manage their owned resources. If set to `false`, nonadministrators can browse the Microsoft Entra admin center. The possible values are: `false`, `true`, `unknownFutureValue`.| ++## Response ++If successful, this method returns a `204 No Content` response code. It doesn't return anything in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_uxsetting" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/admin/entra/uxSetting +Content-Type: application/json ++{ + "restrictNonAdminAccess": "true" +} +``` ++# [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 +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Virtualendpoint List Deviceimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-deviceimages.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 | Virtualendpoint List Galleryimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-galleryimages.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" }, { "id": "MicrosoftWindowsDesktop_windows-ent-cpc_20h1-ent-cpc-os", Content-Type: application/json "sizeInGB": 64, "startDate": "2020-05-27", "endDate": "2021-12-14",- "expirationDate": "2022-06-14" + "expirationDate": "2022-06-14", + "osVersionNumber": "10.0.18363.720" } ] } |
v1.0 | Virtualendpoint List Provisioningpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-provisioningpolicies.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", |
v1.0 | Virtualendpoint List Shareduseserviceplans | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-shareduseserviceplans.md | - Title: "List cloudPcSharedUseServicePlans (deprecated)" -description: "Get a list of the cloudPcSharedUseServicePlan objects and their properties." ---doc_type: apiPageType ---# List cloudPcSharedUseServicePlans (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). --Get a list of the [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.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": "virtualendpoint_list_shareduseserviceplans" } --> --## HTTP request --<!-- { - "blockType": "ignored" -} >--``` http -GET /deviceManagement/virtualEndpoint/sharedUseServicePlans -``` --## Optional query parameters --This method supports the `$select`, `$filter`, `$orderby`, and `$skip` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). --## Request headers --| Name | Description | -| : | : | -|Authorization|Bearer {token}. Required. 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 [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) objects in the response body. --## Examples --### Request --The following example shows a request. --<!-- { - "blockType": "request", - "name": "list_cloudpcshareduseserviceplans" -} >--``` http -GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/sharedUseServicePlans -``` --### 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", - "isCollection": true -} >--``` http -HTTP/1.1 200 OK -Content-Type: application/json --{ - "value": [ - { - "@odata.type": "#microsoft.graph.cloudPcSharedUseServicePlan", - "id": "1d164206-bf41-4fd2-8424-a3192d39ffff", - "displayName": "Display Name value", - "usedCount": 5, - "totalCount": 10 - } - ] -} -``` |
v1.0 | Virtualendpoint List Snapshots | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-list-snapshots.md | Title: "List snapshots" + Title: "List snapshots (deprecated)" description: "Get a list of cloudPcSnapshot objects and their properties."-+ ms.localizationpriority: medium doc_type: apiPageType -# List snapshots +# List snapshots (deprecated) Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +> [!CAUTION] +> This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the [retrieveSnapshots](./cloudpc-retrievesnapshots.md) API. + Get a list of [cloudPcSnapshot](../resources/cloudpcsnapshot.md) objects and their properties. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Virtualendpoint Post Deviceimages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-post-deviceimages.md | Content-Type: application/json "statusDetails": null, "errorCode": null, "osStatus": null,- "expirationDate": null + "expirationDate": null, + "osVersionNumber": null } ``` |
v1.0 | Virtualendpoint Post Provisioningpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-post-provisioningpolicies.md | Content-Type: application/json "autopatch": { "autopatchGroupId": null },+ "autopilotConfiguration": null, "enableSingleSignOn": true, "id": "1d164206-bf41-4fd2-8424-a3192d39ffff", "imageDisplayName": "Windows-10 19h1-evd", |
v1.0 | Virtualendpoint Retrievescopedpermissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-retrievescopedpermissions.md | Content-Type: application/json #### Request -When the signed-in user has the Microsoft Entra Global admin role, the Windows 365 admin role, or the Intune admin role assigned by Microsoft Entra ID, the returned permission is *\**, and no scope IDs are returned. In these cases, queries aren't supported. +When the signed-in user has an admin role such as the Intune admin or the Windows 365 admin role assigned by Microsoft Entra ID, the returned permission is *\**, and no scope IDs are returned. In these cases, queries aren't supported. # [HTTP](#tab/http) <!-- { |
v1.0 | Virtualendpoint Retrievetenantencryptionsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualendpoint-retrievetenantencryptionsetting.md | Retrieve the encryption setting of the tenant associated with the current authen 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|Least privileged permissions|Higher privileged permissions| -|:|:|:| -|Delegated (work or school account)|CloudPC.Read.All|CloudPC.ReadWrite.All| -|Delegated (personal Microsoft account)|Not supported.|Not supported.| -|Application|Not supported.|Not supported.| +<!-- { "blockType": "permissions", "name": "virtualendpoint_retrievetenantencryptionsetting" } --> ## HTTP request |
v1.0 | Virtualeventregistration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventregistration-get.md | Content-Type: application/json "firstName": "Emilee", "lastName": "Pham", "email": "EmileeMPham@contoso.com",+ "externalRegistrationInformation": { + "referrer": "Facebook", + "registrationId": "myExternalRegistrationId" + }, "status": "registered", "registrationDateTime": "2023-03-07T22:04:17", "cancelationDateTime": null, |
v1.0 | Virtualeventregistration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventregistration-list.md | Content-Type: application/json "firstName": "Emilee", "lastName": "Pham", "email": "EmileeMPham@contoso.com",+ "externalRegistrationInformation": { + "referrer": "Facebook", + "registrationId": "myExternalRegistrationId" + }, "status": "registered", "registrationDateTime": "2023-03-07T22:04:17", "cancelationDateTime": null, Content-Type: application/json "firstName": "Emilee", "lastName": "Pham", "email": "EmileeMPham@contoso.com",+ "externalRegistrationInformation": { + "referrer": "Facebook", + "registrationId": "myExternalRegistrationId" + }, "status": "registered", "registrationDateTime": "2023-03-07T22:04:17", "cancelationDateTime": null, Content-Type: application/json "firstName": "Emilee", "lastName": "Pham", "email": "EmileeMPham@contoso.com",+ "externalRegistrationInformation": { + "referrer": "Facebook", + "registrationId": "myExternalRegistrationId" + }, "status": "registered", "registrationDateTime": "2023-03-07T22:04:17", "cancelationDateTime": null, |
v1.0 | Virtualeventregistrationconfiguration List Questions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventregistrationconfiguration-list-questions.md | GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f4b39f1c-5 [!INCLUDE [sample-code](../includes/snippets/php/list-questions-virtualeventregistration-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/list-questions-virtualeventregistration-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Virtualeventregistrationconfiguration Post Questions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventregistrationconfiguration-post-questions.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/post-custom-question-virtualeventregistration-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/post-custom-question-virtualeventregistration-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] POST https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f4b39f1c- [!INCLUDE [sample-code](../includes/snippets/php/post-predefined-question-virtualeventregistration-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/post-predefined-question-virtualeventregistration-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Virtualeventregistrationquestionbase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventregistrationquestionbase-delete.md | DELETE https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f4b39f1 [!INCLUDE [sample-code](../includes/snippets/php/delete-virtualeventregistrationquestion-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/delete-virtualeventregistrationquestion-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Virtualeventsroot List Townhalls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventsroot-list-townhalls.md | + + Title: "List townhalls" +description: "Get the list of all virtualEventTownhall objects created in a tenant." ++ms.localizationpriority: medium ++++# List townhalls ++Namespace: microsoft.graph +++Get the list of all [virtualEventTownhall](../resources/virtualeventtownhall.md) objects created in 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": "virtualeventsroot_list_townhalls" } --> ++> [!NOTE] +> +> This API returns only **virtualEventTownhall** objects where the organizer is assigned an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy). ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> ++``` http +GET /solutions/virtualEvents/townhalls +``` ++## Optional query parameters ++This method supports the `$count` [OData query parameter](/graph/query-parameters) to help customize the response. If you use `?$count=true` in the request URL, the response contains a root-level property that denotes the total number of the resource; for example, `"@odata.count": 6`. ++## 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 [virtualEventTownhall](../resources/virtualeventtownhall.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++``` http +GET https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls +``` ++### 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.virtualEventTownhall)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.virtualEventTownhall", + "id": "fc6e8c15-2fd7-1dd5-caa0-87056e6a12be", + "status": "published", + "displayName": "The Impact of Tech on Our Lives", + "description": { + "content": "<p>Discusses how technology has changed the way we communicate, work, and interact with each other.</p>", + "contentType": "html" + }, + "startDateTime": { + "dateTime": "2023-11-30T16:30:00", + "timeZone": "Eastern Standard Time" + }, + "endDateTime": { + "dateTime": "2023-11-30T17:00:00", + "timeZone": "Eastern Standard Time" + }, + "createdBy": { + "@odata.type": "microsoft.graph.communicationsIdentitySet", + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.communicationsUserIdentity", + "id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68", + "displayName": "Diane Demoss", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + }, + "audience": "everyone", + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kenneth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ], + "invitedAttendees": [ + { + "@odata.type": "microsoft.graph.communicationsUserIdentity", + "id": "127962bb-84e1-7b62-fd98-1c9d39def7b6", + "displayName": "Emilee Pham", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + }, + "isInviteOnly": false + } + ] +} +``` |
v1.0 | Virtualeventsroot List Webinars | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventsroot-list-webinars.md | Title: "List webinars" -description: "Get the list of all virtual event webinars created in a tenant." +description: "Get the list of all virtualEventWebinar objects created in a tenant." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in the tenant. +Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in a tenant. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] GET /solutions/virtualEvents/webinars ## Optional query parameters -This method supports the `$count` [OData query parameter](/graph/query-parameters) to help customize the response. If you use `?$count=true` in the request URL, the response contains a root-level property that denotes the total number of the resource; for example: `"@odata.count": 6`. +This method supports the `$count` [OData query parameter](/graph/query-parameters) to help customize the response. If you use `?$count=true` in the request URL, the response contains a root-level property that denotes the total number of the resource; for example, `"@odata.count": 6`. ## Request headers |
v1.0 | Virtualeventtownhall Getbyuseridandrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventtownhall-getbyuseridandrole.md | + + Title: "virtualEventTownhall: getByUserIdAndRole" +description: "Get a list of virtualEventTownhall objects where the specified user is either the organizer or a coorganizer." ++ms.localizationpriority: medium ++++# virtualEventTownhall: getByUserIdAndRole ++Namespace: microsoft.graph +++Get a list of [virtualEventTownhall](../resources/virtualeventtownhall.md) objects where the specified user is either the organizer or a coorganizer. ++## 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": "virtualeventtownhall_getbyuseridandrole" } --> ++> [!IMPORTANT] +> +> To use application permission for this API, tenant administrators must create an [application access policy](/graph/cloud-communication-online-meeting-application-access-policy) and grant it to the specified user to authorize the app to get **virtualEventTownhall** objects on behalf of that user. ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/virtualEvents/townhalls/getByUserIdAndRole(userId='{userId}', role='{role}') +``` ++## Function parameters ++In the request URL, provide the following query parameters with values. ++|Parameter|Type|Description| +|:|:|:| +|role|String|User role of the specified user in the **virtualEventTownhall**. Possible values are: `organizer`, `coOrganizer`.| +|userId|String|The ID of the specified user in Microsoft Entra.| ++## 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 collection of [virtualEventTownhall](../resources/virtualeventtownhall.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "virtualeventtownhallthis.getbyuseridandrole" +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/getByUserIdAndRole(userId='b7ef013a-c73c-4ec7-8ccb-e56290f45f68', role='organizer') +``` ++# [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.virtualEventTownhall)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.virtualEventTownhall", + "id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33", + "status": "published", + "displayName": "The Impact of Tech on Our Lives", + "description":ΓÇ»{ + "contentType": "text", + "content": "Discusses how technology has changed the way we communicate, work, and interact with each other." + }, + "startDateTime": { + "dateTime": "2023-03-30T10:00:00", + "timeZone": "PacificSt" + }, + "endDateTime": { + "dateTime": "2023-03-30T17:00:00", + "timeZone": "PacificSt" + }, + "createdBy": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.communicationsUserIdentity", + "id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68", + "displayName": "Diane Demoss", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + }, + "audience": "everyone", + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kenneth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + } + } + ] +} +``` |
v1.0 | Virtualeventtownhall Getbyuserrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventtownhall-getbyuserrole.md | + + Title: "virtualEventTownhall: getByUserRole" +description: "Get a list of virtualEventTownhall objects where the signed-in user is either the organizer a coorganizer." ++ms.localizationpriority: medium ++++# virtualEventTownhall: getByUserRole ++Namespace: microsoft.graph +++Get a list of [virtualEventTownhall](../resources/virtualeventtownhall.md) objects where the signed-in user is either the organizer or a coorganizer. +++## 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": "virtualeventtownhall_getbyuserrole" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /solutions/virtualEvents/townhalls/getByUserRole(role='{role}') +``` ++## Function parameters ++In the request URL, provide the following query parameter with value. ++|Parameter|Type|Description| +|:|:|:| +|role|String|User role of the signed-in user in the **virtualEventTownhall**. Possible values are: `organizer`, `coOrganizer`.| ++## 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 collection of [virtualEventTownhall](../resources/virtualeventtownhall.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "virtualeventtownhallthis.getbyuserrole" +} +--> +``` http +GET https://graph.microsoft.com/beta/solutions/virtualEvents/townhalls/getByUserRole(role='organizer') +``` ++# [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.virtualEventTownhall)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.virtualEventTownhall", + "id": "88b245ac-b0b2-f1aa-e34a-c81c27abdac2@f9448ec4-804b-46af-b810-62085248da33", + "status": "published", + "displayName": "The Impact of Tech on Our Lives", + "description":ΓÇ»{ + "contentType": "text", + "content": "Discusses how technology has changed the way we communicate, work, and interact with each other." + }, + "startDateTime": { + "dateTime": "2023-03-30T10:00:00", + "timeZone": "PacificSt" + }, + "endDateTime": { + "dateTime": "2023-03-30T17:00:00", + "timeZone": "PacificSt" + }, + "createdBy": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.communicationsUserIdentity", + "id": "b7ef013a-c73c-4ec7-8ccb-e56290f45f68", + "displayName": "Diane Demoss", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + }, + "audience": "everyone", + "coOrganizers": [ + { + "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", + "displayName": "Kenneth Brown", + "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" + } + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + } + } + ] +} +``` |
v1.0 | Virtualeventwebinar Getbyuseridandrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-getbyuseridandrole.md | In the request URL, provide the following query parameters with values. |Parameter|Type|Description| |:|:|:|-|userId|String|The ID of the specified user in Microsoft Entra.| |role|String|User role of the specified user in the webinar. Possible values are: `organizer`, `coOrganizer`.|+|userId|String|The ID of the specified user in Microsoft Entra.| ## Request headers GET https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/getByUserI ### Response -The following example shows the response +The following example shows the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", |
v1.0 | Virtualeventwebinar Post Registrations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/virtualeventwebinar-post-registrations.md | You can specify the following properties when you create a **virtualEventRegistr |Property|Type|Description| |:|:|:|+|externalRegistrationInformation|[virtualEventExternalRegistrationInformation](../resources/virtualeventexternalregistrationinformation.md)| The external information for a virtual event registration. Optional. | |preferredTimezone|String|The registrant's time zone details. Required. | |preferredLanguage|String|The registrant's preferred language. Required. | |registrationQuestionAnswers|[virtualEventRegistrationQuestionAnswer](../resources/virtualeventregistrationquestionanswer.md) collection|The registrant's answer to the registration questions. Optional. | You can specify the following properties when you create a **virtualEventRegistr |firstName|String|The registrant's first name. Required. | |lastName|String|The registrant's last name. Required. | |email|String|The registrant's email address. Required. |+|externalRegistrationInformation|[virtualEventExternalRegistrationInformation](../resources/virtualeventexternalregistrationinformation.md)| The external information for a virtual event registration. Optional. | |preferredTimezone|String|The registrant's time zone details. Required. | |preferredLanguage|String|The registrant's preferred language. Required. | |registrationQuestionAnswers|[virtualEventRegistrationQuestionAnswer](../resources/virtualeventregistrationquestionanswer.md) collection|The registrant's answer to the registration questions. Optional. | ## Response -If successful, this action returns one of the following: -* A `201 Created` response code and [virtualEventRegistration](../resources/virtualeventregistration.md) object for delegated permissions. +If successful, this method returns one of the following results: +* A `201 Created` response code and a [virtualEventRegistration](../resources/virtualeventregistration.md) object for delegated permissions. * A `204 No Content` response code for application permissions. ## Examples Use delegated permission to create a registration record for a person who has a #### Request The following example shows a request.+ # [HTTP](#tab/http) <!-- { "blockType": "request", POST https://graph.microsoft.com/beta/solutions/virtualEvents/webinars/f4b39f1c- Content-Type: application/json {+ "externalRegistrationInformation": { + "referrer": "Facebook", + "registrationId": "myExternalRegistrationId" + }, "preferredTimezone":"Pacific Standard Time", "preferredLanguage":"en-us", "registrationQuestionAnswers": [ Content-Type: application/json "firstName": "Emilee", "lastName": "Pham", "email": "EmileeMPham@contoso.com",+ "externalRegistrationInformation": { + "referrer": "Facebook", + "registrationId": "myExternalRegistrationId" + }, "status": "registered", "registrationDateTime": "2023-03-07T22:04:17", "cancelationDateTime": null, Content-Type: application/json ### Example 2: Creating registration record with application permission -Use application permission to create a registration record for a person who does not have a [Microsoft Entra ID](/entra/fundamentals/whatis) as a way to register an anonymous user for a webinar. +Use application permission to create a registration record for a person who doesn't have a [Microsoft Entra ID](/entra/fundamentals/whatis) as a way to register an anonymous user for a webinar. #### Request The following example shows a request.+ # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json "firstName" : "Diane", "lastName" : "Demoss", "email" : "DianeDemoss@contoso.com",+ "externalRegistrationInformation": { + "referrer": "Facebook", + "registrationId": "myExternalRegistrationId" + }, "preferredTimezone":"Pacific Standard Time", "preferredLanguage":"en-us", "registrationQuestionAnswers": [ |
v1.0 | Windowsupdates Azureaddevice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-azureaddevice-delete.md | Title: "Delete azureADDevice" description: "Delete an azureADDevice object." ms.localizationpriority: medium-+ doc_type: apiPageType Namespace: microsoft.graph.windowsUpdates Delete an [azureADDevice](../resources/windowsupdates-azureaddevice.md) object. -When a Microsoft Entra device is deleted, it is unregistered from the deployment service and automatically unenrolled from management by the service for all update categories, as well as removed from every [deploymentAudience](../resources/windowsupdates-deploymentaudience.md) and [updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md). +When a Microsoft Entra device is deleted, it is unregistered and automatically unenrolled from management for all update categories, as well as removed from every [deploymentAudience](../resources/windowsupdates-deploymentaudience.md) and [updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Windowsupdates Azureaddevice Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-azureaddevice-get.md | description: "Read the properties of an azureADDevice object." ms.localizationpriority: medium -+ doc_type: apiPageType |
v1.0 | Windowsupdates Catalog List Entries | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-catalog-list-entries.md | Title: "List entries" description: "Get a list of catalogEntry resources from the catalog." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Compliancechange Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-compliancechange-delete.md | Title: "Delete complianceChange" description: "Delete a complianceChange object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Compliancechange Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-compliancechange-get.md | Title: "Get complianceChange" description: "Read the properties and relationships of a complianceChange object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Compliancechange Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-compliancechange-update.md | Title: "Update complianceChange" description: "Update the properties of a complianceChange object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Contentapproval Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-contentapproval-delete.md | Title: "Delete contentApproval" description: "Delete a contentApproval object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Contentapproval Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-contentapproval-get.md | Title: "Get contentApproval" description: "Read the properties and relationships of a contentApproval object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Contentapproval Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-contentapproval-update.md | Title: "Update contentApproval" description: "Update the properties of a contentApproval object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Deployment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deployment-delete.md | Title: "Delete deployment" description: "Delete a deployment object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Deployment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deployment-get.md | Title: "Get deployment" description: "Read the properties and relationships of a deployment object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Deployment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deployment-update.md | Title: "Update deployment" description: "Update the properties of a deployment object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Deploymentaudience Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deploymentaudience-delete.md | Title: "Delete deploymentAudience" description: "Delete a deploymentAudience object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Deploymentaudience Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deploymentaudience-get.md | Title: "Get deploymentAudience" description: "Read the properties and relationships of a deploymentAudience object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Deploymentaudience List Exclusions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deploymentaudience-list-exclusions.md | Title: "List deployment audience exclusions" description: "List the updatableAsset resources that are excluded from a deploymentAudience." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us ``` http GET /admin//windows/updates/deploymentAudiences/{deploymentAudienceId}/exclusions ```-**Note:** Only $skiptoken is supported for paging, client-driven paging is not impelemented. +**Note:** Only `$skipToken` is supported for paging. Client-driven paging isn't implemented. ## Request headers |Name|Description| |
v1.0 | Windowsupdates Deploymentaudience List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deploymentaudience-list-members.md | Title: "List deployment audience members" description: "List the updatableAsset resources that are members of a deploymentAudience." ms.localizationpriority: medium-+ doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us ``` http GET /admin//windows/updates/deploymentAudiences/{deploymentAudienceId}/members ```-**Note:** Only $skiptoken is supported for paging, client-driven paging is not impelemented. +**Note:** Only `$skipToken` is supported for paging. Client-driven paging isn't implemented. ## Request headers |
v1.0 | Windowsupdates Deploymentaudience Updateaudience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deploymentaudience-updateaudience.md | Title: "deploymentAudience: updateAudience" description: "Update the members and exclusions collections of a deploymentAudience." ms.localizationpriority: medium-+ doc_type: apiPageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Update the members and exclusions collections of a [deploymentAudience](../resources/windowsupdates-deploymentaudience.md). +Update the **members** and **exclusions** relationships of a [deploymentAudience](../resources/windowsupdates-deploymentaudience.md). -Adding an [azureADDevice](../resources/windowsupdates-azureaddevice.md) to the members or exclusions collections of a deployment audience automatically creates a Microsoft Entra device object, if it does not already exist. +Adding an [azureADDevice](../resources/windowsupdates-azureaddevice.md) to the **members** or **exclusions** collections of a deployment audience automatically creates a Microsoft Entra device object, if it doesn't already exist. -If the same [updatableAsset](../resources/windowsupdates-updatableasset.md) gets included in the **exclusions** and **members** collections of a **deploymentAudience**, deployment will not apply to that asset. +If the same [updatableAsset](../resources/windowsupdates-updatableasset.md) gets included in the **exclusions** and **members** collections of a **deploymentAudience**, the deployment doesn't apply to that asset. If all **updatableAsset** objects are the same type, you can also use the method [updateAudienceById](windowsupdates-deploymentaudience-updateaudiencebyid.md) to update the **deploymentAudience**. |
v1.0 | Windowsupdates Deploymentaudience Updateaudiencebyid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-deploymentaudience-updateaudiencebyid.md | Title: "deploymentAudience: updateAudienceById" description: "Update the members and exclusions collections of a deploymentAudience with updatableAsset resources of the same type." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Operationalinsightsconnection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-operationalinsightsconnection-delete.md | Title: "Delete operationalInsightsConnection" description: "Delete an operationalInsightsConnection object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Operationalinsightsconnection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-operationalinsightsconnection-get.md | Title: "Get operationalInsightsConnection" description: "Read the properties and relationships of an operationalInsightsConnection object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Product Findbykbnumber | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-product-findbykbnumber.md | Title: "product: findByKbNumber" description: "Find the product revisions associated with a knowledge base number and the known issues directly or indirectly related to the knowledge base number." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Product Getknownissuesbytimerange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-product-getknownissuesbytimerange.md | Title: "product: getKnownIssuesByTimeRange" description: "Get known issues related to a particular product based on a specified timeframe in the past." ms.localizationpriority: medium-+ doc_type: apiPageType The following table shows the parameters that must be used with this function. |Parameter|Type|Description| |:|:|:| |daysInPast|Int32|The number of days to look up in the past. This filter is applied on all known issues that are in final status and have a resolved date time.|-|includeAllActive|Boolean|If set to `true`, the response includes all active known issues. If set to `false`, the response doesn't include any active known issues.| +|includeAllActive|Boolean|If set to `true`, the response includes all active known issues. If set to `false`, the response doesn't include any active known issues.| ## Request headers |
v1.0 | Windowsupdates Resourceconnection Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-resourceconnection-delete.md | Title: "Delete resourceConnection" description: "Delete a resourceConnection object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Resourceconnection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-resourceconnection-get.md | Title: "Get resourceConnection" description: "Read the properties and relationships of a resourceConnection object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableasset Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableasset-delete.md | Title: "Delete updatableAsset" description: "Delete an updatableAsset object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableasset Enrollassets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableasset-enrollassets.md | Title: "updatableAsset: enrollAssets" -description: "Enroll updatableAsset resources in update management by the deployment service." +description: "Enroll updatableAsset resources in update management by Windows Autopatch." ms.localizationpriority: medium-+ doc_type: apiPageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Enroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources in update management by the deployment service. +Enroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources in update management by Windows Autopatch. You can enroll an [azureADDevice](../resources/windowsupdates-azureaddevice.md) resource in update management, but may not enroll an [updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md) in update management. The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:|-|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for the service to manage. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| -|assets|[microsoft.graph.windowsUpdates.updatableAsset](../resources/windowsupdates-updatableasset.md) collection|List of **updatableAsset** resources to enroll in update management by the service for the given **updateCategory**.| +|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for Windows Autopatch to manage. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| +|assets|[microsoft.graph.windowsUpdates.updatableAsset](../resources/windowsupdates-updatableasset.md) collection|List of **updatableAsset** resources to enroll in update management for the given **updateCategory**.| ## Response |
v1.0 | Windowsupdates Updatableasset Enrollassetsbyid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableasset-enrollassetsbyid.md | Title: "updatableAsset: enrollAssetsById" -description: "Enroll updatableAsset resources of the same type in update management by the deployment service." +description: "Enroll updatableAsset resources of the same type in update management by Windows Autopatch." ms.localizationpriority: medium-+ doc_type: apiPageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Enroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources of the same type in update management by the deployment service. +Enroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources of the same type in update management by Windows Autopatch. You can also use the method [enrollAssets](windowsupdates-updatableasset-enrollassets.md) to enroll assets. The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:|-|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for the service to manage. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| +|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for Windows Autopatch to manage. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| |memberEntityType|String|The full type of the **updatableAsset** resources. Possible values are: `#microsoft.graph.windowsUpdates.azureADDevice`.|-|ids|String collection|List of identifiers corresponding to the **updatableAsset** resources to enroll in update management by the service for the given **updateCategory**.| +|ids|String collection|List of identifiers that correspond to the **updatableAsset** resources to enroll in update management for the given **updateCategory**.| ## Response |
v1.0 | Windowsupdates Updatableasset Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableasset-get.md | Title: "Get updatableAsset" description: "Read the properties and relationships of an updatableAsset object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableasset Unenrollassets | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableasset-unenrollassets.md | Title: "updatableAsset: unenrollAssets" -description: "Unenroll updatableAsset resources from update management by the deployment service." +description: "Unenroll updatableAsset resources from update management by Windows Autopatch." ms.localizationpriority: medium-+ doc_type: apiPageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Unenroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources from update management by the deployment service. +Unenroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources from update management by Windows Autopatch. You can also use the method [unenrollAssetsById](windowsupdates-updatableasset-unenrollassetsbyid.md) to unenroll assets. The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:|-|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for the service to stop managing. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| -|assets|[microsoft.graph.windowsUpdates.updatableAsset](../resources/windowsupdates-updatableasset.md) collection|List of **updatableAsset** resources to unenroll from update management by the service for the given **updateCategory**.| +|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for Windows Autopatch to stop managing. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| +|assets|[microsoft.graph.windowsUpdates.updatableAsset](../resources/windowsupdates-updatableasset.md) collection|List of **updatableAsset** resources to unenroll from update management for the given **updateCategory**.| ## Response |
v1.0 | Windowsupdates Updatableasset Unenrollassetsbyid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableasset-unenrollassetsbyid.md | Title: "updatableAsset: unenrollAssetsById" -description: "Unenroll updatableAsset resources of the same type from update management by the deployment service." +description: "Unenroll updatableAsset resources of the same type from update management by Windows Autopatch." ms.localizationpriority: medium-+ doc_type: apiPageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Unenroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources of the same type from update management by the deployment service. +Unenroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources of the same type from update management by Windows Autopatch. You can also use the method [unenrollAssets](windowsupdates-updatableasset-unenrollassets.md) to unenroll assets. The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:|-|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for the service to stop managing. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| +|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates for Windows Autopatch to stop managing. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| |memberEntityType|String|The full type of the **updatableAsset** resources. Possible values are: `#microsoft.graph.windowsUpdates.azureADDevice`.|-|ids|String collection|List of identifiers corresponding to the **updatableAsset** resources to unenroll from update management by the service for the given **updateCategory**.| +|ids|String collection|List of identifiers that correspond to the **updatableAsset** resources to unenroll from update management for the given **updateCategory**.| ## Response |
v1.0 | Windowsupdates Updatableassetgroup Addmembersbyid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableassetgroup-addmembersbyid.md | Title: "updatableAssetGroup: addMembersById" description: "Add members of the same type to an updatableAssetGroup." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableassetgroup Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableassetgroup-delete.md | Title: "Delete updatableAssetGroup" description: "Delete an updatableAssetGroup object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableassetgroup Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableassetgroup-get.md | Title: "Get updatableAssetGroup" description: "Read the properties and relationships of an updatableAssetGroup object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableassetgroup List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableassetgroup-list-members.md | Title: "List updatable asset group members" description: "List the members of an updatableAssetGroup resource. Members are of the azureADDevice type." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableassetgroup Removemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableassetgroup-removemembers.md | Title: "updatableAssetGroup: removeMembers" description: "Remove members from an updatableAssetGroup." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatableassetgroup Removemembersbyid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatableassetgroup-removemembersbyid.md | Title: "updatableAssetGroup: removeMembersById" description: "Remove members of the same type from an updatableAssetGroup." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatepolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatepolicy-delete.md | Title: "Delete updatePolicy" description: "Delete an updatePolicy object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatepolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatepolicy-get.md | Title: "Get updatePolicy" description: "Read the properties and relationships of an updatePolicy object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatepolicy List Compliancechanges Contentapproval | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatepolicy-list-compliancechanges-contentapproval.md | Title: "List contentApprovals" description: "Get a list of the contentApproval objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatepolicy List Compliancechanges | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatepolicy-list-compliancechanges.md | Title: "List complianceChanges" description: "Get a list of the complianceChange objects and their properties." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatepolicy Post Compliancechanges Contentapproval | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatepolicy-post-compliancechanges-contentapproval.md | Title: "Create contentApproval" description: "Create a new contentApproval object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Windowsupdates Updatepolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/windowsupdates-updatepolicy-update.md | Title: "Update updatePolicy" description: "Update the properties of an updatePolicy object." ms.localizationpriority: medium-+ doc_type: apiPageType |
v1.0 | Workbookformatprotection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookformatprotection-get.md | Retrieve the properties and relationships of formatprotection 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": "formatprotection_get" } --> +<!-- { "blockType": "permissions", "name": "workbookformatprotection_get" } --> ## HTTP request <!-- { "blockType": "ignored" } --> If successful, this method returns a `200 OK` response code and a [formatProtect ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_formatprotection" The following example shows a request. GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/protection ``` +# [JavaScript](#tab/javascript) +++ ### Response The following example shows the response. |
v1.0 | Workbookformatprotection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookformatprotection-update.md | Update the properties of formatprotection 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": "formatprotection_update" } --> +<!-- { "blockType": "permissions", "name": "workbookformatprotection_update" } --> ## HTTP request <!-- { "blockType": "ignored" } --> If successful, this method returns a `200 OK` response code and updated [FormatP ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_formatprotection" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ### Response The following example shows the response. |
v1.0 | Workbookrange Columnsafter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookrange-columnsafter.md | Namespace: microsoft.graph Gets a specified number of columns to the right of the given range. + ## 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). Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "workbookrange_columnsafter" The following example shows a request. GET https://graph.microsoft.com/beta/drive/root/workbook/worksheets/{id}/range/columnsAfter(count=2) ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrange Columnsbefore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookrange-columnsbefore.md | Namespace: microsoft.graph Gets a specific number of columns to the left of the given range. + ## 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). Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "workbookrange_columnsbefore" The following example shows a request. GET https://graph.microsoft.com/beta/drive/root/workbook/worksheets/{id}/range/columnsBefore(count=2) ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrange Rowsabove | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookrange-rowsabove.md | Namespace: microsoft.graph Gets a specified in number of rows above a given range. + ## 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). Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "workbookrange_rowsAbove" The following example shows a request. GET https://graph.microsoft.com/beta/drive/root/workbook/worksheets/{id}/range/rowsAbove(count=2) ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrange Rowsbelow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookrange-rowsbelow.md | Namespace: microsoft.graph Gets certain number of rows below a given range. + ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "workbookrange_rowsBelow" The following example shows a request. GET https://graph.microsoft.com/beta/drive/root/workbook/worksheets/{id}/range/rowsBelow(count=2) ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrange Visibleview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookrange-visibleview.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "workbookrange_visibleview" The following example shows a request. GET https://graph.microsoft.com/beta/drive/root/workbook/worksheets/{id}/range(address='A1:Z10')/visibleView ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrangeview List Rows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookrangeview-list-rows.md | If successful, this method returns a `200 OK` response code and collection of [w ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rows" The following example shows a request. GET https://graph.microsoft.com/beta/drive/root/workbook/worksheets/{id}/range(address='A1:Z10')/visibleView/rows ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. |
v1.0 | Workbookrangeview Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workbookrangeview-range.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "workbookrangeview_range" The following example shows a request. GET https://graph.microsoft.com/beta/drive/root/workbook/worksheets/{id}/range(address='A1:Z10')/visibleView/range ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workingtimeschedule Endworkingtime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workingtimeschedule-endworkingtime.md | + + Title: "workingTimeSchedule: endWorkingTime" +description: "Trigger the policies associated with the end of working hours for a specific user." ++ms.localizationpriority: medium ++++# workingTimeSchedule: endWorkingTime ++Namespace: microsoft.graph +++Trigger the policies associated with the end of working hours for a specific user. +++## 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": "workingtimeschedule_endworkingtime" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{userId}/solutions/workingTimeSchedule/endWorkingTime +``` ++## Path parameters ++|Parameter|Type|Description| +|:|:|:| +|userId|String|ID of the user whose working time ended.| ++## 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 `202 Accepted` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "workingtimeschedulethis.endworkingtime" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/ccdf8279-8a3f-4c10-af1a-4a7f46b1489f/solutions/workingTimeSchedule/endWorkingTime +``` ++# [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 202 Accepted +``` |
v1.0 | Workingtimeschedule Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workingtimeschedule-get.md | + + Title: "Get workingTimeSchedule" +description: "Read the properties and relationships of a workingTimeSchedule object." ++ms.localizationpriority: medium ++++# Get workingTimeSchedule ++Namespace: microsoft.graph +++Read the properties and relationships of a [workingTimeSchedule](../resources/workingtimeschedule.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": "workingtimeschedule-get-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /users/{usersId}/solutions/schedule +``` ++## Optional query parameters ++This method doesn't support [OData query parameters](/graph/query-parameters) to 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 [workingTimeSchedule](../resources/workingtimeschedule.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "get_workingtimeschedule" +} +--> +``` http +GET https://graph.microsoft.com/beta/users/ccdf8279-8a3f-4c10-af1a-4a7f46b1489f/solutions/schedule +``` +++### 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.workingTimeSchedule" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.teams.workingTime.workingTimeSchedule", + "id": "da5f72af-450e-56fc-10d7-afc9acb40cc0" + } +} +``` + |
v1.0 | Workingtimeschedule Startworkingtime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workingtimeschedule-startworkingtime.md | + + Title: "workingTimeSchedule: startWorkingTime" +description: "Trigger the policies associated with the start of working hours for a specific user." ++ms.localizationpriority: medium ++++# workingTimeSchedule: startWorkingTime ++Namespace: microsoft.graph +++Trigger the policies associated with the start of working hours for a specific user. +++## 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": "workingtimeschedule_startworkingtime" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{userId}/solutions/workingTimeSchedule/startWorkingTime +``` ++## Path parameters ++|Parameter|Type|Description| +|:|:|:| +|userId|String|ID of the user whose working hours started.| ++## 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 `202 Accepted` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "workingtimeschedulethis.startworkingtime" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/ccdf8279-8a3f-4c10-af1a-4a7f46b1489f/solutions/workingTimeSchedule/startWorkingTime +``` ++# [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 202 Accepted +``` |
v1.0 | Workplace Post Sensordevices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplace-post-sensordevices.md | Create a new workplace sensor device. ## 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). +> [!NOTE] +> For an app with delegated permissions to write workplace devices, the signed-in user must be a member of the **TenantPlacesManagement** Exchange Online administrator role. + <!-- { "blockType": "permissions", "name": "workplace_post_sensordevices" } --> [!INCLUDE [permissions-table](../includes/permissions/workplace-post-sensordevices-permissions.md)] -For an app with delegated permissions to write workplace devices, the signed-in user must be a member of one of the following Microsoft Entra administrator roles: either Global Administrator or one of the Exchange Online management roles, specifically TenantPlacesManagement. - ## HTTP request <!-- { |
v1.0 | Workplacesensordevice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplacesensordevice-delete.md | Delete a workplace sensor device. ## 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). +> [!NOTE] +> For an app with delegated permissions to write workplace devices, the signed-in user must be a member of the **TenantPlacesManagement** Exchange Online administrator role. + <!-- { "blockType": "permissions", "name": "workplacesensordevice_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/workplacesensordevice-delete-permissions.md)] -For an app with delegated permissions to write workplace devices, the signed-in user must be a member of one of the following Microsoft Entra administrator roles: either Global Administrator or one of the Exchange Online management roles, specifically TenantPlacesManagement. - ## HTTP request <!-- { |
v1.0 | Workplacesensordevice Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/api/workplacesensordevice-update.md | Update the properties of a workplace sensor device. ## 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). +> [!NOTE] +> For an app with delegated permissions to write workplace devices, the signed-in user must be a member of the **TenantPlacesManagement** Exchange Online administrator role. + <!-- { "blockType": "permissions", "name": "workplacesensordevice_update" } --> [!INCLUDE [permissions-table](../includes/permissions/workplacesensordevice-update-permissions.md)] -For an app with delegated permissions to write workplace devices, the signed-in user must be a member of one of the following Microsoft Entra administrator roles: either Global Administrator or one of the Exchange Online management roles, specifically TenantPlacesManagement. ## HTTP request |
v1.0 | Aaduserconversationmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/aaduserconversationmember.md | Title: "aadUserConversationMember resource type" -description: "Represents a Microsoft Entra user in a chat or channel." +description: "Represents a Microsoft Entra user in a team, a channel, or a chat. " ms.localizationpriority: high Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a Microsoft Entra user in a [team](team.md) or a [channel](channel.md) or a [chat](chat.md). This type inherits from [conversationMember](conversationmember.md). +Represents a Microsoft Entra user in a [team](team.md), a [channel](channel.md), or a [chat](chat.md). ++Inherits from [conversationMember](conversationmember.md). ## Methods Represents a Microsoft Entra user in a [team](team.md) or a [channel](channel.md |[Get team member](../api/team-get-members.md) | [conversationMember](conversationmember.md) collection | Get a member in the team.| |[Update team member's role](../api/team-update-members.md)|[conversationMember](../resources/conversationmember.md)|Change a member to an owner or back to a regular member.| |[Remove team member](../api/team-delete-members.md)|None|Remove an existing member from the team.|+|[Remove team members in bulk](../api/conversationmember-remove.md)|[actionResultPart](../resources/actionresultpart.md) collection|Remove multiple members from a team in a single request.| |[List channel members](../api/channel-list-members.md) | [conversationMember](conversationmember.md) collection | Get the list of all members in a channel.| |[Add channel member](../api/channel-post-members.md) | [conversationMember](conversationmember.md) | Add a member to a channel. Only supported for `channel` with membershipType of `private`.| |[Get channel member](../api/channel-get-members.md) | [conversationMember](conversationmember.md) collection | Get a member in a channel.| Represents a Microsoft Entra user in a [team](team.md) or a [channel](channel.md | Property | Type |Description| |:|:--|:-|-|id| String | Read-only. Unique ID of the user.| |displayName| String | The display name of the user. |-|roles| String collection | The roles of the user such as owner, member, or guest. | -|userId| String | The GUID of the user. | |email| String | The email address of the user. |+|id| String | Read-only. Unique ID of the user.| +|roles| String collection | The roles of the user such as owner, member, or guest. | |tenantId| string | TenantId which the Microsoft Entra user belongs to. |-|visibleHistoryStartDateTime| DateTimeOffset | The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat.| +|userId| String | The GUID of the user. | +|visibleHistoryStartDateTime| DateTimeOffset | The timestamp that denotes how far back the history of a conversation is shared with the conversation member. This property is settable only for members of a chat.| ## JSON representation The following JSON representation shows the resource type. --> ``` json {- "@odata.type": "#microsoft.graph.aadUserConversationMember", - "id": "String (identifier)", - "roles": [ - "String" - ], + "@odata.type": "#microsoft.graph.aadUserConversationMember", "displayName": "String",- "visibleHistoryStartDateTime": "String (timestamp)", - "userId": "String", "email": "String",- "tenantId": "String" + "id": "String (identifier)", + "roles": ["String"], + "tenantId": "String", + "userId": "String", + "visibleHistoryStartDateTime": "String (timestamp)" } ``` |
v1.0 | Aaduserconversationmemberresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/aaduserconversationmemberresult.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the individual response for each member specified in a bulk operation comprising of [aadUserConversationMember(s)](aadUserConversationMember.md) in the request. -This resource is the derivative of the [actionResultPart](actionresultpart.md) resource. +Represents the individual response for each member specified in a bulk operation that includes [aadUserConversationMember](aaduserconversationmember.md) objects in the request. ++Inherits from [actionResultPart](actionresultpart.md). ## Properties | Property | Type | Description | |:|:--|:-|-|userId|`String`|The user object ID of the Microsoft Entra user that was being added as part of the bulk operation.| |error|[publicError](publicerror.md) |The error that occurred, if any, during the course of the bulk operation.|+|userId|String|The user object ID of the Microsoft Entra user that was being added as part of the bulk operation.| ## JSON representation The following JSON representation shows the resource type. ```json {- "userId": "string", - "error": "microsoft.graph.publicError" + "error": "microsoft.graph.publicError", + "userId": "String" } ``` ## Related content -- [Add members in bulk to team](../api/conversationmembers-add.md)+- [Add members in bulk to a team](../api/conversationmembers-add.md) +- [Remove members in bulk from a team](../api/conversationmember-remove.md) <!-- uuid: 20fd7863-9545-40d4-ae8f-fee2d115a690 2015-10-25 14:57:30 UTC --> <!-- { "type": "#page.annotation",- "description": "actionResultPart", + "description": "aadUserConversationMemberResult", "keywords": "", "section": "documentation", "tocPath": "", |
v1.0 | Accesspackageassignmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accesspackageassignmentrequest.md | In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md), | [Create](../api/entitlementmanagement-post-assignmentrequests.md) | [accessPackageAssignmentRequest](accesspackageassignmentrequest.md) | Create a new **accessPackageAssignmentRequest**. | | [Get](../api/accesspackageassignmentrequest-get.md) | [accessPackageAssignmentRequest](accesspackageassignmentrequest.md) | Read properties and relationships of an **accessPackageAssignmentRequest** object. | | [Delete](../api/accesspackageassignmentrequest-delete.md) |None | Delete an **accessPackageAssignmentRequest**. |-|[Filter by current user](../api/accesspackageassignmentrequest-filterbycurrentuser.md)|[accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) collection|Retrieve the list of **accessPackageAssignmentRequest** objects filtered on the signed-in user.| |[Cancel](../api/accesspackageassignmentrequest-cancel.md)|[accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) collection|Cancel an **accessPackageAssignmentRequest** object that is in a cancelable state.|+|[Filter by current user](../api/accesspackageassignmentrequest-filterbycurrentuser.md)|[accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) collection|Retrieve the list of **accessPackageAssignmentRequest** objects filtered on the signed-in user.| | [Reprocess](../api/accesspackageassignmentrequest-reprocess.md) | None | Automatically retry a user's request for access to an access package.|+| [Resume](../api/accesspackageassignmentrequest-resume.md) | None | Resume a user's access package request after waiting for a callback from a custom extension.| | [List (deprecated)](../api/entitlementmanagement-list-accesspackageassignmentrequests.md) | [accessPackageAssignmentRequest](accesspackageassignmentrequest.md) collection | Retrieve a list of **accesspackageassignmentrequest** objects. **This API will be retired soon. Use the [List assignmentRequests](../api/entitlementmanagement-list-assignmentrequests.md) API instead.** | | [Create (deprecated)](../api/entitlementmanagement-post-accesspackageassignmentrequests.md) | [accessPackageAssignmentRequest](accesspackageassignmentrequest.md) | Create a new **accessPackageAssignmentRequest**. **This API will be retired soon. Use the [Create accessPackageAssignmentRequest](../api/entitlementmanagement-post-assignmentrequests.md) API instead.** | |
v1.0 | Accessreviews Root | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/accessreviews-root.md | Typical customer scenarios for access reviews of group memberships and applicati - Customers can collect access review controls into programs that are relevant for your organization to track reviews for compliance or risk-sensitive applications. -There's also a related capability for customers to review and certify the role assignments of administrative users who are assigned to Microsoft Entra roles such as Global Administrator or Azure subscription roles. This capability is included in [Microsoft Entra Privileged Identity Management](privilegedidentitymanagement-root.md). +There's also a related capability for customers to review and certify the role assignments of administrative users who are assigned to [Microsoft Entra roles](/entr). The tenant where an access review is being created or managed via the API must have sufficient purchased or trial licenses. For more information about the license requirements, see [Access reviews license requirements](/azure/active-directory/governance/access-reviews-overview#license-requirements). |
v1.0 | Actionresultpart | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/actionresultpart.md | Title: "actionResultPart resource type" -description: "Abstract type to model responses of bulk operations." +description: "An abstract type that serves as a base to model responses of bulk operations." ms.localizationpriority: medium The following JSON representation shows the resource type. ``` ## Related content -- [aadUserConversationMemberResult](aadUserConversationMemberResult.md)+- [aadUserConversationMemberResult](aaduserconversationmemberresult.md) - [Add members in bulk to a team](../api/conversationmembers-add.md)+- [Remove members in bulk from a team](../api/conversationmember-remove.md) <!-- uuid: 20fd7863-9545-40d4-ae8f-fee2d115a690 2015-10-25 14:57:30 UTC --> |
v1.0 | Admin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/admin.md | Title: "admin resource type" description: "Represents an entity that acts as a container for administrator functionality." ms.localizationpriority: medium-+ doc_type: resourcePageType Represents an entity that acts as a container for administrator functionality. |Relationship|Type|Description| |:|:|:| | edge | [edge](edge.md) | A container for Microsoft Edge resources. Read-only. |+| entra | [entra](entra.md) | A container for Microsoft Entra resources. Read-only. | | microsoft365Apps |[adminMicrosoft365Apps](../resources/adminmicrosoft365apps.md)|A container for the Microsoft 365 apps admin functionality.| | people | [peopleAdminSettings](../resources/peopleadminsettings.md) | Represents a setting to control people-related admin settings in the tenant. | | reportSettings |[microsoft.graph.adminReportSettings](../resources/adminreportsettings.md)|A container for administrative resources to manage reports.| |
v1.0 | Administrativeunit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/administrativeunit.md | This resource supports: |displayName|String|Display name for the administrative unit. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`.| |id|String|Unique identifier for the administrative unit. Read-only. Supports `$filter` (`eq`).| |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. <br/><br/> For more information about working with restricted management administrative units, see [Restricted management administrative units in Microsoft Entra ID](/azure/active-directory/roles/admin-units-restricted-management).|-| 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. If not set, the default behavior is `Paused`. | -| membershipType | String | Membership type for the administrative unit. Can be `dynamic` or `assigned`. If not set, the default behavior is `assigned`. | -| visibility | String | Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership` or `Public`. If not set, the default behavior is `Public`. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit. | +| 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 | Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership` or `Public`. If not set, the default value is `null` and the default behavior is public. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit. | > [!TIP] > Directory extensions and associated data are returned by default while schema extensions and associated data returned only on `$select`. The following JSON representation shows the resource type. "description": "String", "displayName": "String", "id": "String (identifier)",- "visibility": "String", - "membershipType": "String", + "isMemberManagementRestricted": "Boolean", "membershipRule": "String",- "membershipRuleProcessingState": "String" + "membershipRuleProcessingState": "String", + "membershipType": "String", + "visibility": "String" }- ``` |
v1.0 | Adminreportsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/adminreportsettings.md | Represents the tenant-level settings for Microsoft 365 reports. |Method|Return type|Description| |:|:|:|-|[Get](../api/adminreportsettings-get.md)|[adminReportSettings](../resources/adminreportsettings.md)|Get the tenant-level settings for Microsoft 365 Reports.| -|[Update](../api/adminreportsettings-update.md)|[adminReportSettings](../resources/adminreportsettings.md)|Update tenant-level settings for Microsoft 365 Reports.| +|[Get](../api/adminreportsettings-get.md)|[adminReportSettings](../resources/adminreportsettings.md)|Get the tenant-level settings for Microsoft 365 reports.| +|[Update](../api/adminreportsettings-update.md)|[adminReportSettings](../resources/adminreportsettings.md)|Update tenant-level settings for Microsoft 365 reports.| ## Properties | 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. | ## JSON representation |
v1.0 | Adminwindows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/adminwindows.md | Title: "adminWindows resource type" description: "Represents a container for all Windows administrator functionalities." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Adminwindowsupdates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/adminwindowsupdates.md | Title: "adminWindowsUpdates resource type" -description: "Represents an entity that acts as a container for all Windows Update for Business deployment service functionalities." +description: "Represents an entity that acts as a container for all Windows Autopatch functionalities." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents an entity that acts as a container for all Windows Update for Business deployment service functionalities. +Represents an entity that acts as a container for all Windows Autopatch functionalities. ## Properties | Property | Type | Description | Represents an entity that acts as a container for all Windows Update for Busines ## Relationships |Relationship|Type|Description| |:|:|:|-|catalog|[microsoft.graph.windowsUpdates.catalog](../resources/windowsupdates-catalog.md)|Catalog of content that can be approved for deployment by the deployment service. Read-only.| +|catalog|[microsoft.graph.windowsUpdates.catalog](../resources/windowsupdates-catalog.md)|Catalog of content that can be approved for deployment by Windows Autopatch. Read-only.| |deploymentAudiences|[microsoft.graph.windowsUpdates.deploymentAudience](../resources/windowsupdates-deploymentaudience.md) collection|The set of [updatableAsset](../resources/windowsupdates-updatableasset.md) resources to which a [deployment](../resources/windowsupdates-deployment.md) can apply.|-|deployments|[microsoft.graph.windowsUpdates.deployment](../resources/windowsupdates-deployment.md) collection|Deployments created using the deployment service.| +|deployments|[microsoft.graph.windowsUpdates.deployment](../resources/windowsupdates-deployment.md) collection|Deployments created using Windows Autopatch.| |products|[microsoft.graph.windowsUpdates.product](../resources/windowsupdates-product.md) collection|A collection of Windows products.| |resourceConnections|[microsoft.graph.windowsUpdates.resourceConnection](../resources/windowsupdates-resourceconnection.md) collection|Service connections to external resources such as analytics workspaces.|-|updatableAssets|[microsoft.graph.windowsUpdates.updatableAsset](../resources/windowsupdates-updatableasset.md) collection|Assets registered with the deployment service that can receive updates.| +|updatableAssets|[microsoft.graph.windowsUpdates.updatableAsset](../resources/windowsupdates-updatableasset.md) collection|Assets registered with Windows Autopatch that can receive updates.| |updatePolicies|[microsoft.graph.windowsUpdates.updatePolicy](../resources/windowsupdates-updatepolicy.md) collection|A collection of policies for approving the deployment of different content to an audience over time.| ## JSON representation |
v1.0 | Application | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/application.md | This resource supports: | appId | String | The unique identifier for the application that is assigned by Microsoft Entra ID. Not nullable. Read-only. Alternate key. Supports `$filter` (`eq`). | |applicationTemplateId | String | Unique identifier of the [applicationTemplate](../resources/applicationtemplate.md). Supports `$filter` (`eq`, `not`, `ne`). Read-only. `null` if the app wasn't created from an application template.| | appRoles | [appRole](approle.md) collection | The collection of roles defined for the application. With [app role assignments](approleassignment.md), these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. |-|authenticationBehaviors|[authenticationBehaviors](../resources/authenticationbehaviors.md)| The collection of authentication behaviors set for the application. Authentication behaviors are unset by default and must be explicitly enabled (or disabled). Returned only on `$select`. <br/><br/> For more information about authentication behaviors, see [Manage application authenticationBehaviors to avoid unverified use of email claims for user identification or authorization](/graph/applications-authenticationbehaviors).| +|authenticationBehaviors|[authenticationBehaviors](../resources/authenticationbehaviors.md)| The collection of breaking change behaviors related to token issuance that are configured for the application. Authentication behaviors are unset by default (`null`) and must be explicitly enabled or disabled. Nullable. Returned only on `$select`. <br/><br/> For more information about authentication behaviors, see [Manage application authenticationBehaviors to avoid unverified use of email claims for user identification or authorization](/graph/applications-authenticationbehaviors).| |certification|[certification](certification.md)|Specifies the certification status of the application.| | createdDateTime | DateTimeOffset | The date and time the application was registered. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, and `eq` on `null` values) and `$orderby`. | |defaultRedirectUri|String|The default redirect URI. If specified and there's no explicit redirect URI in the sign-in request for SAML and OIDC flows, Microsoft Entra ID sends the token to this redirect URI. Microsoft Entra ID also sends the token to this default URI in SAML IdP-initiated single sign-on. The value must match one of the configured redirect URIs for the application.| |
v1.0 | Applicationauthenticationmethodpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/applicationauthenticationmethodpolicy.md | Title: "Microsoft Entra application authentication methods API overview" -description: "Application authentication methods allow apps to acquire tokens to access data in Azure AD." + Title: "Microsoft Entra application management policy API overview" +description: "Application management policies allow administrators to set rules on how Entra apps in their tenant can be configured." ms.localizationpriority: medium doc_type: "conceptualPageType" -# Microsoft Entra application authentication methods API overview +# Microsoft Entra application management policies API overview Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Application authentication methods such as certificates and password secrets allow apps to acquire tokens to access data in Microsoft Entra ID. The policies allow IT admins to enforce best practices for how apps in their organizations use these application authentication methods. For example, an admin might configure a policy to block the use or limit the lifetime of password secrets, and use the creation date of the object to enforce the policy. +Application management policies allow IT admins to enforce best practices for how apps in their organizations should be configured. For example, an admin might configure a policy to block the use or limit the lifetime of password secrets, and use the creation date of the object to enforce the policy. These policies allow organizations to take advantage of the new app security hardening features. By enforcing restrictions that are based on the application or service principal created date, an organization can review their current app security posture, inventory apps, and enforce controls per their resourcing schedules and needs. This approach using the created date allows the organization to enforce the policy for new applications and also apply it to existing applications. The application authentication methods policy API offers the following restricti | symmetricKeyLifetime | Enforce a max lifetime range for a symmetric key. | Restrict all new symmetric keys to a maximum of 30 days for applications created after 01/01/2019. | | asymmetricKeyLifetime | Enforce a max lifetime range for an asymmetric key (certificate). | Restrict all new asymmetric key credentials to a maximum of 30 days for applications created after 01/01/2019. | | trustedCertificateAuthority | Enforce the list of trusted certificate authorities. | Block all new asymmetric key credentials if the issuer is not listed in the trusted certificate authority list. |+| nonDefaultUriAddition | Block new identifier URIs for apps except the "default" URI format. | Block new identifier URIs for apps unless they are of the format `api://{appId}`. | > [!Note] > All lifetime restrictions are expressed in ISO-8601 duration format (For example: P4DT12H30M5S). |
v1.0 | Appliedconditionalaccesspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appliedconditionalaccesspolicy.md | Namespace: microsoft.graph Indicates the attributes related to applied conditional access policy or policies that are triggered by a [sign-in](signin.md) activity. -The data in this object is returned only for callers with privileges to read conditional access data. For more information, see [Viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#viewing-applied-conditional-access-ca-policies-in-sign-ins). +The data in this object is returned only for callers with privileges to read conditional access data. For more information, see [Permissions for viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#permissions). ## Properties |
v1.0 | Appmanagementapplicationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appmanagementapplicationconfiguration.md | + + Title: "appManagementApplicationConfiguration resource type" +description: "App management application configuration object to configure app management policy restrictions like identifier URIs, password credentials, and certificate credentials that are specific to applications." ++ms.localizationpriority: medium ++++# appManagementApplicationConfiguration resource type ++Namespace: microsoft.graph +++Configuration object to configure app management policy restrictions like identifier URIs, password credentials, and certificate credentials that are specific to applications. +++Inherits from [appManagementConfiguration](appmanagementconfiguration.md). ++## Properties +| Property | Type | Description | +| : | :-- | :- | +| identifierUris | [identifierUriConfiguration](identifieruriconfiguration.md) | Configuration object for restrictions on **identifierUris** property for an application | +| keyCredentials | [keyCredentialConfiguration](keyCredentialConfiguration.md) collection | Collection of certificate credential restrictions settings to be applied to an application or service principal. Inherited from [appManagementConfiguration](../resources/appmanagementconfiguration.md). | +| passwordCredentials | [passwordCredentialConfiguration](passwordCredentialConfiguration.md) collection | Collection of password restrictions settings to be applied to an application or service principal. Inherited from [appManagementConfiguration](../resources/appmanagementconfiguration.md). | ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.appManagementApplicationConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.appManagementApplicationConfiguration", + "passwordCredentials": [ + { + "@odata.type": "microsoft.graph.passwordCredentialConfiguration" + } + ], + "keyCredentials": [ + { + "@odata.type": "microsoft.graph.keyCredentialConfiguration" + } + ], + "identifierUris": { + "@odata.type": "microsoft.graph.identifierUriConfiguration" + } +} +``` + |
v1.0 | Appmanagementconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appmanagementconfiguration.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -App management configuration object that contains properties which can be configured to enable various restrictions for applications and service principals. +Base app management configuration object that contains properties that can be configured to enable various restrictions for applications and service principals through an [application management policy](../resources/applicationauthenticationmethodpolicy.md). This resource is an abstract type from which the following resources inherit: +- [appManagementApplicationConfiguration](../resources/appmanagementapplicationconfiguration.md) resource type +- [appManagementServicePrincipalConfiguration](../resources/appmanagementserviceprincipalconfiguration.md) resource type ## Properties -| Property | Type | Description | -| : | :-- | : | +| Property | Type | Description | +| : | :-- | :- | +| keyCredentials | [keyCredentialConfiguration](../resources/keycredentialconfiguration.md) collection | Collection of certificate restrictions settings to be applied to an application or service principal. | | passwordCredentials | [passwordCredentialConfiguration](passwordCredentialConfiguration.md) collection | Collection of password restrictions settings to be applied to an application or service principal. |-| keyCredentials | [keyCredentialConfiguration](keyCredentialConfiguration.md) collection | Collection of keyCredential restrictions settings to be applied to an application or service principal. | ## Relationships |
v1.0 | Appmanagementpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appmanagementpolicy.md | To learn more about how to use app management policy, see [Microsoft Entra appli | Method | Return type | Description | | :- | :- | : |-| [List](../api/appmanagementpolicy-list.md) | [appManagementPolicy](../resources/appmanagementpolicy.md) | Returns a list of app management policies created for applications and service principals along with their properties. | +| [List](../api/appmanagementpolicy-list.md) | [appManagementPolicy](../resources/appmanagementpolicy.md) collection| Returns a list of app management policies created for applications and service principals along with their properties. | | [Create](../api/appmanagementpolicy-post.md) | [appManagementPolicy](../resources/appmanagementpolicy.md) | Creates an app management policy that can be assigned to an application or service principal object. | | [Get](../api/appmanagementpolicy-get.md) | [appManagementPolicy](../resources/appmanagementpolicy.md) | Gets a single app management policy object. | | [Update](../api/appmanagementpolicy-update.md) | None | Updates an app management policy. | | [Delete](../api/appmanagementpolicy-delete.md) | None | Deletes an app management policy from the collection of policies in appManagementPolicies. | | [List applies to](../api/appmanagementpolicy-list-appliesto.md)| [appManagementPolicy](../resources/appmanagementpolicy.md)|Returns a list of applications and service principals to which the policy is applied. |-| [Create applies to](../api/appmanagementpolicy-post-appliesto.md)| None |Returns a list of applications and service principals to which the policy is applied. | +| [Create applies to](../api/appmanagementpolicy-post-appliesto.md)| None |Assign an appManagementPolicy policy object to an application or service principal object. | +| [Delete applies to](../api/appmanagementpolicy-delete-appliesto.md)| None |Remove an appManagementPolicy policy object from an application or service principal object. | ## Properties To learn more about how to use app management policy, see [Microsoft Entra appli | displayName | String | The display name of the policy. Inherited from [policyBase](policybase.md).| | id | String | The unique identifier for the policy. | | isEnabled | Boolean | Denotes whether the policy is enabled. |-| restrictions | [appManagementConfiguration](appManagementConfiguration.md) | Restrictions that apply to an application or service principal object. | +| restrictions | [customAppManagementConfiguration](customAppManagementConfiguration.md) | Restrictions that apply to an application or service principal object. | ## Relationships The following JSON representation shows the resource type. "displayName": "String", "id": "String (identifier)", "isEnabled": "Boolean",- "restrictions": {"@odata.type": "microsoft.graph.appManagementConfiguration"} + "restrictions": {"@odata.type": "microsoft.graph.customAppManagementConfiguration"} } ``` |
v1.0 | Appmanagementserviceprincipalconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/appmanagementserviceprincipalconfiguration.md | + + Title: "appManagementServicePrincipalConfiguration resource type" +description: "Configuration object to configure app management policy restrictions like that are specific to service principals." ++ms.localizationpriority: medium ++++# appManagementServicePrincipalConfiguration resource type ++Namespace: microsoft.graph +++Configuration object to configure app management policy restrictions like password credentials and certificate key credentials that are specific to service principals. +++Inherits from [appManagementConfiguration](appmanagementconfiguration.md). ++## Properties +| Property | Type | Description | +| : | :-- | :- | +| keyCredentials | [keyCredentialConfiguration](keyCredentialConfiguration.md) collection | Collection of certificate credential restrictions settings to be applied to an application or service principal. Inherited from [appManagementConfiguration](../resources/appmanagementconfiguration.md).| +| passwordCredentials | [passwordCredentialConfiguration](passwordCredentialConfiguration.md) collection | Collection of password restrictions settings to be applied to an application or service principal. Inherited from [appManagementConfiguration](../resources/appmanagementconfiguration.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.appManagementServicePrincipalConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.appManagementServicePrincipalConfiguration", + "passwordCredentials": [ + { + "@odata.type": "microsoft.graph.passwordCredentialConfiguration" + } + ], + "keyCredentials": [ + { + "@odata.type": "microsoft.graph.keyCredentialConfiguration" + } + ] +} +``` + |
v1.0 | Approleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/approleassignment.md | Title: "appRoleAssignment resource type" -description: "Used to record when a user, group, or service principal is assigned to an app role on an application's service principal. You can create, read and delete app role assignments." +description: "Used to record when a user, group, or service principal is assigned to an app role on an application's service principal. You can create, read, and delete app role assignments." ms.localizationpriority: high doc_type: resourcePageType Used to record when a user, group, or service principal is assigned an app role An app role assignment is a relationship between the assigned principal (a user, a group, or a service principal), a resource application (the app's service principal) and an app role defined on the resource application. -When the [app role](approle.md) which has been assigned to a principal has a non-empty **value** property, this will be included in the **roles** claim of tokens where the subject is the assigned principal (e.g. SAML responses, ID tokens, access tokens identifying a signed-in user, or an access token identifying a service principal). Applications and APIs use these claims as part of their authorization logic. +When the [app role](approle.md) that has been assigned to a principal has a nonempty **value** property, this is included in the **roles** claim of tokens where the subject is the assigned principal (for example, SAML responses, ID tokens, access tokens identifying a signed-in user, or an access token identifying a service principal). Applications and APIs use these claims as part of their authorization logic. A user can be assigned an app role directly. If an app role is assigned to a group, direct members of the group are also considered to have been assigned the app role. When a user is assigned an app role for an application, a tile for that application is displayed in the user's [MyApps portal](/azure/active-directory/user-help/my-apps-portal-end-user-access) and [Microsoft 365 app launcher](https://support.office.com/article/meet-the-office-365-app-launcher-79f12104-6fed-442f-96a0-eb089a3f476a). An app role assignment where the assigned principal is a service principal is an ## Methods |Method|Return type|Description| |:|:|:|-|[List appRoleAssignments granted to a group](../api/group-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[List appRoleAssignments granted to a user](../api/user-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[List appRoleAssignments granted to a service principal](../api/serviceprincipal-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[List appRoleAssignments granted to users, groups, and client service principals for a resource service principal](../api/serviceprincipal-list-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[Grant an appRole to a group](../api/group-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Grant an appRole to a user](../api/user-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Grant an appRole to a service principal](../api/serviceprincipal-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Grant a user, group, or client service principal an appRoleAssignment for a resource service principal](../api/serviceprincipal-post-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object. -|[Get appRoleAssignment](../api/approleassignment-get.md)|[appRoleAssignment](../resources/approleassignment.md)|Get a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Dlete an appRoleAssignment from a group](../api/group-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| -|[Delete an appRoleAssignment from a user](../api/user-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| -|[Delete an appRoleAssignment from a service principal](../api/serviceprincipal-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| -|[Delete an appRoleAssignment granted to a user, group, or client service principal for a resource service principal](../api/serviceprincipal-delete-approleassignedto.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| +|[List app role assignments for a group](../api/group-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for a group.| +|[List app role assignments for a user](../api/user-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for a user.| +|[List app role assignments for a client service principal](../api/serviceprincipal-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for a client service principal.| +|[List app role assignments for users, groups, and client service principals for a resource service principal](../api/serviceprincipal-list-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for users, groups, and client service principals for a specified resource service principal.| +|[Grant app role to a group](../api/group-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object for a group.| +|[Grant app role to a user](../api/user-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object for a user.| +|[Grant app role to a client service principal](../api/serviceprincipal-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object for a client service principal.| +|[Grant app role assignment to user, group, or client service principal for a resource service principal](../api/serviceprincipal-post-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object to a user, group, or client service principal for a specified resource service principal.| +|[Get app role assignment](../api/approleassignment-get.md)|[appRoleAssignment](../resources/approleassignment.md)|Get an [appRoleAssignment](../resources/approleassignment.md) object assigned to a user, group, or client service principal for a resource service principal.| +|[Delete app role assignment for a group](../api/group-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a group.| +|[Delete app role assignment for a user](../api/user-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a user.| +|[Delete app role assignment for a client service principal](../api/serviceprincipal-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a client service principal.| +|[Delete app role assignment for user, group, or client service principal to a resource service principal](../api/serviceprincipal-delete-approleassignedto.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a user, group, or client service principal for a specified resource service principal.| ## Properties An app role assignment where the assigned principal is a service principal is an | principalDisplayName | String |The display name of the user, group, or service principal that was granted the app role assignment. Read-only. Supports `$filter` (`eq` and `startswith`). | | resourceId | Guid |The unique identifier (**id**) for the resource [service principal](serviceprincipal.md) for which the assignment is made. Required on create. Supports `$filter` (`eq` only). | | resourceDisplayName | String | The display name of the resource app's service principal to which the assignment is made. |-| appRoleId | Guid | The identifier (**id**) for the [app role](approle.md) which is assigned to the principal. This app role must be exposed in the **appRoles** property on the resource application's service principal (**resourceId**). If the resource application has not declared any app roles, a default app role ID of `00000000-0000-0000-0000-000000000000` can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. | +| appRoleId | Guid | The identifier (**id**) for the [app role](approle.md) that is assigned to the principal. This app role must be exposed in the **appRoles** property on the resource application's service principal (**resourceId**). If the resource application hasn't declared any app roles, a default app role ID of `00000000-0000-0000-0000-000000000000` can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. | ## JSON representation |
v1.0 | Approvalsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/approvalsettings.md | Title: "approvalSettings complex type" + Title: "approvalSettings resource type" description: "The settings for approval as defined in a role management policy rule." ms.localizationpriority: medium -# approvalSettings complex type +# approvalSettings resource type Namespace: microsoft.graph |
v1.0 | Approvalstage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/approvalstage.md | Title: "approvalStage complex type" + Title: "approvalStage resource type" description: "In entitlement management, used for the approvalStages property of approval settings in the requestApprovalSettings property of an access package assignment policy. Specifies the primary, fallback, and escalation approvers of each stage. In PIM, defines the settings of the approval stages in a unifiedRoleManagementPolicyApprovalRule object." ms.localizationpriority: medium -# approvalStage complex type +# approvalStage resource type Namespace: microsoft.graph |
v1.0 | Attachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attachment.md | Title: "attachment resource type" -description: "You can add related content to an event," +description: "The base type for several types of attachments on a user, message, task, or group post." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] +The base type for several types of attachments on a user, message, task, or group post that serves as the base resource for the following derived types of attachments: ++* A file ([fileAttachment](../resources/fileattachment.md) resource) +* An item (contact, event, or message, represented by an [itemAttachment](../resources/itemattachment.md) resource) +* A link to a file ([referenceAttachment](../resources/referenceattachment.md) resource) You can add related content to a user [event](../resources/event.md), [message](../resources/message.md), [Outlook task](../resources/outlooktask.md), or group [post](../resources/post.md) in the form of an attachment. + Events in group calendars do not support attachments. Outlook tasks do not support reference attachments. -**attachment** is the base resource for the following derived types of attachments: --* A file ([fileAttachment](../resources/fileattachment.md) resource) -* An item (contact, event or message, represented by an [itemAttachment](../resources/itemattachment.md) resource) -* A link to a file ([referenceAttachment](../resources/referenceattachment.md) resource) - >**Note**: If you're attaching a file to a group post, or attaching an item to an event, message, or group post, limit the size of the attachment to 3 MB. > > If you're attaching a file under 3 MB, you can [add the file attachment to a user event](../api/event-post-attachments.md), [to a message](../api/message-post-attachments.md), or [to a group post](../api/post-post-attachments.md). |
v1.0 | Attendancerecord | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/attendancerecord.md | Contains information associated with an attendance record in a [meetingAttendanc | identity | [identity](identity.md) | Identity of the user associated with this attendance record. The specific type will be one of the following derived types of [identity](identity.md), depending on the type of the user: [communicationsUserIdentity](communicationsUserIdentity.md), [azureCommunicationServicesUserIdentity](azureCommunicationServicesUserIdentity.md). | | role | String | Role of the attendee. Possible values are: `None`, `Attendee`, `Presenter`, and `Organizer`. | | registrantId | String | Unique identifier of a [meetingRegistrant](meetingregistrantbase.md). Presents when the participant has registered for the meeting. (deprecated) |+| registrationId | String | Unique identifier of a virtualEventRegistration. Presents for all participant who has registered for the virtualEventWebinar. | | totalAttendanceInSeconds | Int32 | Total duration of the attendances in seconds. | > [!TIP]-> The **registrantId** property is deprecated and will stop returning data on **December 31, 2024**. There will be a new property replacing this by the end of 2024. 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 **registrantId** property is deprecated and will stop returning data on **December 12, 2024**. There will be a new property replacing this by the end of 2024. 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/). ## JSON representation The following JSON representation shows the resource type. "totalAttendanceInSeconds": "Int32", "role": "String(None|Attendee|Presenter|Organizer)", "registrantId": "String",+ "registrationId": "String", "identity": { "@odata.type": "#microsoft.graph.identity" }, |
v1.0 | Authenticationbehaviors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/authenticationbehaviors.md | Namespace: microsoft.graph Describes the authentication behaviors set in the context of an [application](application.md). Authentication behaviors are Boolean flags that provide applications flexibility in adopting breaking-change behaviors related to token issuance. These updated token issuance behaviors can be related to security mitigations, security improvements, or feature deprecations. -Applications can adopt new breaking changes by enabling a behavior (set the behavior to `true`), or continue using pre-existing behavior by disabling it (by setting the behavior to `false`). For more information about managing authentication behaviors, see [Manage application authenticationBehaviors](/graph/applications-authenticationbehaviors). +Applications can adopt new breaking changes by enabling a behavior (set the behavior to `true`), or continue using preexisting behavior by disabling it (by setting the behavior to `false`). For more information about managing authentication behaviors, see [Manage application authenticationBehaviors](/graph/applications-authenticationbehaviors). ## Properties |Property|Type|Description| |:|:|:|-|removeUnverifiedEmailClaim|Boolean| Removes the `email` claim from tokens sent to an application when the email address's domain can't be verified. | -|requireClientServicePrincipal|Boolean| Requires multitenant applications to have a service principal in the resource tenant as part of authorization checks before they're granted access tokens. This property is only modifiable for multi-tenant resource applications that rely on access from clients without a service principal and had this behavior as set to `false` by Microsoft. Tenant administrators should respond to security advisories sent through Azure Health Service events and the Microsoft 365 message center.| +|blockAzureADGraphAccess|Boolean| If `false`, allows the app to have extended access to Azure AD Graph until June 30, 2025 when Azure AD Graph is fully retired. For more information on Azure AD retirement updates, see [June 2024 update on Azure AD Graph API retirement](https://techcommunity.microsoft.com/t5/microsoft-entra-blog/june-2024-update-on-azure-ad-graph-api-retirement/ba-p/4094534).| +|removeUnverifiedEmailClaim|Boolean| If `true`, removes the `email` claim from tokens sent to an application when the email address's domain can't be verified. | +|requireClientServicePrincipal|Boolean| If `true`, requires multitenant applications to have a service principal in the resource tenant as part of authorization checks before they're granted access tokens. This property is only modifiable for multitenant resource applications that rely on access from clients without a service principal and had this behavior as set to `false` by Microsoft. Tenant administrators should respond to security advisories sent through Azure Health Service events and the Microsoft 365 message center.| ## Relationships None. The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.authenticationBehaviors",+ "blockAzureADGraphAccess": "Boolean", "removeUnverifiedEmailClaim": "Boolean", "requireClientServicePrincipal": "Boolean" } ```++## Related content ++- [How-to: Manage application authenticationBehaviors](/graph/applications-authenticationbehaviors) |
v1.0 | Azureactivedirectorytenant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureactivedirectorytenant.md | Namespace: microsoft.graph Used in the identity sources of an [connectedOrganization](connectedOrganization.md). The `@odata.type` value `#microsoft.graph.azureActiveDirectoryTenant` indicates that this type identifies another Microsoft Entra tenant as an identity source for a connected organization. -When [creating a new connectedOrganization](../api/entitlementmanagement-post-connectedorganizations.md), if the caller provides in the identitySources collection a domainIdentitySource and the domain corresponds to a registered domain of a Microsoft Entra tenant, then the resulting connectedOrganization that is created will have an identitySources collection containing a single member of the [azureActiveDirectoryTenant](azureactivedirectorytenant.md) type. - ## Properties | Property | Type | Description | |
v1.0 | Azureadauthentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/azureadauthentication.md | Title: "azureADAuthentication resource type" -description: "Represents the Microsoft Entra SLA attainment for each month for a Microsoft Entra tenant." +description: "Represents the Microsoft Entra Health service level agreement (SLA) attainment for each month for a Microsoft Entra tenant." ms.localizationpriority: medium doc_type: resourcePageType-toc. Title: "Microsoft Entra health" # azureADAuthentication resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the Microsoft Entra SLA attainment for each month for a Microsoft Entra tenant. For more information, see [What is Microsoft Entra Health?](/entra/identity/monitoring-health/concept-microsoft-entra-health) +Represents the Microsoft Entra Health service level agreement (SLA) attainment for each month for a Microsoft Entra tenant. For more information, see [What is Microsoft Entra Health?](/entra/identity/monitoring-health/concept-microsoft-entra-health) Inherits from [entity](../resources/entity.md). |
v1.0 | Bookingschedulingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/bookingschedulingpolicy.md | Namespace: microsoft.graph Represents the set of policies that determine how appointments should be created in a Microsoft Bookings calendar. +> [!NOTE] +> +> If the Default Scheduling Policy is enabled at the service level, the values of this resource are limited to those defined in the policy in the [List services](/graph/api/bookingbusiness-list-services) API response. In this case, the client must fall back to the Default Scheduling Policy for the business. + ## Properties | Property | Type |Description| |:|:--|:-| |
v1.0 | Businessflowtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/businessflowtemplate.md | Namespace: microsoft.graph In the Microsoft Entra [access reviews](accessreviews-root.md) feature, the **businesFlowTemplate** represents a Microsoft Entra business flow template. The identifier of a template, such as to review guest members of a group, is supplied by the caller when creating an access review. -The business flow template objects are automatically generated when the global administrator onboards the tenant to use the access reviews feature. The business flow templates include access reviews of assignments to an application, memberships of a group, memberships of a Microsoft Entra role, guest user memberships of a group, and guest user assignments to an application. No additional business flow templates can be created. -+The business flow template objects are predefined and automatically generated when an authorized administrator onboards the tenant to use the access reviews feature. They include the following access reviews workflows and scopes: +- Assignments to an application +- Memberships of a group +- Memberships of a Microsoft Entra role +- Memberships of guests to a group +- Assignments of guests to an application. ## Methods |
v1.0 | Calendar | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/calendar.md | Title: "calendar resource type" -description: "A calendar which is a container for events. It can be a calendar for a user, or the default calendar of a Microsoft 365 group." +description: "Represents a container for events. It can be a calendar for a user, or the default calendar of a Microsoft 365 group." ms.localizationpriority: high Represents a container for [event](event.md) resources. It can be a calendar for | Method | Return Type |Description| |:|:--|:-|-|[List calendars](../api/user-list-calendars.md)|[calendar](calendar.md) collection|Get all the user's calendars, or the calendars in the default or other specific calendar group.| -|[Create calendar](../api/user-post-calendars.md) |[calendar](calendar.md)| Create a new calendar in the default calendar group or specified calendar group for a user.| -|[Get calendar](../api/calendar-get.md) | [calendar](calendar.md) |Get the properties and relationships of a **calendar** object. The calendar can be one for a user, or the default calendar of a Microsoft 365 group. | -|[Update calendar](../api/calendar-update.md) | [calendar](calendar.md) |Update the properties of a **calendar** object. The calendar can be one for a user, or the default calendar of a Microsoft 365 group. | -|[Delete calendar](../api/calendar-delete.md) | None |Delete calendar object. | +|[List](../api/user-list-calendars.md)|[calendar](calendar.md) collection|Get all the user's calendars, or the calendars in the default or other specific calendar group.| +|[Create](../api/user-post-calendars.md) |[calendar](calendar.md)| Create a new calendar in the default calendar group or specified calendar group for a user.| +|[Get](../api/calendar-get.md) | [calendar](calendar.md) |Get the properties and relationships of a **calendar** object. The calendar can be one for a user, or the default calendar of a Microsoft 365 group. | +|[Update](../api/calendar-update.md) | [calendar](calendar.md) |Update the properties of a **calendar** object. The calendar can be one for a user, or the default calendar of a Microsoft 365 group. | +|[Delete](../api/calendar-delete.md) | None |Delete calendar object. | +|[Permanently delete](../api/calendar-permanentdelete.md)|None|Permanently delete the **calendar** folder and remove it from the mailbox. | |[List calendar view](../api/calendar-list-calendarview.md) |[event](event.md) collection| Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's primary calendar `(../me/calendarView)` or from a specified calendar.| |[List events](../api/calendar-list-events.md) |[event](event.md) collection| Retrieve a list of events in a calendar. The list contains single instance meetings and series masters.|-|[Create Event](../api/calendar-post-events.md) |[event](event.md)| Create a new event in the default or specified calendar.| +|[Create event](../api/calendar-post-events.md) |[event](event.md)| Create a new event in the default or specified calendar.| |[Get free/busy schedule](../api/calendar-getschedule.md) |[scheduleInformation](scheduleinformation.md) collection|Get the free/busy availability information for a collection of users, distributions lists, or resources, for a specified time period. | |[Find meeting times](../api/user-findmeetingtimes.md) |[meetingTimeSuggestionsResult](meetingtimesuggestionsresult.md) |Suggest meeting times and locations based on organizer and attendee availability, and time or location constraints. | |[Create single-value property](../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md) |[calendar](calendar.md) |Create one or more single-value extended properties in a new or existing calendar. | |
v1.0 | Call | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/call.md | Becomes: ```http https://teams.microsoft.com/l/meetup-join/19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLThmNmEtOGQ3M2E0ODdmZDZk@thread.v2/0?context={"Tid":"72f988bf-86f1-41af-91ab-2d7cd011db47","Oid":"4b444206-207c-42f8-92a6-e332b41c88a2"} ```-+> [!NOTE] +> The following known issues are associated with this resource: +> - [Webhook message processing exception: System.Security.Cryptography.CryptographicException](https://developer.microsoft.com/en-us/graph/known-issues/?search=24752) +> - [Support for multi-endpoint use case in delta roster notification mode is missing](https://developer.microsoft.com/en-us/graph/known-issues/?search=24894) ## Methods | Method | Return Type | Description | |:-|:|:--|+| [Create](../api/application-post-calls.md) | [call](call.md) | Create **call** enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. | | [Get](../api/call-get.md) | [call](call.md) | Read properties of the **call** object. | | [Delete/hang up](../api/call-delete.md) | None | Delete or Hang-up an active **call**. | | [Keep alive](../api/call-keepalive.md) | None | Ensure that the call remains active. |
v1.0 | Calloptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/calloptions.md | Namespace: microsoft.graph An abstract base class that contains the optional features for a call. +Base type of [incomingCallOptions](../resources/incomingcalloptions.md) and [outgoingCallOptions](../resources/outgoingcalloptions.md). + ## Properties |Property |Type |Description | |: |: |: | | hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. | | isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. |+| isDeltaRosterEnabled | Boolean | Indicates whether delta roster is enabled for the call. | ## JSON representation The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.callOptions", "hideBotAfterEscalation": "Boolean",- "isContentSharingNotificationEnabled": "Boolean" + "isContentSharingNotificationEnabled": "Boolean", + "isDeltaRosterEnabled": "Boolean" } ``` |
v1.0 | Callrecording | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecording.md | Represents a recording associated with an [online meeting](onlinemeeting.md). |:|:--|:-| |[List](../api/onlinemeeting-list-recordings.md) | [callRecording](callrecording.md) collection | Get the list of [callRecording](../resources/callrecording.md) objects associated with a scheduled [onlineMeeting](../resources/onlinemeeting.md).| |[Get](../api/callrecording-get.md) | [callRecording](callrecording.md) | Get a [callRecording](../resources/callrecording.md) object associated with a scheduled [onlineMeeting](../resources/onlinemeeting.md).|-|[Get delta by organizer](../api/callrecording-delta.md) | [callRecording](callrecording.md) collection | Get a set of [callRecording](../resources/callrecording.md) resources that have been added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| +|[Get delta by organizer](../api/callrecording-delta.md) | [callRecording](callrecording.md) collection | Get a set of [callRecording](../resources/callrecording.md) resources that were added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| |[List recordings by organizer](../api/onlinemeeting-getallrecordings.md) | [callRecording](callrecording.md) collection | Get the [callRecording](../resources/callrecording.md) objects for all the [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| ## Properties |
v1.0 | Callrecords Media | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/callrecords-media.md | Title: "media resource type" -description: "The media type" +description: "Represents the media (for example, audio, video, and video-based screen-sharing) used in a call." ms.localizationpriority: medium Namespace: microsoft.graph.callRecords [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the media (audio, video, video-based screen-sharing, etc.) used in a call. +Represents the media (for example, audio, video, and video-based screen-sharing) used in a call. ## Properties |
v1.0 | Calltranscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/calltranscript.md | Represents a transcript associated with an [online meeting](onlinemeeting.md). |:|:--|:-| |[List transcripts](../api/onlinemeeting-list-transcripts.md) | [callTranscript](calltranscript.md) collection | Get the list of [callTranscript](../resources/calltranscript.md) objects associated with an [onlineMeeting](../resources/onlinemeeting.md).| |[Get transcript](../api/calltranscript-get.md) | [callTranscript](calltranscript.md) | Get a [callTranscript](../resources/calltranscript.md) object associated with an [onlineMeeting](../resources/onlinemeeting.md).|-|[Get delta by organizer](../api/calltranscript-delta.md) | [callTranscript](calltranscript.md) collection | Get a set of [callTranscript](../resources/calltranscript.md) resources that have been added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| +|[Get delta by organizer](../api/calltranscript-delta.md) | [callTranscript](calltranscript.md) collection | Get a set of [callTranscript](../resources/calltranscript.md) resources that were added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| |[List transcripts by organizer](../api/onlinemeeting-getalltranscripts.md) | [callTranscript](calltranscript.md) collection | Get the [callTranscript](../resources/calltranscript.md) objects for all the [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| |
v1.0 | Channel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/channel.md | where files are shared, and where tabs are added. |[Get primary channel](../api/team-get-primarychannel.md)|[channel](channel.md)| The general channel for the team. | |[Update channel](../api/channel-patch.md) | [channel](channel.md) | Update properties of the channel.| |[Delete channel](../api/channel-delete.md) | None | Delete a channel.|-|[Get message delta](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) | Get incremental messages in a channel. | |[List channel messages](../api/channel-list-messages.md) | [chatMessage](../resources/chatmessage.md) | Get messages in a channel | |[Get all channel messages](../api/channel-getallmessages.md)|[channel](channel.md) collection | Get all messages from all channels that a user is a participant in. |-|[Get all retained channel messages](../api/channel-getallretainedmessages.md)|[chatMessage](../resources/chatmessage.md) collection|Get retained [messages](../resources/chatmessage.md) across all [channels](../resources/channel.md) in a [team](../resources/team.md). | +|[Get all retained channel messages](../api/channel-getallretainedmessages.md)|[chatMessage](../resources/chatmessage.md) collection|Get all retained [messages](../resources/chatmessage.md) across all [channels](../resources/channel.md) in a [team](../resources/team.md). | |[Create channel message post](../api/channel-post-messages.md) | [chatMessage](../resources/chatmessage.md) | Send a message to a channel. | |[Create reply to channel message post](../api/chatmessage-post-replies.md) | [chatMessage](../resources/chatmessage.md) | Reply to a message in a channel.| |[Get files folder](../api/channel-get-filesfolder.md)| [driveItem](driveitem.md) | Retrieves the details of the SharePoint folder where the files for the channel are stored. | |
v1.0 | Chat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chat.md | Represents a chat that is a collection of [chatMessages](chatmessage.md) between |[List messages in a chat](../api/chat-list-messages.md) | [chatMessage](../resources/chatmessage.md) | Get messages in a chat. | |[Get message reply](../api/chatmessage-get.md) | [chatMessage](../resources/chatmessage.md) | Get a single message in a chat. | |[Get messages across all chats](../api/chats-getallmessages.md)| [chat](chat.md) collection| Get messages from all chats that a user is a participant in. |-|[Get retained messages across all chats](../api/chat-getallretainedmessages.md)|[chatMessage](../resources/chatmessage.md) collection| 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 retained messages across all chats](../api/chat-getallretainedmessages.md)|[chatMessage](../resources/chatmessage.md) collection| 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. | +|[Get delta chat messages for user](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) collection | 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. | | **Apps** ||| |[List apps in chat](../api/chat-list-installedapps.md) |[teamsAppInstallation](teamsappinstallation.md) collection | List apps installed in a chat (and associated meeting).| |[Get app installed in chat](../api/chat-get-installedapps.md) | [teamsAppInstallation](teamsappinstallation.md) | Get a specific app installed in a chat (and associated meeting).| |
v1.0 | Chatmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessage.md | Represents an individual chat message within a [channel](channel.md) or [chat](c |:|:--|:-| |**Channel messages**| | | |[List messages in channel](../api/channel-list-messages.md) | [chatMessage](chatmessage.md) collection | List of all root messages in a channel.|-|[Get delta of messages in channel](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) | Get incremental messages in a channel. | |[Create subscription for new channel messages](../api/subscription-post-subscriptions.md) | [subscription](subscription.md) | Listen for new, edited, and deleted messages, and reactions to them. | |[Get message in channel](../api/chatmessage-get.md) | [chatMessage](chatmessage.md) | Get a single root message in a channel.| |[Send message in channel](../api/chatmessage-post.md) | [chatMessage](chatmessage.md)| Create a new root message in a channel.| Represents an individual chat message within a [channel](channel.md) or [chat](c |[List messages in chat](../api/chat-list-messages.md) | [chatMessage](../resources/chatmessage.md) | List chat messages in a chat. | |[Get message in chat](../api/chatmessage-get.md) | [chatMessage](../resources/chatmessage.md) | Get a single chat message in a chat. | |[Get messages across all chats for user](../api/chats-getallmessages.md)| [chat](chat.md) collection| Get messages from all chats that a user is a participant in, including 1:1 chats, group chats, and meeting chats. |+|[Get delta chat messages for user](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) collection | 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. | |[Get all channel messages](../api/channel-getallmessages.md)|[channel](channel.md) collection | Get all messages from all channels that a user is a participant in. | |[Create subscription for new chat messages](../api/subscription-post-subscriptions.md) | [subscription](subscription.md) | Listen for new, edited, and deleted chat messages, and reactions to them. | |[Send message in chat](../api/chat-post-messages.md) | [chatMessage](chatmessage.md)| Send a chat message in an existing 1:1 or group chat conversation.| Represents an individual chat message within a [channel](channel.md) or [chat](c |lastEditedDateTime|dateTimeOffset|Read only. Timestamp when edits to the chat message were made. Triggers an "Edited" flag in the Teams UI. If no edits are made the value is `null`.| |lastModifiedDateTime|dateTimeOffset|Read only. Timestamp when the chat message is created (initial setting) or modified, including when a reaction is added or removed. | |locale|string|Locale of the chat message set by the client. Always set to `en-us`.|-|mentions|[chatMessageMention](chatmessagemention.md) collection| List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, and tag.| +|mentions|[chatMessageMention](chatmessagemention.md) collection| List of entities mentioned in the chat message. Supported entities are: user, bot, team, channel, chat, and tag.| |messageHistory|[chatMessageHistoryItem](../resources/chatmessagehistoryitem.md) collection|List of activity history of a message item, including modification time and actions, such as reactionAdded, reactionRemoved, or reaction changes, on the message. |messageType|chatMessageType|The type of chat message. The possible values are: `message`, `chatEvent`, `typing`, `unknownFutureValue`, `systemEventMessage`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `systemEventMessage`.| |onBehalfOf|[chatMessageFromIdentitySet](chatmessagefromidentityset.md)| User attribution of the message when [bot](/microsoftteams/platform/messaging-extensions/how-to/action-commands/respond-to-task-module-submit?tabs=dotnet%2Cdotnet-1#user-attribution-for-bots-messages) sends a message on behalf of a user.| |
v1.0 | Chatmessageattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessageattachment.md | Namespace: microsoft.graph Represents an attachment to a chat message entity. -An entity of type `chatMessageAttachment` is returned as part of the [Get channel messages](../api/channel-list-messages.md) API, as a part of [chatMessage](chatmessage.md) entity. +An entity of type **chatMessageAttachment** is returned as part of the [Get channel messages](../api/channel-list-messages.md) API, as a part of [chatMessage](chatmessage.md) entity. ## Properties | Property | Type |Description| |:|:--|:-|-|id|string| Read-only. The unique id of the attachment.| -|contentType| string | The media type of the content attachment. It can have the following values: <br><ul><li>`reference`: Attachment is a link to another file. Populate the <b>contentURL</b> with the link to the object.</li><li>Any <b>contentType</b> that is supported by the Bot Framework's [Attachment object](/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?#attachment-object).</li><li>`application/vnd.microsoft.card.codesnippet`: A code snippet. </li><li>`application/vnd.microsoft.card.announcement`: An announcement header. </li>| -|contentUrl|string|The URL for the content of the attachment. | |content|string|The content of the attachment. If the attachment is a [rich card](/microsoftteams/platform/task-modules-and-cards/cards/cards-reference), set the property to the rich card object. This property and **contentUrl** are mutually exclusive.|+|contentType| string | The media type of the content attachment. The possible values are: <br><ul><li>`reference`: The attachment is a link to another file. Populate the <b>contentURL</b> with the link to the object.</li><li>`forwardedMessageReference`: The attachment is a reference to a forwarded message. Populate the <b>content</b> with the original message context.</li><li>Any <b>contentType</b> that is supported by the Bot Framework's [Attachment object](/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference?#attachment-object).</li><li>`application/vnd.microsoft.card.codesnippet`: A code snippet. </li><li>`application/vnd.microsoft.card.announcement`: An announcement header. </li>| +|contentUrl|string|The URL for the content of the attachment. | +|id|string| Read-only. The unique ID of the attachment.| |name|string|Name of the attachment.| |teamsAppId| string |The ID of the Teams app that is associated with the attachment. The property is used to attribute a Teams message card to the specified app.| |thumbnailUrl| string |The URL to a thumbnail image that the channel can use if it supports using an alternative, smaller form of **content** or **contentUrl**. For example, if you set **contentType** to application/word and set **contentUrl** to the location of the Word document, you might include a thumbnail image that represents the document. The channel could display the thumbnail image instead of the document. When the user selects the image, the channel would open the document.| An entity of type `chatMessageAttachment` is returned as part of the [Get channe ```json {- "id": "string (identifier)", + "content": "string", "contentType": "string", "contentUrl": "string",- "content": "string", + "id": "string (identifier)", "name": "string", "teamsAppId": "string", "thumbnailUrl": "string" |
v1.0 | Chatmessagemention | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessagemention.md | Title: "chatMessageMention resource type" -description: "Represents a mention in a chatMessage entity. The mention can be to a user, team, bot or channel. " +description: "Represents a mention in a chatMessage entity." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a mention in a [chatMessage](chatmessage.md) entity. The mention can be to a [user](user.md), [team](team.md), bot, or [channel](channel.md). +Represents a mention in a [chatMessage](chatmessage.md) entity. The mention can be to a [user](user.md), [team](team.md), bot, [channel](channel.md), or [chat](chat.md). In a **chatMessage** object that contains one or more mentions, the message body **content** property represents the chat message in HTML. It encloses the **mentionText** of each mention in an HTML `at` element, with an `id` attribute that corresponds to the **id** property of the mention. For a fuller context of the example, see [List channel message replies](../api/c |:|:--|:-| |id|Int32|Index of an entity being mentioned in the specified **chatMessage**. Matches the {index} value in the corresponding `<at id="{index}">` tag in the message body.| |mentionText|string|String used to represent the mention. For example, a user's display name, a team name.|-|mentioned|[chatMessageMentionedIdentitySet](chatmessagementionedidentityset.md)|The entity (user, application, team, or channel) that was @mentioned.| +|mentioned|[chatMessageMentionedIdentitySet](chatmessagementionedidentityset.md)|The entity (user, application, team, channel, or chat) that was @mentioned.| ## JSON representation |
v1.0 | Chatmessagementionedidentityset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessagementionedidentityset.md | Inherits from [identitySet](../resources/identityset.md). |Property|Type|Description| |:|:|:| |application|[identity](../resources/identity.md)|Inherited from [identitySet](../resources/identityset.md). If present, represents an application (for example, bot) @mentioned in a [message](../resources/chatmessage.md).|-|conversation|[teamworkConversationIdentity](../resources/teamworkconversationidentity.md)|If present, represents a conversation (for example, team or channel) @mentioned in a [message](../resources/chatmessage.md).| +|conversation|[teamworkConversationIdentity](../resources/teamworkconversationidentity.md)|If present, represents a conversation (for example, team, channel, or chat) @mentioned in a [message](../resources/chatmessage.md).| |device|[identity](../resources/identity.md)|Inherited from [identitySet](../resources/identityset.md). Not used because it's not supported to @mention devices.| |user|[identity](../resources/identity.md)|Inherited from [identitySet](../resources/identityset.md). If present, represents a user @mentioned in a [message](../resources/chatmessage.md).| |tag|[teamworkTagIdentity](../resources/teamworktagidentity.md)|If present, represents a tag @mentioned in a team [message](../resources/chatmessage.md).| |
v1.0 | Chatmessagereaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/chatmessagereaction.md | An entity of type `chatMessageReaction` is returned as part of the [Get channel | Property | Type | Description | |:-|:|:| |createdDateTime|DateTimeOffset|The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|+|displayName|String|The name of the reaction.| |reactionContentUrl|String|The hosted content URL for the custom reaction type. |-|reactionType|String|Supported values are Unicode characters and `custom`. Some backward-compatible reaction types include `like`, `angry`, `sad`, `laugh`, `heart`, and `surprised`. | +|reactionType|String|The reaction type. Supported values include Unicode characters, `custom`, and some backward-compatible reaction types, such as `like`, `angry`, `sad`, `laugh`, `heart`, and `surprised`. | |user|[chatMessageReactionIdentitySet](chatmessagereactionidentityset.md)|The user who reacted to the message.| ## JSON representation The following JSON representation shows the resource type. ```json { "createdDateTime": "String (timestamp)",+ "displayName": "String", "reactionContentUrl": "String", "reactionType": "String", "user": {"@odata.type": "microsoft.graph.chatMessageReactionIdentitySet"} |
v1.0 | Claimsmappingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/claimsmappingpolicy.md | The number of claims and transformations that can be added to a claims-mapping p For more scenario and configuration details, see [Claims mapping policy type](/azure/active-directory/develop/reference-claims-mapping-policy-type) and [How to: Customize claims emitted in tokens for a specific app in a tenant](/azure/active-directory/develop/active-directory-claims-mapping#claims-mapping-policy-properties). +Additionally, visit [Claims customization using a policy](/entr). + Inherits from [stsPolicy](stsPolicy.md). ## Methods |
v1.0 | Clonableteamparts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/clonableteamparts.md | description: "Describes which part of a team should be cloned. " ms.localizationpriority: medium doc_type: enumPageType -+ # clonableTeamParts enum type |
v1.0 | Cloud Licensing Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloud-licensing-api-overview.md | + + Title: "Use the cloud licensing API in Microsoft Graph (preview)" +description: "Learn how to use the cloud licensing API to access licenses across different subscriptions." ++ms.localizationpriority: medium ++++# Use the cloud licensing API in Microsoft Graph (preview) +++The Microsoft Cloud Licensing platform improves license management by breaking down licenses from various subscriptions into smaller, manageable pools called allotments. The association of licenses to their unique subscriptions enables more granular accounting and reporting for an organization. ++The cloud licensing API is defined in the OData subnamespace `microsoft.graph.cloudLicensing`. ++## Authentication and permissions ++Microsoft Graph controls access to resources via permissions. As a developer, you must specify the permissions you need to access cloud licensing resources. Typically, you specify the permissions in the Microsoft Entra admin center. For more information, see [Microsoft Graph permissions reference](/graph/permissions-reference). ++## Common use cases ++The following table lists common use cases for the cloud licensing API. ++| Use case | REST resources | +| :-- | :- | +| List and get usage rights | [usageRight](../resources/cloudlicensing-usageright.md) | ++## API design details ++The following sections describe design details for the cloud licensing API. ++### Usage rights ++The [usageRight](../resources/cloudlicensing-usageright.md) entity is designed for client and workload license checks, with relationships structured to flow from the user or group to the **usageRight**. ++## Next steps ++- Explore the resources and methods that are most helpful to your scenario. +- Try the cloud licensing API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). |
v1.0 | Cloudlicensing Groupcloudlicensing | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudlicensing-groupcloudlicensing.md | + + Title: "groupCloudLicensing resource type" +description: "Represents the relationships of a group to cloud licensing resources." ++ms.localizationpriority: medium ++++# groupCloudLicensing resource type ++Namespace: microsoft.graph.cloudLicensing +++Represents the relationships of a group to cloud licensing resources. ++## Properties +None. ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|usageRights|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) collection|The rights that all direct members of the group have to use various services, granted by the combination of its assigned licenses.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudLicensing.groupCloudLicensing" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudLicensing.groupCloudLicensing" +} +``` |
v1.0 | Cloudlicensing Service | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudlicensing-service.md | + + Title: "service resource type" +description: "Represents a specific service granted by an individual usageRight." ++ms.localizationpriority: medium ++++# service resource type ++Namespace: microsoft.graph.cloudLicensing +++Represents a specific service granted by an individual [usageRight](../resources/cloudlicensing-usageright.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|assignableTo|[microsoft.graph.cloudLicensing.assigneeTypes](../resources/cloudlicensing-service.md#assigneetypes-values)|Identifies the types of directory objects to which the service can be assigned. The possible values are: `none`, `user`, `group`, `device`, `unknownFutureValue`.<br/><br/>If new values are added to this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations) in the future, you must use the `Prefer: include-unknown-enum-members` request header to get them.<br/><br/>The **assigneeTypes** property is a multi-valued enumeration and the property can contain multiple values in a comma-separated list.| +|planId|Guid|The unique identifier of the service plan that is equal to the **servicePlanId** property on the related [servicePlanInfo](../resources/serviceplaninfo.md) objects.| +|planName|String|The name of the service plan that is equal to the **servicePlanName** property on the related [servicePlanInfo](../resources/serviceplaninfo.md) objects.| ++### assigneeTypes values ++| Member | Description | +|:|:--| +| none | No flags are enabled; this service can't be assigned. | +| user | If enabled, this service can be assigned directly to users. | +| group | If enabled, this service can be assigned to groups. | +| device | If enabled, this service can be assigned directly to devices. | +| unknownFutureValue| Evolvable enumeration sentinel value. Don't use. | ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudLicensing.service" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudLicensing.service", + "assignableTo": "String", + "planId": "Guid", + "planName": "String" +} +``` |
v1.0 | Cloudlicensing Usageright | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudlicensing-usageright.md | + + Title: "usageRight resource type" +description: "Represents the right of a user or group to use a particular set of services, as granted by the combination of their assigned licenses for the same subscribedSku." ++ms.localizationpriority: medium ++++# usageRight resource type ++Namespace: microsoft.graph.cloudLicensing +++Represents the right of a user or group to use a particular set of services, as granted by the combination of their assigned licenses for the same [subscribedSku](../resources/subscribedsku.md). ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List for group](../api/cloudlicensing-groupcloudlicensing-list-usagerights.md)|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) collection|Get a list of the [usageRight](../resources/cloudlicensing-usageright.md) objects granted to a group.| +|[List for user](../api/cloudlicensing-usercloudlicensing-list-usagerights.md)|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) collection|Get a list of the [usageRight](../resources/cloudlicensing-usageright.md) objects granted to a user.| +|[Get](../api/cloudlicensing-usageright-get.md)|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md)|Get the properties and relationships of a [usageRight](../resources/cloudlicensing-usageright.md) for a [user](../resources/user.md) or [group](../resources/group.md).| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier for the **usageRight** that should be treated as an opaque identifier. Inherited from [entity](../resources/entity.md). Not nullable. Read-only.| +|services|[microsoft.graph.cloudLicensing.service](../resources/cloudlicensing-service.md) collection| Information about the services associated with the **usageRight**. Not nullable. Read-only. Supports `$filter` on the **planId** property. | +|skuId|Guid| Unique identifier (GUID) for the service SKU that is equal to the **skuId** property on the related [subscribedSku](subscribedsku.md) object. Read-only. Supports `$filter`. | +|skuPartNumber|String| Unique SKU display name that is equal to the **skuPartNumber** on the related [subscribedSku](subscribedsku.md) object; for example, `AAD_Premium`. Read-only. | ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudLicensing.usageRight", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudLicensing.usageRight", + "id": "String (identifier)", + "services": [{"@odata.type": "microsoft.graph.cloudLicensing.service"}], + "skuId": "Guid", + "skuPartNumber": "String" +} +``` |
v1.0 | Cloudlicensing Usercloudlicensing | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudlicensing-usercloudlicensing.md | + + Title: "userCloudLicensing resource type" +description: "Represents the relationships of a user to cloud licensing resources." ++ms.localizationpriority: medium ++++# userCloudLicensing resource type ++Namespace: microsoft.graph.cloudLicensing +++Represents the relationships of a user to cloud licensing resources. ++## Properties +None. ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|usageRights|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) collection|The rights of the user to use various services, granted by the combination of their assigned licenses.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudLicensing.userCloudLicensing" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudLicensing.userCloudLicensing" +} +``` |
v1.0 | Cloudpc | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpc.md | Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In |[Restore](../api/cloudpc-restore.md)|None|Restore a Cloud PC object to a previous state from a snapshot.| |[Set review status](../api/cloudpc-setreviewstatus.md)|None|Set the review status of a specific Cloud PC device using the Cloud PC ID.| |[Retrieve review status](../api/cloudpc-retrievereviewstatus.md)|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|Get the [review status](..\resources\cloudpcreviewstatus.md) of a Cloud PC.|-|[Bulk set review status](../api/manageddevice-bulksetcloudpcreviewstatus.md)|[cloudPcBulkRemoteActionResult](../resources/cloudpcbulkremoteactionresult.md)|Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices.| |[List for user](../api/user-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List the Cloud PC devices that are attributed to the signed-in user.| |[Get launch info for user](../api/cloudpc-getcloudpclaunchinfo.md)|[cloudPcLaunchInfo](../resources/cloudpclaunchinfo.md)|Get the [cloudPcLaunchInfo](../resources/cloudpclaunchinfo.md) for the signed-in user.| |[Get connectivity history](../api/cloudpc-getcloudpcconnectivityhistory.md)|[cloudPcConnectivityEvent](../resources/cloudpcconnectivityevent.md) collection|Get the Cloud PC connectivity history.| Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In |[Retry partner agent installation](../api/cloudpc-retrypartneragentinstallation.md)|None|Retry installation for the partner agents that failed to install on the Cloud PC.| |[Validate bulk resize](../api/cloudpc-validatebulkresize.md)|[cloudPcResizeValidateResult](../resources/cloudPcResizeValidationResult.md) collection|Validate that a set of Cloud PC devices meet the requirements to be bulk resized.| |[Create snapshot](../api/cloudpc-createsnapshot.md)|None|Create a snapshot for a specific Cloud PC device.|-|[Get frontline access state](../api/cloudpc-getfrontlinecloudpcaccessstate.md)|[frontlineCloudPcAccessState](#frontlinecloudpcaccessstate-values)|Get the access state of the frontline Cloud PC. The possible values are: `unassigned`, `noLicensesAvailable`, `activationFailed`, `active`, `activating`, `standbyMode`, `unknownFutureValue`.| +|[Retrieve snapshots](../api/cloudpc-retrievesnapshots.md)|[cloudPcSnapshot](../resources/cloudpcsnapshot.md) collection|Get a list of [cloudPcSnapshot](../resources/cloudpcsnapshot.md) resources for a Cloud PC.| +|[Get frontline access state](../api/cloudpc-getfrontlinecloudpcaccessstate.md)|[frontlineCloudPcAccessState](#frontlinecloudpcaccessstate-values)|Get the access state of the frontline Cloud PC. The possible values are: `unassigned`, `noLicensesAvailable`, `activationFailed`, `active`, `activating`, `standbyMode`, `unknownFutureValue`. The `noLicensesAvailable` member is deprecated and will stop returning on September 30, 2024.| |[Bulk reprovision remote action (deprecated)](../api/manageddevice-bulkreprovisioncloudpc.md) |None|Bulk reprovision a set of Cloud PC devices with Intune managed device IDs. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the [cloudPcBulkReprovision](../resources/cloudpcbulkreprovision.md) resource. | |[Bulk resize (deprecated)](../api/cloudpc-bulkresize.md) |[cloudPcRemoteActionResult](../resources//cloudpcremoteactionresult.md) collection|Perform a bulk resize action to resize a group of Cloud PCs that have successfully passed validation (cloudPC: validateBulkResize). If any devices can't be resized, they're labeled as "resize failed", while the remaining devices are `provisioned` for the resize process. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the [cloudPcBulkResize](../resources/cloudpcbulkresize.md) resource.| |[Bulk restore remote action (deprecated)](../api/manageddevice-bulkrestorecloudpc.md) |[cloudPcBulkRemoteActionResult](../resources/cloudpcbulkremoteactionresult.md)|Restore multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices and a restore point date and time. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the [cloudPcBulkRestore](../resources/cloudpcbulkrestore.md) resource.| |[Get remote action results (deprecated)](../api/manageddevice-getcloudpcremoteactionresults.md)|[cloudPcRemoteActionResult](../resources/cloudpcremoteactionresult.md)|Check the [Cloud PC-specified remote action results](../resources/cloudpcremoteactionresult.md) for a Cloud PC device. This API is deprecated and will stop returning data on September 30, 2024. Going forward, use the [retrieveCloudPcRemoteActionResults](../api/cloudpc-retrievecloudpcremoteactionresults.md) API.| |[Get review status (deprecated)](../api/manageddevice-getcloudpcreviewstatus.md) |[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|Get the review status of a specific Cloud PC device by managedDeviceId. This API is deprecated and stopped returning data on April 30, 2024. Going forward, use the [cloudPC: retrieveReviewStatus](../api/cloudpc-retrievereviewstatus.md) API.|-|[Get shift work access state (deprecated)](../api/cloudpc-getshiftworkcloudpcaccessstate.md) |[shiftWorkCloudPcAccessState](#shiftworkcloudpcaccessstate-values-deprecated)|Get the access state of the shift work Cloud PC. The possible values are: `unassigned`, `noLicensesAvailable`, `activationFailed`, `active`, `activating`, `waitlisted`, `unknownFutureValue`, `standbyMode`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value in this evolvable enum: `standbyMode`. This API is deprecated and will stop returning data on December 31, 2023. Going forward, use the [getFrontlineCloudPcAccessState](../api/cloudpc-getfrontlinecloudpcaccessstate.md) API.| -|[Reprovision remote action (deprecated)](../api/manageddevice-reprovisioncloudpc.md) |None|Reprovision a Cloud PC with an Intune [managed device](../resources/cloudpc.md) ID. This API is deprecated and will stop returning data on September 30, 2023. Going forward, use the [reprovision](../api/cloudpc-reprovision.md) API.| -|[Resize remote action (deprecated)](../api/manageddevice-resizecloudpc.md) |None|Upgrade or downgrade an existing Cloud PC to another configuration with a new vCPU and storage size through Intune managed device ID. This API is deprecated and stopped returning data on October 30, 2023. Going forward, use the [cloudPC: resize](../api/cloudpc-resize.md) API.| -|[Restore remote action (deprecated)](../api/manageddevice-restorecloudpc.md) |None|Restore a Cloud PC device to a previous state with an Intune [managed device](../resources/cloudpc.md) ID. This API is deprecated and will stop returning data on September 30, 2023. Going forward, use the [restore](../api/cloudpc-restore.md) API.| |[Set review status (deprecated)](../api/manageddevice-setcloudpcreviewstatus.md) |None|Set the review status of a specific Cloud PC device using the managed device ID. This API is deprecated and stopped returning data on April 30, 2024. Going forward, use the [cloudPC: setReviewStatus](../api/cloudpc-setreviewstatus.md) API.|+|[Bulk set review status (deprecated)](../api/manageddevice-bulksetcloudpcreviewstatus.md)|None|Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices. This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the [cloudPcBulkSetReviewStatus](../resources/cloudpcbulksetreviewstatus.md) resource.| ## Properties Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In |allotmentDisplayName|String|The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment. When the **provisioningType** is `dedicated`, the allotment name is `null`. Read-only.| |connectivityResult|[cloudPcConnectivityResult](../resources/cloudpcconnectivityresult.md)|The connectivity health check result of a Cloud PC, including the updated timestamp and whether the Cloud PC can be connected.| |deviceRegionName|String|The name of the geographical region where the Cloud PC is currently provisioned. For example, `westus3`, `eastus2`, and `southeastasia`. Read-only.|-|disasterRecoveryCapability|[cloudPcDisasterRecoveryCapability](../resources/cloudpcdisasterrecoverycapability.md)|The disaster recovery status of the Cloud PC, including the primary region, secondary region, and capability type. The default value is `null` that indicates that the disaster recovery setting is disabled. To receive a response with the **disasterRecoveryCapability** property, `$select` and `$filter` it by `disasterRecoveryCapability/{subProperty}` in the request URL. For more details, see [Example 4: List Cloud PCs filtered by disaster recovery capability type](../api/cloudpc-get.md#example-4-list-cloud-pcs-filtered-by-disaster-recovery-capability-type). Read-only. | +|disasterRecoveryCapability|[cloudPcDisasterRecoveryCapability](../resources/cloudpcdisasterrecoverycapability.md)|The disaster recovery status of the Cloud PC, including the primary region, secondary region, and capability type. The default value is `null` that indicates that the disaster recovery setting is disabled. To receive a response with the **disasterRecoveryCapability** property, `$select` and `$filter` it by `disasterRecoveryCapability/{subProperty}` in the request URL. For more information, see [Example 4: List Cloud PCs filtered by disaster recovery capability type](../api/cloudpc-get.md#example-4-list-cloud-pcs-filtered-by-disaster-recovery-capability-type). Read-only. | |diskEncryptionState|[cloudPcDiskEncryptionState](#cloudpcdiskencryptionstate-values)|The disk encryption applied to the Cloud PC. Possible values: `notAvailable`, `notEncrypted`, `encryptedUsingPlatformManagedKey`, `encryptedUsingCustomerManagedKey`, and `unknownFutureValue`.| |displayName|String|The display name of the Cloud PC.| |gracePeriodEndDateTime|DateTimeOffset|The date and time when the grace period ends and reprovisioning or deprovisioning happens. Required only if the status is `inGracePeriod`. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In |servicePlanId|String|The service plan ID of the Cloud PC.| |servicePlanName|String|The service plan name of the Cloud PC.| |servicePlanType|[cloudPcServicePlanType](../resources/cloudpcserviceplan.md#cloudpcserviceplantype-values)|The service plan type of the Cloud PC.|-|status|[microsoft.graph.cloudPcStatus](#cloudpcstatus-values)|The status of the Cloud PC. Possible values are: `notProvisioned`, `provisioning`, `provisioned`, `inGracePeriod`, `deprovisioning`, `failed`, `provisionedWithWarnings`, `resizing`, `restoring`, `pendingProvision`, `unknownFutureValue`, `movingRegion`, `resizePendingLicense`, `modifyingSingleSignOn`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `movingRegion`, `resizePendingLicense`, `modifyingSingleSignOn`.| +|status|[microsoft.graph.cloudPcStatus](#cloudpcstatus-values)|The status of the Cloud PC. Possible values are: `notProvisioned`, `provisioning`, `provisioned`, `inGracePeriod`, `deprovisioning`, `failed`, `provisionedWithWarnings`, `resizing`, `restoring`, `pendingProvision`, `unknownFutureValue`, `movingRegion`, `resizePendingLicense`, `modifyingSingleSignOn`, `preparing`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `movingRegion`, `resizePendingLicense`, `modifyingSingleSignOn`, `preparing`.| |statusDetails (deprecated)|[cloudPcStatusDetails](../resources/cloudpcstatusdetails.md)|The details of the Cloud PC status. For example, `{ "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }`. This property is deprecated and will no longer be supported effective August 31, 2024. Use statusDetail instead.| |statusDetail|[cloudPcStatusDetail](../resources/cloudpcstatusdetail.md)|Indicates the detailed status associated with Cloud PC, including error/warning code, error/warning message, additionalInformation. For example, `{ "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }`. | |connectionSetting|[cloudPcConnectionSetting](../resources/cloudpcconnectionsetting.md)|The connection setting of the Cloud PC. Possible values: `enableSingleSignOn`. Read Only.| Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled in In |unknown|The Cloud PC status is unknown.| ### cloudPcStatus values-The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `movingRegion`, `resizePendingLicense`, `modifyingSingleSignOn`. +The following table lists the members of an [evolvable enumeration](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `movingRegion`, `resizePendingLicense`, `modifyingSingleSignOn`, `preparing`. |Member|Description| |:|:| The following table lists the members of an [evolvable enumeration](/graph/best- |movingRegion|Indicates that the Cloud PC is being moved from one region to another.| |resizePendingLicense|Indicates that the Cloud PC resize process was initiated but can't be completed because the target license hasn't been identified. It's currently awaiting customer action to resolve the licensing issue.| |modifyingSingleSignOn|Indicates that the Cloud PC is updating the single sign on setting.|+|preparing|Indicates that the Cloud PC is preparing with IT admin defined configuration (Applications, Configuration and Security), appears after provisioning status.ΓÇï Only apply to Frontline Shared devices.| ### frontlineCloudPcAccessState values |Member|Description| |:|:| |unassigned|Set to unassigned if the Cloud PC doesn't consume any shared-use licenses. The default value is `unassigned`.|-|noLicensesAvailable|Indicates that all shared-use licenses are in use.| +|noLicensesAvailable (deprecated)|Indicates that all shared-use licenses are in use. The `noLicensesAvailable` member is deprecated and will stop returning on September 30, 2024.| |activationFailed|Indicates that the frontline Cloud PC activation failed after the user requested a frontline Cloud PC.| |active|Indicates that the frontline Cloud PC is in an active state with a shared-use license assigned, and the user can connect to the Cloud PC.| |activating|Indicates that a user requested to connect the Cloud PC and the service is starting.| |standbyMode|Indicates that the frontline Cloud PC is in a standby state before it's shut down and deallocated. A frontline Cloud PC in a standby state is still accessible by the user.| |unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| -### shiftWorkCloudPcAccessState values (deprecated) -The following table lists the members of an [evolvable enumeration](#shiftworkcloudpcaccessstate-values-deprecated). You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `standbyMode`. --|Member|Description| -|:|:| -|unassigned|Set to unassigned if the Cloud PC isn't consuming any shared-use licenses. The default value is `unassigned`.| -|noLicensesAvailable|Indicates that all shared-use licenses are in use.| -|activationFailed|Indicates that the shift work Cloud PC activation failed after the user requested a shift work Cloud PC.| -|active|Indicates that the shift work Cloud PC is in an active state with a shared-use license assigned, and the user can connect to the Cloud PC.| -|activating|Indicates that a user requested to connect the Cloud PC and the service is starting.| -|waitlisted (deprecated)|Indicates that the shift work Cloud PC is in a waitlisted state after the user requests to connect this Cloud PC and all shared use licenses are being actively used. This value is deprecated and will stop returning on May 17, 2023. | -|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| -|standbyMode|Indicates that the shift work Cloud PC is in a standby state before it's shut down and deallocated. A shift work Cloud PC in standby state is still accessible by the user.| - ## Relationships None. |
v1.0 | Cloudpcautopilotconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcautopilotconfiguration.md | + + Title: "cloudPcAutopilotConfiguration resource type" +description: "Represents specific settings for Windows Autopilot that enable Windows 365 customers to experience it on Cloud PC." ++ms.localizationpriority: medium ++++# cloudPcAutopilotConfiguration resource type ++Namespace: microsoft.graph +++Represents specific settings for Windows Autopilot that enable Windows 365 customers to experience it on Cloud PC. ++## Properties ++|Property|Type|Description| +|:|:|:| +|applicationTimeoutInMinutes|Int32|Indicates the number of minutes allowed for the Autopilot application to apply the device preparation profile (DPP) configurations to the device. If the Autopilot application doesn't finish within the specified time (**applicationTimeoutInMinutes**), the application error is added to the **statusDetail** property of the [cloudPC](../resources/cloudpc.md) object. The supported value is an integer between 10 and 360. Required.| +|devicePreparationProfileId|String|The unique identifier (ID) of the Autopilot device preparation profile (DPP) that links a Windows Autopilot device preparation policy to ensure that devices are ready for users after provisioning. Required.| +|onFailureDeviceAccessDenied|Boolean|Indicates whether the access to the device is allowed when the application of Autopilot device preparation profile (DPP) configurations fails or times out. If `true`, the **status** of the device is `failed` and the device is unable to access; otherwise, the **status** of the device is `provisionedWithWarnings` and the device is allowed to access. The default value is `false`. Required.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudPcAutopilotConfiguration" +} +--> ++``` json +{ + "@odata.type": "#microsoft.graph.cloudPcAutopilotConfiguration", + "applicationTimeoutInMinutes": "Int32", + "devicePreparationProfileId": "String (identifier)", + "onFailureDeviceAccessDenied": "Boolean" +} +``` |
v1.0 | Cloudpcbulkcreatesnapshot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkcreatesnapshot.md | + + Title: "cloudPcBulkCreateSnapshot resource type" +description: "Represents an entity that performs a bulk create snapshot action." ++ms.localizationpriority: medium ++++# cloudPcBulkCreateSnapshot resource type ++Namespace: microsoft.graph +++Represents the entity that performs a bulk create Cloud PC snapshot action. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|The run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|The IDs of the Cloud PCs the bulk action applies to. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|createdDateTime|DateTimeOffset|The date and time when the bulk action was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|displayName|String|Name of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|id|String|The ID of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|initiatedByUserPrincipalName|String|The user principal name (UPN) of the user who initiated this bulk action. Read-only. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| +|scheduledDuringMaintenanceWindow|Boolean|Indicates whether the bulk action is scheduled according to the maintenance window. When `true`, the bulk action uses the maintenance window to schedule the action; `false` means that the bulk action doesn't use the maintenance window. The default value is `false`. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| +|status|[cloudPcBulkActionStatus](../resources/cloudpcbulkaction.md#cloudpcbulkactionstatus-values)|The status of the bulk actions. Possible values are `pending`, `succeeded`, `failed`, `unknownFutureValue`. The default value is `pending`. Read-only. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudPcBulkCreateSnapshot", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkCreateSnapshot", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)", + "initiatedByUserPrincipalName": "String", + "scheduledDuringMaintenanceWindow": "Boolean", + "status": "String" +} +``` |
v1.0 | Cloudpcbulkmove | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulkmove.md | + + Title: "cloudPcBulkMove resource type" +description: "Represents a bulk move action." ++ms.localizationpriority: medium ++++# cloudPcBulkMove resource type ++Namespace: microsoft.graph +++Represents a bulk move action. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|Run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|The IDs of the Cloud PCs to which the bulk action applies. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|createdDateTime|DateTimeOffset|The date and time when the bulk action was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|displayName|String|The name of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|id|String|The ID of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|initiatedByUserPrincipalName|String|The user principal name (UPN) of the user who initiated this bulk action. Read-only. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| +|scheduledDuringMaintenanceWindow|Boolean|Indicates whether the bulk action is scheduled according to the maintenance window. When `true`, the bulk action uses the maintenance window to schedule the action; `false` means that the bulk action doesn't use the maintenance window. The default value is `false`. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| +|status|[cloudPcBulkActionStatus](../resources/cloudpcbulkaction.md#cloudpcbulkactionstatus-values)|The status of bulk actions. Possible values are `pending`, `succeeded`, `failed`, `unknownFutureValue`. The default value is `pending`. Read-only. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudPcBulkMove", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkMove", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)", + "initiatedByUserPrincipalName": "String", + "scheduledDuringMaintenanceWindow": "Boolean", + "status": "String" +} +``` |
v1.0 | Cloudpcbulksetreviewstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcbulksetreviewstatus.md | + + Title: "cloudPcBulkSetReviewStatus resource type" +description: "Represents the entity that performs a bulk set review status action." ++ms.localizationpriority: medium ++++# cloudPcBulkSetReviewStatus resource type ++Namespace: microsoft.graph +++Represents the entity that sets the review status on Cloud PCs in bulk. ++Inherits from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|actionSummary|[cloudPcBulkActionSummary](../resources/cloudpcbulkactionsummary.md)|The run summary of this bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|cloudPcIds|String collection|The IDs of the Cloud PCs the bulk action applies to. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|createdDateTime|DateTimeOffset|The date and time when the bulk action was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|displayName|String|Name of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|id|String|The ID of the bulk action. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md). | +|initiatedByUserPrincipalName|String|The user principal name (UPN) of the user who initiated this bulk action. Read-only. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| +|scheduledDuringMaintenanceWindow|Boolean|Indicates whether the bulk action is scheduled according to the maintenance window. When `true`, the bulk action uses the maintenance window to schedule the action; `false` means that the bulk action doesn't use the maintenance window. The default value is `false`. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| +|status|[cloudPcBulkActionStatus](../resources/cloudpcbulkaction.md#cloudpcbulkactionstatus-values)|The status of bulk actions. Possible values are `pending`, `succeeded`, `failed`, `unknownFutureValue`. The default value is `pending`. Read-only. Inherited from [cloudPcBulkAction](../resources/cloudpcbulkaction.md).| +|reviewStatus|[cloudPcReviewStatus](../resources/cloudpcreviewstatus.md)|The new review status of the Cloud PC. Read-only.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudPcBulkSetReviewStatus", + "baseType": "microsoft.graph.cloudPcBulkAction", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudPcBulkSetReviewStatus", + "actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"}, + "cloudPcIds": ["String"], + "createdDateTime": "String (timestamp)", + "displayName": "String", + "id": "String (identifier)", + "initiatedByUserPrincipalName": "String", + "scheduledDuringMaintenanceWindow": "Boolean", + "status": "String", + "reviewStatus": { + "inReview": "Boolean", + "userAccessLevel": "String", + "azureStorageAccountId": "String" + } +} +``` |
v1.0 | Cloudpccrossregiondisasterrecoverysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpccrossregiondisasterrecoverysetting.md | + + Title: "cloudPcCrossRegionDisasterRecoverySetting resource type" +description: "Represents the settings for cross-region disaster recovery on a Cloud PC." ++ms.localizationpriority: medium ++toc. Title: Cloud PC cross-region disaster recovery setting +++# cloudPcCrossRegionDisasterRecoverySetting resource type ++Namespace: microsoft.graph +++Represents the settings for cross-region disaster recovery on a Cloud PC. ++## Properties ++|Property|Type|Description| +|:|:|:| +|crossRegionDisasterRecoveryEnabled|Boolean|`True` if an end user is allowed to set up cross-region disaster recovery for Cloud PC; otherwise, `false`. The default value is `false`.| +|disasterRecoveryNetworkSetting|[cloudPcDisasterRecoveryNetworkSetting](../resources/cloudpcdisasterrecoverynetworksetting.md)|Indicates the network settings of the Cloud PC during a cross-region disaster recovery operation.| +|maintainCrossRegionRestorePointEnabled|Boolean|Indicates whether Windows 365 maintain the cross-region disaster recovery function generated restore points. If `true`, the Windows 365 stored restore points; `false` indicates that Windows 365 doesn't generate or keep the restore point from the original Cloud PC. If a disaster occurs, the new Cloud PC can only be provisioned using the initial image. This limitation can result in the loss of some user data on the original Cloud PC. The default value is `false`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudPcCrossRegionDisasterRecoverySetting" +} +--> ++``` json +{ + "@odata.type": "#microsoft.graph.cloudPcRestorePointSetting", + "crossRegionDisasterRecoveryEnabled": "Boolean", + "disasterRecoveryNetworkSetting": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryNetworkSetting"}, + "maintainCrossRegionRestorePointEnabled": "Boolean" +} +``` |
v1.0 | Cloudpcdeviceimage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcdeviceimage.md | Represents the image resource on a Cloud PC. |operatingSystem|String|The operating system of the image. For example, `Windows 10 Enterprise`. Read-only.| |osBuildNumber|String|The OS build version of the image. For example, `1909`. Read-only.| |osStatus|[cloudPcDeviceImageOsStatus](#cloudpcdeviceimageosstatus-values)|The OS status of this image. Possible values are: `supported`, `supportedWithWarning`, `unknown`, `unknownFutureValue`. The default value is `unknown`. Read-only.|+|osVersionNumber|String|The operating system version of this image. For example, `10.0.22000.296`. Read-only.| |sourceImageResourceId|String|The unique identifier (ID) of the source image resource on Azure. The required ID format is: "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}". Read-only.| |status|[cloudPcDeviceImageStatus](#cloudpcdeviceimagestatus-values)|The status of the image on the Cloud PC. Possible values are: `pending`, `ready`, `failed`, `unknownFutureValue`. Read-only.| |version|String|The image version. For example, `0.0.1` and `1.5.13`. Read-only.| The following JSON representation shows the resource type. "operatingSystem": "String", "osBuildNumber": "String", "osStatus": "String",+ "osVersionNumber": "String", "sourceImageResourceId": "String", "status": "String", "statusDetails": "String", |
v1.0 | Cloudpcdisasterrecoveryazureconnectionsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcdisasterrecoveryazureconnectionsetting.md | + + Title: "cloudPcDisasterRecoveryAzureConnectionSetting resource type" +description: "Represents the Azure network connection configuration of backup Cloud PCs provisioned for cross-region disaster recovery." ++ms.localizationpriority: medium ++++# cloudPcDisasterRecoveryAzureConnectionSetting resource type ++Namespace: microsoft.graph +++Represents the Azure network connection configuration of backup Cloud PCs provisioned for cross-region disaster recovery. ++Inherits from [cloudPcDisasterRecoveryNetworkSetting](../resources/cloudpcdisasterrecoverynetworksetting.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|onPremisesConnectionId|String|Indicates the unique ID of the virtual network that the new Cloud PC joins.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudPcDisasterRecoveryAzureConnectionSetting" +} +--> ++``` json +{ + "@odata.type": "#microsoft.graph.cloudPcDisasterRecoveryAzureConnectionSetting", + "onPremisesConnectionId": "String" +} +``` |
v1.0 | Cloudpcdisasterrecoverymicrosofthostednetworksetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcdisasterrecoverymicrosofthostednetworksetting.md | + + Title: "cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting resource type" +description: "Represents the configuration of Microsoft-hosted network for backup Cloud PCs provisioned for cross-region disaster recovery." ++ms.localizationpriority: medium ++++# cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting resource type ++Namespace: microsoft.graph +++Represents the configuration of Microsoft-hosted network for backup Cloud PCs provisioned for cross-region disaster recovery. ++Inherits from [cloudPcDisasterRecoveryNetworkSetting](../resources/cloudpcdisasterrecoverynetworksetting.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|regionGroup|[cloudPcRegionGroup](../resources/cloudpcsupportedregion.md#cloudpcregiongroup-values)|Indicates the logic geographic group this region belongs to. Multiple regions can belong to one region group. When a region group is configured for disaster recovery, the new Cloud PC is assigned to one of the regions within the group based on resource availability. For example, the `europeUnion` region group contains the North Europe and West Europe regions. Possible values are: `default`, `australia`, `canada`, `usCentral`, `usEast`, `usWest`, `france`, `germany`, `europeUnion`, `unitedKingdom`, `japan`, `asia`, `india`, `southAmerica`, `euap`, `usGovernment`, `usGovernmentDOD`, `unknownFutureValue`, `norway`, `switzerland`,`southKorea`, `middleEast`, `mexico`. 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): `norway`, `switzerland`,`southKorea`, `middleEast`, `mexico`.| +|regionName|String|Indicates the Azure region that the new Cloud PC is assigned to. The Windows 365 service creates and manages the underlying virtual network.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting" +} +--> ++``` json +{ + "@odata.type": "#microsoft.graph.cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting", + "regionGroup": "String", + "regionName": "String" +} +``` |
v1.0 | Cloudpcdisasterrecoverynetworksetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcdisasterrecoverynetworksetting.md | + + Title: "cloudPcDisasterRecoveryNetworkSetting resource type" +description: "An abstract type that represents the network configuration of backup Cloud PCs provisioned for cross-region disaster recovery." ++ms.localizationpriority: medium ++++# cloudPcDisasterRecoveryNetworkSetting resource type ++Namespace: microsoft.graph +++An abstract type that represents the network configuration of backup Cloud PCs provisioned for cross-region disaster recovery. ++Base type of [cloudPcDisasterRecoveryAzureConnectionSetting](../resources/cloudpcdisasterrecoveryazureconnectionsetting.md) and [cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting](../resources/cloudpcdisasterrecoverymicrosofthostednetworksetting.md) ++## Properties ++None. ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudPcDisasterRecoveryNetworkSetting" +} +--> ++``` json +{ + "@odata.type": "#microsoft.graph.cloudPcDisasterRecoveryNetworkSetting" +} +``` |
v1.0 | Cloudpcexportjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcexportjob.md | Represents the export job for downloading a specified Cloud PC report. | filter | String | The filter applied on the report. | | format | String | The format of the exported report. | | id | String | The unique identifier for the report. Read-only. |-| reportName | [cloudPcReportName](#cloudpcreportname-values) | The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `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`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`.| +| reportName | [cloudPcReportName](#cloudpcreportname-values) | The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `actionStatusReport`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`, `bulkActionStatusReport`. 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`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`.| | requestDateTime | DateTimeOffset | The date and time when the export job was requested. | | select | String collection | The selected columns of the report. | Represents the export job for downloading a specified Cloud PC report. | noLicenseAvailableConnectivityFailureReport | The Cloud PCs that failed to connect because no licenses were available. | | frontlineLicenseUsageReport | The daily/hourly aggregated Windows 365 Frontline license usage report. | | frontlineLicenseUsageRealTimeReport | The real-time data for Windows 365 Frontline license usage. |-| remoteConnectionQualityReports | The overall connection quality report for all devices within a tenant. | +| remoteConnectionQualityReports (deprecated) | The overall connection quality report for all devices within a tenant. Starting from December 31, 2024, this member ('remoteConnectionQualityReports') will be deprecated and no longer supported. Please use 'remoteConnectionQualityReport' instead. | | inaccessibleCloudPcReports | The Cloud PCs that are inaccessible. |+| actionStatusReport | The actions status report for the Cloud PCs. | | rawRemoteConnectionReports | The raw real-time remote connection report. | | cloudPcUsageCategoryReports | The usage category reports of Cloud PCs. | | crossRegionDisasterRecoveryReport | The cross-region disaster recovery status for Cloud PCs. |-+| regionalConnectionQualityTrendReport | The regional connection quality trend reports of Cloud PCs. | +| regionalConnectionQualityInsightsReport | The regional connection quality insights reports of Cloud PCs. | +| remoteConnectionQualityReport | The overall connection quality reports for all devices under a tenant. | +| bulkActionStatusReport | The details of Cloud PC bulk actions, including bulk action status, name, type, state, completion state, and request date time. | ## Relationships None. |
v1.0 | Cloudpcgalleryimage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcgalleryimage.md | Represents the gallery image resource of the current organization that can be us |expirationDate|Date|The date when the image is no longer available. Users are unable to provision new Cloud PCs if the current time is later than **expirationDate**. The value is usually **endDate** plus six months. For example, if the **startDate** is `2025-10-14`, the **expirationDate** is usually `2026-04-14`. Read-only.| |id|String|The unique identifier (ID) of the gallery image resource on Cloud PC. The ID format is {publisherName_offerName_skuName}. For example, `MicrosoftWindowsDesktop_windows-ent-cpc_win11-22h2-ent-cpc-m365`. You can find the **publisherName**, **offerName**, and **skuName** in the Azure Marketplace. Read-only.| |offerName|String|The offer name of this gallery image that is passed to ARM to retrieve the image resource. Read-only.|+|osVersionNumber|String|The operating system version of this gallery image. For example, `10.0.22000.296`. Read-only.| |publisherName|String|The publisher name of this gallery image that is passed to ARM to retrieve the image resource. Read-only.| |sizeInGB|Int32|Indicates the size of this image in gigabytes. For example, `64`. Read-only.| |skuName|String|The SKU name of this image that is passed to ARM to retrieve the image resource. Read-only.| The following JSON representation shows the resource type. "offer": "String", "offerDisplayName": "String", "offerName": "String",+ "osVersionNumber": "String", "publisher": "String", "publisherName": "String", "recommendedSku": "String", |
v1.0 | Cloudpcnotificationsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcnotificationsetting.md | + + Title: "cloudPcNotificationSetting resource type" +description: "Represents specific settings of notification prompt." ++ms.localizationpriority: medium ++++# cloudPcNotificationSetting resource type ++Namespace: microsoft.graph +++Represents the settings of a point-in-time restore of a Cloud PC. ++## Properties ++|Property|Type|Description| +|:|:|:| +|restartPromptsDisabled|Boolean|If `true`, doesn't prompt the user to restart the Cloud PC. If `false`, prompts the user to restart Cloud PC. The default value is `false`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.cloudPcNotificationSetting" +} +--> ++``` json +{ + "@odata.type": "#microsoft.graph.cloudPcNotificationSetting", + "restartPromptsDisabled": "Boolean" +} +``` |
v1.0 | Cloudpconpremisesconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpconpremisesconnection.md | Represents a defined collection of Azure resource information that can be used t |displayName|String|The display name for the Azure network connection.| |healthCheckStatus|[cloudPcOnPremisesConnectionStatus](#cloudpconpremisesconnectionstatus-values)|The status of the most recent health check done on the Azure network connection. For example, if the status is `passed`, the Azure network connection passed all checks run by the service. Possible values are: `pending`, `running`, `passed`, `failed`, `warning`, `informational`, `unknownFutureValue`. Read-only.| |healthCheckStatusDetails|[cloudPcOnPremisesConnectionStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md)|The details of the connection's health checks and the corresponding results. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.|-|healthCheckStatusDetails (deprecated)|[cloudPcOnPremisesConnectionStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md)|Indicates the health checks for the connection and their respective results. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only. The **healthCheckStatusDetails** property is deprecated and stopped returning data on January 31, 2024. Goind forward, use the **healthCheckStatusDetail** property.| +|healthCheckStatusDetails (deprecated)|[cloudPcOnPremisesConnectionStatusDetails](../resources/cloudpconpremisesconnectionstatusdetails.md)|Indicates the health checks for the connection and their respective results. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only. The **healthCheckStatusDetails** property is deprecated and stopped returning data on January 31, 2024. Going forward, use the **healthCheckStatusDetail** property.| |healthCheckStatusDetail|[cloudPcOnPremisesConnectionStatusDetail](../resources/cloudpconpremisesconnectionstatusdetail.md)|Indicates the results of health checks performed on the on-premises connection. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.| |id|String|Unique identifier for the Azure network connection. Read-only.| |inUse|Boolean|When `true`, the Azure network connection is in use. When `false`, the connection isn't in use. You can't delete a connection thatΓÇÖs in use. Returned only on `$select`. For an example that shows how to get the **inUse** property, see [Example 2: Get the selected properties of an Azure network connection, including healthCheckStatusDetails](../api/cloudpconpremisesconnection-get.md). Read-only.|-|managedBy|[cloudPcManagementService](#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `rpaBox`. Read-only.| -|organizationalUnit|String|The organizational unit (OU) in which the computer account is created. If left null, the OU thatΓÇÖs configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.| +|inUseByCloudPc|Boolean| Indicates whether a Cloud PC is using this on-premises network connection. `true` if at least one Cloud PC is using it. Otherwise, `false`. Read-only. Default is false. | +|healthCheckPaused|Boolean| `false` if the regular health checks on the network/domain configuration are currently active. `true` if the checks are paused. If you perform a create or update operation on a **onPremisesNetworkConnection** resource, this value is set to `false` for 4 weeks. If you retry a health check on network/domain configuration, this value is set to `false` for two weeks. If the **onPremisesNetworkConnection** resource is attached in a **provisioningPolicy** or used by a Cloud PC in the past 4 weeks, `healthCheckPaused` is set to `false`. Read-only. Default is `false`.| +|managedBy|[cloudPcManagementService](#cloudpcmanagementservice-values)|Specifies which services manage the Azure network connection. Possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `rpaBox`. Read-only.| +|organizationalUnit|String|The organizational unit (OU) in which the computer account is created. If left null, the OU configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.| |organizationalUnit|String|The organizational unit (OU) in which the computer account is created. If left null, the OU configured as the default (a well-known computer object container) in your Active Directory domain (OU) is used. Optional.| |virtualNetworkId|String|The ID of the target virtual network. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}`.| |virtualNetworkLocation|String|Indicates the resource location of the virtual target network. Read-only, computed value.| Represents a defined collection of Azure resource information that can be used t |subnetId|String|The ID of the target subnet. Required format: `/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkId}/subnets/{subnetName}`.| |subscriptionId|String|The ID of the target Azure subscription associated with your tenant.| |subscriptionName|String|The name of the target Azure subscription. Read-only.|-|type (deprecated)|[cloudPcOnPremisesConnectionType](../resources/cloudpconpremisesconnection.md#cloudpconpremisesconnectiontype-values)|Specifies the method by which a provisioned Cloud PC is joined to Microsoft Entra. The `azureADJoin` option indicates the absence of an on-premises Active Directory (AD) in the current tenant that results in the Cloud PC device only joining to Microsoft Entra. The `hybridAzureADJoin` option indicates the presence of an on-premises AD in the current tenant and that the Cloud PC joins both the on-premises AD and Microsoft Entra. The selected option also determines the types of users who can be assigned and can sign into a Cloud PC. The `azureADJoin` option allows both cloud-only and hybrid users to be assigned and sign in, whereas `hybridAzureADJoin` is restricted to hybrid users only. The default value is `hybridAzureADJoin`. The possible values are: `hybridAzureADJoin`, `azureADJoin`, `unknownFutureValue`. The **type** property is deprecated and stopped returning data on January 31, 2024. Goind forward, use the **connectionType** property.| +|type (deprecated)|[cloudPcOnPremisesConnectionType](../resources/cloudpconpremisesconnection.md#cloudpconpremisesconnectiontype-values)|Specifies the method by which a provisioned Cloud PC is joined to Microsoft Entra. The `azureADJoin` option indicates the absence of an on-premises Active Directory (AD) in the current tenant that results in the Cloud PC device only joining to Microsoft Entra. The `hybridAzureADJoin` option indicates the presence of an on-premises AD in the current tenant and that the Cloud PC joins both the on-premises AD and Microsoft Entra. The selected option also determines the types of users who can be assigned and can sign into a Cloud PC. The `azureADJoin` option allows both cloud-only and hybrid users to be assigned and sign in, whereas `hybridAzureADJoin` is restricted to hybrid users only. The default value is `hybridAzureADJoin`. The possible values are: `hybridAzureADJoin`, `azureADJoin`, `unknownFutureValue`. The **type** property is deprecated and stopped returning data on January 31, 2024. Going forward, use the **connectionType** property.| ### cloudPcManagementService values Represents a defined collection of Azure resource information that can be used t |Member|Description| |:|:| |failed|Health checks notify the customer that the Azure network connection isn't properly configured or functioning. Provisioning fails. The customer needs to identify the issue and resolve it using the guidance provided by Azure network connection for provisioning to be successful.|-|informational|Health checks provide information to the customer about current or associated prerequisite checks on Cloud PC add-on features such as Single Sign-On. This won't affect the provisioning of the customer's Cloud PC, but the information is intended to optimize the user experience.| +|informational|Health checks provide information to the customer about current or associated prerequisite checks on Cloud PC add-on features such as Single Sign-On. Informational health checks don't affect the provisioning of the customer's Cloud PC. The information is intended to optimize the user experience.| |passed|Health checks notify the customer that the Azure network connection is operating as intended. Customer can provision their Cloud PC without any issue.| |pending|Created and waiting for health checks.| |running|Health checks are running.| The following JSON representation shows the resource type. "healthCheckStatusDetails": { "@odata.type": "microsoft.graph.cloudPcOnPremisesConnectionStatusDetails" }, "id": "String (identifier)", "inUse": "Boolean",+ "inUseByCloudPc": "Boolean", + "healthCheckPaused": "Boolean", "managedBy": "String", "organizationalUnit": "String", "resourceGroupId": "String", |
v1.0 | Cloudpcprovisioningpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcprovisioningpolicy.md | Represents a Cloud PC provisioning policy. |:|:|:| |alternateResourceUrl|String|The URL of the alternate resource that links to this provisioning policy. Read-only.| |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`. Supports `$select`.|+|autopilotConfiguration|[cloudPcAutopilotConfiguration](../resources/cloudpcautopilotconfiguration.md)|The specific settings for Windows Autopilot that enable Windows 365 customers to experience it on Cloud PC. Supports `$select`.| |cloudPcGroupDisplayName|String|The display name of the Cloud PC group that the Cloud PCs reside in. Read-only.| |cloudPcNamingTemplate|String|The template used to name Cloud PCs provisioned using this policy. The template can contain custom text and replacement tokens, including `%USERNAME:x%` and `%RAND:x%`, which represent the user's name and a randomly generated number, respectively. For example, `CPC-%USERNAME:4%-%RAND:5%` means that the name of the Cloud PC starts with `CPC-`, followed by a four-character username, a `-` character, and then five random characters. The total length of the text generated by the template can't exceed 15 characters. Supports `$filter`, `$select`, and `$orderby`.| |description|String|The provisioning policy description. Supports `$filter`, `$select`, and `$orderBy`. | The following JSON representation shows the resource type. "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy", "alternateResourceUrl": "String", "autopatch": {"@odata.type": "microsoft.graph.cloudPcProvisioningPolicyAutopatch"},+ "autopilotConfiguration": {"@odata.type": "microsoft.graph.cloudPcAutopilotConfiguration"}, "cloudPcGroupDisplayName": "String", "cloudPcNamingTemplate": "String", "description": "String", |
v1.0 | Cloudpcreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcreports.md | Use a method in the [Methods](#methods) section to get the corresponding report ## Methods |Method|Return type|Description| |:|:|:|-|[getActionStatusReports](../api/cloudpcreports-getactionstatusreports.md)|Stream|Get the remote action status reports, including data such as the Cloud PC ID, Cloud PC device display name, initiating user's principal name, device owner's user principal name, action taken, and action state.| -|[getCloudPcRecommendationReports](../api/cloudpcreports-getcloudpcrecommendationreports.md)|Stream|Get the device recommendation reports for Cloud PCs, such as the usage category report.| -|[getConnectionQualityReports](../api/cloudpcreports-gettotalaggregatedremoteconnectionreports.md)|Stream|Get the overall connection quality reports for all devices within a current tenant during a given period, including metrics like the average round trip time (P50), average available bandwidth, and UDP connection percentage. Get other real-time metrics such as last connection round trip time, last connection client IP, last connection gateway, and last connection protocol.| -|[getDailyAggregatedRemoteConnectionReports](../api/cloudpcreports-getdailyaggregatedremoteconnectionreports.md)|Stream|Get the daily aggregated remote connection reports like round trip time and available bandwidth in a given period.| -|[getFrontlineReport](../api/cloudpcreports-getfrontlinereport.md)|Stream| Get Frontline Cloud PC license usage reports, such as **servicePlanId**, **licenseCount**, and **claimedLicenseCount**, for real-time, 7 days, or 28 days trend.| -|[getInaccessibleCloudPcReports](../api/cloudpcreports-getinaccessiblecloudpcreports.md)|Stream|Get inaccessible Cloud PCs with details, including the latest health state, failed connection count, failed health check count, and system status.| -|[getRawRemoteConnectionReports](../api/cloudpcreports-getrawremoteconnectionreports.md)|Stream|Get the raw real-time remote connection report for a Cloud PC without any calculation or aggregation.| -|[getRealTimeRemoteConnectionLatency](../api/cloudpcreports-getrealtimeremoteconnectionlatency.md)|Stream|Get the real-time remote connection latency reports like current round trip time and available bandwidth of a Cloud PC.| -|[getRealTimeRemoteConnectionStatus](../api/cloudpcreports-getrealtimeremoteconnectionstatus.md)|Stream|Get the real-time remote connection status reports like sign-in status or days since the last use of a Cloud PC.| -|[getRemoteConnectionHistoricalReports](../api/cloudpcreports-getremoteconnectionhistoricalreports.md)|Stream|Get a Cloud PC's remote connection historical reports, such as **signInDateTime**, **signOutDateTime**, or **usageInHour**, in a given period.| -|[getSharedUseLicenseUsageReport](../api/cloudpcreports-getshareduselicenseusagereport.md) (deprecated) |Stream| Get the shared use license usage reports, such as **servicePlanId**, **licenseCount**, and **claimedLicenseCount**, for real-time, 7 days, or 28 days trend.| -|[getTotalAggregatedRemoteConnectionReports](../api/cloudpcreports-gettotalaggregatedremoteconnectionreports.md)|Stream|Get the total aggregated remote connection reports, like usage and **daysSinceLastUse**, in a given period.| -|[retrieveCrossRegionDisasterRecoveryReport](../api/cloudpcreports-retrievecrossregiondisasterrecoveryreport.md)|Stream| Retrieve the Windows 365 cross-region disaster recovery report with configuration health check results, disaster recovery status, latest cross-region restore points, and user settings.| +|[Get action status reports](../api/cloudpcreports-getactionstatusreports.md)|Stream|Get the remote action status reports, including data such as the Cloud PC ID, Cloud PC device display name, initiating user's principal name, device owner's user principal name, action taken, and action state.| +|[Get bulk action status reports](../api/cloudpcreports-retrievebulkactionstatusreport.md)|Stream|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.| +|[Get Cloud PC recommendation reports](../api/cloudpcreports-getcloudpcrecommendationreports.md)|Stream|Get the device recommendation reports for Cloud PCs, such as the usage category report.| +|[Get frontline report](../api/cloudpcreports-getfrontlinereport.md)|Stream| Get Frontline Cloud PC license usage reports, such as **servicePlanId**, **licenseCount**, and **claimedLicenseCount**, for real-time, 7 days, or 28 days trend.| +|[Get inaccessible Cloud PC reports](../api/cloudpcreports-getinaccessiblecloudpcreports.md)|Stream|Get inaccessible Cloud PCs with details, including the latest health state, failed connection count, failed health check count, and system status.| +|[Get raw remote connection reports](../api/cloudpcreports-getrawremoteconnectionreports.md)|Stream|Get the raw real-time remote connection report for a Cloud PC without any calculation or aggregation.| +|[Get real time remote connection agency reports](../api/cloudpcreports-getrealtimeremoteconnectionlatency.md)|Stream|Get the real-time remote connection latency reports like current round trip time and available bandwidth of a Cloud PC.| +|[Get real-time remote connection status reports](../api/cloudpcreports-getrealtimeremoteconnectionstatus.md)|Stream|Get the real-time remote connection status reports like sign-in status or days since the last use of a Cloud PC.| +|[Get remove connection hitorical reports](../api/cloudpcreports-getremoteconnectionhistoricalreports.md)|Stream|Get a Cloud PC's remote connection historical reports, such as **signInDateTime**, **signOutDateTime**, or **usageInHour**, in a given period.| +|[Get total aggregated remote connection reports](../api/cloudpcreports-gettotalaggregatedremoteconnectionreports.md)|Stream|Get the total aggregated remote connection reports, like usage and **daysSinceLastUse**, in a given period.| +|[Retrieve cross-region disaster recovery report](../api/cloudpcreports-retrievecrossregiondisasterrecoveryreport.md)|Stream| Retrieve the Windows 365 cross-region disaster recovery report with configuration health check results, disaster recovery status, latest cross-region restore points, and user settings.| +|[Retrieve connection quality reports](../api/cloudpcreports-retrieveconnectionqualityreports.md)|Stream|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 dropped connections.| +|[Get daily aggregated remote connection reports](../api/cloudpcreports-getdailyaggregatedremoteconnectionreports.md)|Stream|Get the daily aggregated remote connection reports like round trip time and available bandwidth in a given period.| +|[Get connection quality reports (deprecated)](../api/cloudpcreports-gettotalaggregatedremoteconnectionreports.md)|Stream|Get the overall connection quality reports for all devices within a current tenant during a given period, including metrics like the average round trip time (P50), average available bandwidth, and UDP connection percentage. Also get other real-time metrics such as last connection round trip time, last connection client IP, last connection gateway, and last connection protocol. This API is deprecated and will stop returning data on December 31, 2024. Going forward, use the [retrieveConnectionQualityReports](../api/cloudpcreports-retrieveconnectionqualityreports.md) API.| +|[Get shared use license usage report (deprecated)](../api/cloudpcreports-getshareduselicenseusagereport.md) |Stream| Get the shared use license usage reports, such as **servicePlanId**, **licenseCount**, and **claimedLicenseCount**, for real-time, 7 days, or 28 days trend.| ## Properties |Property|Type|Description| |
v1.0 | Cloudpcshareduseserviceplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcshareduseserviceplan.md | - Title: "cloudPcSharedUseServicePlan resource type (deprecated)" -description: "Represents a shared-use service plan available for use by up to three Cloud PCs." ---doc_type: resourcePageType ---# cloudPcSharedUseServicePlan resource type (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). --Represents a shared-use service plan available for use by up to three Cloud PCs. --## Methods --|Method|Return type|Description| -|:|:|:| -|[List](../api/virtualendpoint-list-shareduseserviceplans.md)|[cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) collection|Get a list of the [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) objects and their properties.| -|[Get](../api/cloudpcshareduseserviceplan-get.md)|[cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md)|Read the properties and relationships of a [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) object.| --## Properties --| Property | Type | Description | -|:|:-|:--| -| displayName | String | The display name of the shared-use service plan. | -| id | String | The unique identifier for the shared-use service plan. | -| totalCount | Int32 | Total number of shared-use service plans purchased by the customer. | -| usedCount | Int32 | The number of service plans that the account uses. | --## Relationships --None. --## JSON representation --The following JSON representation shows the resource type. --<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.cloudPcSharedUseServicePlan", - "baseType": "microsoft.graph.entity", - "openType": false -} >-``` json -{ - "@odata.type": "#microsoft.graph.cloudPcSharedUseServicePlan", - "displayName": "String", - "id": "String (identifier)", - "usedCount": "Int32", - "totalCount": "Int32" -} -``` |
v1.0 | Cloudpcsnapshot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcsnapshot.md | Inherits from [entity](../resources/entity.md). ## Methods |Method|Return type|Description| |:|:|:|-|[List](../api/virtualendpoint-list-snapshots.md)|[cloudPcSnapshot](../resources/cloudpcsnapshot.md) collection|Get a list of the [cloudPcSnapshot](../resources/cloudpcsnapshot.md) objects and their properties.| |[Get](../api/cloudpcsnapshot-get.md)|[cloudPcSnapshot](../resources/cloudpcsnapshot.md)|Read the properties and relationships of a [cloudPcSnapshot](../resources/cloudpcsnapshot.md) object.|+|[List (deprecated)](../api/virtualendpoint-list-snapshots.md)|None|Get a list of the [cloudPcSnapshot](../resources/cloudpcsnapshot.md) objects and their properties. This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the [cloudPcRetrieveSnapshots](../api/cloudpc-retrievesnapshots.md) API.| ## Properties |Property|Type|Description| Inherits from [entity](../resources/entity.md). |Member|Description| |:|:| |ready|The snapshot is ready to restore the Cloud PC device.|-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| ### cloudPcSnapshotType values | Member | Description | | -- | -- |-| `automatic` | The snapshot is created automaticaly. | +| `automatic` | The snapshot is created automatically. | | `manual` | The snapshot is created manually. |-| `unknownFutureValue` | Evolvable enumeration sentinel value. Do not use. | +| `unknownFutureValue` | Evolvable enumeration sentinel value. Don't use. | ## Relationships None. |
v1.0 | Cloudpcsupportedregion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcsupportedregion.md | Represents a supported region to establish an Azure network connection for Cloud |: |: |: | |displayName|String|The name for the supported region. Read-only.| |id|String|The unique identifier for the supported region. Read-only.|-|regionGroup|[cloudPcRegionGroup](#cloudpcregiongroup-values)|The geographic group this region belongs to. Multiple regions can belong to one region group. For example, the `europeUnion` region group contains the Northern Europe and Western Europe regions. A customer can select a region group when provisioning a Cloud PC; however, the Cloud PC is put under one of the regions under the group based on resource capacity. The region with more quota is chosen. Possible values are: `default`, `australia`, `canada`, `usCentral`, `usEast`, `usWest`, `france`, `germany`, `europeUnion`, `unitedKingdom`, `japan`, `asia`, `india`, `southAmerica`, `euap`, `usGovernment`, `usGovernmentDOD`, `unknownFutureValue`, `norway`, `switzerland`,`southKorea`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `norway`, `switzerland`,`southKorea`. Read-only.| +|regionGroup|[cloudPcRegionGroup](#cloudpcregiongroup-values)|The geographic group this region belongs to. Multiple regions can belong to one region group. For example, the `europeUnion` region group contains the Northern Europe and Western Europe regions. A customer can select a region group when provisioning a Cloud PC; however, the Cloud PC is put under one of the regions under the group based on resource capacity. The region with more quota is chosen. Possible values are: `default`, `australia`, `canada`, `usCentral`, `usEast`, `usWest`, `france`, `germany`, `europeUnion`, `unitedKingdom`, `japan`, `asia`, `india`, `southAmerica`, `euap`, `usGovernment`, `usGovernmentDOD`, `unknownFutureValue`, `norway`, `switzerland`,`southKorea`, `middleEast`, `mexico`. 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): `norway`, `switzerland`,`southKorea`, `middleEast`, `mexico`. Read-only.| |regionStatus|[cloudPcSupportedRegionStatus](#cloudpcsupportedregionstatus-values)|The status of the supported region. Possible values are: `available`, `restricted`, `unavailable`, `unknownFutureValue`. Read-only.| |supportedSolution|[cloudPcManagementService](../resources/cloudpconpremisesconnection.md#cloudpcmanagementservice-values)|The supported service or solution for the region. The possible values are: `windows365`, `devBox`, `unknownFutureValue`, `rpaBox`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value or values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `rpaBox`. Read-only.| Represents a supported region to establish an Azure network connection for Cloud | norway | The region belongs to the region group: Norway. | | switzerland | The region belongs to the region group: Switzerland. | | southKorea | The region belongs to the region group: South Korea. |+| middleEast | The region belongs to the region group: Middle East. | +| mexico | The region belongs to the region group: Mexico. | ## Relationships |
v1.0 | Cloudpcusersetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcusersetting.md | Represents a Cloud PC user setting. |Property|Type|Description| |:|:|:| |createdDateTime|DateTimeOffset|The date and time the setting was created. The timestamp type represents the date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 looks like this: '2014-01-01T00:00:00Z'. |+|crossRegionDisasterRecoverySetting|[cloudPcCrossRegionDisasterRecoverySetting](../resources/cloudpccrossregiondisasterrecoverysetting.md)|Defines whether the user's Cloud PC enables cross-region disaster recovery and specifies the network for the disaster recovery.| |displayName|String|The setting name displayed in the user interface. | |id|String|Unique identifier for the Cloud PC user setting. Read-only.| |lastModifiedDateTime|DateTimeOffset|The last date and time the setting was modified. The timestamp type represents the date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 looks like this: '2014-01-01T00:00:00Z'. | |localAdminEnabled|Boolean|Indicates whether the local admin option is enabled. Default value is `false`. To enable the local admin option, change the setting to `true`. If the local admin option is enabled, the end user can be an admin of the Cloud PC device. |-|resetEnabled|Boolean|Indicates whether an end user is allowed to reset their Cloud PC. When `true`, the user is allowed to reset their Cloud PC. When `false`, end-user initiated reset is not allowed. The default value is `false`. | +|resetEnabled|Boolean|Indicates whether an end user is allowed to reset their Cloud PC. When `true`, the user is allowed to reset their Cloud PC. When `false`, end-user initiated reset isn't allowed. The default value is `false`. | |restorePointSetting|[cloudPcRestorePointSetting](../resources/cloudpcrestorepointsetting.md)|Defines how frequently a restore point is created that is, a snapshot is taken) for users' provisioned Cloud PCs (default is 12 hours), and whether the user is allowed to restore their own Cloud PCs to a backup made at a specific point in time.| |selfServiceEnabled (deprecated)|Boolean|Indicates whether the self-service option is enabled. Default value is `false`. To enable the self-service option, change the setting to `true`. If the self-service option is enabled, the end user is allowed to perform some self-service operations, such as upgrading the Cloud PC through the end user portal. The **selfServiceEnabled** property is deprecated and will stop returning data on December 1, 2023.|+|notificationSetting|[cloudPcNotificationSetting](../resources/cloudpcnotificationsetting.md)|Defines the setting of the Cloud PC notification prompts for the Cloud PC user.| + ## Relationships |Relationship|Type|Description| The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.cloudPcUserSetting", "createdDateTime": "String (timestamp)",+ "crossRegionDisasterRecoverySetting": {"@odata.type": "microsoft.graph.cloudPcCrossRegionDisasterRecoverySetting"}, "displayName": "String", "id": "String (identifier)", "lastModifiedDateTime": "String (timestamp)", The following JSON representation shows the resource type. "restorePointSetting": { "@odata.type": "microsoft.graph.cloudPcRestorePointSetting" },- "selfServiceEnabled": "Boolean" + "selfServiceEnabled": "Boolean", + "notificationSetting": { + "@odata.type": "microsoft.graph.cloudPcNotificationSetting" + } } ``` |
v1.0 | Cloudpcwindowssetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcwindowssetting.md | +toc. Title: Cloud PC Windows setting # cloudPcWindowsSetting resource type |
v1.0 | Cloudpcwindowssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/cloudpcwindowssettings.md | +toc. Title: Cloud PC Windows settings # cloudPcWindowsSettings resource type |
v1.0 | Community | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/community.md | Inherits from [entity](../resources/entity.md). |[Create](../api/employeeexperience-post-communities.md)|[engagementAsyncOperation](../resources/engagementasyncoperation.md)|Create a new [community](../resources/community.md) in Viva Engage.| |[Get](../api/community-get.md)|[community](../resources/community.md)|Read the properties and relationships of a [community](../resources/community.md) object.| |[Update](../api/community-update.md)|None|Update the properties of an existing Viva Engage [community](../resources/community.md).|-|[Delete](../api/community-delete.md)|None|Delete a [community](../resources/community.md) in Viva Engage.| +|[Delete](../api/community-delete.md)|None|Delete a Viva Engage [community](../resources/community.md) along with all associated Microsoft 365 content, including the connected Microsoft 365 group, OneNote notebook, and Planner plans.| ## Properties |Property|Type|Description| |:|:|:|-| description | String | The description of the community. The maximum length is 1024 characters. | +| description | String | The description of the community. The maximum length is 1,024 characters. | | displayName | String | The name of the community. The maximum length is 255 characters. | | groupId | String | The ID of the [Microsoft 365 group](../resources/group.md) that manages the membership of this community. |-| id | String | The unique identifier of the community. Read only. Inherited from [entity](../resources/entity.md). | +| id | String | The unique identifier of the community. Read-only. Inherited from [entity](../resources/entity.md). | | privacy | [communityPrivacy](../resources/community.md#communityprivacy-values) | Defines the privacy level of the community. The possible values are: `public`, `private`, `unknownFutureValue`. | ### communityPrivacy values |
v1.0 | Companydetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/companydetail.md | Represents information about companies related to entities within their [profile |displayName |String | Company name. | |officeLocation |String | Office Location of the person referred to. | |pronunciation |String | Pronunciation guide for the company name. |+|secondaryDepartment|String | Secondary Department Name within a company. | |webUrl |String | Link to the company home page. | ## JSON representation The following JSON representation shows the resource type. "displayName": "String", "officeLocation": "String", "pronunciation": "String",+ "secondaryDepartment": "String", "webUrl": "String" } ``` |
v1.0 | Connectedorganizationmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/connectedorganizationmembers.md | Title: "connectedOrganizationMembers complex type" + Title: "connectedOrganizationMembers resource type" description: "The connectedOrganizationMembers type identifies a collection of users in the tenant who are allowed as requestor, approver, or reviewer." ms.localizationpriority: medium -# connectedOrganizationMembers complex type +# connectedOrganizationMembers resource type Namespace: microsoft.graph |
v1.0 | Contact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contact.md | by providing a [delta](../api/contact-delta.md) function. ## Methods | Method | Return Type |Description| |:|:--|:-|-|[Get contact](../api/contact-get.md) | [contact](contact.md) |Read properties and relationships of contact object.| -|[Create contact](../api/user-post-contacts.md) | [contact](contact.md) |Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.| -|[Update contact](../api/contact-update.md) | [contact](contact.md) |Update contact object. | -|[Delete contact](../api/contact-delete.md) | None |Delete contact object. | +|[Get](../api/contact-get.md) | [contact](contact.md) |Read properties and relationships of contact object.| +|[Create](../api/user-post-contacts.md) | [contact](contact.md) |Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.| +|[Update](../api/contact-update.md) | [contact](contact.md) |Update contact object. | +|[Delete](../api/contact-delete.md) | None |Delete contact object. | +|[Permanently delete](../api/contact-permanentdelete.md)|None|Permanently delete a contact and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.| |[Get contact delta](../api/contact-delta.md)|[contact](contact.md) collection| Get a set of contacts that have been added, deleted, or updated in a specified folder.| |**Open extensions**| | | |[Create open extension](../api/opentypeextension-post-opentypeextension.md) |[openTypeExtension](opentypeextension.md)| Create an open extension and add custom properties to a new or existing resource.| by providing a [delta](../api/contact-delta.md) function. |assistantName|String|The name of the contact's assistant.| |birthday|DateTimeOffset|The contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |categories|String collection|The categories associated with the contact. Each category corresponds to the **displayName** property of an [outlookCategory](outlookcategory.md) defined for the user.|-|changeKey|String|Identifies the version of the contact. Every time the contact is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.| +|changeKey|String|Identifies the version of the contact. Every time the contact is changed, **changeKey** changes as well, which allows Exchange to apply changes to the correct version of the object.| |children|String collection|The names of the contact's children.| |companyName|String|The name of the contact's company.| |createdDateTime|DateTimeOffset|The time the contact was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |department|String|The contact's department.|-|displayName|String|The contact's display name. You can specify the display name in a [create](../api/user-post-contacts.md) or [update](../api/contact-update.md) operation. Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. To preserve a pre-existing value, always include it as displayName in an [update](../api/contact-update.md) operation.| +|displayName|String|The contact's display name. You can specify the display name in a [create](../api/user-post-contacts.md) or [update](../api/contact-update.md) operation. Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified. To preserve a pre-existing value, always include it as displayName in an [update](../api/contact-update.md) operation.| |emailAddresses|[typedEmailAddress](typedemailaddress.md) collection|The contact's email addresses.| |fileAs|String|The name the contact is filed under.| |flag|[followupFlag](followupflag.md)|The flag value that indicates the status, start date, due date, or completion date for the contact. | |
v1.0 | Contactfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/contactfolder.md | by providing a [delta](../api/contactfolder-delta.md) function. | Method | Return Type |Description| |:|:--|:-|-|[Get contact folder](../api/contactfolder-get.md) | [contactFolder](contactfolder.md) |Get a contact folder by using the contact folder ID.| -|[Update contact folder](../api/contactfolder-update.md) | [contactFolder](contactfolder.md) |Update **contactFolder** object. | -|[Delete contact folder](../api/contactfolder-delete.md) | None |Delete a **contactFolder** object. | +|[Get](../api/contactfolder-get.md) | [contactFolder](contactfolder.md) |Get a contact folder by using the contact folder ID.| +|[Update](../api/contactfolder-update.md) | [contactFolder](contactfolder.md) |Update **contactFolder** object. | +|[Delete](../api/contactfolder-delete.md) | None |Delete a **contactFolder** object. | +|[Permanently delete](../api/contactfolder-permanentdelete.md)|None|Permanently delete a contact folder and remove its items from the user's mailbox.| |[List child folders](../api/contactfolder-list-childfolders.md) |[contactFolder](contactfolder.md) collection| Get a collection of child folders under the specified contact folder.| |[Create child folder](../api/contactfolder-post-childfolders.md) |[contactFolder](contactfolder.md)| Create a new **contactFolder** as a child of a specified folder.|-|[Get contact delta](../api/contact-delta.md)|[contact](contact.md) collection| Get a set of contact folders that have been added, deleted, or removed from the user's mailbox.| +|[Get contact delta](../api/contact-delta.md)|[contact](contact.md) collection| Get a set of contact folders that were added, deleted, or removed from the user's mailbox.| |[List contacts in folder](../api/contactfolder-list-contacts.md) |[contact](contact.md) collection| Get a contact collection from the default contacts folder of the signed-in user (`.../me/contacts`), or from the specified contact folder.| |[Create contact in folder](../api/contactfolder-post-contacts.md) |[contact](contact.md)| Add a contact to the root contacts folder or to the `contacts` endpoint of another contact folder.| |**Extended properties**| | | |
v1.0 | Conversationmember | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/conversationmember.md | - + Title: "conversationMember resource type" description: "Represents a user in a conversation." ms.localizationpriority: medium Base type for the following supported conversation member types: |[Get team member](../api/team-get-members.md) | [conversationMember](conversationmember.md) collection | Get a member in the team.| |[Update team member's role](../api/team-update-members.md)|[conversationMember](../resources/conversationmember.md)|Change a member to an owner or back to a regular member.| |[Remove team member](../api/team-delete-members.md)|None|Remove an existing member from the team.|+|[Remove team members in bulk](../api/conversationmember-remove.md)|[actionResultPart](../resources/actionresultpart.md) collection|Remove multiple members from a team in a single request.| |[List channel members](../api/channel-list-members.md) | [conversationMember](conversationmember.md) collection | Get the list of all members in a channel.| |[Add channel member](../api/channel-post-members.md) | [conversationMember](conversationmember.md) | Add a member to a channel. Only supported for `channel` with membershipType of `private`.| |[Get channel member](../api/channel-get-members.md) | [conversationMember](conversationmember.md) collection | Get a member in a channel.| Base type for the following supported conversation member types: | Property | Type |Description| |:|:--|:-|-|id|String| Read-only. Unique ID of the user.| |displayName| string | The display name of the user. |+|id|String| Read-only. Unique ID of the user.| |roles| string collection | The roles for that user. This property contains additional qualifiers only when relevant - for example, if the member has `owner` privileges, the **roles** property contains `owner` as one of the values. Similarly, if the member is an in-tenant guest, the **roles** property contains `guest` as one of the values. A basic member should not have any values specified in the **roles** property. An Out-of-tenant external member is assigned the `owner` role.| |visibleHistoryStartDateTime| DateTimeOffset | The timestamp denoting how far back a conversation's history is shared with the conversation member. This property is settable only for members of a chat. | The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.conversationMember",- "id": "String (identifier)", - "roles": [ - "String" - ], "displayName": "String",+ "id": "String (identifier)", + "roles": ["String"], "visibleHistoryStartDateTime": "String (timestamp)" } ``` |
v1.0 | Createfromtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/createfromtemplate.md | + + Title: "createFromPageTemplate resource type" +description: "Represents the required fields to create a page from a template in SharePoint." ++ms.localizationpriority: medium ++++# createFromPageTemplate resource type ++Namespace: microsoft.graph +++Represents the required fields to create a page from a template in SharePoint. ++## Properties ++| Property | Type | Description | +| :| :--| :- | +| title | String | The title of the site page template to create. Optional. | +| name | String | The name of the site page template to create. Required. | +| templateId | String | The identifier for an existing page template. Required. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.createFromTemplate", + "baseType": null +}--> ++```json +{ + "title": "String", + "name": "String", + "templateId": "String" +} +``` ++<!-- { + "type": "#page.annotation", + "description": "create from template request body", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> |
v1.0 | Customappmanagementapplicationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customappmanagementapplicationconfiguration.md | + + Title: "customAppManagementApplicationConfiguration resource type" +description: "Custom app management application configuration object that contains properties which can be configured to enable various restrictions specific to applications." ++ms.localizationpriority: medium +++++# customAppManagementApplicationConfiguration resource type ++Namespace: microsoft.graph +++Custom app management application configuration object that contains properties which can be configured to enable various restrictions specific to application objects. ++## Properties ++| Property | Type | Description | +| :- | :-- | :- | +| identifierUris | [identifierUriConfiguration](identifieruriconfiguration.md) | Configuration for identifierUris restrictions | ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customAppManagementApplicationConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customAppManagementApplicationConfiguration", + "identifierUris": { + "@odata.type": "microsoft.graph.identifierUriConfiguration" + } +} +``` + |
v1.0 | Customappmanagementconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customappmanagementconfiguration.md | + + Title: "customAppManagementConfiguration resource type" +description: "Configuration object that contains properties that can be configured to enable various restrictions for applications and service principals as part of an appManagementPolicy object." ++ms.localizationpriority: medium ++++# customAppManagementConfiguration resource type ++Namespace: microsoft.graph +++Configuration object that can be configured to enable various restrictions for applications and service principals as part of the [appManagementPolicy](../resources/appmanagementpolicy.md) object. Some of these restrictions apply to both applications and service principals while others are applicable only to applications. ++Inherits from [appManagementConfiguration](appmanagementconfiguration.md). ++## Properties ++| Property | Type | Description | +| :- | :-- | :- | +| applicationRestrictions | [customAppManagementApplicationConfiguration](customappmanagementapplicationconfiguration.md) | Restrictions applicable only to application objects that the policy applies to. | +| keyCredentials | [keyCredentialConfiguration](keyCredentialConfiguration.md) collection | Collection of keyCredential restrictions settings to be applied to an application or service principal. Inherited from [appManagementConfiguration](appmanagementconfiguration.md). | +| passwordCredentials | [passwordCredentialConfiguration](passwordCredentialConfiguration.md) collection | Collection of password restrictions settings to be applied to an application or service principal. Inherited from [appManagementConfiguration](appmanagementconfiguration.md). | +++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.customAppManagementConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.customAppManagementConfiguration", + "passwordCredentials": [ + { + "@odata.type": "microsoft.graph.passwordCredentialConfiguration" + } + ], + "keyCredentials": [ + { + "@odata.type": "microsoft.graph.keyCredentialConfiguration" + } + ], + "applicationRestrictions": { + "@odata.type": "microsoft.graph.customAppManagementApplicationConfiguration" + } +} +``` + |
v1.0 | Customclaimspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/customclaimspolicy.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a claims policy that allows application admins to customize the claims emitted in tokens affected by this policy. +Represents a claims policy that allows application admins to customize the claims emitted in tokens affected by this policy. Learn more about this policy in the following articles: +- [Customize claims using the custom claims policy (preview)](/entra/identity-platform/claims-customization-custom-claims-policy) +- [Claims customization using a policy](/entr) Inherits from [entity](../resources/entity.md). |
v1.0 | Device | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/device.md | This resource supports: |[List member of](../api/device-list-memberof.md) |[directoryObject](directoryobject.md) collection| List the groups and administrative units that the device is a direct member of. | |[List transitive member of](../api/device-list-transitivememberof.md) |[directoryObject](directoryobject.md) collection| List the groups and administrative units that the device is a member of. This operation is transitive. | |[List registered owners](../api/device-list-registeredowners.md) |[directoryObject](directoryobject.md) collection| Get the users that are registered owners of the device from the registeredOwners navigation property.|+|[Add registered owners](../api/device-post-registeredowners.md) |[directoryObject](directoryobject.md) collection| Add registered owners of the device.| +|[Remove registered owners](../api/device-delete-registeredowners.md) |[directoryObject](directoryobject.md) collection| Delete registered owners from the device.| |[List registered users](../api/device-list-registeredusers.md) |[directoryObject](directoryobject.md) collection| Get the registered users of the device from the registeredUsers navigation property.|+|[Add registered users](../api/device-post-registeredusers.md) |[directoryObject](directoryobject.md) collection| Add registered users of the device .| +|[Remove registered users](../api/device-delete-registeredusers.md) |[directoryObject](directoryobject.md) collection| Remove registered users from the device .| |[List usage rights](../api/device-list-usagerights.md) | [usageRight](usageright.md) collection | Get a collection of usage rights granted to the device.| | [Check member groups](../api/directoryobject-checkmembergroups.md) | String collection | Check for membership in a list of groups. The check is transitive. | | [Get member groups](../api/directoryobject-getmembergroups.md) | String collection | Return all the groups that the device is a member of. The check is transitive. | |
v1.0 | Devicedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicedetail.md | doc_type: resourcePageType # deviceDetail resource type Namespace: microsoft.graph-Indicates device details associated with a device used for signing in. Includes information like device browser and OS info, if device is Microsoft Entra ID managed. - +Indicates details of the device used in a sign-in activity. Includes information like device browser and OS info and if the device is Microsoft Entra ID-managed. ## Properties | Property | Type |Description| |:|:--|:-|-|browser|String|Indicates the browser information of the used for signing-in.| -|deviceId|String|Refers to the UniqueID of the device used for signing-in.| -|displayName|String|Refers to the name of the device used for signing-in.| +|browser|String|Indicates the browser information of the used in the sign-in. Populated for devices registered in Microsoft Entra.| +|deviceId|String|Refers to the unique ID of the device used in the sign-in. Populated for devices registered in Microsoft Entra.| +|displayName|String|Refers to the name of the device used in the sign-in. Populated for devices registered in Microsoft Entra.| |isCompliant|Boolean|Indicates whether the device is compliant or not.| |isManaged|Boolean|Indicates if the device is managed or not.|-|operatingSystem|String|Indicates the OS name and version used for signing-in.| -|trustType|String|Indicates information on whether the signed-in device is Workplace Joined, AzureAD Joined, Domain Joined. | +|operatingSystem|String|Indicates the OS name and version used in the sign-in.| +|trustType|String|Indicates information on whether the device used in the sign-in is workplace-joined, Microsoft Entra-joined, domain-joined.| ## JSON representation |
v1.0 | Devicemanagement Alertrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicemanagement-alertrule.md | For more information, see the [monitoring](devicemanagement-monitoring.md) resou |Property|Type|Description| |:|:|:|-|alertRuleTemplate|[microsoft.graph.deviceManagement.alertRuleTemplate](#alertruletemplate-values)|The rule template of the alert event. The possible values are: `cloudPcProvisionScenario`, `cloudPcImageUploadScenario`, `cloudPcOnPremiseNetworkConnectionCheckScenario`, `cloudPcInGracePeriodScenario`, `cloudPcFrontlineInsufficientLicensesScenario`, `cloudPcInaccessibleScenario`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `cloudPcInGracePeriodScenario`.| +|alertRuleTemplate|[microsoft.graph.deviceManagement.alertRuleTemplate](#alertruletemplate-values)|The rule template of the alert event. The possible values are: `cloudPcProvisionScenario`, `cloudPcImageUploadScenario`, `cloudPcOnPremiseNetworkConnectionCheckScenario`, `cloudPcInGracePeriodScenario`, `cloudPcFrontlineInsufficientLicensesScenario`, `cloudPcInaccessibleScenario`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `cloudPcInGracePeriodScenario`.| |description|String|The rule description.| |displayName|String|The display name of the rule.| |enabled|Boolean|The status of the rule that indicates whether the rule is enabled or disabled. If `true`, the rule is enabled; otherwise, the rule is disabled.| For more information, see the [monitoring](devicemanagement-monitoring.md) resou |cloudPcProvisionScenario|The alert rule was triggered for an issue with the Cloud PC provisioning. For a system rule, the alert rule was triggered for a Cloud PC provisioning failure.| |cloudPcImageUploadScenario|The alert rule was triggered for an issue with the process to upload the Cloud PC image. For a system rule, the alert rule was triggered for a failure to upload the Cloud PC image.| |cloudPcOnPremiseNetworkConnectionCheckScenario|The alert rule was triggered for an issue with the on-premises network connection check. For a system rule, the alert rule was triggered for a failure with the on-premises network connection.|-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| |cloudPcInGracePeriodScenario |The alert rule was triggered when the Cloud PC entered the grace period.| |cloudPcFrontlineInsufficientLicensesScenario| The alert rule was triggered for the Frontline Cloud PCs where more concurrent Cloud PC connections were active than the concurrency limit allows.| |cloudPcInaccessibleScenario| The alert rule was triggered when Cloud PCs couldn't connect due to host health failure, connection errors, or a zone outage. Alternatively, because they were under provisioning or restoring device status.|+|cloudPcFrontlineBufferUsageScenario| The alert rule was triggered for the Frontline Cloud PCs buffer usage when the buffer is used over the time limit or the count limit. When the tenants use all of the frontline licenses, there's a predefined buffer time or number of licenses that allows Cloud PC users to continue to use them. This alert is triggered when tenants use all of the buffered time or licenses.| ### ruleSeverityType values For more information, see the [monitoring](devicemanagement-monitoring.md) resou |informational|The severity level is `informational`.| |warning|The severity level is `warning`.| |critical|The severity level is `critical`.|-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Devicemanagement Monitoring | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicemanagement-monitoring.md | Represents the entry point to access all resources related to alerts in the [Mic The alert monitoring API provides a programmatic alert experience in the Microsoft Endpoint Manager admin center. A Microsoft Endpoint Manager admin can create an [alert rule](devicemanagement-alertrule.md) with preferred notification channels, and receive alerts when conditions set as thresholds in alert rules are met. Notification channels may include email and Microsoft Endpoint Manager admin center notifications. Each alert is recorded as an [alert record](devicemanagement-alertrecord.md). Admins can review alert records to learn about alert impact, severity, status, and more. -The roles of global admin, Intune admin, and Windows 365 admin have full access to the alert monitoring API. +Admin roles such as Intune admins and Windows 365 admins have full access to the alert monitoring API. [!INCLUDE [monitoring-api-support-solicit](../includes/monitoring-api-support-solicit.md)] |
v1.0 | Devicemanagement Rulecondition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/devicemanagement-rulecondition.md | Represents the rule conditions for an [alert rule](devicemanagement-alertrule.md |Property|Type|Description| |:|:|:|-|relationshipType|[microsoft.graph.deviceManagement.relationshipType](#relationshiptype-values)| The relationship type. Possible values are: `and`, `or`.| +|relationshipType|[microsoft.graph.deviceManagement.relationshipType](#relationshiptype-values)| The relationship type. Possible values are: `and`, `or`.| |conditionCategory|[microsoft.graph.deviceManagement.conditionCategory](#conditioncategory-values)|The property that the rule condition monitors. Possible values are: `provisionFailures`, `imageUploadFailures`, `azureNetworkConnectionCheckFailures`, `cloudPcInGracePeriod`, `frontlineInsufficientLicenses`, `cloudPcConnectionErrors`, `cloudPcHostHealthCheckFailures`, `cloudPcZoneOutage`, `unknownFutureValue`.| |aggregation|[microsoft.graph.deviceManagement.aggregationType](#aggregationtype-values)|The built-in aggregation method for the rule condition. The possible values are: `count`, `percentage`, `affectedCloudPcCount`, `affectedCloudPcPercentage`, `unknownFutureValue`.| |operator|[microsoft.graph.deviceManagement.operatorType](#operatortype-values)|The built-in operator for the rule condition. The possible values are: `greaterOrEqual`, `equal`, `greater`, `less`, `lessOrEqual`, `notEqual`, `unknownFutureValue`.| Represents the rule conditions for an [alert rule](devicemanagement-alertrule.md |cloudPcConnectionErrors| The rule condition targets Cloud PC connection errors.| |cloudPcHostHealthCheckFailures| The rule condition targets Cloud PC host health check failures.| |cloudPcZoneOutage| The rule condition targets Cloud PC zone outage.|-|unknownFutureValue| Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue| Evolvable enumeration sentinel value. Don't use.| +|frontlineBufferUsageDuration| The alert rule condition targets Frontline buffer usage exceeds time duration.| +|frontlineBufferUsageThreshold| The alert rule condition targets Frontline buffer usage exceeds limiting frequency.| ### aggregationType values Represents the rule conditions for an [alert rule](devicemanagement-alertrule.md |percentage|The percentage of the items that match the rule conditions.| |affectedCloudPcCount|The total number of Cloud PCs that meet the rule conditions.| |affectedCloudPcPercentage|The percentage of Cloud PCs that meet the rule conditions.|-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| +|durationInMinute| The time range during which Cloud PCs that meet the alert rule conditions are affected.| ### operatorType values Represents the rule conditions for an [alert rule](devicemanagement-alertrule.md |less|The operator is less than the threshold target.| |lessOrEqual|The operator is less than or equal to the threshold target.| |notEqual|The operator isn't equal to the threshold target.|-|unknownFutureValue|Evolvable enumeration sentinel value. Do not use.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Directoryrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directoryrole.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 [unifiedRoleDefinition resource type](./unifiedroledefinition.md). + Represents a Microsoft Entra directory role. Microsoft Entra directory roles are also known as *administrator roles*. For more information about directory (administrator) roles, see [Assigning administrator roles in Microsoft Entra ID](/azure/active-directory/users-groups-roles/directory-assign-admin-roles). With the Microsoft Graph, you can assign users to directory roles to grant them the permissions of the target role. To read a directory role or update its members, it must first be activated in the tenant. Only the Company Administrators directory role is activated by default. To activate other available directory roles, you send a POST request with the ID of the [directoryRoleTemplate](directoryroletemplate.md) on which the directory role is based. [List directory role templates](../api/directoryroletemplate-list.md) to get all the other available directory roles. Inherits from [directoryObject](directoryobject.md). By default, directory roles are scoped to be tenant-wide. However, directory roles (currently only the *user account admin* and *helpdesk admin*) may also be scoped to [administrative units](administrativeunit.md). |
v1.0 | Directoryroletemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directoryroletemplate.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 [unifiedRoleDefinition resource type](./unifiedroledefinition.md). + Represents a directory role template. A directory role template specifies the property values of a directory role ([directoryRole](directoryrole.md)). There's an associated directory role template object for each of the directory roles that may be activated in a tenant. To read a directory role or update its members, it must first be activated in the tenant. Only the Company Administrators directory role is activated by default. To activate other available directory roles, you send a POST request to the `/directoryRoles` endpoint with the ID of the directory role template on which the directory role is based specified in the **roleTemplateId** parameter of the request. Upon successful completion of this request, you can then start to read and assign members to the directory role. **Note**: A directory role template is exposed for the Users directory role. The Users directory role is implicit and isn't visible to directory clients. Every User in the tenant is assigned to this role by the infrastructure. The role is already activated. Don't use this template. |
v1.0 | Directorysizequota | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/directorysizequota.md | Title: "directorySizeQuota resource type" -description: "Represents a company's used and total directory quota." +description: "Represents the used and total directory quota for an organization." ms.localizationpriority: medium doc_type: resourcePageType +Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a [tenant's](organization.md) used and total directory quota. +Represents the used and total directory quota for an [organization](organization.md). ## Properties | Property | Type|Description| |:|:--|:-|-|used|Int32| Used amount of the directory quota. | |total|Int32| Total amount of the directory quota.|+|used|Int32| Used amount of the directory quota. | ## JSON representation The following JSON representation shows the resource type. ```json {- "used": "Int32", - "total": "Int32" + "total": "Int32", + "used": "Int32" } ``` |
v1.0 | Domain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domain.md | Namespace: microsoft.graph Represents a domain associated with the tenant. -Use domain operations to associate domains to a tenant, verify domain ownership, and configure supported services. Domain operations enable registrars to automate domain association for services such as Microsoft 365. For example, as part of domain sign-up, a registrar can enable a vanity domain for email, websites, authentication, etc. +Use domain operations to associate domains to a tenant, verify domain ownership, and configure supported services. Use domain operations to associate domains to a tenant, verify domain ownership, and configure supported services. 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). To associate a domain with a tenant: Relationships between a domain and other objects in the directory such as its ve | Relationship | Type |Description| |:|:--|:-|-|domainNameReferences|[directoryObject](directoryobject.md) collection| The objects such as users and groups that reference the domain ID. Read-only, Nullable. Supports `$expand` and `$filter` by the OData type of objects returned. For example, `/domains/{domainId}/domainNameReferences/microsoft.graph.user` and `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.| -|serviceConfigurationRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Supports `$expand`. | -|verificationDnsRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Microsoft Entra ID. Read-only, Nullable. Supports `$expand`.| -|federationConfiguration|[internalDomainFederation](../resources/internaldomainfederation.md)| Domain settings configured by customer when federated with Microsoft Entra ID. Supports `$expand`.| +|domainNameReferences|[directoryObject](directoryobject.md) collection| The objects such as users and groups that reference the domain ID. Read-only, Nullable. Does not support `$expand`. Supports `$filter` by the OData type of objects returned. For example, `/domains/{domainId}/domainNameReferences/microsoft.graph.user` and `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.| +|serviceConfigurationRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Does not support `$expand`. | +|verificationDnsRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Microsoft Entra ID. Read-only, Nullable. Does not support `$expand`.| +|federationConfiguration|[internalDomainFederation](../resources/internaldomainfederation.md)| Domain settings configured by customer when federated with Microsoft Entra ID. Does not support `$expand`.| |rootDomain|[domain](domain.md)| Root domain of a subdomain. Read-only, Nullable. Supports `$expand`.| ## JSON representation |
v1.0 | Domainidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/domainidentitysource.md | Namespace: microsoft.graph Used in the identity sources of an [connectedOrganization](connectedOrganization.md). The `@odata.type` value `#microsoft.graph.domainIdentitySource` indicates that this type identifies a domain as an identity source for a connected organization. -When [creating a new connectedOrganization](../api/entitlementmanagement-post-connectedorganizations.md), if the caller provides in the identitySources collection a domainIdentitySource and the domain corresponds to a registered domain of a Microsoft Entra tenant, then the resulting connectedOrganization that is created has an identitySources collection containing a single member of the [azureActiveDirectoryTenant](azureactivedirectorytenant.md) type. ## Properties |
v1.0 | Drive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/drive.md | Namespace: microsoft.graph The drive resource is the top-level object representing a user's OneDrive or a document library in SharePoint. -OneDrive users will always have at least one drive available, their default drive. +OneDrive users always have at least one drive available, their default drive. Users without a OneDrive license may not have a default drive available. ## Methods | Method | Return type | Description | | : | :-- |-|-| [Get drive][drive-get] | drive | Get metadata about a drive | -| [Get drive root][item-get] | [driveItem][] | Get root folder of a drive | -| [List activities][drive-activities] | [itemActivity][] collection | List activities that occurred under the drive | -| [List followed items][drive-following] | [driveItem][] collection | List the user's followed driveItems | -| [List children][item-children] | [driveItem][] collection | List children of the root folder of a drive | -| [List changes][item-changes] | [driveItem][] collection | List changes for all driveItems in the Drive | -| [Search][item-search] | [driveItem][] collection | Search for driveItems in a drive | -| [Get special folder](../api/drive-get-specialfolder.md) | [driveItem][] | Access a special folder by its canonical name | +| [List drive][drive-list] | drive collection |Retrieve the list of drive resources available for a target user, group, or site.| +| [Get drive][drive-get] | drive | Get metadata about a drive.| +| [Get drive root][item-get] | [driveItem][] | Get root folder of a drive.| +| [List activities][drive-activities] | [itemActivity][] collection | List activities that occurred under the drive.| +| [List followed items][drive-following] | [driveItem][] collection | List the user's followed driveItems.| +| [List children][item-children] | [driveItem][] collection | List children of the root folder of a drive.| +| [List changes][item-changes] | [driveItem][] collection | List changes for all driveItems in the drive.| +| [Search][item-search] | [driveItem][] collection | Search for driveItems in a drive.| +| [Get special folder](../api/drive-get-specialfolder.md) | [driveItem][] | Access a special folder by its canonical name.| ## Properties Users without a OneDrive license may not have a default drive available. | owner | [identitySet](identityset.md) | Optional. The user account that owns the drive. Read-only. | | quota | [quota](quota.md) | Optional. Information about the drive's storage space quota. Read-only. | | sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. This property isn't returned by default and must be selected using the `$select` query parameter. |-| system | [systemFacet][] | If present, indicates that this is a system-managed drive. Read-only. +| system | [systemFacet][] | If present, indicates that it's a system-managed drive. Read-only. | webUrl | string (url) | URL that displays the resource in the browser. Read-only. | [identitySet]: identityset.md The **drive** resource is derived from [**baseItem**](baseitem.md) and inherits [drive-activities]: ../api/activities-list.md [drive-following]: ../api/drive-list-following.md [drive-get]: ../api/drive-get.md+[drive-list]: ../api/drive-list.md [item-get]: ../api/driveitem-get.md [item-changes]: ../api/driveitem-delta.md [item-search]: ../api/driveitem-search.md |
v1.0 | Driveprotectionrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/driveprotectionrule.md | Title: "driveProtectionRule resource type" -description: "Represents a drive protection rule associated with a OneDrive for Buisness protection policy." +description: "Represents a drive protection rule associated with a OneDrive for Business protection policy." ms.localizationpriority: medium Inherits from [protectionRuleBase](../resources/protectionrulebase.md). |createdBy|[identitySet](../resources/identityset.md) entitySet|The identity of the person who created the rule.| |createdDateTime|DateTimeOffset|The date and time that the rule was created.| |driveExpression|String|Contains a drive expression. For examples, see [driveExpression examples](../resources/driveprotectionrule.md#driveexpression-examples).|-|error|[publicError](../resources/publicerror.md)|If the operation fails, contains the details of the error.| -|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic. Static rules run once; dynamic rules listen to all changes in the system and update the protection unit list.| +|error|[publicError](../resources/publicerror.md)|If the operation fails, this property contains the details of the error.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Static rules run once; dynamic rules listen to all changes in the system and update the protection unit list. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified this rule.| |lastModifiedDateTime|DateTimeOffset|The timestamp of the last modification to this rule.| |status|[protectionRuleStatus](../resources/driveprotectionrule.md#protectionrulestatus-values )|The status of the protection rule. The following are the possible values: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| The following table shows possible formats for the drive expression. |:|:| |draft | The initial status of protection rule upon creation is draft.| |active | The status of the protection rule upon using the `/run` API.|-|completed | The status of the protection rule after it is successfully applied to the corresponding policy.| -|completedWithErrors | The status of the protection rule after it is applied to the corresponding policy and any failures occurred.| -|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.| +|completed | The status of the protection rule after it's successfully applied to the corresponding policy.| +|completedWithErrors | The status of the protection rule after it's applied to the corresponding policy and any failures occurred.| +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Driveprotectionunitsbulkadditionjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/driveprotectionunitsbulkadditionjob.md | + + Title: "driveProtectionUnitsBulkAdditionJob resource type" +description: "Represents the list of drives and directory object IDs of OneDrive users to be added into the corresponding OneDrive protection policy." ++ms.localizationpriority: medium ++++# driveProtectionUnitsBulkAdditionJob resource type ++Namespace: microsoft.graph +++Represents the properties of a driveProtectionUnitsBulkAdditionJob associated with a [oneDriveForBusinessProtectionPolicy](../resources/onedriveforbusinessprotectionpolicy.md). It contains a list of email addresses, drives, and, directory object IDs to be added to the OneDrive protection policy for backup. ++Inherits from [protectionUnitsBulkJobBase](../resources/protectionunitsbulkjobbase.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List](../api/onedriveforbusinessprotectionpolicy-list-driveprotectionunitsbulkadditionjobs.md)|[driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) collection|Get a list of [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md) objects and their properties.| +|[Create](../api/driveprotectionunitsbulkadditionjobs-post.md)|[driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md)|Create a new [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md).| +|[Get](../api/driveprotectionunitsbulkadditionjobs-get.md)|[driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md)|Read the properties and relationships of a [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md).| ++## Properties ++|Property|Type|Description| +|:|:|:| +|createdBy|[identitySet](../resources/identityset.md)|The identity of the person who created the job.| +|createdDateTime|DateTimeOffset|The date and time that the job was created.| +|directoryObjectIds|Collection(String)|The list of OneDrive directoryObjectIds to add to the OneDrive protection policy.| +|displayName|String|The name of the job.| +|drives|Collection(String)|The list of email addresses to add to the OneDrive protection policy.| +|error|[publicError](../resources/publicerror.md)|Contains error details if any email address resolution fails.| +|id|String|The unique identifier of the job associated with the OneDrive protection policy.| +|lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified the job.| +|lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification to the job.| +|status|[protectionUnitsBulkJobStatus](../resources/protectionunitsbulkjobbase.md#protectionunitsbulkjobstatus-values )|Status of the job. The possible values are: `unknown`, `active`, `completed`, `completedWithErrors`, and `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.driveProtectionUnitsBulkAdditionJob", + "baseType": "microsoft.graph.protectionUnitsBulkJobBase", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.driveProtectionUnitsBulkAdditionJob", + "id": "String (identifier)", + "displayName": "String", + "status": "String", + "createdDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "error": { + "@odata.type": "microsoft.graph.publicError" + }, + "drives": [ + "String" + ], + "directoryObjectIds": [ + "String" + ] +} +``` |
v1.0 | Dynamics Taxarea | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/dynamics-taxarea.md | Title: taxArea resource type -description: A tax area. +description: "Represents a tax area resource type in Dynamics 365 Business Central." documentationcenter: '' |
v1.0 | Ediscovery Ediscoveryapioverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/ediscovery-ediscoveryapioverview.md | Title: "Use the Microsoft Graph eDiscovery API" -description: "The Microsoft 365 eDiscovery APIs provide functionality for organizations to automate repetitive tasks and integrate with their existing eDiscovery tools to build a repeatable workflows that might be required based on industry regulations. You can use the eDiscovery APIs to help with your legal needs." +description: "Use the Microsoft 365 eDiscovery APIs to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that industry regulations might require." ms.localizationpriority: high doc_type: conceptualPageType [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The Microsoft Graph APIs for eDiscovery provide functionality for organizations to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that might be required based on industry regulations. You can use the eDiscovery APIs to help with your legal needs. +The Microsoft Graph APIs for eDiscovery enable organizations to automate repetitive tasks and integrate with their existing eDiscovery tools to build repeatable workflows that industry regulations might require. You can use the eDiscovery APIs to help with your legal needs. > [!IMPORTANT]-> The Microsoft Graph APIs for eDiscovery are intended for the use of eDiscovery operations for litigation, investigation, and regulatory requests. These APIs should not be used as a substitute for journaling data out of the Microsoft 365 system or any other mass download. +> The Microsoft Graph APIs for eDiscovery are intended for the use of eDiscovery operations for litigation, investigation, and regulatory requests. These APIs shouldn't be used as a substitute for journaling data out of the Microsoft 365 system or any other mass download. > [!NOTE] > During the preview, usage of these APIs may require subscriptions to specific Microsoft offerings and is subject to the [Microsoft APIs Terms of Use](/legal/microsoft-apis/terms-of-use?context=graph%252fcontext). Upon general availability, Microsoft may require you or your customer to pay additional fees. > > Currently, the eDiscovery APIs in Microsoft Graph only work with Advanced eDiscovery cases. -> [!CAUTION] -> The eDiscovery APIs under eDiscovery subnamespace are being deprecated. Please use the new [eDiscovery APIs under security](security-api-overview.md#ediscovery-preview). - The eDiscovery API is defined in the OData subnamespace, microsoft.graph.ediscovery. The API includes the following key entities. +> [!CAUTION] +> The eDiscovery APIs in eDiscovery subnamespace are deprecated. Please use the new [eDiscovery APIs under security](security-api-overview.md#ediscovery). + | Name | Type | Use case | |:-|:-|:-| | Case | [microsoft.graph.ediscovery.case](ediscovery-case.md) | The container for all eDiscovery objects including custodians, holds, searches, review sets, and exports. |-| Custodian | [microsoft.graph.ediscovery.custodian](ediscovery-custodian.md) | A person and the data they have administrative control over. When custodians are identified, *Advanced eDiscovery* can hold, search, cull, and export their data. For details, see [Work with custodians and non-custodial data sources in Advanced eDiscovery](/microsoft-365/compliance/managing-custodians).| -| Legal hold | [microsoft.graph.ediscovery.legalHold](ediscovery-legalhold.md) | Used to hold content for litigation and legal purposes. Legal holds should not be confused with or used as retention holds, which are typically used to comply with government or industry regulations. To learn more, see [Manage holds in Advanced eDiscovery](/microsoft-365/compliance/managing-holds).| +| Custodian | [microsoft.graph.ediscovery.custodian](ediscovery-custodian.md) | A person and the data they have administrative control over. When custodians are identified, *Advanced eDiscovery* can hold, search, cull, and export their data. For details, see [Work with custodians and noncustodial data sources in Advanced eDiscovery](/microsoft-365/compliance/managing-custodians).| +| Legal hold | [microsoft.graph.ediscovery.legalHold](ediscovery-legalhold.md) | Used to hold content for litigation and legal purposes. Legal holds shouldn't be confused with or used as retention holds, which are typically used to comply with government or industry regulations. To learn more, see [Manage holds in Advanced eDiscovery](/microsoft-365/compliance/managing-holds).| | Review set| [microsoft.graph.ediscovery.reviewSet](ediscovery-reviewset.md) | A static set of electronically stored information collected for use in a litigation, investigation, or regulatory request. | | Review set query | [microsoft.graph.ediscovery.reviewSetQuery](ediscovery-reviewsetquery.md) | Used to discover, cull, review, and tag [ESI](https://en.wikipedia.org/wiki/Electronically_stored_information_(Federal_Rules_of_Civil_Procedure)) with the goal of production to the requestor or opposing counsel.| | Source collection| [microsoft.graph.ediscovery.sourceCollection](ediscovery-sourcecollection.md)| Commonly known as searches, allow you to collect data from the Microsoft 365 live services such as Exchange, SharePoint, and Teams. Source collections can be added to a review set to further cull and eventually export data relevant to your case. For details, see [Collect data for a case in Advanced eDiscovery](/microsoft-365/compliance/collecting-data-for-ediscovery).|-| Tags | [microsoft.graph.ediscovery.tag](ediscovery-tag.md) | Used in a review set during review or culling to cull responsive data from non-responsive data, identify privileged content, or generally aid in the review process. To learn more, see [Tag documents in a review set in Advanced eDiscovery](/microsoft-365/compliance/tagging-documents).| +| Tags | [microsoft.graph.ediscovery.tag](ediscovery-tag.md) | Used in a review set during review or culling to cull responsive data from non-responsive data, identify privileged content, or generally aid in the review process. To learn more, see [Tag documents in a review set in Advanced eDiscovery](/microsoft-365/compliance/tagging-documents).| |
v1.0 | Education Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/education-overview.md | Title: "Working with education APIs in Microsoft Graph" -description: "The education APIs in Microsoft Graph enhance Microsoft 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments. This makes it easy for you to build solutions that integrate with educational resources." +description: "The education APIs in Microsoft Graph enhance Microsoft 365 resources and data with information that is relevant for education scenarios, including schools, students, teachers, classes, enrollments, and assignments." ms.localizationpriority: medium The education APIs include rostering resources and assignments resources that yo ## Authorization -To call the education APIs in Microsoft Graph, your app will need to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](/graph/auth/). Your app will also need the appropriate permissions. For more information, see [Education permissions](/graph/permissions-reference#education-permissions). +To call the education APIs in Microsoft Graph, your app needs to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](/graph/auth/). Your app also needs the appropriate permissions. For more information, see [Education permissions](/graph/permissions-reference#education-permissions). ### App permissions to enable school IT admins to consent The rostering APIs provide the following key resources: - [educationSchool](educationschool.md) - Represents the school. - [educationClass](educationclass.md) - Represents a class within a school. - [educationTerm](educationterm.md) - Represents a designated portion of the academic year.-- [educationTeacher](educationteacher.md) - Represents a users with the primary role of 'Teacher'.-- [educationStudent](educationstudent.md) - Represents a users with the primary role of 'student'.+- [educationTeacher](educationteacher.md) - Represents a user with the primary role of 'Teacher'. +- [educationStudent](educationstudent.md) - Represents a user with the primary role of 'student'. The rostering APIs support the following scenarios: The following are some common use cases for the assignment-related education API | Read assignment information | An analytics application can get information about assignments and student submissions, including dates and grades. | [Get assignment](../api/educationassignment-get.md) | | Track student submissions | Your app can provide a teacher dashboard that shows how many submissions from students need to be graded. | [Submission resource](educationsubmission.md) | +## Classwork ++You can use Classwork as a one-stop shop to create and organize class resources, including assignments, OneNote Class Notebook pages, web links, files, and Teams channels. This means you no longer have to navigate multiple apps and platforms to find what you need. With Classwork, you can curate a view of content and resources that helps your students navigate the class and see everything in one place. ++The Classwork API provides the following key resources: ++- [educationModule](educationmodule.md) - A module is associated with a class. Represents a group of individual learning resources that are organized in a systematic way. +- [educationModuleResource](educationmoduleresource.md) - A wrapper object that stores the resources associated with a module. The student is unable to update this resource, which is a handout from the teacher to the student with nothing to be turned in. ++The following lists show the scenarios supported by the Classwork API. ++### Modules ++The **educationModule** resource supports the following scenarios: ++- [List modules](../api/educationclass-list-modules.md) +- [Create module](../api/educationclass-post-module.md) +- [Get module](../api/educationmodule-get.md) +- [Update module](../api/educationmodule-update.md) +- [Delete module](../api/educationmodule-delete.md) +- [Pin module](../api/educationmodule-pin.md) +- [Unpin module](../api/educationmodule-unpin.md) +- [Publish module](../api/educationmodule-publish.md) +- [Set up module resources folder](../api/educationmodule-setupresourcesfolder.md) ++### Module resources ++The **educationModuleResource** resource supports the following scenarios: ++- [List module resources](../api/educationmodule-list-resources.md) +- [Create module resource](../api/educationmodule-post-resources.md) +- [Get module resource](../api/educationmoduleresource-get.md) +- [Update module resource](../api/educationmoduleresource-update.md) +- [Delete resource from module](../api/educationmoduleresource-delete.md) ++### Common use cases ++The following table shows some common use cases for the module-related education APIs. ++| Use case | Description | See also | +|:|:--|:-| +| Create a module | Only teachers in a class can create a module. Modules start in the draft state, which means that students don't see the modules until publication. | [Create educationModule](../api/educationclass-post-module.md) | +| List modules | A teacher or an application with application permissions can see all module objects for the class. Students can only see published modules. | [List class modules](../api/educationclass-list-modules.md) | +| Publish a module | Changes the state of an **educationModule** from its original `draft` status to the `published` status. | [educationModule: publish](../api/educationmodule-publish.md) | +| Create a resource in a module | Only teachers can perform this operation. | [Create educationModuleResource](../api/educationmodule-post-resources.md) | +| List module resources | Get all the **educationModuleResource** objects associated with a module. Only teachers, students, and applications with application permissions can perform this operation. | [List module resources](../api/educationmodule-list-resources.md) | + ## School data sync management [School Data Sync](https://sds.microsoft.com/) helps to automate the process of importing and synchronizing roster data from student information systems with Microsoft Entra ID and Microsoft 365. You can use the school data sync management APIs in Microsoft Graph to set up synchronization from either a CSV file or a supported SIS API connector. |
v1.0 | Educationclass | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationclass.md | Students are regular members of the class, and Teachers are owners and have appr ## Methods -| Method | Return Type | Description | -| :- | : | :- | -| [Get class](../api/educationclass-get.md) | [educationClass] | Read properties and relationships of an **educationClass** object. | -| [Add member](../api/educationclass-post-members.md) | [educationUser] | Add a new **educationUser** for the class by posting to the members navigation property. | -| [List members](../api/educationclass-list-members.md) | [educationUser] collection | Get an **educationUser** object collection. | -| [Remove member](../api/educationclass-delete-members.md) | [educationUser] | Remove an **educationUser** from the class through the members navigation property. | -| [List schools](../api/educationclass-list-schools.md) | [educationSchool] collection | Get an **educationSchool** object collection. | -| [Add teacher](../api/educationclass-post-teachers.md) | [educationUser] | Add a new **educationUser** for the class by posting to the teachers navigation property. | -| [List teachers](../api/educationclass-list-teachers.md) | [educationUser] collection | Get a list of teachers for the class. | -| [Remove teacher](../api/educationclass-delete-teachers.md) | [educationUser] | Remove an **educationUser** from the class through the teachers navigation property. | -| [Create](../api/educationclass-post-assignments.md) | [educationAssignment] | Create a new **educationAssignment** by posting to the assignments collection. | -| [List assignments](../api/educationclass-list-assignments.md) | [educationAssignment]collection | Get an **educationAssignment** object collection. | -| [List modules](../api/educationclass-list-modules.md) | [educationModule]collection | Get an **educationModule** object collection. | -| [Get group](../api/educationclass-get-group.md) | [group] | Get the Microsoft 365 **group** that corresponds to this **educationClass**. | -| [Create category](../api/educationclass-post-category.md) | [educationCategory] | Create a new **educationCategory** for this class. | -| [List categories](../api/educationclass-list-categories.md) | [educationCategory] collection | Get a list of **educationCategory** objects that belong to this class. | -| [Update class](../api/educationclass-update.md) | [educationClass] | Update **educationClass** object. | -| [Delete class](../api/educationclass-delete.md) | None | Delete **educationClass** object. | -| [Get delta](../api/educationclass-delta.md) | [educationClass](educationclass.md) collection | Get incremental changes for **educationClasses**. | +|Method|Return Type|Description| +|:--|:-|:-| +|[Get class](../api/educationclass-get.md)|[educationClass]|Read properties and relationships of an **educationClass** object.| +|[Add member](../api/educationclass-post-members.md)|[educationUser]|Add a new **educationUser** for the class by posting to the members navigation property.| +|[List members](../api/educationclass-list-members.md)|[educationUser] collection|Get an **educationUser** object collection.| +|[Remove member](../api/educationclass-delete-members.md)|[educationUser]|Remove an **educationUser** from the class through the members navigation property.| +|[List schools](../api/educationclass-list-schools.md)|[educationSchool] collection|Get an **educationSchool** object collection.| +|[Add teacher](../api/educationclass-post-teachers.md)|[educationUser]|Add a new **educationUser** for the class by posting to the teachers navigation property.| +|[List teachers](../api/educationclass-list-teachers.md)|[educationUser] collection|Get a list of teachers for the class.| +|[Remove teacher](../api/educationclass-delete-teachers.md)|[educationUser]|Remove an **educationUser** from the class through the teachers navigation property.| +|[Create](../api/educationclass-post-assignments.md)|[educationAssignment]|Create a new **educationAssignment** by posting to the assignments collection.| +|[List assignments](../api/educationclass-list-assignments.md)|[educationAssignment] collection|Get an **educationAssignment** object collection.| +|[List modules](../api/educationclass-list-modules.md)|[educationModule] collection|Get an **educationModule** object collection.| +|[Get group](../api/educationclass-get-group.md)|[group]|Get the Microsoft 365 **group** that corresponds to this **educationClass**.| +|[Create category](../api/educationclass-post-category.md)|[educationCategory]|Create a new **educationCategory** for this class.| +|[List categories](../api/educationclass-list-categories.md)|[educationCategory] collection|Get a list of **educationCategory** objects that belong to this class.| +|[Update class](../api/educationclass-update.md)|[educationClass]|Update **educationClass** object.| +|[Delete class](../api/educationclass-delete.md)|None|Delete **educationClass** object.| +|[Get delta](../api/educationclass-delta.md)|[educationClass](educationclass.md) collection|Get incremental changes for **educationClasses**.| +|[Get recently modified submissions](../api/educationclass-getrecentlymodifiedsubmissions.md)|[educationSubmission](../resources/educationsubmission.md) collection|Retrieve submissions modified in the previous seven days.| ## Properties -| Property | Type | Description | -| :- | : | :- | -| id | String | Unique identifier for the class. | -| classCode | String | Class code used by the school to identify the class. | -| course | [educationCourse](educationcourse.md) | Course information for the class. | -| createdBy | [identitySet] | Entity who created the class. | -| description | String | Description of the class. | -| displayName | String | Name of the class. | -| externalId | String | ID of the class from the syncing system. | -| externalName | String | Name of the class in the syncing system. | -| externalSource | String | The type of external source this resource was generated from (automatically determined from `externalSourceDetail`). Possible values are: `sis`, `lms`, or `manual`. | -| externalSourceDetail | String | The name of the external source this resources was generated from. | -| grade | String | Grade level of the class. | -| mailNickname | String | Mail name for sending email to all members, if this is enabled. | -| term | [educationTerm] | Term for the class. | +|Property|Type|Description| +|:-|:|:-| +|id|String|Unique identifier for the class.| +|classCode|String|Class code used by the school to identify the class.| +|course|[educationCourse](educationcourse.md)|Course information for the class.| +|createdBy|[identitySet]|Entity who created the class.| +|description|String|Description of the class.| +|displayName|String|Name of the class.| +|externalId|String|ID of the class from the syncing system.| +|externalName|String|Name of the class in the syncing system.| +|externalSource|String|The type of external source this resource was generated from (automatically determined from `externalSourceDetail`). Possible values are: `sis`, `lms`, or `manual`.| +|externalSourceDetail|String|The name of the external source from which this resource was generated.| +|grade|String|Grade level of the class.| +|mailNickname|String|Mail name for sending email to all members, if this is enabled.| +|term|[educationTerm]|Term for the class.| ## Relationships -| Relationship | Type | Description | -| :-- | :- | :-- | -| assignments | [educationAssignment] collection | All assignments associated with this class. Nullable. | -| members | [educationUser] collection | All users in the class. Nullable. | -| modules | [educationModule] collection | All modules in the class. Nullable. | -| schools | [educationSchool] collection | All schools that this class is associated with. Nullable. | -| teachers | [educationUser] collection | All teachers in the class. Nullable. | -|assignmentCategories| [educationCategory](educationcategory.md) collection | All categories associated with this class. Nullable. | -|assignmentDefaults| [educationAssignmentDefaults](educationassignmentdefaults.md) collection | Specifies class-level defaults respected by new assignments created in the class. | -|assignmentSettings| [educationAssignmentSettings](educationassignmentsettings.md) collection | Specifies class-level assignments settings. | +|Relationship|Type|Description| +|:--|:|:-| +|assignments|[educationAssignment] collection|All assignments associated with this class. Nullable.| +|members|[educationUser] collection|All users in the class. Nullable.| +|modules|[educationModule] collection|All modules in the class. Nullable.| +|schools|[educationSchool] collection|All schools that this class is associated with. Nullable.| +|teachers|[educationUser] collection|All teachers in the class. Nullable.| +|assignmentCategories|[educationCategory](educationcategory.md) collection|All categories associated with this class. Nullable.| +|assignmentDefaults|[educationAssignmentDefaults](educationassignmentdefaults.md) collection|Specifies class-level defaults respected by new assignments created in the class.| +|assignmentSettings|[educationAssignmentSettings](educationassignmentsettings.md) collection|Specifies class-level assignments settings.| ## JSON representation |
v1.0 | Educationsubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/educationsubmission.md | If [setUpResourcesFolder](../api/educationsubmission-setupResourcesFolder.md) ha ## Methods -| Method | Return Type |Description| -|:|:--|:-| -|[Get submission](../api/educationsubmission-get.md) | [educationSubmission](educationsubmission.md) |Read properties and relationships of an **educationSubmission** object.| -|[List submission resources](../api/educationsubmission-list-resources.md) |[educationSubmissionResource](educationsubmissionresource.md) collection| Get an **educationSubmissionResource** object collection.| -|[List submitted resources](../api/educationsubmission-list-submittedresources.md) |[educationSubmissionResource](educationsubmissionresource.md) collection| Get an **educationSubmissionResource** object collection.| -|[List outcomes](../api/educationsubmission-list-outcomes.md) |[educationOutcome](educationoutcome.md) collection| Get an **educationOutcome** object collection.| +|Method|Return Type|Description| +|:--|:-|:-| +|[Get submission](../api/educationsubmission-get.md)|[educationSubmission](educationsubmission.md)|Read properties and relationships of an **educationSubmission** object.| +|[List submission resources](../api/educationsubmission-list-resources.md)|[educationSubmissionResource](educationsubmissionresource.md) collection|Get an **educationSubmissionResource** object collection.| +|[List submitted resources](../api/educationsubmission-list-submittedresources.md)|[educationSubmissionResource](educationsubmissionresource.md) collection|Get an **educationSubmissionResource** object collection.| +|[List outcomes](../api/educationsubmission-list-outcomes.md)|[educationOutcome](educationoutcome.md) collection|Get an **educationOutcome** object collection.| |[Excuse submission](../api/educationsubmission-excuse.md)|[educationSubmission](educationsubmission.md)|Indicates that the submission has no further action for the student and isn't included in average grade calculations.| |[Return submission](../api/educationsubmission-return.md)|[educationSubmission](educationsubmission.md)|A teacher uses return to indicate that the grades/feedback can be shown to the student.| |[Reassign submission](../api/educationsubmission-reassign.md)|[educationSubmission](educationsubmission.md)|Reassign the submission to the student with feedback for review.|-|[Set up submission resources folder](../api/educationsubmission-setupresourcesfolder.md) |[educationSubmission](educationsubmission.md) | Create a SharePoint folder (under pre-defined location) to upload files as submission resources. | +|[Set up submission resources folder](../api/educationsubmission-setupresourcesfolder.md)|[educationSubmission](educationsubmission.md)|Create a SharePoint folder (under a predefined location) to upload files as submission resources.| |[Submit submission](../api/educationsubmission-submit.md)|[educationSubmission](educationsubmission.md)|A student uses submit to turn in the **assignment**. This operation copies the resources into the **submittedResources** folder for grading and updates the status.| |[Unsubmit submission](../api/educationsubmission-unsubmit.md)|[educationSubmission](educationsubmission.md)|A student uses the unsubmit to move the state of the submission from submitted back to working. This operation copies the resources into the **workingResources** folder for grading and updates the status.| ## Properties-| Property | Type |Description| -|:|:--|:-| +|Property|Type|Description| +|:-|:|:-| +|assignmentId|String|The unique identifier for the assignment with which this submission is associated. A submission is always associated with one and only one assignment.| +|excusedBy|[identitySet](identityset.md)|The user that marked the submission as excused.| +|excusedDateTime|DateTimeOffset|Moment in time when the submission was moved to the excused state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |id|String|Unique identifier for the submission.|+|lastModifiedBy|[identitySet](../resources/intune-rbac-identityset.md)|The identities of those who modified the submission.| +|lastModifiedDateTime|DateTimeOffset|The date and time the submission was modified.| +|reassignedBy|[identitySet](identityset.md)|User who moved the status of this submission to reassigned.| +|reassignedDateTime|DateTimeOffset|Moment in time when the submission was reassigned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |recipient|[educationSubmissionRecipient](educationsubmissionrecipient.md)|Who this submission is assigned to.|+|resourcesFolderUrl|String|Folder where all file resources for this submission need to be stored.| |returnedBy|[identitySet](identityset.md)|User who moved the status of this submission to returned.| |returnedDateTime|DateTimeOffset|Moment in time when the submission was returned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|-|resourcesFolderUrl|String|Folder where all file resources for this submission need to be stored.| -|status|educationSubmissionStatus| Read-only. Possible values are: `working`, `submitted`, `returned`, `unknownFutureValue`, `reassigned`, and `excused`. Note that 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): `reassigned`, and `excused`.| +|status|educationSubmissionStatus|Read-only. Possible values are: `working`, `submitted`, `returned`, `unknownFutureValue`, `reassigned`, and `excused`. 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): `reassigned`, and `excused`.| |submittedBy|[identitySet](identityset.md)|User who moved the resource into the submitted state.| |submittedDateTime|DateTimeOffset|Moment in time when the submission was moved into the submitted state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |unsubmittedBy|[identitySet](identityset.md)|User who moved the resource from submitted into the working state.| |unsubmittedDateTime|DateTimeOffset|Moment in time when the submission was moved from submitted into the working state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|-|reassignedBy|[identitySet](identityset.md)|User who moved the status of this submission to reassigned.| -|reassignedDateTime|DateTimeOffset|Moment in time when the submission was reassigned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| -|webUrl|String| The deep link URL for the given submission.| +|webUrl|String|The deep link URL for the given submission.| ## Relationships-| Relationship | Type |Description| -|:|:--|:-| -|resources|[educationSubmissionResource](educationsubmissionresource.md) collection| Nullable.| -|submittedResources|[educationSubmissionResource](educationsubmissionresource.md) collection| Read-only. Nullable.| +|Relationship|Type|Description| +|:--|:|:-| |outcomes|[educationOutcome](educationOutcome.md) collection. Holds grades, feedback and/or rubrics information the teacher assigns to this submission|Read-Write. Nullable.|+|resources|[educationSubmissionResource](educationsubmissionresource.md) collection|Nullable.| +|submittedResources|[educationSubmissionResource](educationsubmissionresource.md) collection|Read-only. Nullable.| ## JSON representation The following JSON representation shows the resource type. ```json {+ "excusedBy": {"@odata.type":"microsoft.graph.identitySet"}, + "excusedDateTime": "String (timestamp)", "id": "String (identifier)", "reassignedBy": {"@odata.type":"microsoft.graph.identitySet"}, "reassignedDateTime": "String (timestamp)", |
v1.0 | Employeeexperience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/employeeexperience.md | Represents a container that exposes navigation properties for employee experienc |Method|Return type|Description| |:|:|:|+|[List communities](../api/employeeexperience-list-communities.md)|[community](../resources/community.md) collection|Get a list of the Viva Engage [community](../resources/community.md) objects and their properties.| |[Create community](../api/employeeexperience-post-communities.md)|[community](../resources/community.md)|Create a new [community](../resources/community.md) in Viva Engage.|-|[Get community](../api/community-get.md)|[community](../resources/community.md)|Read the properties and relationships of a [community](../resources/community.md) object.| |[List learningProviders](../api/employeeexperience-list-learningproviders.md)|[learningProvider](../resources/learningprovider.md) collection|Get a list of the [learningProvider](../resources/learningprovider.md) resources registered in Viva Learning for a tenant.| |[Create learningProvider](../api/employeeexperience-post-learningproviders.md)|[learningProvider](../resources/learningprovider.md)|Create a new [learningProvider](../resources/learningprovider.md) object and register it with Viva Learning using the specified display name and logos for different themes.| |
v1.0 | Employeeorgdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/employeeorgdata.md | description: "Represents organization data associated with a user." ms.localizationpriority: medium doc_type: resourcePageType -+ # employeeOrgData resource type |
v1.0 | Engagement Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/engagement-api-overview.md | Title: "Use the Microsoft Graph API to work with Viva Engage (preview)" + Title: "Use the Microsoft Graph API to work with Viva Engage" description: "The Microsoft Graph API enables apps to manage communities in Viva Engage." ms.localizationpriority: medium -# Use the Microsoft Graph API to work with Viva Engage (preview) +# Use the Microsoft Graph API to work with Viva Engage [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] For more information about the relationship between Viva Engage communities and Viva Engage API calls are subject to rate limiting, allowing 10 requests per user, per app, within a 30-second time period. When you exceed the rate limit, all subsequent requests return a `429 Too Many Requests` response code. -For guidance for how to handle throttling in Microsoft Graph, see [Microsoft Graph throttling guidance](/graph/throttling). +For guidance on how to handle throttling in Microsoft Graph, see [Microsoft Graph throttling guidance](/graph/throttling). ## Next steps |
v1.0 | Engagementasyncoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/engagementasyncoperation.md | Namespace: microsoft.graph Represents the status of a Viva Engage async operation that is an operation that transcends the lifetime of a single API request. These operations are long-running or too expensive to complete within the time frame of their original request. -When an async operation is initiated, the method returns a `202 Accepted` response code and an operation location header that contains the location of the **engagementAsyncOperation**. Periodically check the status of the operation by making a GET request to this location; wait >30 seconds between checks. When the request completes successfully, the operation **status** indicates `succeeded` and the **resourceLocation** points to the created or modified resource. +When an async operation is initiated, the method returns a `202 Accepted` response code and an `Operation-Location` header that contains the location of the **engagementAsyncOperation**. Periodically check the status of the operation by making a GET request to this location; wait >30 seconds between checks. When the request completes successfully, the operation **status** indicates `succeeded` and the **resourceLocation** points to the created or modified resource. Inherits from [longRunningOperation](../resources/longrunningoperation.md). |
v1.0 | Entra | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/entra.md | + + Title: "entra resource type" +description: "Represents the entra resource related to access to Microsoft Entra settings." ++ms.localizationpriority: medium ++++# entra resource type ++Namespace: microsoft.graph +++Represents the entra resource related to access to Microsoft Entra settings. ++Inherits from [entity](../resources/entity.md). ++## Methods ++None. ++## Properties ++None. ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|uxSetting|[uxSetting](../resources/uxsetting.md)|Represents settings related to access to the Microsoft Entra admin center.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.entra", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.entra" +} +``` |
v1.0 | Enums Healthmonitoring | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums-healthmonitoring.md | + + Title: "Health monitoring enum values" +description: "Microsoft Graph health monitoring enumeration values" ++ms.localizationpriority: medium ++++# Health monitoring enum Values ++Namespace: microsoft.graph.healthMonitoring ++### alertState values ++++|Member| +|:| +|active| +|resolved| +|unknownFutureValue| ++### alertType values ++++|Member| +|:| +|unknown| +|mfaSignInFailure| +|managedDeviceSignInFailure| +|compliantDeviceSignInFailure| +|unknownFutureValue| ++### category values ++++|Member| +|:| +|unknown| +|authentication| +|unknownFutureValue| ++### enrichmentState values ++++|Member| +|:| +|none| +|inProgress| +|enriched| +|unknownFutureValue| ++### scenario values ++++|Member| +|:| +|unknown| +|mfa| +|devices| +|unknownFutureValue| ++<!-- +{ + "type": "#page.annotation", + "namespace": "microsoft.graph.healthMonitoring" +} +--> |
v1.0 | Enums Partner Security | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums-partner-security.md | Namespace: microsoft.graph.partner.security |investigating| |unknownFutureValue| ++### complianceStatus values ++|Member| +|:| +|compliant| +|noncomplaint| +|unknownFutureValue| ++### policyStatus values ++|Member| +|:| +|enabled| +|disabled| +|unknownFutureValue| ++### securityRequirementState values ++|Member| +|:| +|active| +|preview| +|unknownFutureValue| ++### securityRequirementType values ++|Member| +|:| +|mfaEnforcedForAdmins| +|mfaEnforcedForAdminsOfCustomers| +|securityAlertsPromptlyResolved| +|securityContactProvided| +|spendingBudgetSetForCustomerAzureSubscriptions| +|unknownFutureValue| + <!-- { "type": "#page.annotation", |
v1.0 | Enums Windowsupdates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums-windowsupdates.md | Title: "Microsoft Graph Windows Updates enumeration values" description: "Microsoft Graph Windows Updates enumeration values" ms.localizationpriority: medium-+ doc_type: enumTypes |
v1.0 | Enums | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/enums.md | -# provisionState values +### provisionState values | Member | | -- | Namespace: microsoft.graph | provisioningCompleted | | unknownFutureValue | -# approvalOperationStatus values +### approvalOperationStatus values | Member | | -- | Namespace: microsoft.graph | timeout | | unknownFutureValue | -## approverRole values +### approverRole values | Member | | -- | | approver | | owner | -## approvalItemState values +### approvalItemState values | Member | | -- | Namespace: microsoft.graph | pending | | completed | -## approvalItemType values +### approvalItemType values | Member | | -- | Namespace: microsoft.graph | custom | | customAwaitAll | -## responseFeedbackType values +### responseFeedbackType values | Member | | -- | Namespace: microsoft.graph | veryPleasant | | unknownFutureValue | -## responseEmotionType values +### responseEmotionType values | Member | | -- | Namespace: microsoft.graph | sad | | unknownFutureValue | -## virtualEventRegistrationPredefinedQuestionLabel values +### virtualEventRegistrationPredefinedQuestionLabel values | Member | | -- | Namespace: microsoft.graph | organization | | unknownFutureValue | -## fileStorageContainerOwnershipType values +### fileStorageContainerOwnershipType values | Member | | -- | | tenantOwned | | unknownfuturevalue | -## groupAccessType values +### groupAccessType values | Member | | -- | Namespace: microsoft.graph | secret | | public | -## fileStorageContainerStatus values +### fileStorageContainerStatus values | Member | | -- | Namespace: microsoft.graph | active | | unknownfuturevalue | -## siteLockState values +### siteLockState values | Value | | | | unlocked | | lockedReadOnly | -## userDefaultAuthenticationMethod values +### userDefaultAuthenticationMethod values | Member | | -- | Namespace: microsoft.graph | none | | unknownFutureValue | -## applicationKeyUsage values +### applicationKeyUsage values | Member | | -- | Namespace: microsoft.graph | verify | | unknownFutureValue | -## applicationKeyType values +### applicationKeyType values | Member | | -- | Namespace: microsoft.graph | certificate | | unknownFutureValue | -## plannerTaskCompletionRequirements values +### plannerTaskCompletionRequirements values | Member | | -- | Namespace: microsoft.graph | formCompletion | | approvalCompletion | -## plannerApprovalStatus values +### plannerApprovalStatus values | Member | | -- | Namespace: microsoft.graph | cancelled | | unknownFutureValue | -## applicationKeyOrigin values +### applicationKeyOrigin values | Member | | -- | Namespace: microsoft.graph | servicePrincipal | | unknownFutureValue | -## authenticationAttributeCollectionInputType values +### authenticationAttributeCollectionInputType values | Member | | - | Namespace: microsoft.graph | boolean | | unknownFutureValue | -## userType values +### userType values | Member | | - | Namespace: microsoft.graph | guest | | unknownFutureValue | -## assignmentType values +### assignmentType values | Member | | | Namespace: microsoft.graph | unknownFutureValue | | peerRecommeded | -## courseStatus values +### courseStatus values | Member | | - | Namespace: microsoft.graph | inProgress | | completed | -## usqState values +### usqState values | Member | | | Namespace: microsoft.graph | full | | overLimit | -## userPurpose values +### userPurpose values | Member | | | Namespace: microsoft.graph | others | | unknownFutureValue | -## releaseType values +### releaseType values | Member | | - | Namespace: microsoft.graph | generallyAvailable | | unknownFutureValue | -## requiredLicenses values +### requiredLicenses values | Member | | - | Namespace: microsoft.graph | microsoftEntraWorkloadId | | unknownFutureValue | -## recommendationCategory values +### recommendationCategory values | Member | | -- | Namespace: microsoft.graph | identitySecureScore | | unknownFutureValue | -## recommendationFeatureAreas values +### recommendationFeatureAreas values | Member | | | Namespace: microsoft.graph | governance | | unknownFutureValue | -## recommendationPriority values +### recommendationPriority values | Member | | | Namespace: microsoft.graph | medium | | high | -## recommendationStatus values +### recommendationStatus values | Member | | | Namespace: microsoft.graph | postponed | | unknownFutureValue | -## recommendationType values +### recommendationType values | Member | | -- | Namespace: microsoft.graph | aadGraphDeprecationServicePrincipal | | mfaServerDeprecation | -## layoutTemplateType values +### layoutTemplateType values | Member | | | Namespace: microsoft.graph | verticalSplit | | unknownFutureValue | -## conditionalAccessExternalTenantsMembershipKind values +### conditionalAccessExternalTenantsMembershipKind values | Member | | | Namespace: microsoft.graph | enumerated | | unknownFutureValue | -## conditionalAccessGuestOrExternalUserTypes values +### conditionalAccessGuestOrExternalUserTypes values | Member | | - | Namespace: microsoft.graph | serviceProvider | | unknownFutureValue | -## teamTemplateAudience values +### teamTemplateAudience values | Member | | | Namespace: microsoft.graph | public | | unknownFutureValue | -## decisionItemPrincipalResourceMembershipType values +### decisionItemPrincipalResourceMembershipType values | Member | | | Namespace: microsoft.graph | indirect | | unknownFutureValue | -## signInFrequencyAuthenticationType values +### signInFrequencyAuthenticationType values | Member | | | Namespace: microsoft.graph | secondaryAuthentication | | unknownFutureValue | -## signInFrequencyInterval values +### signInFrequencyInterval values | Member | | | | timeBased | | everyTime | -## authenticationProtocol values +### authenticationProtocol values | Member | | | Namespace: microsoft.graph | saml | | unknownFutureValue | -## federatedIdpMfaBehavior values +### federatedIdpMfaBehavior values | Member | | -- | Namespace: microsoft.graph | rejectMfaByFederatedIdp | | unknownFutureValue | -## promptLoginBehavior values +### promptLoginBehavior values | Member | | -- | Namespace: microsoft.graph | disabled | | unknownFutureValue | -## bookingsAvailabilityStatus values +### bookingsAvailabilityStatus values | Member | | | Namespace: microsoft.graph | outOfOffice | | unknownFutureValue | -## accessPackageCustomExtensionHandlerStatus values +### accessPackageCustomExtensionHandlerStatus values | Member | | | Namespace: microsoft.graph | requestReceived | | unknownFutureValue | -## accessPackageSubjectLifecycle values +### accessPackageSubjectLifecycle values | Member | | - | Namespace: microsoft.graph | governed | | unknownFutureValue | -## customExtensionCalloutInstanceStatus values +### customExtensionCalloutInstanceStatus values | Member | | | Namespace: microsoft.graph | waitingForCallback | | unknownFutureValue | -## accessPackageCustomExtensionStage values +### accessPackageCustomExtensionStage values | Member | | -- | Namespace: microsoft.graph | assignmentOneDayBeforeExpiration | | unknownFutureValue | -## accessReviewHistoryStatus values +### accessReviewHistoryStatus values | Member | | | Namespace: microsoft.graph | requested | | unknownFutureValue | -## accessReviewHistoryDecisionFilter values +### accessReviewHistoryDecisionFilter values | Member | | | Namespace: microsoft.graph | notNotified | | unknownFutureValue | -## crossTenantAccessPolicyTargetConfigurationAccessType values +### crossTenantAccessPolicyTargetConfigurationAccessType values | Member | | | Namespace: microsoft.graph | blocked | | unknownFutureValue | -## crossTenantAccessPolicyTargetType values +### crossTenantAccessPolicyTargetType values | Member | | | | user | | group | -## multiTenantOrganizationMemberProcessingStatus values +### multiTenantOrganizationMemberProcessingStatus values | Member | | - | Namespace: microsoft.graph | failed | | unknownFutureValue | -## multiTenantOrganizationMemberRole values +### multiTenantOrganizationMemberRole values | Member | | - | Namespace: microsoft.graph | member | | unknownFutureValue | -## multiTenantOrganizationMemberState values +### multiTenantOrganizationMemberState values | Member | | - | Namespace: microsoft.graph | removed | | unknownFutureValue | -## multiTenantOrganizationState values +### multiTenantOrganizationState values | Member | | - | Namespace: microsoft.graph | inactive | | unknownFutureValue | -## templateApplicationLevel values +### templateApplicationLevel values | Member | | - | Namespace: microsoft.graph | existingPartners | | unknownFutureValue | -## approvalFilterByCurrentUserOptions values +### approvalFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | approver | | unknownFutureValue | -## accessPackageFilterByCurrentUserOptions values +### accessPackageFilterByCurrentUserOptions values | Member | | | | allowedRequestor | | unknownFutureValue | -## userSignInRecommendationScope values +### userSignInRecommendationScope values | Member | | -- | | tenant | | application | -## incomingTokenType values +### incomingTokenType values | Member | | - | Namespace: microsoft.graph | saml20 | | unknownFutureValue | | remoteDesktopToken |+| refreshToken | -## protocolType values +### protocolType values | Member | | | Namespace: microsoft.graph | authenticationTransfer | | nativeAuth | -## accessReviewInstanceDecisionItemFilterByCurrentUserOptions values +### accessReviewInstanceDecisionItemFilterByCurrentUserOptions values | Member | | | | reviewer | | unknownFutureValue | -## accessReviewStageFilterByCurrentUserOptions values +### accessReviewStageFilterByCurrentUserOptions values | Member | | | | reviewer | | unknownFutureValue | -## continuousAccessEvaluationMode values +### continuousAccessEvaluationMode values | Member | | | Namespace: microsoft.graph | unknownFutureValue | | strictLocation | -## msiType values +### msiType values | Member | | | Namespace: microsoft.graph | systemAssigned | | unknownFutureValue | -## multiFactorAuthConfiguration values +### multiFactorAuthConfiguration values | Member | Value | Description | | | -- | - | Namespace: microsoft.graph | required | 1 | Multifactor authentication is required for a user to complete device registration. | | unknownFutureValue | 2 | Evolvable enumeration sentinel value. Don't use. | -## policyScope values +### policyScope values | Member | Value | Description | | | -- | | Namespace: microsoft.graph | selected | 2 | The policy applies to specific users or groups in the organization. | | unknownFutureValue | 3 | Evolvable enumeration sentinel value. Don't use. | -## appManagementRestrictionState values +### appManagementRestrictionState values | Member | | - | Namespace: microsoft.graph | disabled | | unknownFutureValue | -## appCredentialRestrictionType values +### appCredentialRestrictionType values | Member | | - | Namespace: microsoft.graph | customPasswordAddition | | unknownFutureValue | -## appKeyCredentialRestrictionType values +### appKeyCredentialRestrictionType values | Member | | | Namespace: microsoft.graph | trustedCertificateAuthority | | unknownFutureValue | -## synchronizationSecret values +### synchronizationSecret values | Member | | - | Namespace: microsoft.graph | TestReferences | | ConnectionString | -## synchronizationScheduleState values +### synchronizationScheduleState values | Member | | -- | Namespace: microsoft.graph | Disabled | | Paused | -## synchronizationStatusCode values +### synchronizationStatusCode values | Member | | - | Namespace: microsoft.graph | Paused | | Quarantine | -## synchronizationTaskExecutionResult values +### synchronizationTaskExecutionResult values | Member | | - | Namespace: microsoft.graph | Failed | | EntryLevelErrors | -## quarantineReason values +### quarantineReason values | Member | | | Namespace: microsoft.graph | TooManyDeletes | | IngestionInterrupted | -## attributeMappingSourceType values +### attributeMappingSourceType values | Member | | | Namespace: microsoft.graph | Constant | | Function | -## filterMode values +### filterMode values | Member | | - | | include | | exclude | -## lifecycleEventType values +### lifecycleEventType values | Member | | -- | Namespace: microsoft.graph | subscriptionRemoved | | reauthorizationRequired | -## changeType values +### changeType values | Member | | - | Namespace: microsoft.graph | updated | | deleted | -## countryLookupMethodType values +### countryLookupMethodType values | Member | | - | | clientIpAddress | | authenticatorAppGps | -## approvalState values +### approvalState values | Member | | -- | Namespace: microsoft.graph | aborted | | canceled | -## roleSummaryStatus values +### roleSummaryStatus values | Member | | | | ok | | bad | -## dataPolicyOperationStatus values +### dataPolicyOperationStatus values | Member | | | Namespace: microsoft.graph | failed | | unknownFutureValue | -## conditionalAccessClientApp values +### conditionalAccessClientApp values | Member | | | Namespace: microsoft.graph | easSupported | | other | -## consentRequestFilterByCurrentUserOptions values +### consentRequestFilterByCurrentUserOptions values | Member | | | | reviewer | | unknownFutureValue | -## attributeType values +### attributeType values | Member | | | Namespace: microsoft.graph | Boolean | | DateTime | -## scopeOperatorType values +### scopeOperatorType values | Member | | | | Binary | | Unary | -## synchronizationJobRestartScope values +### synchronizationJobRestartScope values | Member | | - | Namespace: microsoft.graph | Full | | ForceDeletes | -## synchronizationMetadata values +### synchronizationMetadata values | Member | | - | Namespace: microsoft.graph | SynchronizationLearnMoreIbizaFwLink | | ConfigurationFields | -## mutability values +### mutability values | Member | | | Namespace: microsoft.graph | Immutable | | WriteOnly | -## directoryDefinitionDiscoverabilities values +### directoryDefinitionDiscoverabilities values | Member | | - | Namespace: microsoft.graph | ReferenceAttributes | | UnknownFutureValue | -## objectDefinitionMetadata values +### objectDefinitionMetadata values | Member | | - | Namespace: microsoft.graph | Extensions | | BaseObjectName | -## connectorGroupRegion values +### connectorGroupRegion values | Member | | | Namespace: microsoft.graph | ind | | unknownFutureValue | -## connectorGroupType values +### connectorGroupType values | Member | | - | | applicationProxy | -## onPremisesPublishingType values +### onPremisesPublishingType values | Member | | | Namespace: microsoft.graph | oflineDomainJoin | | unknownFutureValue | -## agentStatus values +### agentStatus values | Member | | -- | | active | | inactive | -## connectorStatus values +### connectorStatus values | Member | | -- | | active | | inactive | -## callType values +### callType values | Member | | | Namespace: microsoft.graph | peerToPeer | | unknownFutureValue | -## tone values +### tone values | Member | | | Namespace: microsoft.graph | d | | flash | -## callState values +### callState values | Member | | - | Namespace: microsoft.graph | terminating | | terminated | -## routingPolicy values +### routingPolicy values | Member | | - | Namespace: microsoft.graph | preferSkypeForBusiness | | unknownFutureValue | -## meetingCapabilities values +### meetingCapabilities values | Member | | | | questionAndAnswer | | unknownFutureValue | -## onlineMeetingRole values +### onlineMeetingRole values | Member | | | Namespace: microsoft.graph | producer | | unknownFutureValue | -## autoAdmittedUsersType values +### autoAdmittedUsersType values | Member | | -- | | everyoneInCompany | | everyone | -## mediaState values +### mediaState values | Member | | | Namespace: microsoft.graph | inactive | | unknownFutureValue | -## callDirection values +### callDirection values | Member | | -- | | incoming | | outgoing | -## modality values +### modality values | Member | | -- | Namespace: microsoft.graph | screenSharing | | unknownFutureValue | -## endpointType values +### endpointType values | Member | | - | Namespace: microsoft.graph | skypeForBusinessVoipPhone | | unknownFutureValue | -## kerberosSignOnMappingAttributeType values +### kerberosSignOnMappingAttributeType values | Member | | - | Namespace: microsoft.graph | onPremisesUserPrincipalUsername | | onPremisesSAMAccountName | -## externalAuthenticationType values +### externalAuthenticationType values | Member | | -- | | passthru | | aadPreAuthentication | -## recipientScopeType values +### recipientScopeType values | Member | | | Namespace: microsoft.graph | externalPartner | | externalNonPartner | -## appliedConditionalAccessPolicyResult values +### appliedConditionalAccessPolicyResult values | Member | | | Namespace: microsoft.graph | reportOnlyNotApplied | | reportOnlyInterrupted | -## microsoftAuthenticatorAuthenticationMode values +### microsoftAuthenticatorAuthenticationMode values | Member | | | Namespace: microsoft.graph | push | | deviceBasedPush | -## authenticationMethodFeature values +### authenticationMethodFeature values | Member | | - | Namespace: microsoft.graph | passwordlessCapable | | mfaCapable | -## authMethodsType values +### authMethodsType values | Member | | - | Namespace: microsoft.graph | mobilePhoneAndSMS | | unknownFutureValue | -## defaultMfaMethodType values +### defaultMfaMethodType values | Member | | -- | Namespace: microsoft.graph | softwareOneTimePasscode | | unknownFutureValue | -## clientCredentialType values +### clientCredentialType values | Member | | | Namespace: microsoft.graph | certificate | | unknownFutureValue | -## azureADLicenseType values +### azureADLicenseType values | Member | | | Namespace: microsoft.graph | premiumP2 | | unknownFutureValue | -## conditionalAccessConditions values +### conditionalAccessConditions values | Member | | - | Namespace: microsoft.graph | authenticationFlows | | insiderRisk | -## conditionalAccessStatus values +### conditionalAccessStatus values | Member | | | Namespace: microsoft.graph | notApplied | | unknownFutureValue | -## featureType values +### featureType values | Member | | | Namespace: microsoft.graph | reset | | unknownFutureValue | -## groupType values +### groupType values | Member | | | Namespace: microsoft.graph | azureAD | | unknownFutureValue | -## includedUserRoles values +### includedUserRoles values | Member | | | Namespace: microsoft.graph | user | | unknownFutureValue | -## includedUserTypes values +### includedUserTypes values | Member | | | Namespace: microsoft.graph | guest | | unknownFutureValue | -## initiatorType values +### initiatorType values | Member | | | Namespace: microsoft.graph | system | | unknownFutureValue | -## migrationStatus values +### migrationStatus values | Member | | -- | Namespace: microsoft.graph | additionalStepsRequired | | unknownFutureValue | -## networkType values +### networkType values | Member | | | Namespace: microsoft.graph | trusted | | unknownFutureValue | -## operationResult values +### operationResult values | Member | | | Namespace: microsoft.graph | timeout | | unknownFutureValue | -## provisioningResult values +### provisioningResult values | Member | | | Namespace: microsoft.graph | warning | | unknownFutureValue | -## provisioningStepType values +### provisioningStepType values | Member | | - | Namespace: microsoft.graph | export | | unknownFutureValue | -## registrationAuthMethod values +### registrationAuthMethod values | Member | | -- | Namespace: microsoft.graph | appPassword | | unknownFutureValue | -## registrationStatusType values +### registrationStatusType values | Member | | | Namespace: microsoft.graph | mfaRegistered | | unknownFutureValue | -## signInIdentifierType values +### signInIdentifierType values | Member | | | Namespace: microsoft.graph | onPremisesUserPrincipalName | | unknownFutureValue | -## signInUserType values +### signInUserType values | Member | | | Namespace: microsoft.graph | guest | | unknownFutureValue | -## requirementProvider values +### requirementProvider values | Member | | - | Namespace: microsoft.graph | scopeBasedAuthRequirementPolicy | | authenticationStrengths | -## riskDetail values +### riskDetail values | Member | | -- | Namespace: microsoft.graph | adminConfirmedAccountSafe | <!-- maintenance comment: Do not delete enum delcaration for riskEventType until all properties of this type are marked as deleted. Dec 28, 2021: Pending eventTypes (in riskUserActivity) and riskType (in riskDetection)-->-## riskEventType values +### riskEventType values | Member | | -- | Namespace: microsoft.graph | maliciousIPAddressValidCredentialsBlockedIP | | unknownFutureValue | -## usageAuthMethod values +### usageAuthMethod values | Member | | - | Namespace: microsoft.graph | appPassword | | unknownFutureValue | -## authenticationAppAdminConfiguration values +### authenticationAppAdminConfiguration values | Member | | | Namespace: microsoft.graph | disabled | | unknownFutureValue | -## authenticationAppEvaluation values +### authenticationAppEvaluation values | Member | | | Namespace: microsoft.graph | failure | | unknownFutureValue | -## authenticationAppPolicyStatus values +### authenticationAppPolicyStatus values | Member | | | Namespace: microsoft.graph | tamperResistantHardwareNotUsed | | unknownFutureValue | -## authenticationMethodKeyStrength values +### authenticationMethodKeyStrength values | Member | | - | Namespace: microsoft.graph | weak | | unknown | -## authenticationMethodPlatform values +### authenticationMethodPlatform values | Member | | - | Namespace: microsoft.graph | linux | | unknown | -## authenticationContextDetail values +### authenticationContextDetail values | Member | | - | Namespace: microsoft.graph | notApplicable | | unknownFutureValue | -## educationAddedStudentAction values +### educationAddedStudentAction values | Member | | | Namespace: microsoft.graph | assignIfOpen | | unknownFutureValue | -## educationAddToCalendarOptions values +### educationAddToCalendarOptions values | Member | | | Namespace: microsoft.graph | unknownFutureValue | | studentsOnly | -## educationModuleStatus values +### educationModuleStatus values | Member | | | | draft | | published | -## educationAssignmentStatus values +### educationAssignmentStatus values | Member | | | Namespace: microsoft.graph | unknownFutureValue | | inactive | -## educationSubmissionStatus values +### educationSubmissionStatus values | Member | | - | Namespace: microsoft.graph | reassigned | | excused | -## educationFeedbackResourceOutcomeStatus values +### educationFeedbackResourceOutcomeStatus values | Member | | | Namespace: microsoft.graph | failedPublish | | unknownFutureValue | -## externalEmailOtpState values +### externalEmailOtpState values | Member | | | Namespace: microsoft.graph | disabled | | unknownFutureValue | -## expirationRequirement values +### expirationRequirement values | Member | | - | Namespace: microsoft.graph | signInFrequencyEveryTime | | unknownFutureValue | -## replyRestriction values +### replyRestriction values | Member | | | Namespace: microsoft.graph | authorAndModerators | | unknownFutureValue | -## userNewMessageRestriction values +### userNewMessageRestriction values | Member | | | Namespace: microsoft.graph | moderators | | unknownFutureValue | -## volumeType values +### volumeType values | Member | | | Namespace: microsoft.graph | removableDataVolume | | unknownFutureValue | -## allowedAudiences values +### allowedAudiences values | Member | | - | Namespace: microsoft.graph | everyone | | unknownFutureValue | -## attestationLevel values +### attestationLevel values | Member | | | Namespace: microsoft.graph | notAttested | | unknownFutureValue | -## emailType values +### emailType values | Member | | -- | Namespace: microsoft.graph | main | | other | -## authenticationMethodSignInState values +### authenticationMethodSignInState values | Member | | -- | Namespace: microsoft.graph | notConfigured | | unknownFutureValue | -## authenticationPhoneType values +### authenticationPhoneType values | Member | | | Namespace: microsoft.graph | office | | unknownFutureValue | -## authenticationMethodTargetType values +### authenticationMethodTargetType values | Member | | | Namespace: microsoft.graph | group | | unknownFutureValue | -## authenticationMethodState values +### authenticationMethodState values | Member | | -- | | enabled | | disabled | -## fido2RestrictionEnforcementType values +### fido2RestrictionEnforcementType values | Member | | | Namespace: microsoft.graph | block | | unknownFutureValue | -## x509CertificateAuthenticationMode values +### x509CertificateAuthenticationMode values | Member | | | Namespace: microsoft.graph | x509CertificateMultiFactor | | unknownFutureValue | -## x509CertificateAffinityLevel values +### x509CertificateAffinityLevel values | Member | | | Namespace: microsoft.graph | high | | unknownFutureValue | -## x509CertificateRuleType values +### x509CertificateRuleType values | Member | | - | Namespace: microsoft.graph | unknownFutureValue | | issuerSubjectAndPolicyOID | -## x509CertificateIssuerHintsState values +### x509CertificateIssuerHintsState values | Member | | - | Namespace: microsoft.graph | enabled | | unknownFutureValue | -## anniversaryType values +### anniversaryType values | Member | | | Namespace: microsoft.graph | wedding | | unknownFutureValue | -## skillProficiencyLevel values +### skillProficiencyLevel values | Member | | -- | Namespace: microsoft.graph | expert | | unknownFutureValue | -## languageProficiencyLevel values +### languageProficiencyLevel values | Member | | - | Namespace: microsoft.graph | nativeOrBilingual | | unknownFutureValue | -## personRelationship values +### personRelationship values | Member | | | Namespace: microsoft.graph | other | | unknownFutureValue | -## attachmentType values +### attachmentType values | Member | | | Namespace: microsoft.graph | item | | reference | -## analyticsActivityType values +### analyticsActivityType values | Member | | | Namespace: microsoft.graph | focus | | meeting | -## entityTypes values +### entityTypes values | Member | | | Namespace: microsoft.graph | qna | | unknownFutureValue | -## searchAlterationType values +### searchAlterationType values | Member | | | | modification | | suggestion | -## bucketAggregationSortProperty values +### bucketAggregationSortProperty values | Member | | -- | Namespace: microsoft.graph | keyAsString | | keyAsNumber | -## contactRelationship values +### contactRelationship values | Member | Value | Description | | | -- | - | Namespace: microsoft.graph | other | 6 | An unspecified relationship to the user. | | unknownFutureValue | 7 | Marker value for future compatibility. | -## scheduleEntityTheme values +### scheduleEntityTheme values | Member | | -- | Namespace: microsoft.graph | darkYellow | | unknownFutureValue | -## timeOffReasonIconType values +### timeOffReasonIconType values | Member | | | Namespace: microsoft.graph | sunny | | unknownFutureValue | -## timeCardState values +### timeCardState values | Member | | | Namespace: microsoft.graph | clockedOut | | unknownFutureValue | -## scheduleChangeState values +### scheduleChangeState values | Member | | -- | Namespace: microsoft.graph | declined | | unknownFutureValue | -## scheduleChangeRequestActor values +### scheduleChangeRequestActor values | Member | | -- | Namespace: microsoft.graph | system | | unknownFutureValue | -## windowsSettingType values +### windowsSettingType values | Member | | | Namespace: microsoft.graph | backup | | unknownFutureValue | -## workforceIntegrationEncryptionProtocol values +### workforceIntegrationEncryptionProtocol values | Member | | -- | | sharedSecret | | unknownFutureValue | -## workforceIntegrationSupportedEntities values +### workforceIntegrationSupportedEntities values | Member | | -- | Namespace: microsoft.graph | timeOff | | timeOffRequest | -## confirmedBy values +### confirmedBy values | Member | | | Namespace: microsoft.graph | manager | | unknownFutureValue | -## timeZoneStandard values +### timeZoneStandard values | Member | | | | windows | | iana | -## freeBusyStatus values +### freeBusyStatus values | Member | Value | | - | -- | Namespace: microsoft.graph | workingElsewhere | 4 | | unknown | -1 | -## physicalAddressType values +### physicalAddressType values | Member | | -- | Namespace: microsoft.graph | business | | other | -## attendeeType values +### attendeeType values | Member | | -- | Namespace: microsoft.graph | optional | | resource | -## externalAudienceScope values +### externalAudienceScope values | Member | | -- | Namespace: microsoft.graph | contactsOnly | | all | -## automaticRepliesStatus values +### automaticRepliesStatus values | Member | | -- | Namespace: microsoft.graph | alwaysEnabled | | scheduled | -## calendarColor values +### calendarColor values | Member | Value | | -- | -- | Namespace: microsoft.graph | lightRed | 8 | | maxColor | 9 | -## educationSynchronizationProfileState values +### educationSynchronizationProfileState values | Member | Value | | | -- | Namespace: microsoft.graph | provisioning | 7 | | unknownFutureValue | 8 | -## educationSynchronizationStatus values +### educationSynchronizationStatus values | Member | | | Namespace: microsoft.graph | extracting | | validating | -## educationExternalSource values +### educationExternalSource values | Member | | -- | Namespace: microsoft.graph | manual | | unknownFutureValue | -## educationGender values +### educationGender values | Member | | -- | Namespace: microsoft.graph | other | | unknownFutureValue | -## eventType values +### eventType values | Member | | -- | Namespace: microsoft.graph | exception | | seriesMaster | -## sensitivity values +### sensitivity values | Member | | -- | Namespace: microsoft.graph | private | | confidential | -## importance values +### importance values | Member | | -- | Namespace: microsoft.graph | normal | | high | -## educationUserRole values +### educationUserRole values | Member | | - | Namespace: microsoft.graph | teacher | | faculty | -## meetingMessageType values +### meetingMessageType values | Member | | | Namespace: microsoft.graph | meetingTentativelyAccepted | | meetingDeclined | -## followupFlagStatus values +### followupFlagStatus values | Member | | -- | Namespace: microsoft.graph | complete | | flagged | -## inferenceClassificationType values +### inferenceClassificationType values | Member | | | | focused | | other | -## iosNotificationAlertType values +### iosNotificationAlertType values | Member | | -- | Namespace: microsoft.graph | modal | | none | -## deviceEnrollmentFailureReason values +### deviceEnrollmentFailureReason values | Member | | -- | Namespace: microsoft.graph | enrollmentRestrictionsEnforced | | clientDisconnected | -## bodyType values +### bodyType values | Member | | - | | text | | html | -## locationType values +### locationType values | Member | | -- | Namespace: microsoft.graph | localBusiness | | postalAddress | -## locationUniqueIdType values +### locationUniqueIdType values | Member | | -- | Namespace: microsoft.graph | private | | bing | -## messageActionFlag values +### messageActionFlag values | Member | | -- | Namespace: microsoft.graph | replyToAll | | review | -## onenoteUserRole values +### onenoteUserRole values | Member | Value | | -- | -- | Namespace: microsoft.graph | Reader | 2 | | None | -1 | -## operationStatus values +### operationStatus values | Member | | | Namespace: microsoft.graph | Completed | | Failed | -## onenotePatchActionType values +### onenotePatchActionType values | Member | | -- | Namespace: microsoft.graph | Insert | | Prepend | -## onenotePatchInsertPosition values +### onenotePatchInsertPosition values | Member | | -- | | After | | Before | -## phoneType values +### phoneType values | Member | | -- | Namespace: microsoft.graph | pager | | radio | -## plannerPreviewType values +### plannerPreviewType values | Member | | -- | Namespace: microsoft.graph | description | | reference | -## status values +### status values | Member | | | Namespace: microsoft.graph | ignored | | unknownFutureValue | -## weekIndex values +### weekIndex values | Member | | -- | Namespace: microsoft.graph | fourth | | last | -## dayOfWeek values +### dayOfWeek values | Member | | -- | Namespace: microsoft.graph | friday | | saturday | -## recurrencePatternType values +### recurrencePatternType values | Member | | -- | Namespace: microsoft.graph | absoluteYearly | | relativeYearly | -## recurrenceRangeType values +### recurrenceRangeType values | Member | | -- | Namespace: microsoft.graph | noEnd | | numbered | -## onenoteSourceService values +### onenoteSourceService values | Member | | - | Namespace: microsoft.graph | OneDriveForBusiness | | OnPremOneDriveForBusiness | -## responseType values +### responseType values | Member | | -- | Namespace: microsoft.graph | declined | | notResponded | -## activityDomain values +### activityDomain values | Member | | -- | Namespace: microsoft.graph | personal | | unrestricted | -## websiteType values +### websiteType values | Member | | -- | Namespace: microsoft.graph | blog | | profile | -## categoryColor values +### categoryColor values | Member | Value | | -- | -- | Namespace: microsoft.graph | preset23 | 23 | | preset24 | 24 | -## alertFeedback values +### alertFeedback values Possible feedback values on the alert provided by an analyst. Possible feedback values on the alert provided by an analyst. | falsePositive | 2 | Alert is false-positive. | | benignPositive | 3 | Alert is benign-positive. | -## fileHashType values +### fileHashType values | Member | Value | Description | | - | -- | | Possible feedback values on the alert provided by an analyst. | peSha1 | 7 | PESHA1 hash type. | | peSha256 | 8 | PESHA256 hash type. | -## connectionDirection values +### connectionDirection values | Member | Value | Description | | -- | -- | -- | Possible feedback values on the alert provided by an analyst. | inbound | 1 | Inbound connection. | | outbound | 2 | Outbound connection. | -## connectionStatus values +### connectionStatus values | Member | Value | Description | | | -- | -- | Possible feedback values on the alert provided by an analyst. | blocked | 3 | Connection blocked. | | failed | 4 | Connection failed. | -## processIntegrityLevel values +### processIntegrityLevel values | Member | Value | Description | | | -- | -- | Possible feedback values on the alert provided by an analyst. | high | 40 | Integrity level is High. | | system | 50 | Integrity level is System. | -## registryHive values +### registryHive values Enum for registry hives as defined by [Registry Hives](/windows/desktop/sysinfo/registry-hives). Enum for registry hives as defined by [Registry Hives](/windows/desktop/sysinfo/ | localMachineSystem | 5 | HKEY_LOCAL_MACHINE\System hive. | | usersDefault | 6 | HKEY_USERS\\.DEFAULT hive. | -## registryOperation values +### registryOperation values Operation that changed the registry key name and/or value. Operation that changed the registry key name and/or value. | modify | 2 | Modify registry. | | delete | 3 | Delete registry. | -## registryValueType values +### registryValueType values Enum for registry value types as defined by [Registry value types](/windows/desktop/sysinfo/registry-value-types). Enum for registry value types as defined by [Registry value types](/windows/desk | qwordlittleEndian | 10 | REG_QWORD_LITTLE_ENDIAN registry value type. | | sz | 11 | REG_SZ registry value type. | -## alertSeverity values +### alertSeverity values Enum for severity of alerts. Enum for severity of alerts. | medium | 3 | Severity is medium. | | high | 4 | Severity is high. | -## alertStatus values +### alertStatus values Possible values of an Alert lifecycle status (stage). Possible values of an Alert lifecycle status (stage). | inProgress | 20 | Alert is in progress. | | resolved | 30 | Alert is resolved. | -## emailRole values +### emailRole values Possible values for email roles. Possible values for email roles. | sender | 1 | Sender of the email. | | recipient | 2 | Recipient of the email. | -## logonType values +### logonType values Possible values for the method of user signin. Possible values for the method of user signin. | batch | 3 | Logon is batch. | | service | 4 | Logon is service. | -## userAccountSecurityType values +### userAccountSecurityType values Possible values for user account types (group membership), per Windows definition. Possible values for user account types (group membership), per Windows definitio | power | 1 | Member of Power Users group. | | administrator | 2 | Member of Administrators group. | -## chatMessagePolicyViolationDlpActionType values +### chatMessagePolicyViolationDlpActionType values | Value | | - | Possible values for user account types (group membership), per Windows definitio | BlockAccess | | BlockAccessExternal | -## scopeOperatorMultiValuedComparisonType values +### scopeOperatorMultiValuedComparisonType values | Member | | - | | All | | Any | -## riskLevel values +### riskLevel values | Member | | | Possible values for user account types (group membership), per Windows definitio | none | | unknownFutureValue | -## riskState values +### riskState values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | confirmedCompromised | | unknownFutureValue | -## advancedConfigState values +### advancedConfigState values | Member | | | Possible values for user account types (group membership), per Windows definitio | disabled | | unknownFutureValue | -## referenceAttachmentPermission values +### referenceAttachmentPermission values | Member | | - | Possible values for user account types (group membership), per Windows definitio | organizationView | | organizationEdit | -## referenceAttachmentProvider values +### referenceAttachmentProvider values | Member | | - | Possible values for user account types (group membership), per Windows definitio | oneDriveConsumer | | dropbox | -## exchangeIdFormat values +### exchangeIdFormat values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | restId | | restImmutableEntryId | -## attributeDefinitionMetadata values +### attributeDefinitionMetadata values | Member | | - | Possible values for user account types (group membership), per Windows definitio | MaximumLength | | ReferencedProperty | -## attributeFlowBehavior values +### attributeFlowBehavior values | Member | | - | | FlowWhenChanged | | FlowAlways | -## attributeFlowType values +### attributeFlowType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | ValueAddOnly | | AttributeAddOnly | -## objectFlowTypes values +### objectFlowTypes values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Update | | Delete | -## objectMappingMetadata values +### objectMappingMetadata values | Member | | - | Possible values for user account types (group membership), per Windows definitio | ExcludeFromReporting | | Unsynchronized | -## chatMessageType values +### chatMessageType values | Member | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | systemEventMessage | -## chatMessageImportance values +### chatMessageImportance values | Member | | | Possible values for user account types (group membership), per Windows definitio | high | | urgent | -## stagedFeatureName values +### stagedFeatureName values | Member | | - | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | certificateBasedAuthentication | -## tokenIssuerType values +### tokenIssuerType values | Member | | | Possible values for user account types (group membership), per Windows definitio | ADFederationServicesMFAAdapter | | NPSExtension | -## riskDetectionTimingType values +### riskDetectionTimingType values | Member | | | Possible values for user account types (group membership), per Windows definitio | offline | | unknownFutureValue | -## activityType values +### activityType values | Member | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | servicePrincipal | -## chatMessagePolicyViolationUserActionType values +### chatMessagePolicyViolationUserActionType values | Member | Int value | Description | | - | | | Possible values for user account types (group membership), per Windows definitio | Override | 1 | Sender has overridden the message verdict and sent the message anyway. | | ReportFalsePositive | 2 | Sender has reported the message verdict to the admins as a false positive. | -## chatMessagePolicyViolationVerdictDetailsType values +### chatMessagePolicyViolationVerdictDetailsType values | Member | Int value | Description | | | | | Possible values for user account types (group membership), per Windows definitio | AllowOverrideWithoutJustification | 2 | User is allowed to override the block and send the message. Justification text isn't required. Exclusive to `AllowOverrideWithJustification`. | | AllowOverrideWithJustification | 4 | User is allowed to override the block and send the message. Justification text is required. Exclusive to `AllowOverrideWithoutJustification`. | -## entityType values +### entityType values | Member | | | Possible values for user account types (group membership), per Windows definitio | externalFile | | externalItem | -## onlineMeetingProviderType values +### onlineMeetingProviderType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | skypeForConsumer | | teamsForBusiness | -## delegateMeetingMessageDeliveryOptions values +### delegateMeetingMessageDeliveryOptions values | Member | | | Possible values for user account types (group membership), per Windows definitio | sendToDelegateAndPrincipal | | sendToDelegateOnly | -## calendarRoleType values +### calendarRoleType values | Member | | | Possible values for user account types (group membership), per Windows definitio | delegateWithPrivateEventAccess | | custom | -## contentFormat values +### contentFormat values | Member | Value | Description | | - | -- | | | default | 0 | Content is a file or non-email type. | | email | 1 | Content is an email. | -## contentState values +### contentState values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | motion | 1 | Data is in motion. A file intercepted by a network appliance in transit. | | use | 2 | Data is in use. A file is open in a client application such as Microsoft Office. | -## assignmentMethod values +### assignmentMethod values | Member | Value | Description | | - | -- | -- | Possible values for user account types (group membership), per Windows definitio | privileged | 1 | The label was set explicitly by a user. | | auto | 2 | Allows override of any existing label. Justification required on downgrade. Results in `standard` assignment method in metadata. | -## actionSource values +### actionSource values | Member | Value | Description | | - | -- | | Possible values for user account types (group membership), per Windows definitio | policyDefault | 3 | The user no action and the policy-default label was applied. | | mandatory | 4 | The user chose a label after being forced to choose. | -## contentAlignment values +### contentAlignment values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | right | 1 | Align content marking to the right. | | center | 2 | Center content marking. | -## watermarkLayout values +### watermarkLayout values | Member | Value | Description | | - | -- | | | horizontal | 0 | Use a horizontal watermark. | | diagonal | 1 | Use a diagonal watermark. | -## conditionalAccessPolicyState values +### conditionalAccessPolicyState values | Member | | | Possible values for user account types (group membership), per Windows definitio | disabled | | enabledForReportingButNotEnforced | -## conditionalAccessGrantControl values +### conditionalAccessGrantControl values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | passwordChange | | unknownFutureValue | -## perUserMfaState values +### perUserMfaState values | Member | | - | Possible values for user account types (group membership), per Windows definitio | enabled | | unknownFutureValue | -## conditionalAccessRule values +### conditionalAccessRule values | Member | | | Possible values for user account types (group membership), per Windows definitio | authenticationTransfer | | insiderRisk | -## signInAccessType values +### signInAccessType values | Member | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | passthrough | -## signinFrequencyType values +### signinFrequencyType values | Member | | | | days | | hours | -## originalTransferMethods values +### originalTransferMethods values | Member | | - | Possible values for user account types (group membership), per Windows definitio | authenticationTransfer | | unknownFutureValue | -## tokenProtectionStatus values +### tokenProtectionStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | unbound | | unknownFutureValue | -## conditionalAccessAudienceReason values +### conditionalAccessAudienceReason values | Member | | | Possible values for user account types (group membership), per Windows definitio | thirdPartyResourceDefault | | unknownFutureValue | -## persistentBrowserSessionMode values +### persistentBrowserSessionMode values | Member | | | | always | | never | -## cloudAppSecuritySessionControlType values +### cloudAppSecuritySessionControlType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | monitorOnly | | blockDownloads | -## conditionalAccessDevicePlatform values +### conditionalAccessDevicePlatform values | Member | | | Possible values for user account types (group membership), per Windows definitio | all | | unknownFutureValue | -## priority values +### priority values | Member | Value | | | -- | Possible values for user account types (group membership), per Windows definitio | High | 1 | | Low | 2 | -## templateScenarios values +### templateScenarios values | Member | | | Possible values for user account types (group membership), per Windows definitio | emergingThreats | | unknownFutureValue | -## threatAssessmentContentType values +### threatAssessmentContentType values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | url | 2 | URL threat. | | file | 3 | Attachment file threat. | -## threatExpectedAssessment values +### threatExpectedAssessment values | Member | Value | Description | | - | -- | -- | | block | 1 | The threat should be blocked. | | unblock | 2 | The threat shouldn't be blocked. | -## threatCategory values +### threatCategory values | Member | Value | Description | | | -- | | Possible values for user account types (group membership), per Windows definitio | malware | 3 | Malware threat. | | unknownFutureValue | 4 | A sentinel member. | -## threatAssessmentStatus values +### threatAssessmentStatus values | Member | Value | Description | | | -- | - | | pending | 1 | The threat assessment still in progress. | | completed | 2 | The threat assessment completed. | -## threatAssessmentRequestSource values +### threatAssessmentRequestSource values | Member | Value | Description | | - | -- | | Possible values for user account types (group membership), per Windows definitio | user | 1 | User submission. | | administrator | 2 | Tenant admin submission. | -## threatAssessmentResultType values +### threatAssessmentResultType values | Member | Value | Description | | | -- | - | Possible values for user account types (group membership), per Windows definitio | rescan | 2 | The rescan result. | | unknownFutureValue | 3 | A sentinel member. | -## mailDestinationRoutingReason values +### mailDestinationRoutingReason values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | junk | 14 | Blocked due to junk. | | unknownFutureValue | 15 | A sentinel member. | -## threatAssessmentRequestPivotProperty values +### threatAssessmentRequestPivotProperty values | Member | Value | Description | | - | -- | - | | threatCategory | 1 | Aggregate threat assessment request by `threatCategory`. | | mailDestinationRoutingReason | 2 | Aggregate threat assessment request by `mailDestinationRoutingReason`. | -## userFlowType values +### userFlowType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | resourceOwner | | unknownFutureValue | -## openIdConnectResponseMode values +### openIdConnectResponseMode values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | query | | unknownFutureValue | -## wellknownListName values +### wellknownListName values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | flaggedEmails | | unknownFutureValue | -## taskStatus values +### taskStatus values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | waitingOnOthers | | deferred | -## columnTypes values +### columnTypes values | Member | Description | | | -- | Possible values for user account types (group membership), per Windows definitio | approvalStatus | Content approval status column. | | unknownFutureValue | unknownFuturevalue | -## contentModelType values +### contentModelType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | prebuiltReceiptModel | | unknownFutureValue | -## documentProcessingJobStatus values +### documentProcessingJobStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | failed | | unknownFutureValue | -## documentProcessingJobType values +### documentProcessingJobType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Folder | | UnknownFutureValue | -## connectedOrganizationState values +### connectedOrganizationState values | Member | Value | Description | | | -- | - | Possible values for user account types (group membership), per Windows definitio | proposed | 1 | Connected Organizations that are automatically created by the system have this state value. They aren't included in assignment policies with requestor scope type `AllConfiguredConnectedOrganizationSubjects`. | | unknownFutureValue | 2 | A sentinel member. | -## identityUserFlowAttributeDataType values +### identityUserFlowAttributeDataType values | Member | Value | Description | | | -- | | Possible values for user account types (group membership), per Windows definitio | dateTime | 5 | | | unknownFutureValue | 6 | A sentinel member. | -## identityUserFlowAttributeType values +### identityUserFlowAttributeType values | Member | Value | Description | | | -- | | Possible values for user account types (group membership), per Windows definitio | required | 3 | | | unknownFutureValue | 4 | A sentinel member. | -## permissionClassificationType values +### permissionClassificationType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | medium | | high | -## permissionType values +### permissionType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | delegated | | delegatedUserConsentable | -## identityUserFlowAttributeInputType values +### identityUserFlowAttributeInputType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | emailBox | | checkboxMultiSelect | -## teamworkActivityTopicSource values +### teamworkActivityTopicSource values | Member | | - | | entityUrl | | text | -## cloudPcProvisioningPolicyImageType values +### cloudPcProvisioningPolicyImageType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | gallery | | unknownFutureValue | -## cloudPcPolicySettingType values +### cloudPcPolicySettingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | singleSignOn | | unknownFutureValue | -## chatType values +### chatType values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | meeting | 2 | Indicates that the chat is a Meeting chat, which is created as a side effect of creation of an OnlineMeeting. | | unknownFutureValue | 3 | Sentinel value to indicate future values. | -## singleSignOnMode values +### singleSignOnMode values | Member | | | Possible values for user account types (group membership), per Windows definitio | aadHeaderBased | | pingHeaderBased | -## plannerContainerType values +### plannerContainerType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | driveItem | | user | -## plannerPlanContextType values +### plannerPlanContextType values | Member | | | Possible values for user account types (group membership), per Windows definitio | other | | unknownFutureValue | -## plannerContextState values +### plannerContextState values | Member | | | Possible values for user account types (group membership), per Windows definitio | delinked | | unknownFutureValue | -## plannerExternalTaskSourceDisplayType values +### plannerExternalTaskSourceDisplayType values | Member | | | Possible values for user account types (group membership), per Windows definitio | default | | unknownFutureValue | -## plannerCreationSourceKind values +### plannerCreationSourceKind values | Member | | | Possible values for user account types (group membership), per Windows definitio | publication | | unknownFutureValue | -## teamsAppInstallationScope values +### teamsAppInstallationScope values | Member | Value | Description | | | -- | | Possible values for user account types (group membership), per Windows definitio | groupChat | 1 | Indicates that the Teams app can be installed within a group chat and is authorized to access that group chat's data. | | personal | 2 | Indicates that the Teams app can be installed in the personal scope of a user and is authorized to access that user's data. | -## assignmentScheduleFilterByCurrentUserOptions values +### assignmentScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## assignmentScheduleInstanceFilterByCurrentUserOptions values +### assignmentScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## assignmentScheduleRequestFilterByCurrentUserOptions values +### assignmentScheduleRequestFilterByCurrentUserOptions values | Member | | | Possible values for user account types (group membership), per Windows definitio | approver | | unknownFutureValue | -## eligibilityScheduleFilterByCurrentUserOptions values +### eligibilityScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## eligibilityScheduleInstanceFilterByCurrentUserOptions values +### eligibilityScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## eligibilityScheduleRequestFilterByCurrentUserOptions values +### eligibilityScheduleRequestFilterByCurrentUserOptions values | Member | | | Possible values for user account types (group membership), per Windows definitio | approver | | unknownFutureValue | -## privilegedAccessGroupAssignmentType values +### privilegedAccessGroupAssignmentType values | Member | | | Possible values for user account types (group membership), per Windows definitio | activated | | unknownFutureValue | -## privilegedAccessGroupMemberType values +### privilegedAccessGroupMemberType values | Member | | | Possible values for user account types (group membership), per Windows definitio | group | | unknownFutureValue | -## privilegedAccessGroupRelationships values +### privilegedAccessGroupRelationships values | Member | | | Possible values for user account types (group membership), per Windows definitio | member | | unknownFutureValue | -## scheduleRequestActions values +### scheduleRequestActions values | Member | | | Possible values for user account types (group membership), per Windows definitio | selfRenew | | unknownFutureValue | -## roleAssignmentScheduleRequestFilterByCurrentUserOptions values +### roleAssignmentScheduleRequestFilterByCurrentUserOptions values | Member | | | Possible values for user account types (group membership), per Windows definitio | approver | | unknownFutureValue | -## roleAssignmentScheduleFilterByCurrentUserOptions values +### roleAssignmentScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## roleAssignmentScheduleInstanceFilterByCurrentUserOptions values +### roleAssignmentScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## roleEligibilityScheduleRequestFilterByCurrentUserOptions values +### roleEligibilityScheduleRequestFilterByCurrentUserOptions values | Member | | | Possible values for user account types (group membership), per Windows definitio | approver | | unknownFutureValue | -## roleEligibilityScheduleFilterByCurrentUserOptions values +### roleEligibilityScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## roleEligibilityScheduleInstanceFilterByCurrentUserOptions values +### roleEligibilityScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## cloudPcAuditActivityOperationType values +### cloudPcAuditActivityOperationType values | Member | | | Possible values for user account types (group membership), per Windows definitio | patch | | other | -## cloudPcAuditActivityResult values +### cloudPcAuditActivityResult values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | timeout | | other | -## cloudPcAuditActorType values +### cloudPcAuditActorType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | partner | | unknown | -## cloudPcAuditCategory values +### cloudPcAuditCategory values | Member | | - | | cloudPC | | other | -## postType values +### postType values | Member | | | Possible values for user account types (group membership), per Windows definitio | strategic | | unknownFutureValue | -## serviceHealthClassificationType values +### serviceHealthClassificationType values | Member | | | Possible values for user account types (group membership), per Windows definitio | incident | | unknownFutureValue | -## serviceHealthOrigin values +### serviceHealthOrigin values | Member | | | Possible values for user account types (group membership), per Windows definitio | customer | | unknownFutureValue | -## serviceHealthStatus values +### serviceHealthStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | reported | | unknownFutureValue | -## serviceUpdateCategory values +### serviceUpdateCategory values | Member | | | Possible values for user account types (group membership), per Windows definitio | stayInformed | | unknownFutureValue | -## serviceUpdateSeverity values +### serviceUpdateSeverity values | Member | | | Possible values for user account types (group membership), per Windows definitio | critical | | unknownFutureValue | -## teamworkApplicationIdentityType values +### teamworkApplicationIdentityType values | Member | | | Possible values for user account types (group membership), per Windows definitio | outgoingWebhook | | unknownFutureValue | -## teamworkConversationIdentityType values +### teamworkConversationIdentityType values | Member | | | Possible values for user account types (group membership), per Windows definitio | chat | | unknownFutureValue | -## teamworkUserIdentityType values +### teamworkUserIdentityType values | Member | | | Possible values for user account types (group membership), per Windows definitio | emailUser | | azureCommunicationServicesUser | -## callRecordingStatus values +### callRecordingStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | chunkFinished | | unknownFutureValue | -## payloadDeliveryPlatform values +### payloadDeliveryPlatform values | Member | | | Possible values for user account types (group membership), per Windows definitio | teams | | unknownFutureValue | -## trainingStatus values +### trainingStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | overdue | | unknownFutureValue | -## teamworkCallEventType values +### teamworkCallEventType values | Member | | | Possible values for user account types (group membership), per Windows definitio | screenShare | | unknownFutureValue | -## binaryOperator values +### binaryOperator values | Member | | | | or | | and | -## subjectRightsRequestStage values +### subjectRightsRequestStage values | Member | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | approval | -## subjectRightsRequestStageStatus values +### subjectRightsRequestStageStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | failed | | unknownFutureValue | -## subjectRightsRequestStatus values +### subjectRightsRequestStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | closed | | unknownFutureValue | -## subjectRightsRequestType values +### subjectRightsRequestType values | Member | | | Possible values for user account types (group membership), per Windows definitio | tagForAction | | unknownFutureValue | -## dataSubjectType values +### dataSubjectType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | other | | unknownFutureValue | -## answerInputType values +### answerInputType values | Member | Value | Description | | | -- | - | Possible values for user account types (group membership), per Windows definitio | radioButton | 1 | RadioButton. | | unknownFutureValue | 2 | UnknownFutureValue. | -## taskStatus_v2 values +### taskStatus_v2 values | Member | | | Possible values for user account types (group membership), per Windows definitio | completed | | unknownFutureValue | -## wellKnownListName_v2 values +### wellKnownListName_v2 values | Member | | | Possible values for user account types (group membership), per Windows definitio | flaggedEmail | | unknownFutureValue | -## bookingPriceType values +### bookingPriceType values | Member | | | Possible values for user account types (group membership), per Windows definitio | notSet | | unknownFutureValue | -## bookingStaffRole values +### bookingStaffRole values | Member | | | Possible values for user account types (group membership), per Windows definitio | scheduler | | teamMember | -## bookingReminderRecipients values +### bookingReminderRecipients values | Member | | | Possible values for user account types (group membership), per Windows definitio | customer | | unknownFutureValue | -## teamworkConnectionStatus values +### teamworkConnectionStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | disconnected | | unknownFutureValue | -## teamworkDeviceActivityState values +### teamworkDeviceActivityState values | Member | Value | Description | | | -- | | Possible values for user account types (group membership), per Windows definitio | unavailable | 3 | The device is unavailable. | | unknownFutureValue | 4 | Evolvable enumeration sentinel value. Don't use. | -## teamworkDeviceOperationType values +### teamworkDeviceOperationType values | Member | Value | Description | | | -- | | Possible values for user account types (group membership), per Windows definitio | remoteLogout | 6 | Device remote logout. | | unknownFutureValue | 7 | Evolvable enumeration sentinel value. Don't use. | -## teamworkSoftwareFreshness values +### teamworkSoftwareFreshness values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | updateAvailable | 2 | Indicates that a software update is available for a device component. | | unknownFutureValue | 3 | Evolvable enumeration sentinel value. Don't use. | -## teamworkSoftwareType values +### teamworkSoftwareType values | Member | | | Possible values for user account types (group membership), per Windows definitio | companyPortal | | unknownFutureValue | -## teamworkSupportedClient values +### teamworkSupportedClient values | Member | Value | Description | | -- | -- | | Possible values for user account types (group membership), per Windows definitio | teamsOnly | 4 | Supports only `Teams`. | | unknownFutureValue | 5 | Evolvable enumeration sentinel value. Don't use. | -## delegatedAdminAccessAssignmentStatus values +### delegatedAdminAccessAssignmentStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | error | | unknownFutureValue | -## delegatedAdminAccessContainerType values +### delegatedAdminAccessContainerType values | Member | | | | securityGroup | | unknownFutureValue | -## delegatedAdminRelationshipOperationType values +### delegatedAdminRelationshipOperationType values | Member | | | | delegatedAdminAccessAssignmentUpdate | | unknownFutureValue | -## delegatedAdminRelationshipRequestAction values +### delegatedAdminRelationshipRequestAction values | Member | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | reject | -## delegatedAdminRelationshipRequestStatus values +### delegatedAdminRelationshipRequestStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | failed | | unknownFutureValue | -## delegatedAdminRelationshipStatus values +### delegatedAdminRelationshipStatus values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | terminationRequested | | unknownFutureValue | -## featureTargetType values +### featureTargetType values | Member | | | Possible values for user account types (group membership), per Windows definitio | role | | unknownFutureValue | -## longRunningOperationStatus values +### longRunningOperationStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | skipped | | unknownFutureValue | -## submissionCategory values +### submissionCategory values | Member | | | Possible values for user account types (group membership), per Windows definitio | malware | | unknownFutureValue | -## submissionClientSource values +### submissionClientSource values | Member | | | Possible values for user account types (group membership), per Windows definitio | other | | unknownFutureValue | -## submissionContentType values +### submissionContentType values | Member | | | Possible values for user account types (group membership), per Windows definitio | app | | unknownFutureValue | -## submissionSource values +### submissionSource values | Member | | | Possible values for user account types (group membership), per Windows definitio | administrator | | unknownFutureValue | -## weakAlgorithms values +### weakAlgorithms values | Member | | | | rsaSha1 | | unknownFutureValue | -## tenantAllowBlockListAction values +### tenantAllowBlockListAction values | Member | | | Possible values for user account types (group membership), per Windows definitio | block | | unknownFutureValue | -## tenantAllowBlockListEntryType values +### tenantAllowBlockListEntryType values | Member | | | Possible values for user account types (group membership), per Windows definitio | recipient | | unknownFutureValue | -## outlierMemberType values +### outlierMemberType values | Member | | | | user | | unknownFutureValue | -## outlierContainerType values +### outlierContainerType values | Member | | | | group | | unknownFutureValue | -## browserSharedCookieSourceEnvironment values +### browserSharedCookieSourceEnvironment values | Member | | | Possible values for user account types (group membership), per Windows definitio | both | | unknownFutureValue | -## browserSiteCompatibilityMode values +### browserSiteCompatibilityMode values | Member | | | Possible values for user account types (group membership), per Windows definitio | internetExplorer5 | | unknownFutureValue | -## browserSiteMergeType values +### browserSiteMergeType values | Member | | | Possible values for user account types (group membership), per Windows definitio | default | | unknownFutureValue | -## browserSiteTargetEnvironment values +### browserSiteTargetEnvironment values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | none | | unknownFutureValue | -## browserSiteStatus values +### browserSiteStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | pendingDelete | | unknownFutureValue | -## browserSharedCookieStatus values +### browserSharedCookieStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | pendingDelete | | unknownFutureValue | -## browserSiteListStatus values +### browserSiteListStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | pending | | unknownFutureValue | -## authenticationStrengthPolicyType values +### authenticationStrengthPolicyType values | Member | | | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## authenticationStrengthRequirements values +### authenticationStrengthRequirements values | Member | | | Possible values for user account types (group membership), per Windows definitio | mfa | | unknownFutureValue | -## authenticationStrengthResult values +### authenticationStrengthResult values | Member | | | Possible values for user account types (group membership), per Windows definitio | cannotSatisfy | | unknownFutureValue | -## authenticationMethodModes values +### authenticationMethodModes values | Member | | | Possible values for user account types (group membership), per Windows definitio | federatedMultiFactor | | unknownFutureValue | -## baseAuthenticationMethod values +### baseAuthenticationMethod values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | federation | | unknownFutureValue | -## searchContent values +### searchContent values | Member | | | Possible values for user account types (group membership), per Windows definitio | sharedContent | | unknownFutureValue | -## chatMessageActions values +### chatMessageActions values | Member | | | Possible values for user account types (group membership), per Windows definitio | actionUndefined | | unknownFutureValue | -## plannerRelationshipUserRoles values +### plannerRelationshipUserRoles values | Member | | | Possible values for user account types (group membership), per Windows definitio | applications | | unknownFutureValue | -## plannerRuleKind values +### plannerRuleKind values | Member | | | Possible values for user account types (group membership), per Windows definitio | planRule | | unknownFutureValue | -## plannerUserRoleKind values +### plannerUserRoleKind values | Member | | | | relationship | | unknownFutureValue | -## plannerTaskTargetKind values +### plannerTaskTargetKind values | Member | | | | group | | unknownFutureValue | -## onPremisesDirectorySynchronizationDeletionPreventionType values +### onPremisesDirectorySynchronizationDeletionPreventionType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | enabledForPercentage | | unknownFutureValue | -## authenticationMethodsPolicyMigrationState values +### authenticationMethodsPolicyMigrationState values | Member | | - | Possible values for user account types (group membership), per Windows definitio | migrationComplete | | unknownFutureValue | -## authenticationEventType values +### authenticationEventType values | Member | | | Possible values for user account types (group membership), per Windows definitio | pageRenderStart | | unknownFutureValue | -## microsoftAuthenticatorAuthenticationMethodClientAppName values +### microsoftAuthenticatorAuthenticationMethodClientAppName values | Member | | - | Possible values for user account types (group membership), per Windows definitio | outlookMobile | | unknownFutureValue | -## userDefaultAuthenticationMethodType values +### userDefaultAuthenticationMethodType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | sms | | unknownFutureValue | -## endUserNotificationPreference values +### endUserNotificationPreference values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## endUserNotificationSettingType values +### endUserNotificationSettingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | noNotification | | unknownFutureValue | -## endUserNotificationType values +### endUserNotificationType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | trainingReminder | | unknownFutureValue | -## notificationDeliveryFrequency values +### notificationDeliveryFrequency values | Member | | - | Possible values for user account types (group membership), per Windows definitio | biWeekly | | unknownFutureValue | -## notificationDeliveryPreference values +### notificationDeliveryPreference values | Member | | - | Possible values for user account types (group membership), per Windows definitio | deliverAfterCampaignEnd | | unknownFutureValue | -## oAuthAppScope values +### oAuthAppScope values | Member | | - | Possible values for user account types (group membership), per Windows definitio | sendMail | | unknownFutureValue | -## targettedUserType values +### targettedUserType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | allUsers | | unknownFutureValue | -## trainingAssignedTo values +### trainingAssignedTo values | Member | | - | Possible values for user account types (group membership), per Windows definitio | didNothing | | unknownFutureValue | -## trainingAvailabilityStatus values +### trainingAvailabilityStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | delete | | unknownFutureValue | -## trainingCompletionDuration values +### trainingCompletionDuration values | Member | | - | Possible values for user account types (group membership), per Windows definitio | month | | unknownFutureValue | -## trainingSettingType values +### trainingSettingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## trainingType values +### trainingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | phishing | | unknownFutureValue | -## verifiableCredentialPresentationStatusCode values +### verifiableCredentialPresentationStatusCode values | Member | | | Possible values for user account types (group membership), per Windows definitio | presentation_verified | | unknownFutureValue | -## labelKind values +### labelKind values | Member | | - | Possible values for user account types (group membership), per Windows definitio | enumerated | | unknownFutureValue | -## permissionKind values +### permissionKind values | Member | | - | Possible values for user account types (group membership), per Windows definitio | allPermissionsOnResourceApp | | unknownFutureValue | -## resourceScopeType values +### resourceScopeType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | tenant | | unknownFutureValue | -## rootDomains values +### rootDomains values | Member | | - | Possible values for user account types (group membership), per Windows definitio | allManagedAndEnumeratedFederated | | unknownFutureValue | -## allowedRolePrincipalTypes values +### allowedRolePrincipalTypes values | Member | | - | Possible values for user account types (group membership), per Windows definitio | group | | unknownFutureValue | -## b2bIdentityProvidersType values +### b2bIdentityProvidersType values | Member | | | Possible values for user account types (group membership), per Windows definitio | defaultConfiguredIdp | | unknownFutureValue | -## authorizationSystemActionSeverity values +### authorizationSystemActionSeverity values | Member | | - | Possible values for user account types (group membership), per Windows definitio | high | | unknownFutureValue | -## authorizationSystemActionType values +### authorizationSystemActionType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | read | | unknownFutureValue | -## awsPolicyType values +### awsPolicyType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## awsRoleTrustEntityType values +### awsRoleTrustEntityType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | webIdentity | | unknownFutureValue | -## awsRoleType values +### awsRoleType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## awsStatementEffect values +### awsStatementEffect values | Member | | - | Possible values for user account types (group membership), per Windows definitio | deny | | unknownFutureValue | -## azureRoleDefinitionType values +### azureRoleDefinitionType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## dataCollectionStatus values +### dataCollectionStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | offline | | unknownFutureValue | -## gcpRoleType values +### gcpRoleType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## permissionsDefinitionIdentityType values +### permissionsDefinitionIdentityType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | serviceAccount | | unknownFutureValue | -## permissionsModificationCapability values +### permissionsModificationCapability values | Member | | - | Possible values for user account types (group membership), per Windows definitio | noRecentDataCollected | | unknownFutureValue | -## permissionsRequestOccurrenceStatus values +### permissionsRequestOccurrenceStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | revokingFailed | | unknownFutureValue | -## statusDetail values +### statusDetail values | Member | | - | Possible values for user account types (group membership), per Windows definitio | rejected | | unknownFutureValue | -## socialIdentitySourceType values +### socialIdentitySourceType values | Member | | - | | facebook | | unknownFutureValue | -## authorizationSystemType values +### authorizationSystemType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | aws | | unknownFutureValue | -## awsAccessType values +### awsAccessType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | private | | unknownFutureValue | -## awsSecretInformationWebServices values +### awsSecretInformationWebServices values | Member | | - | Possible values for user account types (group membership), per Windows definitio | certificateManager | | unknownFutureValue | -## awsSecurityToolWebServices values +### awsSecurityToolWebServices values | Member | | - | Possible values for user account types (group membership), per Windows definitio | guardDuty | | unknownFutureValue | -## azureAccessType values +### azureAccessType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | private | | unknownFutureValue | -## azureEncryption values +### azureEncryption values | Member | | - | Possible values for user account types (group membership), per Windows definitio | customer | | unknownFutureValue | -## externalSystemAccessMethods values +### externalSystemAccessMethods values | Member | | - | Possible values for user account types (group membership), per Windows definitio | roleChaining | | unknownFutureValue | -## gcpAccessType values +### gcpAccessType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | private | | unknownFutureValue | -## gcpEncryption values +### gcpEncryption values | Member | | - | Possible values for user account types (group membership), per Windows definitio | customer | | unknownFutureValue | -## iamStatus values +### iamStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | disabled | | unknownFutureValue | -## devicePlatformType values +### devicePlatformType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | iOSMobileApplicationManagement | | unknownFutureValue | -## bookingPageAccessControl values +### bookingPageAccessControl values | Member | | - | Possible values for user account types (group membership), per Windows definitio | restrictedToOrganization | | unknownFutureValue | -## bookingsServiceAvailabilityType values +### bookingsServiceAvailabilityType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | customWeeklyHours | | unknownFutureValue | -## conditionalAccessTransferMethods values +### conditionalAccessTransferMethods values | Member | | - | Possible values for user account types (group membership), per Windows definitio | authenticationTransfer | | unknownFutureValue | -## claimConditionUserType values +### claimConditionUserType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | externalGuests | | unknownFutureValue | -## filterType values +### filterType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | contains | | unknownFutureValue | -## matchOn values +### matchOn values | Member | | - | Possible values for user account types (group membership), per Windows definitio | samAccountName | | unknownFutureValue | -## samlAttributeNameFormat values +### samlAttributeNameFormat values | Member | | - | Possible values for user account types (group membership), per Windows definitio | basic | | unknownFutureValue | -## samlNameIDFormat values +### samlNameIDFormat values | Member | | - | Possible values for user account types (group membership), per Windows definitio | persistent | | unknownFutureValue | -## samlSLOBindingType values +### samlSLOBindingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | httpPost | | unknownFutureValue | -## tokenFormat values +### tokenFormat values | Member | | - | Possible values for user account types (group membership), per Windows definitio | jwt | | unknownFutureValue | -## transformationExtractType values +### transformationExtractType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | suffix | | unknownFutureValue | -## transformationTrimType values +### transformationTrimType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | leadingAndTrailing | | unknownFutureValue | -## sharingRole values +### sharingRole values | Member | | - | Possible values for user account types (group membership), per Windows definitio | submitOnly | | unknownFutureValue | -## sharingScope values +### sharingScope values | Member | | - | Possible values for user account types (group membership), per Windows definitio | users | | unknownFutureValue | -## sharingVariant values +### sharingVariant values | Member | | - | Possible values for user account types (group membership), per Windows definitio | embed | | unknownFutureValue | -## trustFrameworkKeyStatus values +### trustFrameworkKeyStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | disabled | | unknownFutureValue | -## conditionalAccessInsiderRiskLevels values +### conditionalAccessInsiderRiskLevels values | Member | | - | Possible values for user account types (group membership), per Windows definitio | elevated | | unknownFutureValue | -## compliantNetworkType values +### compliantNetworkType values | Member | | - | | allTenantCompliantNetworks | | unknownFutureValue | -## meetingRequestType values +### meetingRequestType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | outdated | | principalWantsCopy | -## photoUpdateSource values +### photoUpdateSource values | Member | | - | | cloud | | onPremises | -## uriUsageType values +### uriUsageType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | logoutUrl | | unknownFutureValue | -## nativeAuthenticationApisEnabled values +### nativeAuthenticationApisEnabled values | Member | | - | | none | | all | | unknownFutureValue |++### nonAdminSetting values ++|Member| +|:| +|false| +|true| +|unknownFutureValue| |
v1.0 | Event | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/event.md | This resource supports: | Method | Return Type |Description| |:|:--|:-|-|[List events](../api/user-list-events.md)|[Event](event.md) collection |Retrieve a list of [event](../resources/event.md) objects in the user's mailbox. The list contains single instance meetings and series masters.| -|[Create event](../api/user-post-events.md) |[event](event.md)| Create a new event by posting to the instances collection.| -|[Get event](../api/event-get.md) | [event](event.md) |Read properties and relationships of event object.| -|[Update event](../api/event-update.md) | [event](event.md) |Update event object. | -|[Delete event](../api/event-delete.md) | None |Delete event object. | -|[Get delta](../api/event-delta.md)|[event](event.md) collection|Get a set of events that have been added, deleted, or updated in a **calendarView** (a range of events) of the user's primary calendar.| +|[List](../api/user-list-events.md)|[Event](event.md) collection |Retrieve a list of [event](../resources/event.md) objects in the user's mailbox. The list contains single instance meetings and series masters.| +|[Create](../api/user-post-events.md) |[event](event.md)| Create a new event by posting to the instances collection.| +|[Get](../api/event-get.md) | [event](event.md) |Read properties and relationships of event object.| +|[Update](../api/event-update.md) | [event](event.md) |Update event object. | +|[Delete](../api/event-delete.md) | None |Delete event object. | +|[Permanently delete](../api/event-permanentdelete.md)|None|Permanently delete an event and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.| +|[Get delta](../api/event-delta.md)|[event](event.md) collection|Get a set of events that were added, deleted, or updated in a **calendarView** (a range of events) of the user's primary calendar.| |[Forward event](../api/event-forward.md)|None|Lets the organizer or attendee of a meeting event forward the meeting request to a new recipient.| |[Cancel event](../api/event-cancel.md) | None | Send cancellation message from the organizer to all the attendees and cancel the specified meeting. | |[Accept event](../api/event-accept.md)|None|Accept the specified event in a user calendar.| This resource supports: |changeKey|String|Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.| |createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |end|[DateTimeTimeZone](datetimetimezone.md)|The date, time, and time zone that the event ends. By default, the end time is in UTC.|-|exceptionOccurrences|[event](event.md) collection|Contains the **id** property values of the event instances that are exceptions in a recurring series.<br>Exceptions can differ from other occurrences in a recurring series, such as the subject, start or end times, or attendees. Exceptions don't include canceled occurrences.<br><br>Returned only on $select and $expand in a [GET](../api/event-get.md) operation which specifies the id of a series master event (that is, the seriesMasterId property value).| +|exceptionOccurrences|[event](event.md) collection|Contains the **id** property values of the event instances that are exceptions in a recurring series.<br>Exceptions can differ from other occurrences in a recurring series, such as the subject, start or end times, or attendees. Exceptions don't include canceled occurrences.<br><br>Returned only on $select and $expand in a [GET](../api/event-get.md) operation that specifies the id of a series master event (that is, the **seriesMasterId** property value).| |hasAttachments|Boolean|Set to true if the event has attachments.| |hideAttendees|Boolean|When set to `true`, each attendee only sees themselves in the meeting request and meeting **Tracking** list. Default is false.| |iCalUId|String|A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.| This resource supports: |isAllDay|Boolean|Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.| |isCancelled|Boolean|Set to true if the event has been canceled.| |isDraft|Boolean|Set to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.|-|isOnlineMeeting|Boolean| `True` if this event has online meeting information (that is, **onlineMeeting** points to an [onlineMeetingInfo](onlinemeetinginfo.md) resource), `false` otherwise. Default is `false` (**onlineMeeting** is `null`). Optional. <br> After you set **isOnlineMeeting** to `true`, Microsoft Graph initializes **onlineMeeting**. Subsequently Outlook ignores any further changes to **isOnlineMeeting**, and the meeting remains available online. | +|isOnlineMeeting|Boolean| `True` if this event has online meeting information (that is, **onlineMeeting** points to an [onlineMeetingInfo](onlinemeetinginfo.md) resource), `false` otherwise. Default is `false` (**onlineMeeting** is `null`). Optional. <br> After you set **isOnlineMeeting** to `true`, Microsoft Graph initializes **onlineMeeting**. Outlook then ignores any further changes to **isOnlineMeeting**, and the meeting remains available online. | |isOrganizer|Boolean|Set to true if the calendar owner (specified by the **owner** property of the [calendar](calendar.md)) is the organizer of the event (specified by the **organizer** property of the **event**). This also applies if a delegate organized the event on behalf of the owner.| |isReminderOn|Boolean|Set to true if an alert is set to remind the user of the event.| |lastModifiedDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |location|[Location](location.md)|The location of the event.| |locations|[Location](location.md) collection|The locations where the event is held or attended from. The **location** and **locations** properties always correspond with each other. If you update the **location** property, any prior locations in the **locations** collection would be removed and replaced by the new **location** value. | |occurrenceId|String|An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series.<br><br>The format of the property value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time zone for {occurrence-start-date} is the recurrenceTimeZone property defined for the corresponding [recurrenceRange](recurrencerange.md).<br><br>This property can identify any occurrence in a recurring series, including an occurrence that has been modified or canceled. You can use this property to perform all operations supported by occurrences in the recurring series.|-|onlineMeeting|[OnlineMeetingInfo](onlinemeetinginfo.md)| Details for an attendee to join the meeting online. Default is null. Read-only. <br>After you set the **isOnlineMeeting** and **onlineMeetingProvider** properties to enable a meeting online, Microsoft Graph initializes **onlineMeeting**. When set, the meeting remains available online, and you cannot change the **isOnlineMeeting**, **onlineMeetingProvider**, and **onlneMeeting** properties again.| -|onlineMeetingProvider|onlineMeetingProviderType| Represents the online meeting service provider. By default, **onlineMeetingProvider** is `unknown`. The possible values are `unknown`, `teamsForBusiness`, `skypeForBusiness`, and `skypeForConsumer`. Optional. <br> After you set **onlineMeetingProvider**, Microsoft Graph initializes **onlineMeeting**. Subsequently you cannot change **onlineMeetingProvider** again, and the meeting remains available online. | +|onlineMeeting|[OnlineMeetingInfo](onlinemeetinginfo.md)| Details for an attendee to join the meeting online. Default is null. Read-only. <br>After you set the **isOnlineMeeting** and **onlineMeetingProvider** properties to enable a meeting online, Microsoft Graph initializes **onlineMeeting**. When set, the meeting remains available online, and you can't change the **isOnlineMeeting**, **onlineMeetingProvider**, and **onlneMeeting** properties again.| +|onlineMeetingProvider|onlineMeetingProviderType| Represents the online meeting service provider. By default, **onlineMeetingProvider** is `unknown`. The possible values are `unknown`, `teamsForBusiness`, `skypeForBusiness`, and `skypeForConsumer`. Optional. <br> After you set **onlineMeetingProvider**, Microsoft Graph initializes **onlineMeeting**. Subsequently you can't change **onlineMeetingProvider** again, and the meeting remains available online. | |onlineMeetingUrl|String|A URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.<br>To access the URL to join an online meeting, use **joinUrl** which is exposed via the **onlineMeeting** property of the **event**. The **onlineMeetingUrl** property will be deprecated in the future. | |organizer|[Recipient](recipient.md)|The organizer of the event.| |originalEndTimeZone|String|The end time zone that was set when the event was created. A value of `tzone://Microsoft/Custom` indicates that a legacy custom time zone was set in desktop Outlook.|-|originalStart|DateTimeOffset|Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| +|originalStart|DateTimeOffset|Represents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property isn't returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |originalStartTimeZone|String|The start time zone that was set when the event was created. A value of `tzone://Microsoft/Custom` indicates that a legacy custom time zone was set in desktop Outlook.| |recurrence|[PatternedRecurrence](patternedrecurrence.md)|The recurrence pattern for the event.| |reminderMinutesBeforeStart|Int32|The number of minutes before the event start time that the reminder alert occurs.| This resource supports: |showAs|String|The status to show. Possible values are: `free`, `tentative`, `busy`, `oof`, `workingElsewhere`, `unknown`.| |start|[DateTimeTimeZone](datetimetimezone.md)|The start date, time, and time zone of the event. By default, the start time is in UTC.| |subject|String|The text of the event's subject line.|-|transactionId|String|A custom identifier specified by a client app for the server to avoid redundant [POST](../api/calendar-post-events.md) operations in case of client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set **transactionId** when creating an event, you cannot change **transactionId** in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.| +|transactionId|String|A custom identifier specified by a client app for the server to avoid redundant [POST](../api/calendar-post-events.md) operations if the client retries to create the same event. This is useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set **transactionId** when creating an event, you can't change **transactionId** in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.| |type|String|The event type. Possible values are: `singleInstance`, `occurrence`, `exception`, `seriesMaster`. Read-only| |uid|String|A unique identifier for calendar events. For recurring events, the value is the same for the series master and all of its occurrences including exceptions.|-|webLink|String|The URL to open the event in Outlook on the web.<br/><br/>Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.<br/><br/>This URL cannot be accessed from within an iFrame.| +|webLink|String|The URL to open the event in Outlook on the web.<br/><br/>Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.<br/><br/>This URL can't be accessed from within an iFrame.| > [!NOTE] > The **webLink** property specifies a URL that opens the event in only earlier versions of Outlook on the web. The following is its URL format, with _{event-id}_ being the _**URL-encoded**_ value of the **id** property: This resource supports: |attachments|[Attachment](attachment.md) collection|The collection of [FileAttachment](fileattachment.md), [ItemAttachment](itemattachment.md), and [referenceAttachment](referenceattachment.md) attachments for the event. Navigation property. Read-only. Nullable.| |calendar|[Calendar](calendar.md)|The calendar that contains the event. Navigation property. Read-only.| |extensions|[Extension](extension.md) collection|The collection of open extensions defined for the event. Nullable.|-|instances|[Event](event.md) collection|The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern, and exceptions that have been modified, but doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.| +|instances|[Event](event.md) collection|The occurrences of a recurring series, if the event is a series master. This property includes occurrences that are part of the recurrence pattern and exceptions that have been modified. It doesn't include occurrences that have been canceled from the series. Navigation property. Read-only. Nullable.| |multiValueExtendedProperties|[multiValueLegacyExtendedProperty](multivaluelegacyextendedproperty.md) collection| The collection of multi-value extended properties defined for the event. Read-only. Nullable.| |singleValueExtendedProperties|[singleValueLegacyExtendedProperty](singlevaluelegacyextendedproperty.md) collection| The collection of single-value extended properties defined for the event. Read-only. Nullable.| |
v1.0 | Eventmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/eventmessage.md | Title: "eventMessage resource type" -description: "A message that represents a meeting request, cancellation, or response (which can be one of the following: acceptance, tentative acceptance, or decline). " +description: "A message that represents a meeting request, cancellation, or response. Can be one of the following values: acceptance, tentative acceptance, or decline." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A message that represents a meeting request, cancellation, or response (which can be one of the following: acceptance, tentative acceptance, or decline). +A message that represents a meeting request, cancellation, or response. Can be one of the following values: acceptance, tentative acceptance, or decline. The **eventMessage** entity is derived from [message](message.md). **eventMessage** is the base type for [eventMessageRequest](eventmessagerequest.md) and [eventMessageResponse](eventmessageresponse.md). The **meetingMessageType** property identifies the type of the event message. The following JSON representation shows the resource type. |receivedDateTime|DateTimeOffset|The date and time the message was received.| |recurrence|[patternedRecurrence](patternedrecurrence.md)|The recurrence pattern of the requested meeting.| |replyTo|[recipient](recipient.md) collection|The email addresses to use when replying.|-|sender|[recipient](recipient.md)|The account that is used to generate the message. In most cases, this value is the same as the **from** property. You can set this property to a different value when sending a message from a [shared mailbox](/exchange/collaboration/shared-mailboxes/shared-mailboxes), [for a shared calendar, or as a delegate](/graph/outlook-share-delegate-calendar). In any case, the value must correspond to the actual mailbox used. For more information, see [setting the from and sender properties](/graph/outlook-create-send-messages#setting-the-from-and-sender-properties).| +|sender|[recipient](recipient.md)|The account that is used to generate the message. In most cases, this value is the same as the **from** property. You can set this property to a different value when sending a message from a [shared mailbox](/exchange/collaboration/shared-mailboxes/shared-mailboxes), [for a shared calendar, or as a delegate](/graph/outlook-share-or-delegate-calendar). In any case, the value must correspond to the actual mailbox used. For more information, see [setting the from and sender properties](/graph/outlook-create-send-messages#setting-the-from-and-sender-properties).| |sentDateTime|DateTimeOffset|The date and time the message was sent.| |startDateTime|[dateTimeTimeZone](datetimetimezone.md)|The start time of the requested meeting.| |subject|String|The subject of the message.| The following JSON representation shows the resource type. | Method | Return Type |Description| |:|:--|:-|-|[Get event message](../api/eventmessage-get.md) | [eventMessage](eventmessage.md) |Read properties and relationships of eventMessage object.| -|[Update event message](../api/eventmessage-update.md) | [eventMessage](eventmessage.md) |Update eventMessage object.| -|[Delete event message](../api/eventmessage-delete.md) | None |Delete eventMessage object.| +|[Get](../api/eventmessage-get.md) | [eventMessage](eventmessage.md) |Read properties and relationships of eventMessage object.| +|[Update](../api/eventmessage-update.md) | [eventMessage](eventmessage.md) |Update eventMessage object.| +|[Delete](../api/eventmessage-delete.md) | None |Delete eventMessage object.| |[Copy message](../api/message-copy.md)|[message](message.md)|Copy a message to a folder.| |[Create draft to forward message](../api/message-createforward.md)|[message](message.md)|Create a draft of the Forward message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| |[Create draft to reply](../api/message-createreply.md)|[message](message.md)|Create a draft of the Reply message. You can then [update](../api/message-update.md) or [send](../api/message-send.md) the draft.| The following JSON representation shows the resource type. |[Send draft message](../api/message-send.md)|None|Sends a previously created message draft. The message is then saved in the Sent Items folder.| |[Recall message](../api/message-recall.md)|[message](message.md)|Recall a message in the specified user's mailbox Sent Items folder.| |[Unsubscribe](../api/message-unsubscribe.md)|None|Send a message using the data and address specified in the first mailto command in the List-Unsubscribe header.|+|[Permanently delete](../api/eventmessage-permanentdelete.md)|None|Permanently delete an event message and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.| |**Attachments**| | | |[List attachments](../api/eventmessage-list-attachments.md) |[attachment](attachment.md) collection| Get all attachments on an eventMessage.| |[Add attachment](../api/eventmessage-post-attachments.md) |[attachment](attachment.md)| Add a new attachment to an eventMessage by posting to the attachments collection.| |
v1.0 | Externalmeetingregistrant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalmeetingregistrant.md | Represents an external meeting registrant who enrolled in an online meeting. Inherits from [meetingRegistrantBase](../resources/meetingregistrantbase.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/). ## Methods |
v1.0 | Externalmeetingregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalmeetingregistration.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/). Represents external registration details of an [onlineMeeting](../resources/onlinemeeting.md). |
v1.0 | Externalsponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/externalsponsors.md | Title: "externalSponsors complex type" -description: "Identifies a relationship to another user in the tenant who will be allowed as approver." + Title: "externalSponsors resource type" +description: "Identifies a relationship to another user in the tenant who is allowed as approver." ms.localizationpriority: medium doc_type: "resourcePageType" -# externalSponsors complex type +# externalSponsors resource type Namespace: microsoft.graph |
v1.0 | Federatedidentitycredentials Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/federatedidentitycredentials-overview.md | You create a trust relationship between an external identity provider (IdP) and ## Set up federated identity credentials through Microsoft Graph -The [federatedIdentityCredential](federatedidentitycredential.md) resource represents the configuration of a federated identity credential via Microsoft Graph. The following properties are the building blocks of federated identity credentials: +The [federatedIdentityCredential](federatedidentitycredential.md) resource represents the configuration of a federated identity credential via Microsoft Graph. Use the [Create federatedIdentityCredential](../api/application-post-federatedidentitycredentials.md) API to configure the object. The following properties are the building blocks of federated identity credentials: -+ **audiences** — 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 might need to create a new application registration in your IdP to serve as the audience of this token. -+ **issuer** — The URL of the external identity provider. Must match the **issuer** claim of the external token being exchanged. -+ **subject** — The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each IdP 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. ++ **audiences** - 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 might need to create a new application registration in your IdP to serve as the audience of this token.++ **issuer** - The URL of the external identity provider. Must match the **issuer** claim of the external token being exchanged.++ **subject** - The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each IdP 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.++ **name** - A unique string to identify the credential. This property is an alternate key and the value can be used to reference the federated identity credential via the [GET](../api/federatedidentitycredential-get.md) and [UPSERT](../api/federatedidentitycredential-upsert.md) operations. -The combination of **issuer** and **subject** must be unique on the app. When the external software workload requests Microsoft identity platform to exchange the external token for an access token, the **issuer** and **subject** values of the federated identity credential are checked against the `issuer` and `subject` claims provided in the external token. If that validation check passes, Microsoft identity platform issues an access token to the external software workload. +The combination of **issuer** and **subject** must be unique on the app. When the external software workload requests Microsoft identity platform to exchange the external token for an access token, the **issuer** and **subject** values of the federated identity credential are checked against the `issuer` and `subject` claims provided in the external token. If that validation check passes, Microsoft identity platform issues an access token to the external software workload. ## Design considerations |
v1.0 | Fileattachment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/fileattachment.md | The following JSON representation shows the resource type. "name": "string", "size": "Int32" }- ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Filestoragecontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filestoragecontainer.md | Represents a location where multiple users or a group of users can store files a |[Update column](../api/filestoragecontainer-update-column.md)|[columnDefinition](../resources/columndefinition.md)|Update a column in a fileStorageContainer.| |[Delete file storage container column](../api/filestoragecontainer-delete-column.md)|None|Delete a column from a fileStorageContainer.| |[Get column](../api/filestoragecontainer-get-column.md)|[columnDefinition](../resources/columndefinition.md)|Get a column from a fileStorageContainer.|+|[Update recycle bin settings](../api/filestoragecontainer-update-recyclebinsettings.md)|[recyclebinsettings](../resources/recyclebinsettings.md)|Update recycleBin settings for a fileStorageContainer.| |[Restore recycle bin items](../api/filestoragecontainer-restore-recyclebin-items.md)|[recycleBinItem](../resources/recyclebinitem.md) collection|Restore recycle bin items in a fileStorageContainer.| |[Delete recycle bin items](../api/filestoragecontainer-delete-recyclebin-items.md)|None|Delete recycle bin items from a fileStorageContainer.| |[Get recycle bin items](../api/filestoragecontainer-list-recyclebin-items.md)|[recycleBinItem](../resources/recyclebinitem.md) collection|List recycle bin items in a fileStorageContainer.| Represents a location where multiple users or a group of users can store files a |customProperties|[fileStorageContainerCustomPropertyDictionary](../resources/filestoragecontainercustompropertydictionary.md)|Custom property collection for the **fileStorageContainer**. Read-write.| |description|String|Provides a user-visible description of the **fileStorageContainer**. Read-write.| |displayName|String|The display name of the **fileStorageContainer**. Read-write.|-|id|String|The unique stable identifier of the **filerStorageContainer**. Read-only.| -|isItemVersioningEnabled|Boolean|Indicates whether versioning is enabled for the **fileStorageContainer**. The setting is applicable to all items in the **fileStorageContainer**. Read-Write.| -|itemMajorVersionLimit|Int32|Maximum number of major versions allowed for items in the **fileStorageContainer**. Read-write.| +|id|String|The unique stable identifier of the **fileStorageContainer**. Read-only.| |owners|[userIdentity](../resources/useridentity.md) collection|List of users who own the **fileStorageContainer**. Read-only.|-|ownershipType|fileStorageContainerOwnershipType|Ownership type of the **fileStorageContainer**.The possible values are: `tenantOwned`. Read-only.| +|ownershipType|fileStorageContainerOwnershipType|Ownership type of the **fileStorageContainer**. The possible values are: `tenantOwned`. Read-only.| |status|fileStorageContainerStatus|Status of the **fileStorageContainer**. Containers are created as inactive and require activation. Inactive containers are subjected to automatic deletion in 24 hours. The possible values are: `inactive`, `active`. Read-only.| |storageUsedInBytes|Int64|Storage used in the **fileStorageContainer**, in bytes. Read-only.| |viewpoint|[fileStorageContainerViewpoint](../resources/filestoragecontainerviewpoint.md)|Data specific to the current user. Read-only.| |lockState|siteLockState|Indicates the lock state of the **fileStorageContainer**. The possible values are `unlocked` and `lockedReadOnly`. Read-only.|-|Settings|[fileStorageContainerSettings](../resources/filestoragecontainersettings.md)|Settings associated with a **fileStorageContainer**. Read-write. +|settings|[fileStorageContainerSettings](../resources/filestoragecontainersettings.md)|Settings associated with a **fileStorageContainer**. Read-write. ## Relationships |Relationship|Type|Description| |:|:|:| |columns|[columnDefinition](../resources/columndefinition.md) collection|The set of custom structured metadata supported by the **fileStorageContainer**. Read-write.| |drive|[drive](../resources/drive.md)|The drive of the resource **fileStorageContainer**. Read-only.|-|permissions|[permission](../resources/permission.md) collection|The set of permissions for users in the **fileStorageContainer**. The permission for each user is set by the **roles** property. The possible values are 'reader', 'writer', 'manager', and 'owner'. Read-write.| +|permissions|[permission](../resources/permission.md) collection|The set of permissions for users in the **fileStorageContainer**. The permission for each user is set by the **roles** property. The possible values are `reader`, `writer`, `manager`, and `owner`. Read-write.| |recycleBin|[recycleBin](../resources/recyclebin.md)|Recycle bin of the **fileStorageContainer**. Read-only.| ### roles property values The following JSON representation shows the resource type. "owners": [ { "@odata.type": "microsoft.graph.userIdentity" } ], "ownershipType": {"@odata.type": "microsoft.graph.fileStorageContainerOwnershipType"}, "expiryDateTime": "string (timestamp)",- "itemMajorVersionLimit": "int64", - "isItemVersioningEnabled": "boolean", "lockState": {"@odata.type": "microsoft.graph.siteLockState"}, "settings": { "@odata.type": "microsoft.graph.fileStorageContainerSettings" } } |
v1.0 | Filestoragecontainersettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/filestoragecontainersettings.md | doc_type: resourcePageType Namespace: microsoft.graph -Represents settings associated with a [fileStorageContainer](../resources/filestoragecontainer.md). +Represents the settings of a [fileStorageContainer](../resources/filestoragecontainer.md) object. ## Properties- |Property|Type|Description| |:|:|:|-|isOcrEnabled|Boolean|Indicates whether OCR is enabled for a given container. If OCR is enabled on a container, OCR extraction is performed for recently added or updated documents (of supported document types) and the extracted fields are added to the metadata of the document. This enables end-user search and search-driven solutions.| +|isOcrEnabled|Boolean|Indicates whether Optical Character Recognition (OCR) is enabled for the container. The default value is `false`. When set to `true`, OCR extraction is performed for new and updated documents of supported document types, and the extracted fields in the metadata of the document enable end-user search and search-driven solutions. When set to `false`, existing OCR metadata is not impacted. Optional. Read-write.| +|itemMajorVersionLimit|Int32|The maximum major versions allowed for items in the container. Optional. Read-write.| +|isItemVersioningEnabled|Boolean|Indicates whether versioning is enabled for items in the container. Optional. Read-write.| ## Relationships- None. ## JSON representation -The following JSON representation shows the resource type. +The following JSON representation shows the resource type. <!-- { The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.fileStorageContainerSettings",- "isOcrEnabled": "Boolean" + "isOcrEnabled": "Boolean", + "itemMajorVersionLimit": "int32", + "isItemVersioningEnabled": "Boolean" } ``` |
v1.0 | Group | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/group.md | This resource supports: | [Update event](../api/group-update-event.md) | None | Update the properties of an event object. | | [Delete event](../api/group-delete-event.md) | None | Delete event object. | | [List calendar view](../api/group-list-calendarview.md) | [event](event.md) collection | Get a collection of events in a specified time window. |+| **Cloud licensing** | | | +|[List usage rights](../api/cloudlicensing-groupcloudlicensing-list-usagerights.md)|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) collection|Get a list of the [usageRight](../resources/cloudlicensing-usageright.md) objects granted to a group.| +|[Get usage right](../api/cloudlicensing-usageright-get.md)|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md)|Get the properties and relationships of a [usageRight](../resources/cloudlicensing-usageright.md) object granted to a group.| | **Conversations** | | | | [List conversations](../api/group-list-conversations.md) | [conversation](conversation.md) collection | Get a conversation object collection. | | [Create conversation](../api/group-post-conversations.md) | [conversation](conversation.md) | Create a new conversation by posting to the conversations collection. | name. | |--|--|--| | accessType | groupAccessType | Indicates the type of access to the group. Possible values are `none`, `private`, `secret`, and `public`. | | allowExternalSenders | Boolean | Indicates if people external to the organization can send messages to the group. The default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). |-| assignedLabels | [assignedLabel](assignedlabel.md) collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. <br><br>Returned only on `$select`. | +| assignedLabels | [assignedLabel](assignedlabel.md) collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. <br><br>Returned only on `$select`. 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).| | assignedLicenses | [assignedLicense](assignedlicense.md) collection | The licenses that are assigned to the group. <br><br>Returned only on `$select`. Supports `$filter` (`eq`). Read-only. | | autoSubscribeNewMembers | Boolean | Indicates if new members added to the group are auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; don't set it in the initial POST request that creates the group. Default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | classification | String | Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList [setting](directorysetting.md) value, based on the [template definition](directorysettingtemplate.md).<br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`). |+| cloudLicensing | [microsoft.graph.cloudLicensing.groupCloudLicensing](../resources/cloudlicensing-groupcloudlicensing.md) | The relationships of a group to cloud licensing resources. | | createdByAppId | String | App ID of the app used to create the group. Can be null for some groups. <br><br>Returned by default. Read-only. Supports `$filter` (`eq`, `ne`, `not`, `in`, `startsWith`). | | createdDateTime | DateTimeOffset | Timestamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. <br><br>Returned by default. Read-only. | | deletedDateTime | DateTimeOffset | For some Microsoft Entra objects (user, group, application), if the object is deleted, it is first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null. If the object is restored, this property is updated to `null`. Inherited from [directoryObject](../resources/directoryobject.md). | name. | | members | [directoryObject](directoryobject.md) collection | Direct group members, who can be users, devices, other groups, or service principals. Supports the [List members](../api/group-list-members.md), [Add member](../api/group-post-members.md), and [Remove member](../api/group-delete-members.md) operations. Nullable. <br/>Supports `$expand` including nested `$select`. For example, `/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName)`. | | membersWithLicenseErrors | [user](user.md) collection | A list of group members with license errors from this group-based license assignment. Read-only. | | onenote | [onenote](onenote.md) | Read-only. |-| owners | [directoryObject](directoryobject.md) collection | The owners of the group who can be users or service principals. Nullable. If this property isn't specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. <br/> Supports `$filter` (`/$count eq 0`, `/$count ne 0`, `/$count eq 1`, `/$count ne 1`); Supports `$expand` including nested `$select`. For example, `/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName)`. | +| owners | [directoryObject](directoryobject.md) collection | The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. <li>If this property isn't specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. <li>A non-admin user can't explicitly add themselves to this collection when they're creating the group. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419). <li>For security groups, the admin user isn't automatically added to this collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419).<br/><br/> Supports `$filter` (`/$count eq 0`, `/$count ne 0`, `/$count eq 1`, `/$count ne 1`); Supports `$expand` including nested `$select`. For example, `/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName)`. | | permissionGrants | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) | The permissions granted for a group to a specific application. Supports `$expand`. | | photo | [profilePhoto](profilephoto.md) | The group's profile photo. | | photos | [profilePhoto](profilephoto.md) collection | The profile photos owned by the group. Read-only. Nullable. | The following JSON representation shows the resource type. "assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }], "allowExternalSenders": false, "autoSubscribeNewMembers": true,+ "cloudLicensing": { "@odata.type": "microsoft.graph.cloudLicensing.groupCloudLicensing" }, "createdByAppId": "String", "createdDateTime": "String (timestamp)", "deletedDateTime": "String (timestamp)", |
v1.0 | Groupmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/groupmembers.md | Title: "groupMembers complex type" -description: "Identifies a collection of users in the tenant who will be allowed as requestor, approver, or reviewer." + Title: "groupMembers resource type" +description: "Identifies a collection of users in the tenant who are allowed as requestor, approver, or reviewer." ms.localizationpriority: medium doc_type: "resourcePageType" -# groupMembers complex type +# groupMembers resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Used in the request, approval, and assignment review settings of an [access package assignment policy](accesspackageassignmentpolicy.md). -The `@odata.type` value `#microsoft.graph.groupMembers` indicates that this type identifies a collection of users in the tenant who will be allowed as requestor, approver, or reviewer, who are the members of a specific group. +The `@odata.type` value `#microsoft.graph.groupMembers` indicates that this type identifies a collection of users in the tenant who are allowed as requestor, approver, or reviewer, who are the members of a specific group. ## Properties |
v1.0 | Groups Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/groups-overview.md | Content-type: application/json } ``` -To learn more about Microsoft 365 groups and the administrator experiences, see [Learn about Microsoft 365 groups](https://support.office.com/article/Learn-about-Office-365-groups-b565caa1-5c40-40ef-9915-60fdb2d97fa2). - ## Security groups and mail-enabled security groups **Security groups** are for controlling user access to resources. By checking whether a user is a member of a security group, your app can make authorization decisions when that user is trying to access some secure resources in your app. Security groups can have users, other security groups, devices, and service principals as members. Using Microsoft Graph, you can perform the following common operations on groups ## Microsoft Entra roles for managing groups -To manage groups in delegated scenarios, the app must be granted the appropriate permissions and the signed-in user must be in a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +To manage groups in delegated scenarios, the app must be granted the appropriate Microsoft Graph permissions and the signed-in user must be in a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). -The following Microsoft Entra roles are the least privileged roles for managing all aspects of groups through Microsoft Graph, except for role-assignable groups. The least privileged role for managing role-assignable groups is **Privileged Role Administrator**. +The following Microsoft Entra roles are the least privileged roles for all read and write operations on groups through Microsoft Graph, *except* for role-assignable groups. The least privileged role for managing role-assignable groups is **Privileged Role Administrator**. - Directory Writers - Groups Administrator - User Administrator +For a summary of the least privileged admin roles for different group-related tasks, see [Least privileged roles to manage groups](/entra/identity/role-based-access-control/delegate-by-task#groups). ++You can also create custom roles for group-related tasks. Refer to the [Microsoft Entra built-in roles reference](/entr) with the selected permissions. + ## Next step > [!div class="nextstepaction"] |
v1.0 | Hardwareoathauthenticationmethodconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/hardwareoathauthenticationmethodconfiguration.md | -toc. Title: Hardware method +toc. Title: Hardware OATH # hardwareOathAuthenticationMethodConfiguration resource type |
v1.0 | Healthmonitoring Alert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-alert.md | + + Title: "alert resource type" +description: "Represents a system-detected health monitoring alert associated with common Microsoft Entra authentication and access management scenarios." ++ms.localizationpriority: medium ++++# alert resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a system-detected health monitoring alert associated with common Microsoft Entra authentication and access management scenarios. Anomaly detection catches unusual patterns in health metrics data streams, for example, unusually high MFA sign-in failures, and surfaces these patterns in the form of alerts in Microsoft Entra Health monitoring. ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/healthmonitoring-healthmonitoringroot-list-alerts.md)|[microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md) collection|Get a list of the [microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md) objects and their properties.| +|[Get](../api/healthmonitoring-alert-get.md)|[microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md)|Read the properties and relationships of a [microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md) object.| +|[Update](../api/healthmonitoring-alert-update.md)|[microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md)|Update the properties of a [microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md) object.| +++## Properties +|Property|Type|Description| +|:|:|:| +|alertType|microsoft.graph.healthMonitoring.alertType|Indicates which type of scenario an alert is associated with. The possible values are: `unknown`, `mfaSignInFailure`, `managedDeviceSignInFailure`, `compliantDeviceSignInFailure`, `unknownFutureValue`. Supports `$filter` (`eq`).| +|category|microsoft.graph.healthMonitoring.category|The classification that groups the scenario. The possible values are: `unknown`, `authentication`, `unknownFutureValue`. | +|createdDateTime|DateTimeOffset|The time when Microsoft Entra Health monitoring generated the alert. Supports `$orderby`.| +|documentation|[microsoft.graph.healthMonitoring.documentation](../resources/healthmonitoring-documentation.md)|A key-value pair that contains the name of and link to the documentation to aid in investigation of the alert.| +|enrichment|[microsoft.graph.healthMonitoring.enrichment](../resources/healthmonitoring-enrichment.md)|Investigative information on the alert. This information typically includes counts of impacted objects, which include directory objects such as users, groups, and devices, and a pointer to supporting data.| +|id|String|The unique GUID identifier of this alert in the associated tenant. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|scenario|microsoft.graph.healthMonitoring.scenario|The area being monitored on the system that is emitting the source signals. The possible values are: `unknown`, `mfa`, `devices`, `unknownFutureValue`. | +|signals|[microsoft.graph.healthMonitoring.signals](../resources/healthmonitoring-signals.md)|The collection of signals that were used in the generation of the alert. These signals are sourced from [serviceActivity APIs](../resources/serviceactivity.md) and are added to the alert as key-value pairs.| +|state|microsoft.graph.healthMonitoring.alertState|The current lifecycle state of the alert. The possible values are: `active`, `resolved`, `unknownFutureValue`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.healthMonitoring.alert", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.alert", + "id": "String (identifier)", + "alertType": "String", + "scenario": "String", + "category": "String", + "createdDateTime": "String (timestamp)", + "state": "String", + "enrichment": { + "@odata.type": "microsoft.graph.healthMonitoring.enrichment" + }, + "signals": { + "@odata.type": "microsoft.graph.healthMonitoring.signals" + }, + "documentation": { + "@odata.type": "microsoft.graph.healthMonitoring.documentation" + } +} +``` + |
v1.0 | Healthmonitoring Alertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-alertconfiguration.md | + + Title: "alertConfiguration resource type" +description: "Represents the configuration of an alert type defining behavior that occurs when an alert is created in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# alertConfiguration resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents the configuration of an alert type defining behavior that occurs when an alert is created in Microsoft Entra Health monitoring. For more information about alert configurations, see [What is Microsoft Entra Health?](/entra/identity/monitoring-health/concept-microsoft-entra-health). ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/healthmonitoring-healthmonitoringroot-list-alertconfigurations.md)|[microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) collection|Get a list of the [microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) objects and their properties.| +|[Get](../api/healthmonitoring-alertconfiguration-get.md)|[microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md)|Read the properties and relationships of a [microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) object.| +|[Update](../api/healthmonitoring-alertconfiguration-update.md)|[microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md)|Update the properties of a [microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|emailNotificationConfigurations|[microsoft.graph.healthMonitoring.emailNotificationConfiguration](../resources/healthmonitoring-emailnotificationconfiguration.md) collection|Defines the recipients of email notifications for an alert type. Currently, only one email notification configuration is supported for an alert configuration, meaning only one group can receive notifications for an alert type.| +|id|String|The unique identifier of this alert configuration under the associated tenant. For example: `mfaSignInFailure`, `managedDeviceSignInFailure`. The possible values correspond to the values of **alertType** for an [alert](../resources/healthmonitoring-alert.md) object. Inherited from [microsoft.graph.entity](../resources/entity.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.healthMonitoring.alertConfiguration", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.alertConfiguration", + "id": "String (identifier)", + "emailNotificationConfigurations": [ + { + "@odata.type": "microsoft.graph.healthMonitoring.emailNotificationConfiguration" + } + ] +} +``` + |
v1.0 | Healthmonitoring Applicationimpactsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-applicationimpactsummary.md | + + Title: "applicationImpactSummary resource type" +description: "Represents a summary of an impacted application resource type for an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# applicationImpactSummary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a summary of an impacted application resource type for an alert in Microsoft Entra Health monitoring. +++Inherits from [directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|impactedCount|String|The number of resources impacted. The count could be an exhaustive count or a sampling count. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|impactedCountLimitExceeded|Boolean|Indicates whether **impactedCount** is exhaustive or a sampling. When this value is "true," the limit was exceeded and **impactedCount** represents a sampling. Otherwise, **impactedCount** represents the true number of impacts. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|resourceType|String|The type of resource that was impacted, which is `application`. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|resourceSampling|[microsoft.graph.directoryObject](../resources/directoryobject.md) collection|The collection of sampling resources that were impacted. Inherited from [microsoft.graph.healthMonitoring.directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md)| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.applicationImpactSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.applicationImpactSummary", + "resourceType": "String", + "impactedCount": "Integer", + "impactedCountLimitExceeded": "Boolean" +} +``` + |
v1.0 | Healthmonitoring Deviceimpactsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-deviceimpactsummary.md | + + Title: "deviceImpactSummary resource type" +description: "Represents a summary of an impacted device resource type for an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# deviceImpactSummary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a summary of an impacted device resource type for an alert in Microsoft Entra Health monitoring. +++Inherits from [directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|impactedCount|String|The number of resources impacted. The number could be an exhaustive count or a sampling count. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|impactedCountLimitExceeded|Boolean|Indicates whether **impactedCount** is exhaustive or a sampling. When this value is "true," the limit was exceeded and **impactedCount** represents a sampling. Otherwise, **impactedCount** represents the true number of impacts. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|resourceType|String|The type of resource that was impacted, which is `device`. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|resourceSampling|[microsoft.graph.directoryObject](../resources/directoryobject.md) collection|The collection of sampling resources that were impacted. Inherited from [microsoft.graph.healthMonitoring.directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md)| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.deviceImpactSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.deviceImpactSummary", + "resourceType": "String", + "impactedCount": "Integer", + "impactedCountLimitExceeded": "Boolean" +} +``` + |
v1.0 | Healthmonitoring Dictionary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-dictionary.md | + + Title: "dictionary resource type" +description: "Represents a dictionary type that consists of key-value pairs." ++ms.localizationpriority: medium ++++# dictionary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a dictionary type that consists of key-value pairs. This resource is an open type that allows other properties to be passed in. +++## Properties ++None ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.dictionary", + "openType": true +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.dictionary" +} +``` + |
v1.0 | Healthmonitoring Directoryobjectimpactsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-directoryobjectimpactsummary.md | + + Title: "directoryObjectImpactSummary resource type" +description: "Represents a summary of an impacted resource in the directory object type." ++ms.localizationpriority: medium ++++# directoryObjectImpactSummary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a summary of an impacted resource in the directory (Microsoft Entra ID) object type. +This type is an abstract type from which the following resources inherit: +- [applicationImpactSummary](../resources/healthmonitoring-applicationimpactsummary.md) +- [deviceImpactSummary](../resources/healthmonitoring-deviceimpactsummary.md) +- [groupImpactSummary](../resources/healthmonitoring-groupimpactsummary.md) +- [servicePrincipalImpactSummary](../resources/healthmonitoring-serviceprincipalimpactsummary.md) +- [userImpactSummary](../resources/healthmonitoring-userimpactsummary.md) ++Inherits from [resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|impactedCount|String|The number of resources impacted. The number could be an exhaustive count or a sampling count. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|impactedCountLimitExceeded|Boolean|Indicates whether **impactedCount** is exhaustive or a sampling. When this value is "true," the limit was exceeded and **impactedCount** represents a sampling. Otherwise, **impactedCount** represents the true number of impacts. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|resourceType|String|The type of resource that was impacted. Examples include `user`, `group`, `application`, `servicePrincipal`, `device`. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|resourceSampling|[microsoft.graph.directoryObject](../resources/directoryobject.md) collection|The collection of sampling resources that were impacted. Supports $expand.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.directoryObjectImpactSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.directoryObjectImpactSummary", + "resourceType": "String", + "impactedCount": "Integer", + "impactedCountLimitExceeded": "Boolean" +} +``` + |
v1.0 | Healthmonitoring Documentation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-documentation.md | + + Title: "documentation resource type" +description: "Represents a key-value pair that contains the name of and a link to the documentation to aid in investigating an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# documentation resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a key-value pair that contains the name of and a link to the documentation to aid in investigating an alert in Microsoft Entra Health monitoring. This resource is an open type that allows other properties to be passed in. ++Inherits from [healthMonitoringDictionary](../resources/healthmonitoring-healthmonitoringdictionary.md). ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.documentation", + "openType": true +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.documentation" +} +``` + |
v1.0 | Healthmonitoring Emailnotificationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-emailnotificationconfiguration.md | + + Title: "emailNotificationConfiguration resource type" +description: "Represents the email configuration for an alert type in Microsoft Entra Health monitoring. " ++ms.localizationpriority: medium ++++# emailNotificationConfiguration resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents the email configuration for an alert type in Microsoft Entra Health monitoring. ++## Properties +|Property|Type|Description| +|:|:|:| +|groupId|String|The identifier of the group to send an email to. All group types with configured email addresses are supported.| +|isEnabled|Boolean|Indicates whether email notifications are enabled on the alert type.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.emailNotificationConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.emailNotificationConfiguration", + "groupId": "String", + "isEnabled": "Boolean" +} +``` + |
v1.0 | Healthmonitoring Enrichment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-enrichment.md | + + Title: "enrichment resource type" +description: "Represents more context for an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# enrichment resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents more context for an [alert](../resources/healthmonitoring-alert.md) in Microsoft Entra Health monitoring. ++## Properties +|Property|Type|Description| +|:|:|:| +|impacts|[microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md) collection|A collection of resource impact summaries that gives a high level view of the kind of resources that were impacted and to what degree.| +|state|microsoft.graph.healthMonitoring.enrichmentState|The current enrichment state of the alert. The possible values are: `none`, `inProgress`, `enriched`, `unknownFutureValue`.| +|supportingData|[microsoft.graph.healthMonitoring.supportingData](../resources/healthmonitoring-supportingdata.md)|A collection of supportingData locations that can be queried for debugging the alert.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.enrichment" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.enrichment", + "state": "String", + "impacts": [ + { + "@odata.type": "microsoft.graph.healthMonitoring.resourceImpactSummary" + } + ], + "supportingData": { + "@odata.type": "microsoft.graph.healthMonitoring.supportingData" + } +} +``` + |
v1.0 | Healthmonitoring Groupimpactsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-groupimpactsummary.md | + + Title: "groupImpactSummary resource type" +description: "Represents a summary of an impacted group resource type for an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# groupImpactSummary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a summary of an impacted group resource type for an alert in Microsoft Entra Health monitoring. +++Inherits from [directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|impactedCount|String|The number of resources impacted. The number could be an exhaustive count or a sampling count. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|impactedCountLimitExceeded|Boolean|Indicates whether **impactedCount** is exhaustive or a sampling. When this value is "true," the limit was exceeded and **impactedCount** represents a sampling. Otherwise, **impactedCount** represents the true number of impacts. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|resourceType|String|The type of resource that was impacted, which is `group`. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|resourceSampling|[microsoft.graph.directoryObject](../resources/directoryobject.md) collection|Shows a collection of sampling resources that were impacted. Inherited from [microsoft.graph.healthMonitoring.directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md)| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.groupImpactSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.groupImpactSummary", + "resourceType": "String", + "impactedCount": "Integer", + "impactedCountLimitExceeded": "Boolean" +} +``` + |
v1.0 | Healthmonitoring Healthmonitoringdictionary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-healthmonitoringdictionary.md | + + Title: "healthMonitoringDictionary resource type" +description: "Represents a dictionary type used in Microsoft Entra Health monitoring. This resource is an open type that allows other properties to be passed in." ++ms.localizationpriority: medium ++++# healthMonitoringDictionary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a dictionary type used in Microsoft Entra Health monitoring. This resource is an open type that allows other properties to be passed in. +++Inherits from [Dictionary](../resources/healthmonitoring-dictionary.md). ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.healthMonitoringDictionary", + "openType": true +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.healthMonitoringDictionary" +} +``` + |
v1.0 | Healthmonitoring Healthmonitoringroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-healthmonitoringroot.md | + + Title: "healthMonitoringRoot resource type" +description: "Represents a container for navigation properties of resources for Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# healthMonitoringRoot resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a container for navigation properties of resources for Microsoft Entra Health monitoring. +++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods ++None. ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier. Inherited from [microsoft.graph.entity](../resources/entity.md).| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|alertConfigurations|[microsoft.graph.healthMonitoring.alertConfiguration](../resources/healthmonitoring-alertconfiguration.md) collection|The configuration of an alert type, which defines behavior that occurs when an alert is created.| +|alerts|[microsoft.graph.healthMonitoring.alert](../resources/healthmonitoring-alert.md) collection|The collection of health monitoring system detected alerts for anomalous usage patterns found in a Microsoft Entra tenant.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.healthMonitoring.healthMonitoringRoot", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.healthMonitoringRoot", + "id": "String (identifier)" +} +``` + |
v1.0 | Healthmonitoring Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-overview.md | + + Title: "Microsoft Entra Health monitoring API overview" +description: "The Microsoft Entra Health monitoring APIs allow you to view anomalous usage patterns for your tenant on business-critical identity scenarios and receive alert notifications." ++ms.localizationpriority: medium ++toc. Title: "Health monitoring" +++# Microsoft Entra Health monitoring API overview ++Namespace: microsoft.graph.healthMonitoring +++The Microsoft Entra Health monitoring alerts APIs allow you to view anomalous usage patterns for your tenant on business-critical identity scenarios and receive alert notifications. The API is built to fire alerts based on monitoring the health metric streams in [serviceActivity APIs](../resources/serviceactivity.md). These alerts contain information about the type, date, and impact of the anomalous usage patterns and allow you to investigate and remediate issues that you find. ++## Licenses ++For more information about the licenses required to use this premium feature, see [Microsoft Entra licensing: Microsoft Entra monitoring and health](/entra/fundamentals/licensing#microsoft-entra-monitoring-and-health). ++## Common requests ++The following table lists some common requests that you can use with this API. ++| Scenarios | API | +| -- | -- | +| Retrieve all alerts of a Microsoft Entra tenant | [List alerts](../api/healthmonitoring-healthmonitoringroot-list-alerts.md) | +| Retrieve an alert and its associated data, including the impacted resources | [Get alert](../api/healthmonitoring-alert-get.md) | +| Update the state of an alert | [Update alert](../api/healthmonitoring-alert-update.md) | +| Retrieve alert configurations for all alert types | [List alert configurations](../api/healthmonitoring-healthmonitoringroot-list-alertconfigurations.md) | +| Retrieve alert configuration for an alert type | [Get alert configuration](../api/healthmonitoring-alertconfiguration-get.md) | +| Update alert configuration for an alert type | [Update alert configuration](../api/healthmonitoring-alertconfiguration-update.md) | ++> [!NOTE] +> You might see `unknownFutureValue` as a member in enums due to evolvable enumerations. Here's how you can [handle future members in evolvable enumerations](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). ++## Related content ++- [What is Microsoft Entra Health?](/entra/identity/monitoring-health/concept-microsoft-entra-health) |
v1.0 | Healthmonitoring Resourceimpactsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-resourceimpactsummary.md | + + Title: "resourceImpactSummary resource type" +description: "Represent a summary of the impacted resource type for a Microsoft Entra Health monitoring alert." ++ms.localizationpriority: medium ++++# resourceImpactSummary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represent a summary of the impacted resource type for a Microsoft Entra Health monitoring [alert](../resources/healthmonitoring-alert.md). ++This resource is an abstract type from which the [directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md) resource inherits. ++## Properties +|Property|Type|Description| +|:|:|:| +|impactedCount|String|The number of resources impacted. The number could be an exhaustive count or a sampling count.| +|impactedCountLimitExceeded|Boolean|Indicates whether **impactedCount** is exhaustive or a sampling. When this value is `true`, the limit was exceeded and **impactedCount** represents a sampling; otherwise, **impactedCount** represents the true number of impacts.| +|resourceType|String|The type of resource that was impacted. Examples include `user`, `group`, `application`, `servicePrincipal`, `device`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.resourceImpactSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.resourceImpactSummary", + "resourceType": "String", + "impactedCount": "Integer", + "impactedCountLimitExceeded": "Boolean" +} +``` + |
v1.0 | Healthmonitoring Serviceprincipalimpactsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-serviceprincipalimpactsummary.md | + + Title: "servicePrincipalImpactSummary resource type" +description: "Represents a summary of an impacted service principal resource type for an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# servicePrincipalImpactSummary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a summary of an impacted service principal resource type for an alert in Microsoft Entra Health monitoring. +++Inherits from [directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|impactedCount|String|The number of resources impacted. The number could be an exhaustive count or a sampling count. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|impactedCountLimitExceeded|Boolean|Indicates whether **impactedCount** is exhaustive or a sampling. When this value is "true," the limit was exceeded and **impactedCount** represents a sampling. Otherwise, **impactedCount** represents the true number of impacts. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|resourceType|String|The type of resource that was impacted, which is `servicePrincipal`. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|resourceSampling|[microsoft.graph.directoryObject](../resources/directoryobject.md) collection|The collection of sampling resources that were impacted. Inherited from [microsoft.graph.healthMonitoring.directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md)| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.servicePrincipalImpactSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.servicePrincipalImpactSummary", + "resourceType": "String", + "impactedCount": "Integer", + "impactedCountLimitExceeded": "Boolean" +} +``` + |
v1.0 | Healthmonitoring Signals | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-signals.md | + + Title: "signals resource type" +description: "Represents a collection of signals that are used in the generation of an alert in Microsoft Entra Health." ++ms.localizationpriority: medium ++++# signals resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a collection of signals that are used in the generation of an [alert](../resources/healthmonitoring-alert.md) in Microsoft Entra Health. ++This resource is an open type that allows other properties to be passed in. +++Inherits from [healthMonitoringDictionary](../resources/healthmonitoring-healthmonitoringdictionary.md). ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.signals", + "openType": true +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.signals" +} +``` + |
v1.0 | Healthmonitoring Supportingdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-supportingdata.md | + + Title: "supportingData resource type" +description: "Represents a collection of supporting data locations that can be queried for debugging an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# supportingData resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a collection of supporting data locations that can be queried for debugging an [alert](../resources/healthmonitoring-alert.md) in Microsoft Entra Health monitoring. ++This resource is an open type that allows other properties to be passed in. +++Inherits from [healthMonitoringDictionary](../resources/healthmonitoring-healthmonitoringdictionary.md). ++## Properties ++None. ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.supportingData", + "openType": true +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.supportingData" +} +``` + |
v1.0 | Healthmonitoring Userimpactsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/healthmonitoring-userimpactsummary.md | + + Title: "userImpactSummary resource type" +description: "Represents a summary of an impacted user resource type for an alert in Microsoft Entra Health monitoring." ++ms.localizationpriority: medium ++++# userImpactSummary resource type ++Namespace: microsoft.graph.healthMonitoring +++Represents a summary of an impacted user resource type for an alert in Microsoft Entra Health monitoring. +++Inherits from [directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|impactedCount|String|The number of resources impacted. The number could be an exhaustive count or a sampling count. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|impactedCountLimitExceeded|Boolean|Indicates whether **impactedCount** is exhaustive or a sampling. When this value is "true," the limit was exceeded and **impactedCount** represents a sampling. Otherwise, **impactedCount** represents the true number of impacts. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| +|resourceType|String|The type of resource that was impact, which is `user`. Inherited from [microsoft.graph.healthMonitoring.resourceImpactSummary](../resources/healthmonitoring-resourceimpactsummary.md).| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|resourceSampling|[microsoft.graph.directoryObject](../resources/directoryobject.md) collection|The collection of sampling resources that were impacted. Inherited from [microsoft.graph.healthMonitoring.directoryObjectImpactSummary](../resources/healthmonitoring-directoryobjectimpactsummary.md)| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.healthMonitoring.userImpactSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.healthMonitoring.userImpactSummary", + "resourceType": "String", + "impactedCount": "Integer", + "impactedCountLimitExceeded": "Boolean" +} +``` + |
v1.0 | Identifieruriconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identifieruriconfiguration.md | + + Title: "identifierUriConfiguration resource type" +description: "Configuration object to configure restrictions for identifier URIs on applications." ++ms.localizationpriority: medium ++++# identifierUriConfiguration resource type ++Namespace: microsoft.graph +++ Represents a restriction to block identifier URI formats on applications that could either be easily compromised or used for compromise. ++## Properties +| Property | Type | Description | +| :--| : | :-- | +| nonDefaultUriAddition | [identifierUriRestriction](../resources/identifierurirestriction.md) | Block new identifier URIs for applications, unless they are the "default" URI of the format `api://{appId}`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identifierUriConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identifierUriConfiguration", + "nonDefaultUriAddition": { + "@odata.type": "microsoft.graph.identifierUriRestriction" + } +} +``` + |
v1.0 | Identifierurirestriction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identifierurirestriction.md | + + Title: "identifierUriRestriction resource type" +description: "Configuration object to configure a restriction for identifier URIs on applications." ++ms.localizationpriority: medium ++++# identifierUriRestriction resource type ++Namespace: microsoft.graph +++Configuration object to configure a restriction for identifier URIs on application objects. ++## Properties +| Property | Type | Description | +| : | : | :-- | +| excludeAppsReceivingV2Tokens | Boolean | If `true`, the restriction isn't enforced for applications that are configured to receive V2 tokens in Entra ID; else, the restriction isn't enforced for those applications.| +| excludeSaml | Boolean | If `true`, the restriction isn't enforced for SAML applications in Microsoft Entra ID; else, the restriction is enforced for those applications.| +| restrictForAppsCreatedAfterDateTime | String | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.| +| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identifierUriRestriction" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identifierUriRestriction", + "state": "String", + "restrictForAppsCreatedAfterDateTime": "String (timestamp)", + "excludeAppsReceivingV2Tokens": "Boolean", + "excludeSaml": "Boolean" +} +``` + |
v1.0 | Identitygovernance Attributechangetrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-attributechangetrigger.md | Title: "attributeChangeTrigger resource type" -description: "An abstract type representing changes in user attributes that trigger the execution of workload conditions for a user." +description: "Represents changes in user attributes that trigger the execution of workload conditions for a user." ms.localizationpriority: medium Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An abstract type representing changes in user attributes that trigger the execution of workload conditions for a user. +Represents changes in user attributes that trigger the execution of workload conditions for a user. Inherits from [microsoft.graph.identityGovernance.workflowExecutionTrigger](../resources/identitygovernance-workflowexecutiontrigger.md). |
v1.0 | Identitygovernance Insights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-insights.md | Inherits from [microsoft.graph.entity](../resources/entity.md). ## Properties -None. +None. ## Relationships |
v1.0 | Identitygovernance Membershipchangetrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-membershipchangetrigger.md | Title: "membershipChangeTrigger resource type" -description: "An abstract type representing the change in group membership that triggers the execution conditions of a workflow for a user." +description: "Represents the change in group membership that triggers the execution conditions of a workflow for a user." ms.localizationpriority: medium Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An abstract type representing the change in group membership that triggers the execution conditions of a workflow for a user. +Represents the change in group membership that triggers the execution conditions of a workflow for a user. Inherits from [microsoft.graph.identityGovernance.workflowExecutionTrigger](../resources/identitygovernance-workflowexecutiontrigger.md). |
v1.0 | Identitygovernance Triggerattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-triggerattribute.md | Title: "triggerAttribute resource type" -description: "An abstract type that defines the trigger attribute, which is changed to activate a workflow using an attributeChangeTrigger." +description: "Defines the trigger attribute, which is changed to activate a workflow using an attributeChangeTrigger." ms.localizationpriority: medium Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An abstract type that defines the trigger attribute, which is changed to activate a workflow using an [attributeChangeTrigger](../resources/identitygovernance-attributechangetrigger.md). +Defines the trigger attribute, which is changed to activate a workflow using an [attributeChangeTrigger](../resources/identitygovernance-attributechangetrigger.md). ## Properties |Property|Type|Description| |
v1.0 | Identitygovernance Workflowexecutionconditions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-workflowexecutionconditions.md | Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -This is an abstract type noting the workflow execution conditions in [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) and [workflowBase](../resources/identitygovernance-workflowbase.md) objects. Execution conditions define when a workflow runs and rules that identify the users that are the target of the workflow. The following types are derived from this abstract type: +The workflowExecutionConditions type notes the workflow execution conditions in [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) and [workflowBase](../resources/identitygovernance-workflowbase.md) objects. Execution conditions define when a workflow runs and rules that identify the users that are the target of the workflow. The following types are derived from this abstract type: + [onDemandExecutionOnly](../resources/identitygovernance-ondemandexecutiononly.md) + [triggerAndScopeBasedConditions](../resources/identitygovernance-triggerandscopebasedconditions.md) |
v1.0 | Identitygovernance Workflowexecutiontrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identitygovernance-workflowexecutiontrigger.md | Namespace: microsoft.graph.identityGovernance [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An abstract type that represents the workflow execution trigger when the [workflow runs on schedule](../resources/identitygovernance-triggerandscopebasedconditions.md). Inherited by the following derived types: +The workflowExecutionTrigger type represents the workflow execution trigger when the [workflow runs on schedule](../resources/identitygovernance-triggerandscopebasedconditions.md). Inherited by the following derived types: + [timeBasedAttributeTrigger](../resources/identitygovernance-timebasedattributetrigger.md) + [attributeChangeTrigger](../resources/identitygovernance-attributechangetrigger.md) + [membershipChangeTrigger](../resources/identitygovernance-membershipchangetrigger.md) |
v1.0 | Identityuserflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/identityuserflow.md | ms.localizationpriority: medium doc_type: "resourcePageType"+toc. Title: User flows in Azure AD B2C (deprecated) # identityUserFlow resource type Namespace: microsoft.graph [!INCLUDE [identityuserflow-deprecate](../../includes/identityuserflow-deprecate.md)] -User Flows enable you to define predefined, configurable policies for sign in, sign up, combined sign up and sign in, password reset and profile update. +User Flows enable you to define predefined, configurable policies for sign-in, sign-up, combined sign-up and sign-in, password reset, and profile update. ## Methods |
v1.0 | Incomingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/incomingcalloptions.md | Inherits from [callOptions](calloptions.md). |:|:--|:| | hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | | isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). |+| isDeltaRosterEnabled | Boolean | Indicates whether delta roster is enabled for the call. Inherited from [callOptions](calloptions.md). | ## JSON representation The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.incomingCallOptions", "hideBotAfterEscalation": "Boolean",- "isContentSharingNotificationEnabled": "Boolean" + "isContentSharingNotificationEnabled": "Boolean", + "isDeltaRosterEnabled": "Boolean" } ``` |
v1.0 | Industrydata Credential | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/industrydata-credential.md | Title: "industryData credential resource type" + Title: "credential resource type" description: "Represents a base type for credentials supported in the Industry Data API." ms.localizationpriority: medium-# industryData credential resource type +# credential resource type Namespace: microsoft.graph.industryData [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a base type for credentials supported in the Industry Data API. This is an abstract type. +Represents a base type for credentials supported in the Industry Data API. This type is abstract. ## Properties |Property|Type|Description| |
v1.0 | Insights Insightidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/insights-insightidentity.md | Title: insightIdentity complex type + Title: "insightIdentity resource type" description: "Complex type containing properties of Shared items." ms.localizationpriority: medium-# insightIdentity complex type +# insightIdentity resource type Namespace: microsoft.graph |
v1.0 | Internaldomainfederation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/internaldomainfederation.md | Inherits from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md). |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |nextSigningCertificate|String|Fallback token signing certificate that can also be used to sign tokens, for example when the primary signing certificate expires. Formatted as Base64 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 auto-rollover 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 into Microsoft Entra services. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).|-|preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| +|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`. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.| |signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 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 will update the federation settings for the domain when a new certificate is available. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| The following JSON representation shows the resource type. "certificateUpdateResult": "String", "@odata.type": "microsoft.graph.signingCertificateUpdateStatus" },- "federatedIdpMfaBehavior": "String" + "federatedIdpMfaBehavior": "String", + "passwordResetUri": "String" } ``` |
v1.0 | Internalsponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/internalsponsors.md | Title: "internalSponsors complex type" -description: "Identifies a relationship to another user in the tenant who will be allowed as approver." + Title: "internalSponsors resource type" +description: "Identifies a relationship to another user in the tenant who can approve." ms.localizationpriority: medium doc_type: "resourcePageType" -# internalSponsors complex type +# internalSponsors resource type Namespace: microsoft.graph |
v1.0 | Intune Androidforwork Androiddeviceownerenrollmentmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androiddeviceownerenrollmentmode.md | doc_type: enumPageType # androidDeviceOwnerEnrollmentMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The enrollment mode for an enrollment profile. ## Members |
v1.0 | Intune Androidforwork Androiddeviceownerenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androiddeviceownerenrollmentprofile.md | doc_type: resourcePageType # androidDeviceOwnerEnrollmentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enrollment Profile used to enroll Android Enterprise devices using Google's Cloud Management. ## Methods Enrollment Profile used to enroll Android Enterprise devices using Google's Clou |[revokeToken action](../api/intune-androidforwork-androiddeviceownerenrollmentprofile-revoketoken.md)|None|| |[createToken action](../api/intune-androidforwork-androiddeviceownerenrollmentprofile-createtoken.md)|None|| |[getDefaultTeamsDeviceNonGmsEnrollmentProfile action](../api/intune-androidforwork-androiddeviceownerenrollmentprofile-getdefaultteamsdevicenongmsenrollmentprofile.md)|[enrollmentProfileForNonGmsTeamsDevice](../resources/intune-androidforwork-enrollmentprofilefornongmsteamsdevice.md)||+|[setEnrollmentTimeDeviceMembershipTarget action](../api/intune-androidforwork-androiddeviceownerenrollmentprofile-setenrollmenttimedevicemembershiptarget.md)|[enrollmentTimeDeviceMembershipTargetResult](../resources/intune-shared-enrollmenttimedevicemembershiptargetresult.md)|| +|[retrieveEnrollmentTimeDeviceMembershipTarget action](../api/intune-androidforwork-androiddeviceownerenrollmentprofile-retrieveenrollmenttimedevicemembershiptarget.md)|[enrollmentTimeDeviceMembershipTargetResult](../resources/intune-shared-enrollmenttimedevicemembershiptargetresult.md)|| +|[clearEnrollmentTimeDeviceMembershipTarget action](../api/intune-androidforwork-androiddeviceownerenrollmentprofile-clearenrollmenttimedevicemembershiptarget.md)|None|| ## Properties |Property|Type|Description| |
v1.0 | Intune Androidforwork Androiddeviceownerenrollmenttokentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androiddeviceownerenrollmenttokentype.md | doc_type: enumPageType # androidDeviceOwnerEnrollmentTokenType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The enrollment token type for an enrollment profile. ## Members |
v1.0 | Intune Androidforwork Androidenrollmentcompanycode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidenrollmentcompanycode.md | doc_type: resourcePageType # androidEnrollmentCompanyCode resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class to hold specialty enrollment data used for enrolling via Google's Android Management API, such as Token, Url, and QR code content ## Properties |
v1.0 | Intune Androidforwork Androidforworkappconfigurationschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkappconfigurationschema.md | doc_type: resourcePageType # androidForWorkAppConfigurationSchema resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Schema describing an Android for Work application's custom configurations. ## Methods |
v1.0 | Intune Androidforwork Androidforworkappconfigurationschemaitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkappconfigurationschemaitem.md | doc_type: resourcePageType # androidForWorkAppConfigurationSchemaItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Single configuration item inside an Android for Work application's custom configuration schema. ## Properties |
v1.0 | Intune Androidforwork Androidforworkappconfigurationschemaitemdatatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkappconfigurationschemaitemdatatype.md | doc_type: enumPageType # androidForWorkAppConfigurationSchemaItemDataType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Data type for a configuration item inside an Android for Work application's custom configuration schema ## Members |
v1.0 | Intune Androidforwork Androidforworkbindstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkbindstatus.md | doc_type: enumPageType # androidForWorkBindStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Bind status of the tenant with the Google EMM API ## Members |
v1.0 | Intune Androidforwork Androidforworkenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkenrollmentprofile.md | doc_type: resourcePageType # androidForWorkEnrollmentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enrollment Profile used to enroll COSU devices using Google's Cloud Management. ## Methods |
v1.0 | Intune Androidforwork Androidforworkenrollmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworkenrollmenttarget.md | doc_type: enumPageType # androidForWorkEnrollmentTarget enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android for Work device management targeting type for the account ## Members |
v1.0 | Intune Androidforwork Androidforworksettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworksettings.md | doc_type: resourcePageType # androidForWorkSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Settings for Android For Work. ## Methods |
v1.0 | Intune Androidforwork Androidforworksyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidforworksyncstatus.md | doc_type: enumPageType # androidForWorkSyncStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Sync status of the tenant with the Google EMM API ## Members |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountappsyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountappsyncstatus.md | doc_type: enumPageType # androidManagedStoreAccountAppSyncStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Sync status of the tenant with the Google EMM API ## Members |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountbindstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountbindstatus.md | doc_type: enumPageType # androidManagedStoreAccountBindStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Bind status of the tenant with the Google EMM API ## Members |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountenrollmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountenrollmenttarget.md | doc_type: enumPageType # androidManagedStoreAccountEnrollmentTarget enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android for Work device management targeting type for the account ## Members |
v1.0 | Intune Androidforwork Androidmanagedstoreaccountenterprisesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreaccountenterprisesettings.md | doc_type: resourcePageType # androidManagedStoreAccountEnterpriseSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enterprise settings for an Android managed store account. ## Methods |
v1.0 | Intune Androidforwork Androidmanagedstoreappconfigurationschema | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreappconfigurationschema.md | doc_type: resourcePageType # androidManagedStoreAppConfigurationSchema resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Schema describing an Android application's custom configurations. ## Methods |
v1.0 | Intune Androidforwork Androidmanagedstoreappconfigurationschemaitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreappconfigurationschemaitem.md | doc_type: resourcePageType # androidManagedStoreAppConfigurationSchemaItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Single configuration item inside an Android application's custom configuration schema. ## Properties |
v1.0 | Intune Androidforwork Androidmanagedstoreappconfigurationschemaitemdatatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-androidmanagedstoreappconfigurationschemaitemdatatype.md | doc_type: enumPageType # androidManagedStoreAppConfigurationSchemaItemDataType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Data type for a configuration item inside an Android application's custom configuration schema ## Members |
v1.0 | Intune Androidforwork Aospwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-aospwifisecuritytype.md | doc_type: enumPageType # aospWifiSecurityType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This enum represents Wi-Fi Security Types for Android Device Owner AOSP Scenarios. ## Members |
v1.0 | Intune Androidforwork Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidforwork-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for Android for Work settings functionality under device management. ## Methods |
v1.0 | Intune Androidfotaservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton that acts as container for a collection of Resource Access entities. ## Methods |
v1.0 | Intune Androidfotaservice Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-devicemanagementreports.md | doc_type: resourcePageType # deviceManagementReports resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device management reports entity ## Methods |
v1.0 | Intune Androidfotaservice Zebrafotaartifact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaartifact.md | doc_type: resourcePageType # zebraFotaArtifact resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes a single artifact for a specific device model. ## Methods |
v1.0 | Intune Androidfotaservice Zebrafotaconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotaconnector.md | doc_type: resourcePageType # zebraFotaConnector resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Zebra FOTA connector entity that represents the tenant's authorization status for Intune to call Zebra Update Services. ## Methods |
v1.0 | Intune Androidfotaservice Zebrafotadeployment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-androidfotaservice-zebrafotadeployment.md | doc_type: resourcePageType # zebraFotaDeployment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Zebra FOTA deployment entity that describes settings, deployment device groups required to create a FOTA deployment, and deployment status. ## Methods |
v1.0 | Intune Apps Androidforworkapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidforworkapp.md | doc_type: resourcePageType # androidForWorkApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Android for Work (AFW) Apps. |
v1.0 | Intune Apps Androidforworkmobileappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidforworkmobileappconfiguration.md | doc_type: resourcePageType # androidForWorkMobileAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties, inherited properties and actions for AFW mobile app configurations. |
v1.0 | Intune Apps Androidlobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidlobapp.md | doc_type: resourcePageType # androidLobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Android Line Of Business apps. Here is a JSON representation of the resource. "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "String", "versionCode": "String", |
v1.0 | Intune Apps Androidmanagedstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstoreapp.md | doc_type: resourcePageType # androidManagedStoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Android Managed Store Apps. |
v1.0 | Intune Apps Androidmanagedstoreappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstoreappconfiguration.md | doc_type: resourcePageType # androidManagedStoreAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties, inherited properties and actions for Android Enterprise mobile app configurations. |
v1.0 | Intune Apps Androidmanagedstoreapptrack | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstoreapptrack.md | doc_type: resourcePageType # androidManagedStoreAppTrack resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains track information for Android Managed Store apps. ## Properties |
v1.0 | Intune Apps Androidmanagedstorewebapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidmanagedstorewebapp.md | doc_type: resourcePageType # androidManagedStoreWebApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for web apps configured to be distributed via the managed Android app store. |
v1.0 | Intune Apps Androidminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidminimumoperatingsystem.md | doc_type: resourcePageType # androidMinimumOperatingSystem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the minimum operating system required for an Android mobile app. ## Properties Contains properties for the minimum operating system required for an Android mob |v9_0|Boolean|When TRUE, only Version 9.0 or later is supported. Default value is FALSE. Exactly one of the minimum operating system boolean values will be TRUE.| |v10_0|Boolean|When TRUE, only Version 10.0 or later is supported. Default value is FALSE. Exactly one of the minimum operating system boolean values will be TRUE.| |v11_0|Boolean|When TRUE, only Version 11.0 or later is supported. Default value is FALSE. Exactly one of the minimum operating system boolean values will be TRUE.|+|v12_0|Boolean|When TRUE, only Version 12.0 or later is supported. Default value is FALSE. Exactly one of the minimum operating system boolean values will be TRUE.| +|v13_0|Boolean|When TRUE, only Version 13.0 or later is supported. Default value is FALSE. Exactly one of the minimum operating system boolean values will be TRUE.| +|v14_0|Boolean|When TRUE, only Version 14.0 or later is supported. Default value is FALSE. Exactly one of the minimum operating system boolean values will be TRUE.| +|v15_0|Boolean|When TRUE, only Version 15.0 or later is supported. Default value is FALSE. Exactly one of the minimum operating system boolean values will be TRUE.| ## Relationships None Here is a JSON representation of the resource. "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } ``` |
v1.0 | Intune Apps Androidpermissionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidpermissionaction.md | doc_type: resourcePageType # androidPermissionAction resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Mapping between an Android app permission and the action Android should take when that permission is requested. ## Properties |
v1.0 | Intune Apps Androidpermissionactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidpermissionactiontype.md | doc_type: enumPageType # androidPermissionActionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android action taken when an app requests a dangerous permission. ## Members |
v1.0 | Intune Apps Androidprofileapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidprofileapplicability.md | doc_type: enumPageType # androidProfileApplicability enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android profile applicability ## Members |
v1.0 | Intune Apps Androidstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidstoreapp.md | doc_type: resourcePageType # androidStoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Android store apps. Inherits from [mobileApp](../resources/intune-shared-mobileapp.md) |supersedingAppCount|Int32|The total number of apps this app directly or indirectly supersedes. This property is read-only. Inherited from [mobileApp](../resources/intune-shared-mobileapp.md)| |supersededAppCount|Int32|The total number of apps this app is directly or indirectly superseded by. This property is read-only. Inherited from [mobileApp](../resources/intune-shared-mobileapp.md)| |packageId|String|The package identifier. This property is read-only.|-|appIdentifier|String|The Identity Name. This property is read-only.| |appStoreUrl|String|The Android app store URL.| |minimumSupportedOperatingSystem|[androidMinimumOperatingSystem](../resources/intune-apps-androidminimumoperatingsystem.md)|The value for the minimum applicable operating system.| Here is a JSON representation of the resource. "supersedingAppCount": 1024, "supersededAppCount": 1024, "packageId": "String",- "appIdentifier": "String", "appStoreUrl": "String", "minimumSupportedOperatingSystem": { "@odata.type": "microsoft.graph.androidMinimumOperatingSystem", Here is a JSON representation of the resource. "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` |
v1.0 | Intune Apps Androidtargetedplatforms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-androidtargetedplatforms.md | doc_type: enumPageType # androidTargetedPlatforms enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specifies which platform(s) can be targeted for a given Android LOB application or Managed Android LOB application. ## Members |
v1.0 | Intune Apps Appconfigurationsettingitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-appconfigurationsettingitem.md | doc_type: resourcePageType # appConfigurationSettingItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for App configuration setting item. ## Properties |
v1.0 | Intune Apps Certificatestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-certificatestatus.md | doc_type: enumPageType # certificateStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Apps Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Apps Enterprisecodesigningcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-enterprisecodesigningcertificate.md | doc_type: resourcePageType # enterpriseCodeSigningCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Apps Excludedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-excludedapps.md | doc_type: resourcePageType # excludedApps resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for Excluded Office365 Apps. ## Properties |
v1.0 | Intune Apps Fileencryptioninfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-fileencryptioninfo.md | doc_type: resourcePageType # fileEncryptionInfo resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for file encryption information for the content version of a line of business app. ## Properties |
v1.0 | Intune Apps Iosdevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosdevicetype.md | doc_type: resourcePageType # iosDeviceType resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties of the possible iOS device types the mobile app can run on. ## Properties |
v1.0 | Intune Apps Iosipadoswebclip | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosipadoswebclip.md | doc_type: resourcePageType # iosiPadOSWebClip resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for iOS web apps. |
v1.0 | Intune Apps Ioslobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-ioslobapp.md | doc_type: resourcePageType # iosLobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for iOS Line Of Business apps. |
v1.0 | Intune Apps Ioslobappprovisioningconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-ioslobappprovisioningconfiguration.md | doc_type: resourcePageType # iosLobAppProvisioningConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the iOS Lob App Provisioning Configuration resource. ## Methods |
v1.0 | Intune Apps Ioslobappprovisioningconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-ioslobappprovisioningconfigurationassignment.md | doc_type: resourcePageType # iosLobAppProvisioningConfigurationAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for Group Assignment of an iOS LOB App Provisioning and Configuration. ## Methods |
v1.0 | Intune Apps Iosminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosminimumoperatingsystem.md | doc_type: resourcePageType # iosMinimumOperatingSystem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties of the minimum operating system required for an iOS mobile app. ## Properties |
v1.0 | Intune Apps Iosmobileappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosmobileappconfiguration.md | doc_type: resourcePageType # iosMobileAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties, inherited properties and actions for iOS mobile app configurations. |
v1.0 | Intune Apps Iosstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosstoreapp.md | doc_type: resourcePageType # iosStoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for iOS store apps. |
v1.0 | Intune Apps Iosvppapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppapp.md | doc_type: resourcePageType # iosVppApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for iOS Volume-Purchased Program (VPP) Apps. |
v1.0 | Intune Apps Iosvppappassigneddevicelicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppappassigneddevicelicense.md | doc_type: resourcePageType # iosVppAppAssignedDeviceLicense resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Volume Purchase Program device license assignment. This class does not support Create, Delete, or Update. |
v1.0 | Intune Apps Iosvppappassignedlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppappassignedlicense.md | doc_type: resourcePageType # iosVppAppAssignedLicense resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Volume Purchase Program license assignment. This class does not support Create, Delete, or Update. ## Methods |
v1.0 | Intune Apps Iosvppappassigneduserlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppappassigneduserlicense.md | doc_type: resourcePageType # iosVppAppAssignedUserLicense resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Volume Purchase Program user license assignment. This class does not support Create, Delete, or Update. |
v1.0 | Intune Apps Iosvppapprevokelicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-iosvppapprevokelicensesactionresult.md | doc_type: resourcePageType # iosVppAppRevokeLicensesActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Defines results for actions on iOS Vpp Apps, contains inherited properties for ActionResult. ## Properties |
v1.0 | Intune Apps Macosappscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosappscript.md | doc_type: resourcePageType # macOSAppScript resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Shell script used to assist installation of a macOS app. These scripts are used to perform additional tasks to help the app successfully be configured. ## Properties |
v1.0 | Intune Apps Macosdmgapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosdmgapp.md | doc_type: resourcePageType # macOSDmgApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the MacOS DMG (Apple Disk Image) App. |
v1.0 | Intune Apps Macosincludedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosincludedapp.md | doc_type: resourcePageType # macOSIncludedApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties of an included .app in a MacOS app. ## Properties |
v1.0 | Intune Apps Macoslobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macoslobapp.md | doc_type: resourcePageType # macOSLobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the macOS LOB App. |
v1.0 | Intune Apps Macoslobchildapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macoslobchildapp.md | doc_type: resourcePageType # macOSLobChildApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties of a macOS .app in the package ## Properties |
v1.0 | Intune Apps Macosmicrosoftdefenderapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosmicrosoftdefenderapp.md | doc_type: resourcePageType # macOSMicrosoftDefenderApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the macOS Microsoft Defender App. |
v1.0 | Intune Apps Macosmicrosoftedgeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosmicrosoftedgeapp.md | doc_type: resourcePageType # macOSMicrosoftEdgeApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the macOS Microsoft Edge App. |
v1.0 | Intune Apps Macosminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosminimumoperatingsystem.md | doc_type: resourcePageType # macOSMinimumOperatingSystem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The minimum operating system required for a macOS app. ## Properties |
v1.0 | Intune Apps Macosofficesuiteapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosofficesuiteapp.md | doc_type: resourcePageType # macOSOfficeSuiteApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the MacOS Office Suite App. |
v1.0 | Intune Apps Macospkgapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macospkgapp.md | doc_type: resourcePageType # macOSPkgApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the MacOSPkgApp. |
v1.0 | Intune Apps Macosvppapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosvppapp.md | doc_type: resourcePageType # macOsVppApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for MacOS Volume-Purchased Program (VPP) Apps. |
v1.0 | Intune Apps Macosvppappassignedlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosvppappassignedlicense.md | doc_type: resourcePageType # macOsVppAppAssignedLicense resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS Volume Purchase Program license assignment. This class does not support Create, Delete, or Update. ## Methods |
v1.0 | Intune Apps Macosvppapprevokelicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macosvppapprevokelicensesactionresult.md | doc_type: resourcePageType # macOsVppAppRevokeLicensesActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Defines results for actions on MacOS Vpp Apps, contains inherited properties for ActionResult. ## Properties |
v1.0 | Intune Apps Macoswebclip | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-macoswebclip.md | doc_type: resourcePageType # macOSWebClip resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for macOS web apps. |
v1.0 | Intune Apps Managedandroidlobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedandroidlobapp.md | doc_type: resourcePageType # managedAndroidLobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Managed Android Line Of Business apps. Here is a JSON representation of the resource. "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true }, "versionName": "String", "versionCode": "String", |
v1.0 | Intune Apps Managedandroidstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedandroidstoreapp.md | doc_type: resourcePageType # managedAndroidStoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Android store apps that you can manage with an Intune app protection policy. Here is a JSON representation of the resource. "v8_1": true, "v9_0": true, "v10_0": true,- "v11_0": true + "v11_0": true, + "v12_0": true, + "v13_0": true, + "v14_0": true, + "v15_0": true } } ``` |
v1.0 | Intune Apps Managedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedapp.md | doc_type: resourcePageType # managedApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Abstract class that contains properties and inherited properties for apps that you can manage with an Intune app protection policy. |
v1.0 | Intune Apps Managedappavailability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedappavailability.md | doc_type: enumPageType # managedAppAvailability enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A managed (MAM) application's availability. ## Members |
v1.0 | Intune Apps Manageddevicemobileappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfiguration.md | doc_type: resourcePageType # managedDeviceMobileAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract class for Mobile app configuration for enrolled devices. ## Methods |
v1.0 | Intune Apps Manageddevicemobileappconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationassignment.md | doc_type: resourcePageType # managedDeviceMobileAppConfigurationAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains the properties used to assign an MDM app configuration to a group. ## Methods |
v1.0 | Intune Apps Manageddevicemobileappconfigurationdevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationdevicestatus.md | doc_type: resourcePageType # managedDeviceMobileAppConfigurationDeviceStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties, inherited properties and actions for an MDM mobile app configuration status for a device. ## Methods |
v1.0 | Intune Apps Manageddevicemobileappconfigurationdevicesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationdevicesummary.md | doc_type: resourcePageType # managedDeviceMobileAppConfigurationDeviceSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties, inherited properties and actions for an MDM mobile app configuration device status summary. ## Methods |
v1.0 | Intune Apps Manageddevicemobileappconfigurationuserstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationuserstatus.md | doc_type: resourcePageType # managedDeviceMobileAppConfigurationUserStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties, inherited properties and actions for an MDM mobile app configuration status for a user. ## Methods |
v1.0 | Intune Apps Manageddevicemobileappconfigurationusersummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-manageddevicemobileappconfigurationusersummary.md | doc_type: resourcePageType # managedDeviceMobileAppConfigurationUserSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties, inherited properties and actions for an MDM mobile app configuration user status summary. ## Methods |
v1.0 | Intune Apps Managedioslobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedioslobapp.md | doc_type: resourcePageType # managedIOSLobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Managed iOS Line Of Business apps. |
v1.0 | Intune Apps Managediosstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managediosstoreapp.md | doc_type: resourcePageType # managedIOSStoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for an iOS store app that you can manage with an Intune app protection policy. |
v1.0 | Intune Apps Managedmobilelobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-managedmobilelobapp.md | doc_type: resourcePageType # managedMobileLobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract base class containing properties for all managed mobile line of business apps. |
v1.0 | Intune Apps Mdmappconfigkeytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mdmappconfigkeytype.md | doc_type: enumPageType # mdmAppConfigKeyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - App configuration key types. ## Members |
v1.0 | Intune Apps Microsoftedgechannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftedgechannel.md | doc_type: enumPageType # microsoftEdgeChannel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The enum to specify the channels for Microsoft Edge apps. ## Members |
v1.0 | Intune Apps Microsoftstoreforbusinessapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftstoreforbusinessapp.md | doc_type: resourcePageType # microsoftStoreForBusinessApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Microsoft Store for Business Apps. This class does not support Create, Delete, or Update. |
v1.0 | Intune Apps Microsoftstoreforbusinesscontainedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftstoreforbusinesscontainedapp.md | doc_type: resourcePageType # microsoftStoreForBusinessContainedApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class that represents a contained app of a MicrosoftStoreForBusinessApp. |
v1.0 | Intune Apps Microsoftstoreforbusinesslicensetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-microsoftstoreforbusinesslicensetype.md | doc_type: enumPageType # microsoftStoreForBusinessLicenseType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Apps Mobileapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapp.md | doc_type: resourcePageType # mobileApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract class containing the base properties for Intune mobile apps. Note: Listing mobile apps with `$expand=assignments` has been deprecated. Instead get the list of apps without the `$expand` query on `assignments`. Then, perform the expansion on individual applications. ## Methods |
v1.0 | Intune Apps Mobileappassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappassignment.md | doc_type: resourcePageType # mobileAppAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for Group Assignment of a Mobile App. ## Methods |
v1.0 | Intune Apps Mobileappcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcategory.md | doc_type: resourcePageType # mobileAppCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for a single Intune app category. ## Methods |
v1.0 | Intune Apps Mobileappcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcontent.md | doc_type: resourcePageType # mobileAppContent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains content properties for a specific app version. Each mobileAppContent can have multiple mobileAppContentFile. ## Methods |
v1.0 | Intune Apps Mobileappcontentfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcontentfile.md | doc_type: resourcePageType # mobileAppContentFile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for a single installer file that is associated with a given mobileAppContent version. ## Methods |
v1.0 | Intune Apps Mobileappcontentfileuploadstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappcontentfileuploadstate.md | doc_type: enumPageType # mobileAppContentFileUploadState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for upload request states. ## Members |
v1.0 | Intune Apps Mobileappdependency | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappdependency.md | doc_type: resourcePageType # mobileAppDependency resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes a dependency type between two mobile apps. Inherits from [mobileAppRelationship](../resources/intune-apps-mobileapprelation ## Properties |Property|Type|Description| |:|:|:|-|id|String|The relationship entity id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetId|String|The target mobile app's app id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayName|String|The target mobile app's display name. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayVersion|String|The target mobile app's display version. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetPublisher|String|The target mobile app's publisher. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target is a parent or child. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`.| -|dependencyType|[mobileAppDependencyType](../resources/intune-apps-mobileappdependencytype.md)|The type of dependency relationship between the parent and child apps. Possible values are: `detect`, `autoInstall`.| -|dependentAppCount|Int32|The total number of apps that directly or indirectly depend on the parent app. This property is read-only.| -|dependsOnAppCount|Int32|The total number of apps the child app directly or indirectly depends on. This property is read-only.| +|id|String|The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetId|String|The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayName|String|The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayVersion|String|The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisher|String|The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisherDisplayName|String|The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceId|String|The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayName|String|The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayVersion|String|The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourcePublisherDisplayName|String|The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`, `unknownFutureValue`.| +|dependencyType|[mobileAppDependencyType](../resources/intune-apps-mobileappdependencytype.md)|The type of dependency relationship between the parent and child apps. Possible values are: detect, autoInstall. Read-Only. Possible values are: `detect`, `autoInstall`, `unknownFutureValue`.| +|dependentAppCount|Int32|The total number of apps that directly or indirectly depend on the parent app. Read-Only. This property is read-only.| +|dependsOnAppCount|Int32|The total number of apps the child app directly or indirectly depends on. Read-Only. This property is read-only.| ## Relationships None Here is a JSON representation of the resource. "targetDisplayName": "String", "targetDisplayVersion": "String", "targetPublisher": "String",+ "targetPublisherDisplayName": "String", + "sourceId": "String", + "sourceDisplayName": "String", + "sourceDisplayVersion": "String", + "sourcePublisherDisplayName": "String", "targetType": "String", "dependencyType": "String", "dependentAppCount": 1024, |
v1.0 | Intune Apps Mobileappdependencytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappdependencytype.md | doc_type: enumPageType # mobileAppDependencyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the dependency type associated with a relationship between two mobile apps. ## Members Indicates the dependency type associated with a relationship between two mobile |:|:|:| |detect|0|Indicates that the child app should be detected before installing the parent app.| |autoInstall|1|Indicates that the child app should be installed before installing the parent app.|+|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Mobileappprovisioningconfiggroupassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappprovisioningconfiggroupassignment.md | doc_type: resourcePageType # mobileAppProvisioningConfigGroupAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains the properties used to assign an App provisioning configuration to a group. ## Methods |
v1.0 | Intune Apps Mobileapppublishingconstraints | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapppublishingconstraints.md | doc_type: resourcePageType # mobileAppPublishingConstraints resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for constraints that the UX need to take into consideration to guide the user experience for app creation and publishing flow. ## Properties |
v1.0 | Intune Apps Mobileapppublishingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapppublishingstate.md | doc_type: enumPageType # mobileAppPublishingState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the publishing state of an app. ## Members |
v1.0 | Intune Apps Mobileapprelationship | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapprelationship.md | doc_type: resourcePageType # mobileAppRelationship resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes a relationship between two mobile apps. ## Methods Describes a relationship between two mobile apps. ## Properties |Property|Type|Description| |:|:|:|-|id|String|The relationship entity id.| -|targetId|String|The target mobile app's app id.| -|targetDisplayName|String|The target mobile app's display name. This property is read-only.| -|targetDisplayVersion|String|The target mobile app's display version. This property is read-only.| -|targetPublisher|String|The target mobile app's publisher. This property is read-only.| -|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target is a parent or child. This property is read-only. Possible values are: `child`, `parent`.| +|id|String|The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy.| +|targetId|String|The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy.| +|targetDisplayName|String|The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|targetDisplayVersion|String|The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|targetPublisher|String|The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|targetPublisherDisplayName|String|The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|sourceId|String|The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|sourceDisplayName|String|The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|sourceDisplayVersion|String|The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|sourcePublisherDisplayName|String|The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only.| +|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Possible values are: `child`, `parent`, `unknownFutureValue`.| ## Relationships None Here is a JSON representation of the resource. "targetDisplayName": "String", "targetDisplayVersion": "String", "targetPublisher": "String",+ "targetPublisherDisplayName": "String", + "sourceId": "String", + "sourceDisplayName": "String", + "sourceDisplayVersion": "String", + "sourcePublisherDisplayName": "String", "targetType": "String" } ``` |
v1.0 | Intune Apps Mobileapprelationshiptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileapprelationshiptype.md | doc_type: enumPageType # mobileAppRelationshipType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates whether the target of a relationship is the parent or the child in the relationship. ## Members Indicates whether the target of a relationship is the parent or the child in the |:|:|:| |child|0|Indicates that the target of a relationship is the child in the relationship.| |parent|1|Indicates that the target of a relationship is the parent in the relationship.|+|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Mobileappsupersedence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappsupersedence.md | doc_type: resourcePageType # mobileAppSupersedence resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes a supersedence relationship between two mobile apps. Inherits from [mobileAppRelationship](../resources/intune-apps-mobileapprelation ## Properties |Property|Type|Description| |:|:|:|-|id|String|The relationship entity id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetId|String|The target mobile app's app id. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayName|String|The target mobile app's display name. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetDisplayVersion|String|The target mobile app's display version. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetPublisher|String|The target mobile app's publisher. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| -|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target is a parent or child. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`.| -|supersedenceType|[mobileAppSupersedenceType](../resources/intune-apps-mobileappsupersedencetype.md)|The supersedence relationship type between the parent and child apps. Possible values are: `update`, `replace`.| -|supersededAppCount|Int32|The total number of apps directly or indirectly superseded by the child app. This property is read-only.| -|supersedingAppCount|Int32|The total number of apps directly or indirectly superseding the parent app. This property is read-only.| +|id|String|The unique identifier for the mobile app relationship entity. This is assigned at MobileAppRelationship entity creation. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672_43aaaf35-ce51-4695-9447-5eac6df31161. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetId|String|The unique app identifier of the target of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayName|String|The display name of the app that is the target of the mobile app relationship entity. For example: Firefox Setup 52.0.2 32bit.intunewin. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetDisplayVersion|String|The display version of the app that is the target of the mobile app relationship entity. For example 1.0 or 1.2203.156. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisher|String|The publisher of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Returned by default. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetPublisherDisplayName|String|The publisher display name of the app that is the target of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceId|String|The unique app identifier of the source of the mobile app relationship entity. For example: 2dbc75b9-e993-4e4d-a071-91ac5a218672. If null during relationship creation, then it will be populated with parent Id. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayName|String|The display name of the app that is the source of the mobile app relationship entity. For example: Orca. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourceDisplayVersion|String|The display version of the app that is the source of the mobile app relationship entity. For example 1.0.12 or 1.2203.156 or 3. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|sourcePublisherDisplayName|String|The publisher display name of the app that is the source of the mobile app relationship entity. For example: Fabrikam. Maximum length is 500 characters. Read-Only. Supports: $select. Does not support $search, $filter, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md)| +|targetType|[mobileAppRelationshipType](../resources/intune-apps-mobileapprelationshiptype.md)|The type of relationship indicating whether the target application of a relationship is a parent or child in the relationship. Possible values are: parent, child. Read-Only. Returned by default. Supports: $select, $filter. Does not support $search, $orderBy. This property is read-only. Inherited from [mobileAppRelationship](../resources/intune-apps-mobileapprelationship.md). Possible values are: `child`, `parent`, `unknownFutureValue`.| +|supersedenceType|[mobileAppSupersedenceType](../resources/intune-apps-mobileappsupersedencetype.md)|The supersedence relationship type between the parent and child apps. Possible values are: update, replace. Read-Only. Possible values are: `update`, `replace`, `unknownFutureValue`.| +|supersededAppCount|Int32|The total number of apps directly or indirectly superseded by the child app. Read-Only. This property is read-only.| +|supersedingAppCount|Int32|The total number of apps directly or indirectly superseding the parent app. Read-Only. This property is read-only.| ## Relationships None Here is a JSON representation of the resource. "targetDisplayName": "String", "targetDisplayVersion": "String", "targetPublisher": "String",+ "targetPublisherDisplayName": "String", + "sourceId": "String", + "sourceDisplayName": "String", + "sourceDisplayVersion": "String", + "sourcePublisherDisplayName": "String", "targetType": "String", "supersedenceType": "String", "supersededAppCount": 1024, |
v1.0 | Intune Apps Mobileappsupersedencetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobileappsupersedencetype.md | doc_type: enumPageType # mobileAppSupersedenceType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the supersedence type associated with a relationship between two mobile apps. ## Members Indicates the supersedence type associated with a relationship between two mobil |:|:|:| |update|0|Indicates that the child app should be updated by the internal logic of the parent app.| |replace|1|Indicates that the child app should be uninstalled before installing the parent app.|+|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Apps Mobilecontainedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobilecontainedapp.md | doc_type: resourcePageType # mobileContainedApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract class that represents a contained app in a mobileApp acting as a package. ## Methods |
v1.0 | Intune Apps Mobilelobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-mobilelobapp.md | doc_type: resourcePageType # mobileLobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract base class containing properties for all mobile line of business apps. |
v1.0 | Intune Apps Officeproductid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officeproductid.md | doc_type: enumPageType # officeProductId enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Enum to specify the Office365 ProductIds that represent the Office365 Suite SKUs. ## Members |
v1.0 | Intune Apps Officesuiteapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officesuiteapp.md | doc_type: resourcePageType # officeSuiteApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the Office365 Suite App. |
v1.0 | Intune Apps Officesuitedefaultfileformattype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officesuitedefaultfileformattype.md | doc_type: enumPageType # officeSuiteDefaultFileFormatType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes the OfficeSuiteApp file format types that can be selected. ## Members |
v1.0 | Intune Apps Officesuiteinstallprogressdisplaylevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officesuiteinstallprogressdisplaylevel.md | doc_type: enumPageType # officeSuiteInstallProgressDisplayLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Enum to specify the level of display for the Installation Progress Setup UI on the Device. ## Members |
v1.0 | Intune Apps Officeupdatechannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-officeupdatechannel.md | doc_type: enumPageType # officeUpdateChannel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Enum to specify the Office365 Updates Channel. ## Members |
v1.0 | Intune Apps Resultantappstatedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-resultantappstatedetail.md | doc_type: enumPageType # resultantAppStateDetail enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enum indicating additional details regarding why an application has a particular install state. ## Members |
v1.0 | Intune Apps Runasaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-runasaccounttype.md | doc_type: enumPageType # runAsAccountType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of execution context the app runs in. ## Members |
v1.0 | Intune Apps Symanteccodesigningcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-symanteccodesigningcertificate.md | doc_type: resourcePageType # symantecCodeSigningCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Apps Vpplicensingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-vpplicensingtype.md | doc_type: resourcePageType # vppLicensingType resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for iOS Volume-Purchased Program (Vpp) Licensing Type. ## Properties |
v1.0 | Intune Apps Webapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-webapp.md | doc_type: resourcePageType # webApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for web apps. |
v1.0 | Intune Apps Win32lobapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapp.md | doc_type: resourcePageType # win32LobApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Win32 apps. |
v1.0 | Intune Apps Win32lobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappassignmentsettings.md | doc_type: resourcePageType # win32LobAppAssignmentSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to assign an Win32 LOB mobile app to a group. |
v1.0 | Intune Apps Win32lobappautoupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappautoupdatesettings.md | doc_type: resourcePageType # win32LobAppAutoUpdateSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to perform the auto-update of an application. ## Properties |
v1.0 | Intune Apps Win32lobappdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappdetection.md | doc_type: resourcePageType # win32LobAppDetection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base class to detect a Win32 App ## Properties |
v1.0 | Intune Apps Win32lobappdetectionoperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappdetectionoperator.md | doc_type: enumPageType # win32LobAppDetectionOperator enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for detection operator. ## Members |
v1.0 | Intune Apps Win32lobappfilesystemdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemdetection.md | doc_type: resourcePageType # win32LobAppFileSystemDetection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains file or folder path to detect a Win32 App |
v1.0 | Intune Apps Win32lobappfilesystemdetectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemdetectiontype.md | doc_type: enumPageType # win32LobAppFileSystemDetectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains all supported file system detection type. ## Members |
v1.0 | Intune Apps Win32lobappfilesystemoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemoperationtype.md | doc_type: enumPageType # win32LobAppFileSystemOperationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible operations for rules used to make determinations about an application based on files or folders. Unless noted, can be used with either detection or requirement rules. ## Members |
v1.0 | Intune Apps Win32lobappfilesystemrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemrequirement.md | doc_type: resourcePageType # win32LobAppFileSystemRequirement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains file or folder path to detect a Win32 App |
v1.0 | Intune Apps Win32lobappfilesystemrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappfilesystemrule.md | doc_type: resourcePageType # win32LobAppFileSystemRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to store file or folder rule data for a Win32 LOB app. |
v1.0 | Intune Apps Win32lobappinstallexperience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappinstallexperience.md | doc_type: resourcePageType # win32LobAppInstallExperience resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains installation experience properties for a Win32 App ## Properties |
v1.0 | Intune Apps Win32lobappmsiinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappmsiinformation.md | doc_type: resourcePageType # win32LobAppMsiInformation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains MSI app properties for a Win32 App. ## Properties |
v1.0 | Intune Apps Win32lobappmsipackagetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappmsipackagetype.md | doc_type: enumPageType # win32LobAppMsiPackageType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the package type of an MSI Win32LobApp. ## Members |
v1.0 | Intune Apps Win32lobapppowershellscriptdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptdetection.md | doc_type: resourcePageType # win32LobAppPowerShellScriptDetection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains PowerShell script properties to detect a Win32 App |
v1.0 | Intune Apps Win32lobapppowershellscriptdetectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptdetectiontype.md | doc_type: enumPageType # win32LobAppPowerShellScriptDetectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains all supported Powershell Script output detection type. ## Members |
v1.0 | Intune Apps Win32lobapppowershellscriptrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptrequirement.md | doc_type: resourcePageType # win32LobAppPowerShellScriptRequirement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains PowerShell script properties to detect a Win32 App |
v1.0 | Intune Apps Win32lobapppowershellscriptrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptrule.md | doc_type: resourcePageType # win32LobAppPowerShellScriptRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to store the PowerShell script rule data for a Win32 LOB app. |
v1.0 | Intune Apps Win32lobapppowershellscriptruleoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppowershellscriptruleoperationtype.md | doc_type: enumPageType # win32LobAppPowerShellScriptRuleOperationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains all supported Powershell Script output detection type. ## Members |
v1.0 | Intune Apps Win32lobappproductcodedetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappproductcodedetection.md | doc_type: resourcePageType # win32LobAppProductCodeDetection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains product code and version properties to detect a Win32 App |
v1.0 | Intune Apps Win32lobappproductcoderule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappproductcoderule.md | doc_type: resourcePageType # win32LobAppProductCodeRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to store the product code and version rule data for a Win32 LOB app. This rule is not supported as a requirement rule. |
v1.0 | Intune Apps Win32lobapppublishingconstraints | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapppublishingconstraints.md | doc_type: resourcePageType # win32LobAppPublishingConstraints resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for Win32 LOB app publishing constraints. ## Properties |
v1.0 | Intune Apps Win32lobappregistrydetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistrydetection.md | doc_type: resourcePageType # win32LobAppRegistryDetection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains registry properties to detect a Win32 App |
v1.0 | Intune Apps Win32lobappregistrydetectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistrydetectiontype.md | doc_type: enumPageType # win32LobAppRegistryDetectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains all supported registry data detection type. ## Members |
v1.0 | Intune Apps Win32lobappregistryrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistryrequirement.md | doc_type: resourcePageType # win32LobAppRegistryRequirement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains registry properties to detect a Win32 App |
v1.0 | Intune Apps Win32lobappregistryrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistryrule.md | doc_type: resourcePageType # win32LobAppRegistryRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to store registry rule data for a Win32 LOB app. |
v1.0 | Intune Apps Win32lobappregistryruleoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappregistryruleoperationtype.md | doc_type: enumPageType # win32LobAppRegistryRuleOperationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible operations for rules used to make determinations about an application based on registry keys or values. Unless noted, the values can be used with either detection or requirement rules. ## Members |
v1.0 | Intune Apps Win32lobapprequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapprequirement.md | doc_type: resourcePageType # win32LobAppRequirement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base class to detect a Win32 App ## Properties |
v1.0 | Intune Apps Win32lobapprestartbehavior | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapprestartbehavior.md | doc_type: enumPageType # win32LobAppRestartBehavior enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of restart action. ## Members |
v1.0 | Intune Apps Win32lobappreturncode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappreturncode.md | doc_type: resourcePageType # win32LobAppReturnCode resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains return code properties for a Win32 App ## Properties |
v1.0 | Intune Apps Win32lobappreturncodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappreturncodetype.md | doc_type: enumPageType # win32LobAppReturnCodeType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of return code. ## Members |
v1.0 | Intune Apps Win32lobapprule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobapprule.md | doc_type: resourcePageType # win32LobAppRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A base complex type to store the detection or requirement rule data for a Win32 LOB app. ## Properties |
v1.0 | Intune Apps Win32lobappruleoperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappruleoperator.md | doc_type: enumPageType # win32LobAppRuleOperator enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for detection operator. ## Members |
v1.0 | Intune Apps Win32lobappruletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobappruletype.md | doc_type: enumPageType # win32LobAppRuleType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains rule types for Win32 LOB apps. ## Members |
v1.0 | Intune Apps Win32lobautoupdatesupersededappsstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-win32lobautoupdatesupersededappsstate.md | doc_type: enumPageType # win32LobAutoUpdateSupersededAppsState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains value for auto-update superseded apps. ## Members |
v1.0 | Intune Apps Windowsappx | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsappx.md | doc_type: resourcePageType # windowsAppX resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows AppX Line Of Business apps. |
v1.0 | Intune Apps Windowsarchitecture | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsarchitecture.md | doc_type: enumPageType # windowsArchitecture enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for Windows architecture. ## Members |
v1.0 | Intune Apps Windowsdevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsdevicetype.md | doc_type: enumPageType # windowsDeviceType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for Windows device type. Multiple values can be selected. Default value is `none`. ## Members |
v1.0 | Intune Apps Windowsmicrosoftedgeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsmicrosoftedgeapp.md | doc_type: resourcePageType # windowsMicrosoftEdgeApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for the Microsoft Edge app on Windows. |
v1.0 | Intune Apps Windowsminimumoperatingsystem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsminimumoperatingsystem.md | doc_type: resourcePageType # windowsMinimumOperatingSystem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The minimum operating system required for a Windows mobile app. ## Properties |
v1.0 | Intune Apps Windowsmobilemsi | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsmobilemsi.md | doc_type: resourcePageType # windowsMobileMSI resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows Mobile MSI Line Of Business apps. |
v1.0 | Intune Apps Windowspackageinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowspackageinformation.md | doc_type: resourcePageType # windowsPackageInformation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the package information for a Windows line of business app. Used as property within windowsPhone81AppXBundle object, which is also being deprecated. This complex type will be deprecated in February 2023. ## Properties |
v1.0 | Intune Apps Windowsphone81appx | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphone81appx.md | doc_type: resourcePageType # windowsPhone81AppX resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows Phone 8.1 AppX Line Of Business apps. Inherits from graph.mobileLobApp. Will be deprecated in February 2023. |
v1.0 | Intune Apps Windowsphone81appxbundle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphone81appxbundle.md | doc_type: resourcePageType # windowsPhone81AppXBundle resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows Phone 8.1 AppX Bundle Line Of Business apps. Inherits from graph.windowsPhone81AppX (which is also to be deprecated at the same time). Will be deprecated in February 2023. |
v1.0 | Intune Apps Windowsphone81storeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphone81storeapp.md | doc_type: resourcePageType # windowsPhone81StoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows Phone 8.1 Store apps. Inherits from graph.mobileApp. Will be deprecated in February 2023. |
v1.0 | Intune Apps Windowsphonexap | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsphonexap.md | doc_type: resourcePageType # windowsPhoneXAP resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows Phone XAP Line Of Business apps. |
v1.0 | Intune Apps Windowsstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsstoreapp.md | doc_type: resourcePageType # windowsStoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows Store apps. |
v1.0 | Intune Apps Windowsuniversalappx | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsuniversalappx.md | doc_type: resourcePageType # windowsUniversalAppX resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows Universal AppX Line Of Business apps. Inherits from `mobileLobApp`. |
v1.0 | Intune Apps Windowsuniversalappxcontainedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowsuniversalappxcontainedapp.md | doc_type: resourcePageType # windowsUniversalAppXContainedApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class that represents a contained app of a WindowsUniversalAppX app. |
v1.0 | Intune Apps Windowswebapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-windowswebapp.md | doc_type: resourcePageType # windowsWebApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties and inherited properties for Windows web apps. |
v1.0 | Intune Apps Wingetapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetapp.md | doc_type: resourcePageType # winGetApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A MobileApp that is based on a referenced application in a WinGet repository. |
v1.0 | Intune Apps Wingetappinstallexperience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-apps-wingetappinstallexperience.md | doc_type: resourcePageType # winGetAppInstallExperience resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the install experience settings associated with WinGet apps. This is used to ensure the desired install experiences on the target device are taken into account. Required at creation time. ## Properties |
v1.0 | Intune Auditing Auditactor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditactor.md | doc_type: resourcePageType # auditActor resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties for Audit Actor. ## Properties |
v1.0 | Intune Auditing Auditevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditevent.md | doc_type: resourcePageType # auditEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties for Audit Event. ## Methods |
v1.0 | Intune Auditing Auditproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditproperty.md | doc_type: resourcePageType # auditProperty resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties for Audit Property. ## Properties |
v1.0 | Intune Auditing Auditresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-auditresource.md | doc_type: resourcePageType # auditResource resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties for Audit Resource. ## Properties |
v1.0 | Intune Auditing Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device app management functionality. ## Methods |
v1.0 | Intune Auditing Rolescopetaginfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-auditing-rolescopetaginfo.md | doc_type: resourcePageType # roleScopeTagInfo resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties of Role Scope Tag Object. ## Properties |
v1.0 | Intune Books Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-deviceappmanagement.md | doc_type: resourcePageType # deviceAppManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device app management functionality. ## Methods |
v1.0 | Intune Books Deviceinstallstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-deviceinstallstate.md | doc_type: resourcePageType # deviceInstallState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the installation state for a device. ## Methods |
v1.0 | Intune Books Ebookinstallsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-ebookinstallsummary.md | doc_type: resourcePageType # eBookInstallSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the installation summary of a book for a device. ## Methods |
v1.0 | Intune Books Installstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-installstate.md | doc_type: enumPageType # installState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for install state. ## Members |
v1.0 | Intune Books Iosvppebook | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-iosvppebook.md | doc_type: resourcePageType # iosVppEBook resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties for iOS Vpp eBook. |
v1.0 | Intune Books Iosvppebookassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-iosvppebookassignment.md | doc_type: resourcePageType # iosVppEBookAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to assign an iOS VPP EBook to a group. |
v1.0 | Intune Books Managedebook | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-managedebook.md | doc_type: resourcePageType # managedEBook resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract class containing the base properties for Managed eBook. ## Methods |
v1.0 | Intune Books Managedebookassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-managedebookassignment.md | doc_type: resourcePageType # managedEBookAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to assign a eBook to a group. ## Methods |
v1.0 | Intune Books Managedebookcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-managedebookcategory.md | doc_type: resourcePageType # managedEBookCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for a single Intune eBook category. ## Methods |
v1.0 | Intune Books Userinstallstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-books-userinstallstatesummary.md | doc_type: resourcePageType # userInstallStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the installation state summary for a user. ## Methods |
v1.0 | Intune Chromebooksync Chromeosonboardingsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-chromeosonboardingsettings.md | doc_type: resourcePageType # chromeOSOnboardingSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents a Chromebook tenant settings ## Methods |
v1.0 | Intune Chromebooksync Chromeosonboardingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-chromeosonboardingstatus.md | doc_type: enumPageType # chromeOSOnboardingStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The onboarding status of the tenant. ## Members |
v1.0 | Intune Chromebooksync Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton that acts as container for a collection of Resource Access entities. ## Methods |
v1.0 | Intune Chromebooksync Onboardingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-chromebooksync-onboardingstatus.md | doc_type: enumPageType # onboardingStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The onboarding status of the tenant. ## Members |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthority.md | + + Title: "cloudCertificationAuthority resource type" +description: "Entity that represents a collection of metadata of a cloud certification authority." ++ms.localizationpriority: medium ++++# cloudCertificationAuthority resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Entity that represents a collection of metadata of a cloud certification authority. ++## Methods +|Method|Return Type|Description| +|:|:|:| +|[List cloudCertificationAuthorities](../api/intune-cloudpkigraphservice-cloudcertificationauthority-list.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) collection|List properties and relationships of the [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) objects.| +|[Get cloudCertificationAuthority](../api/intune-cloudpkigraphservice-cloudcertificationauthority-get.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|Read properties and relationships of the [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object.| +|[Create cloudCertificationAuthority](../api/intune-cloudpkigraphservice-cloudcertificationauthority-create.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|Create a new [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object.| +|[Update cloudCertificationAuthority](../api/intune-cloudpkigraphservice-cloudcertificationauthority-update.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|Update the properties of a [cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) object.| +|[postCloudCertificationAuthority action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-postcloudcertificationauthority.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) collection|| +|[getAllCloudCertificationAuthority action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-getallcloudcertificationauthority.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) collection|| +|[getCloudCertificationAuthority action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-getcloudcertificationauthority.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|| +|[patchCloudCertificationAuthority action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-patchcloudcertificationauthority.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|| +|[getAllCloudCertificationAuthorityLeafCertificates action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-getallcloudcertificationauthorityleafcertificates.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) collection|| +|[revokeLeafCertificate action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-revokeleafcertificate.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md)|| +|[revokeLeafCertificateBySerialNumber action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-revokeleafcertificatebyserialnumber.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md)|| +|[searchCloudCertificationAuthorityLeafCertificateBySerialNumber action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-searchcloudcertificationauthorityleafcertificatebyserialnumber.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md)|| +|[changeCloudCertificationAuthorityStatus action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-changecloudcertificationauthoritystatus.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|| +|[revokeCloudCertificationAuthorityCertificate action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-revokecloudcertificationauthoritycertificate.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|| +|[uploadExternallySignedCertificationAuthorityCertificate action](../api/intune-cloudpkigraphservice-cloudcertificationauthority-uploadexternallysignedcertificationauthoritycertificate.md)|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md)|| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|The certification authority entity instance identifier, which is a globally unique identifier. Read-only. Supports $select.| +|displayName|String|The certification authority display name the Intune admin console. Read/write. Supports $select and $orderby.| +|description|String|The certification authority description displayed in the Intune admin console. Nullable. Read/write. Returns null if not set.| +|scepServerUrl|String|The SCEP server URL for device SCEP connections to request certificates. Read-only.| +|certificateRevocationListUrl|String|The cloud certification authority's Certificate Revocation List URL that can be used to determine revocation status. Read-only.| +|certificateDownloadUrl|String|The URL to download the certification authority certificate. Read-only.| +|certificationAuthorityIssuerUri|String|The URI of the issuing certification authority of a subordinate certification authority. Returns null if a root certification authority. Nullable. Read-only.| +|ocspResponderUri|String|The Online Certificate Status Protocol (OCSP) responder URI that can be used to determine certificate status. Read-only.| +|certificationAuthorityStatus|[cloudCertificationAuthorityStatus](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritystatus.md)|Cloud certification authority current status. Unknown value returned by default if the cloud certification authority status is not known. After cloud certification authorities are created their status is set to active. Cloud certification authorities can be set to paused to stop issuing certificates. Possible values are: unknown, active, paused, signingPending, revoked. Read-only. Supports $filter and $orderby. Possible values are: `unknown`, `active`, `paused`, `revoked`, `signingPending`, `unknownFutureValue`.| +|eTag|String|ETag for optimistic concurrency control. Read/write.| +|lastModifiedDateTime|DateTimeOffset|Last modification date and time of this certification authority entity instance. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read/write.| +|roleScopeTagIds|String collection|List of Scope Tags for this entity instance. Scope tags limit access to an entity instance. Nullable. Read/write.| +|createdDateTime|DateTimeOffset|Creation date of this cloud certification authority entity instance. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only.| +|certificationAuthorityIssuerId|String|Issuer (parent) certification authority identifier. Nullable. Read-only. Supports $orderby and $select.| +|issuerCommonName|String|| +|cloudCertificationAuthorityType|[cloudCertificationAuthorityType](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritytype.md)|The certification authority type. rootCertificationAuthority value indicates root certification authorities that be used to create issuing certification authorities. issuingCertificationAuthority value indicates that a certification authority can be used to issue leaf certificates. Possible values are: rootCertificationAuthority, issuingCertificationAuthority, issuingCertificationAuthorityWithExternalRoot. Read-only. Supports $orderby. Possible values are: `unknown`, `rootCertificationAuthority`, `issuingCertificationAuthority`, `issuingCertificationAuthorityWithExternalRoot`, `unknownFutureValue`.| +|validityPeriodInYears|Int32|The certification authority validity period in years configured by admins.| +|validityStartDateTime|DateTimeOffset|The start date time of the validity period of a certification authority certificate. Certificates cannot be used before this date time as they are not yet valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|validityEndDateTime|DateTimeOffset|The end date time of the validity period of a certification authority certificate. Certificates cannot be used after this date time as they are longer valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|organizationName|String|The organization name that is used as a distinguished name in the subject name of a certification authority certificate in the form "O=<VALUE>". Nullable. Example: Microsoft. Read-only.| +|organizationUnit|String|The organization unit name that is used as a distinguished name in the subject name of a certification authority certificate in the form "OU=<VALUE>". Nullable. Example: Security. Read-only.| +|countryName|String|The country name that is used to compose the subject name of a certification authority certificate in the form "C=<VALUE>". Nullable. Example: US. Read-only.| +|stateName|String|The state or province name that is used to compose the subject name of a certification authority certificate in the form "ST=<VALUE>". Nullable. Example: Washington. Read-only.| +|localityName|String|The locality (town, city, etc.) name that is used to compose the subject name of a certification authority certificate in the form "L=<VALUE>". This is Nullable. Example: Redmond. Read-only.| +|certificateKeySize|[cloudCertificationAuthorityCertificateKeySize](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritycertificatekeysize.md)|The configured cryptography and key size in bits used to generate the certification authority certificate. Possible values are: rsa2048, rsa3072, rsa4096, eCP256, eCP256k, eCP384, eCP521. Read-only. Possible values are: `unknown`, `rsa2048`, `rsa3072`, `rsa4096`, `eCP256`, `eCP256k`, `eCP384`, `eCP521`, `unknownFutureValue`.| +|cloudCertificationAuthorityHashingAlgorithm|[cloudCertificationAuthorityHashingAlgorithm](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityhashingalgorithm.md)|Certification authority certificate hashing algorithm. Possible values are: sha256, sha384, sha512. Read-only. Possible values are: `unknown`, `sha256`, `sha384`, `sha512`, `unknownFutureValue`.| +|thumbprint|String|Secure Hash Algorithm 1 digest of the certificate that can be used to identify it. Read-only. Supports $select.| +|serialNumber|String|The serial number used to uniquely identify a certificate with its issuing certification authority. Read-only. Supports $select.| +|subjectName|String|The subject name of the certificate. The subject is the target or intended beneficiary of the security being provided, such as a company or government entity. Read-only. Supports $orderby and $select.| +|commonName|String|The common name of the certificate subject name, which must be unique. This property is a relative distinguished name used to compose the certificate subject name. Read-only. Supports $select.| +|certificateSigningRequest|String|The certificate signing request used to create an issuing certification authority with a root certification authority external to Microsoft Cloud PKI. The based-64 encoded certificate signing request can be downloaded through this property. After downloading the certificate signing request, it must be signed by the external root certifcation authority. Read-only.| +|extendedKeyUsages|[extendedKeyUsage](../resources/intune-cloudpkigraphservice-extendedkeyusage.md) collection|The certificate extended key usages, which specify the usage capabilities of the certificate. Read-only.| +|versionNumber|Int32|The certification authority version, which is incremented each time the certification authority is renewed. Read-only.| +|rootCertificateCommonName|String|The common name of the certificate subject name of the certification authority issuer. This property can be used to identify the certification authority that issued the current certification authority. For issuing certification authorities, this is the common name of the certificate subject name of the root certification authority to which it is anchored. For externally signed certification authorities, this is the common name of the certificate subject name of the signing certification authority. For root certification authorities, this is the common name of the certification authority's own certificate subject name. Read-only.| +|keyPlatform|[cloudCertificationAuthorityKeyPlatformType](../resources/intune-cloudpkigraphservice-cloudcertificationauthoritykeyplatformtype.md)|The key platform used to store the certification authority keys. Read-only. Possible values are: `unknown`, `software`, `hardwareSecurityModule`, `unknownFutureValue`.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|cloudCertificationAuthorityLeafCertificate|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) collection|Required OData property to expose leaf certificate API.| ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudCertificationAuthority" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthority", + "id": "String (identifier)", + "displayName": "String", + "description": "String", + "scepServerUrl": "String", + "certificateRevocationListUrl": "String", + "certificateDownloadUrl": "String", + "certificationAuthorityIssuerUri": "String", + "ocspResponderUri": "String", + "certificationAuthorityStatus": "String", + "eTag": "String", + "lastModifiedDateTime": "String (timestamp)", + "roleScopeTagIds": [ + "String" + ], + "createdDateTime": "String (timestamp)", + "certificationAuthorityIssuerId": "String", + "issuerCommonName": "String", + "cloudCertificationAuthorityType": "String", + "validityPeriodInYears": 1024, + "validityStartDateTime": "String (timestamp)", + "validityEndDateTime": "String (timestamp)", + "organizationName": "String", + "organizationUnit": "String", + "countryName": "String", + "stateName": "String", + "localityName": "String", + "certificateKeySize": "String", + "cloudCertificationAuthorityHashingAlgorithm": "String", + "thumbprint": "String", + "serialNumber": "String", + "subjectName": "String", + "commonName": "String", + "certificateSigningRequest": "String", + "extendedKeyUsages": [ + { + "@odata.type": "microsoft.graph.extendedKeyUsage", + "name": "String", + "objectIdentifier": "String" + } + ], + "versionNumber": 1024, + "rootCertificateCommonName": "String", + "keyPlatform": "String" +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthoritycertificatekeysize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthoritycertificatekeysize.md | + + Title: "cloudCertificationAuthorityCertificateKeySize enum type" +description: "Enum of possible cloud certification authority certificate cryptography and key size combinations." ++ms.localizationpriority: medium ++++# cloudCertificationAuthorityCertificateKeySize enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Enum of possible cloud certification authority certificate cryptography and key size combinations. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default. Unknown or invalid value.| +|rsa2048|1|A certificate generated using RSA cryptography and a key size of 2048 bits.| +|rsa3072|2|A certificate generated using RSA cryptography and a key size of 3072 bits.| +|rsa4096|3|A certificate generated using RSA cryptography and a key size of 4096 bits.| +|eCP256|4|A certificate generated using Elliptic Curve cryptography and a key size of 256 bits.| +|eCP256k|5|A certificate generated using Elliptic Curve cryptography and a key size of 256 bits with a Koblitz curve.| +|eCP384|6|A certificate generated using Elliptic Curve cryptography and a key size of 384 bits.| +|eCP521|7|A certificate generated using Elliptic Curve cryptography and a key size of 521 bits.| +|unknownFutureValue|8|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityhashingalgorithm | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthorityhashingalgorithm.md | + + Title: "cloudCertificationAuthorityHashingAlgorithm enum type" +description: "Enum type of possible certificate hashing algorithms used by the certification authority to create certificates." ++ms.localizationpriority: medium ++++# cloudCertificationAuthorityHashingAlgorithm enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Enum type of possible certificate hashing algorithms used by the certification authority to create certificates. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default. The hashing algorithm is unknown or invalid.| +|sha256|1|The hashing algorithm is SHA-256.| +|sha384|2|The hashing algorithm is SHA-384.| +|sha512|3|The hashing algorithm is SHA-512.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthoritykeyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthoritykeyplatformtype.md | + + Title: "cloudCertificationAuthorityKeyPlatformType enum type" +description: "Enum type of possible key platforms used by the certification authority." ++ms.localizationpriority: medium ++++# cloudCertificationAuthorityKeyPlatformType enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Enum type of possible key platforms used by the certification authority. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default. The key platform type is unknown or invalid.| +|software|1|The certification authority keys are stored in software.| +|hardwareSecurityModule|2|The certification authority keys are stored in a hardware security module.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityleafcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md | + + Title: "cloudCertificationAuthorityLeafCertificate resource type" +description: "Entity that represents a leaf certificate issued by a cloud certification authority." ++ms.localizationpriority: medium ++++# cloudCertificationAuthorityLeafCertificate resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Entity that represents a leaf certificate issued by a cloud certification authority. ++## Methods +|Method|Return Type|Description| +|:|:|:| +|[List cloudCertificationAuthorityLeafCertificates](../api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-list.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) collection|List properties and relationships of the [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) objects.| +|[Get cloudCertificationAuthorityLeafCertificate](../api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-get.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md)|Read properties and relationships of the [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object.| +|[Create cloudCertificationAuthorityLeafCertificate](../api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-create.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md)|Create a new [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object.| +|[Update cloudCertificationAuthorityLeafCertificate](../api/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate-update.md)|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md)|Update the properties of a [cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|The leaf certificate entity instance identifier, which is a randomly-generated globally unique identifier. Read-only. Supports $select.| +|subjectName|String|The subject name of the certificate. The subject is the target or intended beneficiary of the security being provided, such as a user or device. Read-only. Supports $select and $orderby.| +|issuerId|String|The globally unique identifier of the certification authority that issued the leaf certificate. Read-only.| +|issuerName|String|The name of the certification authority that issued the leaf certificate. Read-only.| +|certificateStatus|[cloudCertificationAuthorityLeafCertificateStatus](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificatestatus.md)|The current status of a certificate. Active value indicates the is in its validity period and not revoked. Revoked value indicates the certificate has been revoked and is no longer valid. Expired value indicates that the validity period of the certificate has lapsed. Possible values are: active, revoked, expired. Read-only. Supports $filter and $orderby. Possible values are: `unknown`, `active`, `revoked`, `expired`, `unknownFutureValue`.| +|validityStartDateTime|DateTimeOffset|The start date time of the validity period of a certificate. Certificates cannot be used before this date time as they are not yet valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|validityEndDateTime|DateTimeOffset|The end date time of the validity period of a certificate. Certificates cannot be used after this date time as they are longer valid. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only. Supports $orderby.| +|crlDistributionPointUrl|String|URL to find the relevant Certificate Revocation List for this certificate. Read-only.| +|certificationAuthorityIssuerUri|String|The URI of the certification authority that issued the certificate. Read-only.| +|ocspResponderUri|String|The Online Certificate Status Protocol (OCSP) responder URI that can be used to determine certificate status. Read-only.| +|thumbprint|String|Secure Hash Algorithm 1 digest of the certificate that can be used to identify it. Read-only. Supports $select.| +|serialNumber|String|The serial number used to uniquely identify a certificate with its issuing certification authority. Read-only. Supports $select.| +|revocationDateTime|DateTimeOffset|The date and time a certificate was revoked. If the certificate was not revoked, this will be null. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Nullable. Read-only.| +|deviceName|String|Name of the device for which the certificate was created. Read-only. Supports $select.| +|userPrincipalName|String|User principal name of the user for which the certificate was created. Null for userless devices. Nullable. Read-only. Supports $select.| +|deviceId|String|The unique identifier of the managed device for which the certificate was created. This ID is assigned at device enrollment time. Read-only. Supports $select.| +|userId|String|The unique identifier of the user for which the certificate was created. Null for userless devices. This is an Intune user ID. Nullable. Read-only. Supports $select.| +|devicePlatform|String|The platform of the device for which the certificate was created. Possible values are: Android, AndroidForWork, iOS, MacOS, WindowsPhone81, Windows81AndLater, Windows10AndLater, AndroidWorkProfile, Unknown, AndroidAOSP, AndroidMobileApplicationManagement, iOSMobileApplicationManagement. Default value: Unknown. Read-only. Supports $select.| +|keyUsages|String collection|Certificate extensions that define the purpose of the public key contained in a certificate. For example possible values are "Key Encipherment" and "Digital Signature". Read-only. Nullable.| +|extendedKeyUsages|String collection|Certificate extensions that further define the purpose of the public key contained in a certificate. Data is formatted as a comma-separated list of object identifiers (OID). For example a possible value is "1.3.6.1.5.5.7.3.2". Read-only. Nullable.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.cloudCertificationAuthorityLeafCertificate" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.cloudCertificationAuthorityLeafCertificate", + "id": "String (identifier)", + "subjectName": "String", + "issuerId": "String", + "issuerName": "String", + "certificateStatus": "String", + "validityStartDateTime": "String (timestamp)", + "validityEndDateTime": "String (timestamp)", + "crlDistributionPointUrl": "String", + "certificationAuthorityIssuerUri": "String", + "ocspResponderUri": "String", + "thumbprint": "String", + "serialNumber": "String", + "revocationDateTime": "String (timestamp)", + "deviceName": "String", + "userPrincipalName": "String", + "deviceId": "String", + "userId": "String", + "devicePlatform": "String", + "keyUsages": [ + "String" + ], + "extendedKeyUsages": [ + "String" + ] +} +``` |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthorityleafcertificatestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificatestatus.md | + + Title: "cloudCertificationAuthorityLeafCertificateStatus enum type" +description: "Enum type of possible leaf certificate statuses. These statuses indicate whether certificates are active and usable or unusable if they have been revoked or expired." ++ms.localizationpriority: medium ++++# cloudCertificationAuthorityLeafCertificateStatus enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Enum type of possible leaf certificate statuses. These statuses indicate whether certificates are active and usable or unusable if they have been revoked or expired. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default. Unknown or invalid status.| +|active|1|Certificate is active, indicating it is in its validity period and not revoked.| +|revoked|2|Certificate has been revoked by its issuing certification authority.| +|expired|3|Certificate has expired.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthoritystatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthoritystatus.md | + + Title: "cloudCertificationAuthorityStatus enum type" +description: "Enum type of possible certification authority statuses. These statuses indicate whether a certification authority is currently able to issue certificates or temporarily paused or permanently revoked." ++ms.localizationpriority: medium ++++# cloudCertificationAuthorityStatus enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Enum type of possible certification authority statuses. These statuses indicate whether a certification authority is currently able to issue certificates or temporarily paused or permanently revoked. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default. Indicates certification authority has an unknown or invalid status.| +|active|1|Indicates certification authority is active and can issue certificates.| +|paused|2|Indicates certification authority has been paused from issuing certificates. Paused certification authorities can be put back in an active status to continue issuing certificates.| +|revoked|3|Indicates certification authority has been revoked. This is a permanent state that cannot be changed.| +|signingPending|4|Indicates certification authority certificate signing request has been created and can be downloaded for signing and then be uploaded.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Cloudpkigraphservice Cloudcertificationauthoritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-cloudcertificationauthoritytype.md | + + Title: "cloudCertificationAuthorityType enum type" +description: "Enum type of possible certificate authority types. This feature supports a two-tier certification authority model with a root certification authority and one or more child issuing (intermediate) certification authorities." ++ms.localizationpriority: medium ++++# cloudCertificationAuthorityType enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Enum type of possible certificate authority types. This feature supports a two-tier certification authority model with a root certification authority and one or more child issuing (intermediate) certification authorities. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default. Unknown or invalid certification authority type.| +|rootCertificationAuthority|1|Indicates root certification authority. Can be used as the parent of an issuing certification authority. Root Certification Authority cannot issue leaf certificates.| +|issuingCertificationAuthority|2|Indicates issuing (subordinate) certification authority. Must have a parent root certification authority. Issuing Certification Authority can issue leaf certificates.| +|issuingCertificationAuthorityWithExternalRoot|3|Indicates issuing (subordinate) certification authority that has an external root certification authority. Issuing Certification Authority with external root can issue leaf certificates.| +|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Cloudpkigraphservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-devicemanagement.md | + + Title: "deviceManagement resource type" +description: "Singleton that acts as container for a collection of Cloud PKI entities." ++ms.localizationpriority: medium ++++# deviceManagement resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Singleton that acts as container for a collection of Cloud PKI entities. ++## Methods +|Method|Return Type|Description| +|:|:|:| +|[Get deviceManagement](../api/intune-cloudpkigraphservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-cloudpkigraphservice-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-cloudpkigraphservice-devicemanagement.md) object.| +|[Update deviceManagement](../api/intune-cloudpkigraphservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-cloudpkigraphservice-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-cloudpkigraphservice-devicemanagement.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|Required Graph property| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|cloudCertificationAuthority|[cloudCertificationAuthority](../resources/intune-cloudpkigraphservice-cloudcertificationauthority.md) collection|Collection of CloudCertificationAuthority records associated with account.| +|cloudCertificationAuthorityLeafCertificate|[cloudCertificationAuthorityLeafCertificate](../resources/intune-cloudpkigraphservice-cloudcertificationauthorityleafcertificate.md) collection|Collection of CloudCertificationAuthorityLeafCertificate records associated with account.| ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.deviceManagement" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.deviceManagement", + "id": "String (identifier)" +} +``` |
v1.0 | Intune Cloudpkigraphservice Extendedkeyusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-extendedkeyusage.md | + + Title: "extendedKeyUsage resource type" +description: "Complex type that represents the extended key usage of a certificate. This is shared complex type." ++ms.localizationpriority: medium ++++# extendedKeyUsage resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Complex type that represents the extended key usage of a certificate. This is shared complex type. ++## Properties +|Property|Type|Description| +|:|:|:| +|name|String|The extended key usage (EKU) name that provides a user-friendly way to identify an EKU.| +|objectIdentifier|String|The object identifier (OID) of an extended key usage of a certificate. For example, "1.3.6.1.5.5.7.3.2" for client authentication.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.extendedKeyUsage" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.extendedKeyUsage", + "name": "String", + "objectIdentifier": "String" +} +``` |
v1.0 | Intune Cloudpkigraphservice Trustchaincertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-cloudpkigraphservice-trustchaincertificate.md | + + Title: "trustChainCertificate resource type" +description: "Complex type that represents a certificate in the trust chain of another certificate issued by a certification authority external to Microsoft Cloud PKI. This complex type is only used when calling the uploadExternallySignedCertificationAuthorityCertificate action." ++ms.localizationpriority: medium ++++# trustChainCertificate resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Complex type that represents a certificate in the trust chain of another certificate issued by a certification authority external to Microsoft Cloud PKI. This complex type is only used when calling the uploadExternallySignedCertificationAuthorityCertificate action. ++## Properties +|Property|Type|Description| +|:|:|:| +|displayName|String|The trust chain certificate display name that provides a user-friendly way to identify a certificate in a trust chain.| +|certificate|String|The trust chain certificate in base 64 encoded form.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.trustChainCertificate" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.trustChainCertificate", + "displayName": "String", + "certificate": "String" +} +``` |
v1.0 | Intune Companyterms Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Companyterms Termsandconditions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditions.md | doc_type: resourcePageType # termsAndConditions resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A termsAndConditions entity represents the metadata and contents of a given Terms and Conditions (T&C) policy. T&C policiesΓÇÖ contents are presented to users upon their first attempt to enroll into Intune and subsequently upon edits where an administrator has required re-acceptance. They enable administrators to communicate the provisions to which a user must agree in order to have devices enrolled into Intune. ## Methods |
v1.0 | Intune Companyterms Termsandconditionsacceptancestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditionsacceptancestatus.md | doc_type: resourcePageType # termsAndConditionsAcceptanceStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A termsAndConditionsAcceptanceStatus entity represents the acceptance status of a given Terms and Conditions (T&C) policy by a given user. Users must accept the most up-to-date version of the terms in order to retain access to the Company Portal. ## Methods |
v1.0 | Intune Companyterms Termsandconditionsassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditionsassignment.md | doc_type: resourcePageType # termsAndConditionsAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A termsAndConditionsAssignment entity represents the assignment of a given Terms and Conditions (T&C) policy to a given group. Users in the group will be required to accept the terms in order to have devices enrolled into Intune. ## Methods |
v1.0 | Intune Companyterms Termsandconditionsgroupassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-companyterms-termsandconditionsgroupassignment.md | doc_type: resourcePageType # termsAndConditionsGroupAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A termsAndConditionsGroupAssignment entity represents the assignment of a given Terms and Conditions (T&C) policy to a given group. Users in the group will be required to accept the terms in order to have devices enrolled into Intune. ## Methods |
v1.0 | Intune Deviceconfig Administratorconfigureddevicecompliancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-administratorconfigureddevicecompliancestate.md | doc_type: enumPageType # administratorConfiguredDeviceComplianceState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Administrator configured device compliance state Enum ## Members |
v1.0 | Intune Deviceconfig Advancedbitlockerstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-advancedbitlockerstate.md | doc_type: enumPageType # advancedBitLockerState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Advanced BitLocker State ## Members |
v1.0 | Intune Deviceconfig Advancedthreatprotectiononboardingdevicesettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-advancedthreatprotectiononboardingdevicesettingstate.md | doc_type: resourcePageType # advancedThreatProtectionOnboardingDeviceSettingState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ATP onboarding State for a given device. ## Methods |
v1.0 | Intune Deviceconfig Advancedthreatprotectiononboardingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-advancedthreatprotectiononboardingstatesummary.md | doc_type: resourcePageType # advancedThreatProtectionOnboardingStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows defender advanced threat protection onboarding state summary across the account. ## Methods |
v1.0 | Intune Deviceconfig Airprintdestination | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-airprintdestination.md | doc_type: resourcePageType # airPrintDestination resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an AirPrint destination. ## Properties |
v1.0 | Intune Deviceconfig Androidcertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidcertificateprofilebase.md | doc_type: resourcePageType # androidCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android certificate profile base. |
v1.0 | Intune Deviceconfig Androidcompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidcompliancepolicy.md | doc_type: resourcePageType # androidCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Android. |
v1.0 | Intune Deviceconfig Androidcustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidcustomconfiguration.md | doc_type: resourcePageType # androidCustomConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the androidCustomConfiguration resource. |
v1.0 | Intune Deviceconfig Androiddeviceownerappautoupdatepolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerappautoupdatepolicytype.md | doc_type: enumPageType # androidDeviceOwnerAppAutoUpdatePolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner possible values for states of the device's app auto update policy. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerbatterypluggedmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerbatterypluggedmode.md | doc_type: enumPageType # androidDeviceOwnerBatteryPluggedMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner possible values for states of the device's plugged-in power modes. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownercertificateaccesstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercertificateaccesstype.md | doc_type: enumPageType # androidDeviceOwnerCertificateAccessType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing possible values for cross profile data sharing. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownercertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercertificateprofilebase.md | doc_type: resourcePageType # androidDeviceOwnerCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner certificate profile base. |
v1.0 | Intune Deviceconfig Androiddeviceownercompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercompliancepolicy.md | doc_type: resourcePageType # androidDeviceOwnerCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the AndroidDeviceOwnerCompliancePolicy resource. |
v1.0 | Intune Deviceconfig Androiddeviceownercrossprofiledatasharing | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownercrossprofiledatasharing.md | doc_type: enumPageType # androidDeviceOwnerCrossProfileDataSharing enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing possible values for cross profile data sharing. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerdefaultapppermissionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerdefaultapppermissionpolicytype.md | doc_type: enumPageType # androidDeviceOwnerDefaultAppPermissionPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner default app permission policy type. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerdelegatedappscopetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerdelegatedappscopetype.md | doc_type: enumPageType # androidDeviceOwnerDelegatedAppScopeType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing possible values for delegated app scope. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerdelegatedscopeappsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerdelegatedscopeappsetting.md | doc_type: resourcePageType # androidDeviceOwnerDelegatedScopeAppSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents one item in the list of managed apps with app details and its associated delegated scope(s). ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownerderivedcredentialauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerderivedcredentialauthenticationconfiguration.md | doc_type: resourcePageType # androidDeviceOwnerDerivedCredentialAuthenticationConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android COBO Derived Credential profile. |
v1.0 | Intune Deviceconfig Androiddeviceownerenrollmentprofiletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerenrollmentprofiletype.md | doc_type: enumPageType # androidDeviceOwnerEnrollmentProfileType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Enrollment Profile types. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerenterprisewificonfiguration.md | doc_type: resourcePageType # androidDeviceOwnerEnterpriseWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android Device Owner device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. |
v1.0 | Intune Deviceconfig Androiddeviceownergeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownergeneraldeviceconfiguration.md | doc_type: resourcePageType # androidDeviceOwnerGeneralDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the androidDeviceOwnerGeneralDeviceConfiguration resource. |
v1.0 | Intune Deviceconfig Androiddeviceownerglobalproxy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerglobalproxy.md | doc_type: resourcePageType # androidDeviceOwnerGlobalProxy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Global Proxy. ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownerglobalproxyautoconfig | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerglobalproxyautoconfig.md | doc_type: resourcePageType # androidDeviceOwnerGlobalProxyAutoConfig resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Global Proxy Auto Config. |
v1.0 | Intune Deviceconfig Androiddeviceownerglobalproxydirect | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerglobalproxydirect.md | doc_type: resourcePageType # androidDeviceOwnerGlobalProxyDirect resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Global Proxy Direct. |
v1.0 | Intune Deviceconfig Androiddeviceownerimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerimportedpfxcertificateprofile.md | doc_type: resourcePageType # androidDeviceOwnerImportedPFXCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner PFX Import certificate profile |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskcustomizationstatusbar | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskcustomizationstatusbar.md | doc_type: enumPageType # androidDeviceOwnerKioskCustomizationStatusBar enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing possible values for kiosk customization system navigation. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskcustomizationsystemnavigation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskcustomizationsystemnavigation.md | doc_type: enumPageType # androidDeviceOwnerKioskCustomizationSystemNavigation enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing possible values for kiosk customization system navigation. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeapp.md | doc_type: resourcePageType # androidDeviceOwnerKioskModeApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An application on the Android Device Owner Managed Home Screen |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeapppositionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeapppositionitem.md | doc_type: resourcePageType # androidDeviceOwnerKioskModeAppPositionItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An item in the list of app positions that sets the order of items on the Managed Home Screen ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodefoldericon | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodefoldericon.md | doc_type: enumPageType # androidDeviceOwnerKioskModeFolderIcon enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Kiosk Mode folder icon type. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodefolderitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodefolderitem.md | doc_type: resourcePageType # androidDeviceOwnerKioskModeFolderItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an item that can be added to Android Device Owner folder (application or weblink) |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodehomescreenitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodehomescreenitem.md | doc_type: resourcePageType # androidDeviceOwnerKioskModeHomeScreenItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an item on the Android Device Owner Managed Home Screen (application, weblink or folder ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeiconsize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeiconsize.md | doc_type: enumPageType # androidDeviceOwnerKioskModeIconSize enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Kiosk Mode managed home screen icon size. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodemanagedfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodemanagedfolder.md | doc_type: resourcePageType # androidDeviceOwnerKioskModeManagedFolder resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A folder containing pages of apps and weblinks on the Managed Home Screen ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodemanagedfolderreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodemanagedfolderreference.md | doc_type: resourcePageType # androidDeviceOwnerKioskModeManagedFolderReference resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A reference to folder containing apps and weblinks on the Managed Home Screen |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodescreenorientation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodescreenorientation.md | doc_type: enumPageType # androidDeviceOwnerKioskModeScreenOrientation enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Kiosk Mode managed home screen orientation. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerkioskmodeweblink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerkioskmodeweblink.md | doc_type: resourcePageType # androidDeviceOwnerKioskModeWeblink resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A weblink on the Android Device Owner Managed Home Screen |
v1.0 | Intune Deviceconfig Androiddeviceownerlocationmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerlocationmode.md | doc_type: enumPageType # androidDeviceOwnerLocationMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Location Mode Type ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerpkcscertificateprofile.md | doc_type: resourcePageType # androidDeviceOwnerPkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner PKCS certificate profile |
v1.0 | Intune Deviceconfig Androiddeviceownerplaystoremode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerplaystoremode.md | doc_type: enumPageType # androidDeviceOwnerPlayStoreMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Play Store mode type. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerrequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerrequiredpasswordtype.md | doc_type: enumPageType # androidDeviceOwnerRequiredPasswordType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner policy required password type. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerrequiredpasswordunlock | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerrequiredpasswordunlock.md | doc_type: enumPageType # androidDeviceOwnerRequiredPasswordUnlock enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing possible values for required password unlock. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownerscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerscepcertificateprofile.md | doc_type: resourcePageType # androidDeviceOwnerScepCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner SCEP certificate profile |
v1.0 | Intune Deviceconfig Androiddeviceownersilentcertificateaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownersilentcertificateaccess.md | doc_type: resourcePageType # androidDeviceOwnerSilentCertificateAccess resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contain the package ID that has the pre-granted access to the certificate. ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownersystemupdatefreezeperiod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownersystemupdatefreezeperiod.md | doc_type: resourcePageType # androidDeviceOwnerSystemUpdateFreezePeriod resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents one item in the list of freeze periods for Android Device Owner system updates ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownersystemupdateinstalltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownersystemupdateinstalltype.md | doc_type: enumPageType # androidDeviceOwnerSystemUpdateInstallType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - System Update Types for Android Device Owner. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownertrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownertrustedrootcertificate.md | doc_type: resourcePageType # androidDeviceOwnerTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Trusted Root Certificate configuration profile |
v1.0 | Intune Deviceconfig Androiddeviceowneruserfacingmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceowneruserfacingmessage.md | doc_type: resourcePageType # androidDeviceOwnerUserFacingMessage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a user-facing message with locale information as well as a default message to be used if the user's locale doesn't match with any of the localized messages ## Properties |
v1.0 | Intune Deviceconfig Androiddeviceownervirtualhomebuttontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownervirtualhomebuttontype.md | doc_type: enumPageType # androidDeviceOwnerVirtualHomeButtonType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Device Owner Kiosk Mode managed home screen virtual home button type. ## Members |
v1.0 | Intune Deviceconfig Androiddeviceownervpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownervpnconfiguration.md | doc_type: resourcePageType # androidDeviceOwnerVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android Fully Managed device to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Androiddeviceownerwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerwificonfiguration.md | doc_type: resourcePageType # androidDeviceOwnerWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. This profile provides limited and simpler security types than Enterprise Wi-Fi profile. |
v1.0 | Intune Deviceconfig Androiddeviceownerwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androiddeviceownerwifisecuritytype.md | doc_type: enumPageType # androidDeviceOwnerWiFiSecurityType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wi-Fi Security Types for Android Device Owner. ## Members |
v1.0 | Intune Deviceconfig Androideaptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androideaptype.md | doc_type: enumPageType # androidEapType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Extensible Authentication Protocol (EAP) Configuration Types. ## Members |
v1.0 | Intune Deviceconfig Androideasemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androideasemailprofileconfiguration.md | doc_type: resourcePageType # androidEasEmailProfileConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the native email client on KNOX devices to communicate with an Exchange server and get email, contacts, calendar, tasks, and notes. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Androidenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidenterprisewificonfiguration.md | doc_type: resourcePageType # androidEnterpriseWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. Inherits from [androidWiFiConfiguration](../resources/intune-deviceconfig-androi |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md)|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWiFiConfiguration](../resources/intune-deviceconfig-androidwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |
v1.0 | Intune Deviceconfig Androidforworkcertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcertificateprofilebase.md | doc_type: resourcePageType # androidForWorkCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work certificate profile base. |
v1.0 | Intune Deviceconfig Androidforworkcompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcompliancepolicy.md | doc_type: resourcePageType # androidForWorkCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Android for Work. |
v1.0 | Intune Deviceconfig Androidforworkcrossprofiledatasharingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcrossprofiledatasharingtype.md | doc_type: enumPageType # androidForWorkCrossProfileDataSharingType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work cross profile data sharing type. ## Members |
v1.0 | Intune Deviceconfig Androidforworkcustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkcustomconfiguration.md | doc_type: resourcePageType # androidForWorkCustomConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work custom configuration |
v1.0 | Intune Deviceconfig Androidforworkdefaultapppermissionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkdefaultapppermissionpolicytype.md | doc_type: enumPageType # androidForWorkDefaultAppPermissionPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work default app permission policy type. ## Members |
v1.0 | Intune Deviceconfig Androidforworkeasemailprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkeasemailprofilebase.md | doc_type: resourcePageType # androidForWorkEasEmailProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base for Android For Work EAS Email profiles |
v1.0 | Intune Deviceconfig Androidforworkenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkenterprisewificonfiguration.md | doc_type: resourcePageType # androidForWorkEnterpriseWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android for Work device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. Inherits from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md)|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidForWorkWiFiConfiguration](../resources/intune-deviceconfig-androidforworkwificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |
v1.0 | Intune Deviceconfig Androidforworkgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkgeneraldeviceconfiguration.md | doc_type: resourcePageType # androidForWorkGeneralDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work general device configuration. |
v1.0 | Intune Deviceconfig Androidforworkgmaileasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkgmaileasconfiguration.md | doc_type: resourcePageType # androidForWorkGmailEasConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the Gmail email client on Android For Work devices to communicate with an Exchange server and get email, contacts, calendar, tasks, and notes. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Androidforworkimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkimportedpfxcertificateprofile.md | doc_type: resourcePageType # androidForWorkImportedPFXCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work PFX Import certificate profile |
v1.0 | Intune Deviceconfig Androidforworknineworkeasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworknineworkeasconfiguration.md | doc_type: resourcePageType # androidForWorkNineWorkEasConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the Nine Work email client on Android For Work devices to communicate with an Exchange server and get email, contacts, calendar, tasks, and notes. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Androidforworkpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkpkcscertificateprofile.md | doc_type: resourcePageType # androidForWorkPkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work PKCS certificate profile |
v1.0 | Intune Deviceconfig Androidforworkrequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkrequiredpasswordtype.md | doc_type: enumPageType # androidForWorkRequiredPasswordType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work required password type. ## Members |
v1.0 | Intune Deviceconfig Androidforworkscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkscepcertificateprofile.md | doc_type: resourcePageType # androidForWorkScepCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work SCEP certificate profile |
v1.0 | Intune Deviceconfig Androidforworktrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworktrustedrootcertificate.md | doc_type: resourcePageType # androidForWorkTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work Trusted Root Certificate configuration profile |
v1.0 | Intune Deviceconfig Androidforworkvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkvpnconfiguration.md | doc_type: resourcePageType # androidForWorkVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android device to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Androidforworkvpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkvpnconnectiontype.md | doc_type: enumPageType # androidForWorkVpnConnectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android For Work VPN connection type. ## Members |
v1.0 | Intune Deviceconfig Androidforworkwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidforworkwificonfiguration.md | doc_type: resourcePageType # androidForWorkWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android for Work device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. This profile provides limited and simpler security types than Enterprise Wi-Fi profile. Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| ## Relationships |Relationship|Type|Description| |
v1.0 | Intune Deviceconfig Androidgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidgeneraldeviceconfiguration.md | doc_type: resourcePageType # androidGeneralDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the androidGeneralDeviceConfiguration resource. |
v1.0 | Intune Deviceconfig Androidimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidimportedpfxcertificateprofile.md | doc_type: resourcePageType # androidImportedPFXCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android PFX Import certificate profile |
v1.0 | Intune Deviceconfig Androidkeyguardfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidkeyguardfeature.md | doc_type: enumPageType # androidKeyguardFeature enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android keyguard feature. ## Members |
v1.0 | Intune Deviceconfig Androidomacpconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidomacpconfiguration.md | doc_type: resourcePageType # androidOmaCpConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing a configuration in this profile you can configure Android devices that support OMA-CP. |
v1.0 | Intune Deviceconfig Androidpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidpkcscertificateprofile.md | doc_type: resourcePageType # androidPkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android PKCS certificate profile |
v1.0 | Intune Deviceconfig Androidrequiredpasswordcomplexity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidrequiredpasswordcomplexity.md | doc_type: enumPageType # androidRequiredPasswordComplexity enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The password complexity types that can be set on Android. One of: NONE, LOW, MEDIUM, HIGH. This is an API targeted to Android 11+. ## Members |
v1.0 | Intune Deviceconfig Androidrequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidrequiredpasswordtype.md | doc_type: enumPageType # androidRequiredPasswordType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android required password type. ## Members |
v1.0 | Intune Deviceconfig Androidsafetynetevaluationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidsafetynetevaluationtype.md | doc_type: enumPageType # androidSafetyNetEvaluationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing the Android Play Integrity API evaluation types. ## Members |
v1.0 | Intune Deviceconfig Androidscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidscepcertificateprofile.md | doc_type: resourcePageType # androidScepCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android SCEP certificate profile |
v1.0 | Intune Deviceconfig Androidtrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidtrustedrootcertificate.md | doc_type: resourcePageType # androidTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Trusted Root Certificate configuration profile |
v1.0 | Intune Deviceconfig Androidusernamesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidusernamesource.md | doc_type: enumPageType # androidUsernameSource enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android username source. ## Members |
v1.0 | Intune Deviceconfig Androidvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidvpnconfiguration.md | doc_type: resourcePageType # androidVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android device to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Androidvpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidvpnconnectiontype.md | doc_type: enumPageType # androidVpnConnectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android VPN connection type. ## Members |
v1.0 | Intune Deviceconfig Androidwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidwificonfiguration.md | doc_type: resourcePageType # androidWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. This profile provides limited and simpler security types than Enterprise Wi-Fi profile. Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.| |connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| |connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.|-|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| ## Relationships |Relationship|Type|Description| |
v1.0 | Intune Deviceconfig Androidwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidwifisecuritytype.md | Title: "androidWiFiSecurityType enum type" -description: "Wi-Fi Security Types for Android." +description: "The possible security types for Android Wi-Fi profiles. Default value 'Open', indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. 'WpaEnterprise' and 'Wpa2Enterprise' options are available for Enterprise Wi-Fi profiles. 'Wep' and 'WpaPersonal' (supports WPA and WPA2) options are available for Basic Wi-Fi profiles." ms.localizationpriority: medium doc_type: enumPageType # androidWiFiSecurityType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Wi-Fi Security Types for Android. +The possible security types for Android Wi-Fi profiles. Default value 'Open', indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. 'WpaEnterprise' and 'Wpa2Enterprise' options are available for Enterprise Wi-Fi profiles. 'Wep' and 'WpaPersonal' (supports WPA and WPA2) options are available for Basic Wi-Fi profiles. ## Members |Member|Value|Description| |:|:|:|-|open|0|Open (No Authentication).| -|wpaEnterprise|1|WPA-Enterprise. Must use AndroidEnterpriseWifiConfiguration type to configure enterprise options.| -|wpa2Enterprise|2|WPA2-Enterprise. Must use AndroidEnterpriseWifiConfiguration type to configure enterprise options.| +|open|0|Default. Indicates Android Wifi Security Type is set to "Open" i.e. no authentication is required. (No Authentication).| +|wpaEnterprise|1|Indicates Android Wifi Security Type is set to WPA encryption. Must use AndroidWorkProfileEnterpriseWifiConfiguration type to configure enterprise options.| +|wpa2Enterprise|2|Indicates Android Wifi Security Type is set to WPA2 encryption. Must use AndroidWorkProfileEnterpriseWifiConfiguration type to configure enterprise options.| +|wep|3|Indicates Android Wifi Security Type is set to WEP encryption. This restricts the preSharedKey to a valid passphrase (5 or 13 characters) or a valid HEX key (10 or 26 hexidecimal characters). Use AndroidWorkProfileWifiConfiguration to configure basic Wi-Fi options.| +|wpaPersonal|4| Indicates Android Wifi Security Type is set to WPA encryption. This restricts the preSharedKey to a string between 8 and 64 characters long. Use AndroidWorkProfileWifiConfiguration to configure basic Wi-Fi options.| +|unknownFutureValue|5|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfig Androidworkprofileaccountuse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofileaccountuse.md | doc_type: enumPageType # androidWorkProfileAccountUse enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing possible values for account use in work profile. ## Members |
v1.0 | Intune Deviceconfig Androidworkprofilecertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecertificateprofilebase.md | doc_type: resourcePageType # androidWorkProfileCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile certificate profile base. |
v1.0 | Intune Deviceconfig Androidworkprofilecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecompliancepolicy.md | doc_type: resourcePageType # androidWorkProfileCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Android Work Profile. |
v1.0 | Intune Deviceconfig Androidworkprofilecrossprofiledatasharingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecrossprofiledatasharingtype.md | doc_type: enumPageType # androidWorkProfileCrossProfileDataSharingType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile cross profile data sharing type. ## Members |
v1.0 | Intune Deviceconfig Androidworkprofilecustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilecustomconfiguration.md | doc_type: resourcePageType # androidWorkProfileCustomConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile custom configuration |
v1.0 | Intune Deviceconfig Androidworkprofiledefaultapppermissionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofiledefaultapppermissionpolicytype.md | doc_type: enumPageType # androidWorkProfileDefaultAppPermissionPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile default app permission policy type. ## Members |
v1.0 | Intune Deviceconfig Androidworkprofileeasemailprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofileeasemailprofilebase.md | doc_type: resourcePageType # androidWorkProfileEasEmailProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base for Android Work Profile EAS Email profiles |
v1.0 | Intune Deviceconfig Androidworkprofileenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofileenterprisewificonfiguration.md | doc_type: resourcePageType # androidWorkProfileEnterpriseWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android Work Profile device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. Inherits from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceco |description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)|-|networkName|String|Network Name Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|networkName|String|The name of the Wi-Fi network. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)|-|connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| -|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| -|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|connectAutomatically|Boolean|When set to true, device will connect automatically to the Wi-Fi network when in range, skipping the user prompt. When false, user will need to connect manually through Settings on the Android device. Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. When false, device will not automatically connect to hidden networks. Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|The possible security types for Android Wi-Fi profiles. Default value Open, indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. WpaEnterprise and Wpa2Enterprise options are available for Enterprise Wi-Fi profiles. Wep and WpaPersonal (supports WPA and WPA2) options are available for Basic Wi-Fi profiles. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| +|preSharedKey|String|Specify the pre-shared key for a WEP or WPA personal Wi-Fi network. Restrictions depend on the value set for wiFiSecurityType. If WEP type security is used, then preSharedKey must be a valid passphrase (5 or 13 characters) or a valid HEX key (10 or 26 hexidecimal characters). If WPA security type is used, then preSharedKey can be any string between 8 and 64 characters long. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|preSharedKeyIsSet|Boolean|When set to true, indicates that the pre-shared key is configured. When set to false, indicates that pre-shared key is not configured (any values set for preSharedKey will be ignored). Default value is false. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| +|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md). Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| +|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file. Inherited from [androidWorkProfileWiFiConfiguration](../resources/intune-deviceconfig-androidworkprofilewificonfiguration.md)| |eapType|[androidEapType](../resources/intune-deviceconfig-androideaptype.md)|Indicates the type of EAP protocol set on the Wi-Fi endpoint (router). Possible values are: `eapTls`, `eapTtls`, `peap`.| |trustedServerCertificateNames|String collection|Trusted server certificate names when EAP Type is configured to EAP-TLS/TTLS/FAST or PEAP. This is the common name used in the certificates issued by your trusted certificate authority (CA). If you provide this information, you can bypass the dynamic trust dialog that is displayed on end users' devices when they connect to this Wi-Fi network.| |authenticationMethod|[wiFiAuthenticationMethod](../resources/intune-deviceconfig-wifiauthenticationmethod.md)|Indicates the Authentication Method the client (device) needs to use when the EAP Type is configured to PEAP or EAP-TTLS. Possible values are: `certificate`, `usernameAndPassword`, `derivedCredential`.| |innerAuthenticationProtocolForEapTtls|[nonEapAuthenticationMethodForEapTtlsType](../resources/intune-deviceconfig-noneapauthenticationmethodforeapttlstype.md)|Non-EAP Method for Authentication (Inner Identity) when EAP Type is EAP-TTLS and Authenticationmethod is Username and Password. Possible values are: `unencryptedPassword`, `challengeHandshakeAuthenticationProtocol`, `microsoftChap`, `microsoftChapVersionTwo`.| |innerAuthenticationProtocolForPeap|[nonEapAuthenticationMethodForPeap](../resources/intune-deviceconfig-noneapauthenticationmethodforpeap.md)|Non-EAP Method for Authentication (Inner Identity) when EAP Type is PEAP and Authenticationmethod is Username and Password. Possible values are: `none`, `microsoftChapVersionTwo`.| |outerIdentityPrivacyTemporaryValue|String|Enable identity privacy (Outer Identity) when EAP Type is configured to EAP-TTLS or PEAP. The String provided here is used to mask the username of individual users when they attempt to connect to Wi-Fi network.|-|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection. Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| -|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true, "wiFiSecurityType": "String",+ "preSharedKey": "String", + "preSharedKeyIsSet": true, + "proxySettings": "String", + "proxyAutomaticConfigurationUrl": "String", "eapType": "String", "trustedServerCertificateNames": [ "String" Here is a JSON representation of the resource. "authenticationMethod": "String", "innerAuthenticationProtocolForEapTtls": "String", "innerAuthenticationProtocolForPeap": "String",- "outerIdentityPrivacyTemporaryValue": "String", - "proxySettings": "String", - "proxyAutomaticConfigurationUrl": "String" + "outerIdentityPrivacyTemporaryValue": "String" } ``` |
v1.0 | Intune Deviceconfig Androidworkprofilegeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilegeneraldeviceconfiguration.md | doc_type: resourcePageType # androidWorkProfileGeneralDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile general device configuration. |
v1.0 | Intune Deviceconfig Androidworkprofilegmaileasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilegmaileasconfiguration.md | doc_type: resourcePageType # androidWorkProfileGmailEasConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the Gmail email client on Android Work Profile devices to communicate with an Exchange server and get email, contacts, calendar, tasks, and notes. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Androidworkprofilenineworkeasconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilenineworkeasconfiguration.md | doc_type: resourcePageType # androidWorkProfileNineWorkEasConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the Nine Work email client on Android Work Profile devices to communicate with an Exchange server and get email, contacts, calendar, tasks, and notes. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Androidworkprofilepkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilepkcscertificateprofile.md | doc_type: resourcePageType # androidWorkProfilePkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile PKCS certificate profile |
v1.0 | Intune Deviceconfig Androidworkprofilerequiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilerequiredpasswordtype.md | doc_type: enumPageType # androidWorkProfileRequiredPasswordType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile required password type. ## Members |
v1.0 | Intune Deviceconfig Androidworkprofilescepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilescepcertificateprofile.md | doc_type: resourcePageType # androidWorkProfileScepCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile SCEP certificate profile |
v1.0 | Intune Deviceconfig Androidworkprofiletrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofiletrustedrootcertificate.md | doc_type: resourcePageType # androidWorkProfileTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile Trusted Root Certificate configuration profile |
v1.0 | Intune Deviceconfig Androidworkprofilevpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilevpnconfiguration.md | doc_type: resourcePageType # androidWorkProfileVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android Work Profile device to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Androidworkprofilevpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilevpnconnectiontype.md | doc_type: enumPageType # androidWorkProfileVpnConnectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Android Work Profile VPN connection type. ## Members |
v1.0 | Intune Deviceconfig Androidworkprofilewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-androidworkprofilewificonfiguration.md | doc_type: resourcePageType # androidWorkProfileWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Android Work Profile device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. This profile provides limited and simpler security types than Enterprise Wi-Fi profile. Inherits from [deviceConfiguration](../resources/intune-shared-deviceconfigurati |description|String|Admin provided description of the Device Configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |displayName|String|Admin provided name of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)| |version|Int32|Version of the device configuration. Inherited from [deviceConfiguration](../resources/intune-shared-deviceconfiguration.md)|-|networkName|String|Network Name| +|networkName|String|The name of the Wi-Fi network.| |ssid|String|This is the name of the Wi-Fi network that is broadcast to all devices.|-|connectAutomatically|Boolean|Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.| -|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.| -|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`.| +|connectAutomatically|Boolean|When set to true, device will connect automatically to the Wi-Fi network when in range, skipping the user prompt. When false, user will need to connect manually through Settings on the Android device. Default value is false.| +|connectWhenNetworkNameIsHidden|Boolean|When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices. When false, device will not automatically connect to hidden networks. Default value is false.| +|wiFiSecurityType|[androidWiFiSecurityType](../resources/intune-deviceconfig-androidwifisecuritytype.md)|The possible security types for Android Wi-Fi profiles. Default value Open, indicates no authentication required for the network. The security protocols supported are WEP, WPA and WPA2. WpaEnterprise and Wpa2Enterprise options are available for Enterprise Wi-Fi profiles. Wep and WpaPersonal (supports WPA and WPA2) options are available for Basic Wi-Fi profiles. Possible values are: `open`, `wpaEnterprise`, `wpa2Enterprise`, `wep`, `wpaPersonal`, `unknownFutureValue`.| +|preSharedKey|String|Specify the pre-shared key for a WEP or WPA personal Wi-Fi network. Restrictions depend on the value set for wiFiSecurityType. If WEP type security is used, then preSharedKey must be a valid passphrase (5 or 13 characters) or a valid HEX key (10 or 26 hexidecimal characters). If WPA security type is used, then preSharedKey can be any string between 8 and 64 characters long.| +|preSharedKeyIsSet|Boolean|When set to true, indicates that the pre-shared key is configured. When set to false, indicates that pre-shared key is not configured (any values set for preSharedKey will be ignored). Default value is false.| +|proxySettings|[wiFiProxySetting](../resources/intune-deviceconfig-wifiproxysetting.md)|Proxy Type for this Wi-Fi connection. Possible values are: `none`, `manual`, `automatic`, `unknownFutureValue`.| +|proxyAutomaticConfigurationUrl|String|URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "ssid": "String", "connectAutomatically": true, "connectWhenNetworkNameIsHidden": true,- "wiFiSecurityType": "String" + "wiFiSecurityType": "String", + "preSharedKey": "String", + "preSharedKeyIsSet": true, + "proxySettings": "String", + "proxyAutomaticConfigurationUrl": "String" } ``` |
v1.0 | Intune Deviceconfig Aospdeviceownercertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownercertificateprofilebase.md | doc_type: resourcePageType # aospDeviceOwnerCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - AOSP Device Owner certificate profile base. |
v1.0 | Intune Deviceconfig Aospdeviceownercompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownercompliancepolicy.md | doc_type: resourcePageType # aospDeviceOwnerCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the AndroidDeviceOwnerAOSPCompliancePolicy resource. |
v1.0 | Intune Deviceconfig Aospdeviceownerdeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerdeviceconfiguration.md | doc_type: resourcePageType # aospDeviceOwnerDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the AndroidDeviceOwnerAOSPDeviceConfiguration resource. |
v1.0 | Intune Deviceconfig Aospdeviceownerenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerenterprisewificonfiguration.md | doc_type: resourcePageType # aospDeviceOwnerEnterpriseWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the AOSP Device Owner device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. |
v1.0 | Intune Deviceconfig Aospdeviceownerpkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerpkcscertificateprofile.md | doc_type: resourcePageType # aospDeviceOwnerPkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - AOSP Device Owner PKCS certificate profile |
v1.0 | Intune Deviceconfig Aospdeviceownerscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerscepcertificateprofile.md | doc_type: resourcePageType # aospDeviceOwnerScepCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - AOSP Device Owner SCEP certificate profile |
v1.0 | Intune Deviceconfig Aospdeviceownertrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownertrustedrootcertificate.md | doc_type: resourcePageType # aospDeviceOwnerTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - AOSP Device Owner Trusted Root Certificate configuration profile |
v1.0 | Intune Deviceconfig Aospdeviceownerwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerwificonfiguration.md | doc_type: resourcePageType # aospDeviceOwnerWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the AOSP device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. This profile provides limited and simpler security types than Enterprise Wi-Fi profile. |
v1.0 | Intune Deviceconfig Aospdeviceownerwifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-aospdeviceownerwifisecuritytype.md | doc_type: enumPageType # aospDeviceOwnerWiFiSecurityType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wi-Fi Security Types for AOSP Device Owner. ## Members |
v1.0 | Intune Deviceconfig Appinstallcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appinstallcontroltype.md | doc_type: enumPageType # appInstallControlType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - App Install control Setting ## Members |
v1.0 | Intune Deviceconfig Appleapplistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appleapplistitem.md | doc_type: resourcePageType # appleAppListItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an app in the list of managed Apple applications |
v1.0 | Intune Deviceconfig Appledeploymentchannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appledeploymentchannel.md | doc_type: enumPageType # appleDeploymentChannel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the channel used to deploy the configuration profile. Available choices are DeviceChannel, UserChannel ## Members |
v1.0 | Intune Deviceconfig Appledevicefeaturesconfigurationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appledevicefeaturesconfigurationbase.md | doc_type: resourcePageType # appleDeviceFeaturesConfigurationBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Apple device features configuration profile. |
v1.0 | Intune Deviceconfig Appleexpeditedcheckinconfigurationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-appleexpeditedcheckinconfigurationbase.md | doc_type: resourcePageType # appleExpeditedCheckinConfigurationBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Experimental profile to increase the rate of device check-ins per day of iOS/macOS devices. This profile type is deprecated. |
v1.0 | Intune Deviceconfig Applesubjectnameformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applesubjectnameformat.md | doc_type: enumPageType # appleSubjectNameFormat enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Subject Name Format Options for Apple devices. ## Members |
v1.0 | Intune Deviceconfig Applevpnalwaysonconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applevpnalwaysonconfiguration.md | doc_type: resourcePageType # appleVpnAlwaysOnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Always On VPN configuration for MacOS and iOS IKEv2 ## Properties |
v1.0 | Intune Deviceconfig Applevpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applevpnconfiguration.md | doc_type: resourcePageType # appleVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Apple VPN configuration profile. |
v1.0 | Intune Deviceconfig Applevpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applevpnconnectiontype.md | doc_type: enumPageType # appleVpnConnectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Apple VPN connection type. ## Members |
v1.0 | Intune Deviceconfig Applicationguardblockclipboardsharingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applicationguardblockclipboardsharingtype.md | doc_type: enumPageType # applicationGuardBlockClipboardSharingType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for applicationGuardBlockClipboardSharingType ## Members |
v1.0 | Intune Deviceconfig Applicationguardblockfiletransfertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applicationguardblockfiletransfertype.md | doc_type: enumPageType # applicationGuardBlockFileTransferType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for applicationGuardBlockFileTransfer ## Members |
v1.0 | Intune Deviceconfig Applicationguardenabledoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applicationguardenabledoptions.md | doc_type: enumPageType # applicationGuardEnabledOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for ApplicationGuardEnabledOptions ## Members |
v1.0 | Intune Deviceconfig Applistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applistitem.md | doc_type: resourcePageType # appListItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an app in the list of managed applications ## Properties |
v1.0 | Intune Deviceconfig Applisttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applisttype.md | doc_type: enumPageType # appListType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of the compliance app list. ## Members |
v1.0 | Intune Deviceconfig Applockerapplicationcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-applockerapplicationcontroltype.md | doc_type: enumPageType # appLockerApplicationControlType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of AppLocker Application Control Types ## Members |
v1.0 | Intune Deviceconfig Authenticationtransformconstant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-authenticationtransformconstant.md | doc_type: enumPageType # authenticationTransformConstant enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Authentication transform values for Windows10 VPN policies with IKEv2 connection type. ## Members |
v1.0 | Intune Deviceconfig Automaticupdatemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-automaticupdatemode.md | doc_type: enumPageType # automaticUpdateMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for automatic update mode. ## Members |
v1.0 | Intune Deviceconfig Autorestartnotificationdismissalmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-autorestartnotificationdismissalmethod.md | doc_type: enumPageType # autoRestartNotificationDismissalMethod enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Auto restart required notification dismissal method ## Members |
v1.0 | Intune Deviceconfig Bitlockerencryptionmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerencryptionmethod.md | doc_type: enumPageType # bitLockerEncryptionMethod enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BitLockerEncryptionMethod types ## Members |
v1.0 | Intune Deviceconfig Bitlockerfixeddrivepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerfixeddrivepolicy.md | doc_type: resourcePageType # bitLockerFixedDrivePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BitLocker Fixed Drive Policies. ## Properties |
v1.0 | Intune Deviceconfig Bitlockerrecoveryinformationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerrecoveryinformationtype.md | doc_type: enumPageType # bitLockerRecoveryInformationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BitLockerRecoveryInformationType types ## Members |
v1.0 | Intune Deviceconfig Bitlockerrecoveryoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerrecoveryoptions.md | doc_type: resourcePageType # bitLockerRecoveryOptions resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BitLocker Recovery Options. ## Properties |
v1.0 | Intune Deviceconfig Bitlockerrecoverypasswordrotationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerrecoverypasswordrotationtype.md | doc_type: enumPageType # bitLockerRecoveryPasswordRotationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BitLocker recovery password rotation type ## Members |
v1.0 | Intune Deviceconfig Bitlockerremovabledrivepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockerremovabledrivepolicy.md | doc_type: resourcePageType # bitLockerRemovableDrivePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BitLocker Removable Drive Policies. ## Properties |
v1.0 | Intune Deviceconfig Bitlockersystemdrivepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-bitlockersystemdrivepolicy.md | doc_type: resourcePageType # bitLockerSystemDrivePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BitLocker Encryption Base Policies. ## Properties |
v1.0 | Intune Deviceconfig Browsersyncsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-browsersyncsetting.md | doc_type: enumPageType # browserSyncSetting enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Allow(Not Configured) or prevent(Block) the syncing of Microsoft Edge Browser settings. Option to prevent syncing across devices, but allow user override. ## Members |
v1.0 | Intune Deviceconfig Carttoclassassociation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-carttoclassassociation.md | doc_type: resourcePageType # cartToClassAssociation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - CartToClassAssociation for associating device carts with classrooms. ## Methods |
v1.0 | Intune Deviceconfig Certificateissuancestates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-certificateissuancestates.md | doc_type: enumPageType # certificateIssuanceStates enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Certificate Issuance State Options. ## Members |
v1.0 | Intune Deviceconfig Certificaterevocationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-certificaterevocationstatus.md | doc_type: enumPageType # certificateRevocationStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Certificate Revocation Status. ## Members |
v1.0 | Intune Deviceconfig Changeuefisettingspermission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-changeuefisettingspermission.md | doc_type: enumPageType # changeUefiSettingsPermission enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Defines the permission level granted to users to enable them change Uefi settings ## Members |
v1.0 | Intune Deviceconfig Code | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-code.md | doc_type: enumPageType # code enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Error code for rule validation. ## Members |
v1.0 | Intune Deviceconfig Configurationusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-configurationusage.md | doc_type: enumPageType # configurationUsage enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of the ConfigurationUsage list. ## Members |
v1.0 | Intune Deviceconfig Credentialsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-credentialsinglesignonextension.md | doc_type: resourcePageType # credentialSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Credential-type Single Sign-On extension profile. |
v1.0 | Intune Deviceconfig Cryptographysuite | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-cryptographysuite.md | doc_type: resourcePageType # cryptographySuite resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Security Association Parameters ## Properties |
v1.0 | Intune Deviceconfig Customsubjectalternativename | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-customsubjectalternativename.md | doc_type: resourcePageType # customSubjectAlternativeName resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Custom Subject Alternative Name definition ## Properties |
v1.0 | Intune Deviceconfig Customupdatetimewindow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-customupdatetimewindow.md | doc_type: resourcePageType # customUpdateTimeWindow resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Custom update time window ## Properties |
v1.0 | Intune Deviceconfig Datatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-datatype.md | doc_type: enumPageType # dataType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Data types for rules. ## Members |
v1.0 | Intune Deviceconfig Dayofweek | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-dayofweek.md | doc_type: enumPageType # dayOfWeek enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for a weekday ## Members |
v1.0 | Intune Deviceconfig Defaultdevicecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defaultdevicecompliancepolicy.md | doc_type: resourcePageType # defaultDeviceCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Default device compliance policy rules that are enforced account wide. |
v1.0 | Intune Deviceconfig Defenderattacksurfacetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderattacksurfacetype.md | doc_type: enumPageType # defenderAttackSurfaceType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of Defender Attack Surface Reduction Rules ## Members |
v1.0 | Intune Deviceconfig Defendercloudblockleveltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendercloudblockleveltype.md | doc_type: enumPageType # defenderCloudBlockLevelType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of Cloud Block Level ## Members |
v1.0 | Intune Deviceconfig Defenderdetectedmalwareactions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderdetectedmalwareactions.md | doc_type: resourcePageType # defenderDetectedMalwareActions resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specify DefenderΓÇÖs actions to take on detected Malware per threat level. ## Properties |
v1.0 | Intune Deviceconfig Defendermonitorfileactivity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendermonitorfileactivity.md | doc_type: enumPageType # defenderMonitorFileActivity enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for monitoring file activity. ## Members |
v1.0 | Intune Deviceconfig Defenderpotentiallyunwantedappaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderpotentiallyunwantedappaction.md | doc_type: enumPageType # defenderPotentiallyUnwantedAppAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - DefenderΓÇÖs action to take on detected Potentially Unwanted Application (PUA). ## Members |
v1.0 | Intune Deviceconfig Defenderpromptforsamplesubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderpromptforsamplesubmission.md | doc_type: enumPageType # defenderPromptForSampleSubmission enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for prompting user for samples submission. ## Members |
v1.0 | Intune Deviceconfig Defenderprotectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderprotectiontype.md | doc_type: enumPageType # defenderProtectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of Defender PUA Protection ## Members |
v1.0 | Intune Deviceconfig Defenderrealtimescandirection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderrealtimescandirection.md | doc_type: enumPageType # defenderRealtimeScanDirection enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for monitoring file activity. ## Members |
v1.0 | Intune Deviceconfig Defenderscantype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderscantype.md | doc_type: enumPageType # defenderScanType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for system scan type. ## Members |
v1.0 | Intune Deviceconfig Defendersecuritycenteritcontactdisplaytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendersecuritycenteritcontactdisplaytype.md | doc_type: enumPageType # defenderSecurityCenterITContactDisplayType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for defenderSecurityCenterITContactDisplay ## Members |
v1.0 | Intune Deviceconfig Defendersecuritycenternotificationsfromapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendersecuritycenternotificationsfromapptype.md | doc_type: enumPageType # defenderSecurityCenterNotificationsFromAppType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for defenderSecurityCenterNotificationsFromApp ## Members |
v1.0 | Intune Deviceconfig Defendersubmitsamplesconsenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defendersubmitsamplesconsenttype.md | doc_type: enumPageType # defenderSubmitSamplesConsentType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for DefenderSubmitSamplesConsentType ## Members |
v1.0 | Intune Deviceconfig Defenderthreataction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-defenderthreataction.md | doc_type: enumPageType # defenderThreatAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - DefenderΓÇÖs default action to take on detected Malware threats. ## Members |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidth | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidth.md | doc_type: resourcePageType # deliveryOptimizationBandwidth resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Bandwidth restriction types ## Properties |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthabsolute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthabsolute.md | doc_type: resourcePageType # deliveryOptimizationBandwidthAbsolute resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Bandwidth limits in kilobytes per second. |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthbusinesshourslimit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthbusinesshourslimit.md | doc_type: resourcePageType # deliveryOptimizationBandwidthBusinessHoursLimit resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Bandwidth business hours and percentages type ## Properties |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthhourswithpercentage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthhourswithpercentage.md | doc_type: resourcePageType # deliveryOptimizationBandwidthHoursWithPercentage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Bandwidth limit as a percentage with business hours. |
v1.0 | Intune Deviceconfig Deliveryoptimizationbandwidthpercentage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationbandwidthpercentage.md | doc_type: resourcePageType # deliveryOptimizationBandwidthPercentage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Bandwidth limits specified as a percentage. |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidcustom | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidcustom.md | doc_type: resourcePageType # deliveryOptimizationGroupIdCustom resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Custom group id type |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidoptionstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidoptionstype.md | doc_type: enumPageType # deliveryOptimizationGroupIdOptionsType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for the DeliveryOptimizationGroupIdOptionsType setting. ## Members |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidsource.md | doc_type: resourcePageType # deliveryOptimizationGroupIdSource resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - GroupId Support Types ## Properties |
v1.0 | Intune Deviceconfig Deliveryoptimizationgroupidsourceoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationgroupidsourceoptions.md | doc_type: resourcePageType # deliveryOptimizationGroupIdSourceOptions resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Group id options type |
v1.0 | Intune Deviceconfig Deliveryoptimizationmaxcachesize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationmaxcachesize.md | doc_type: resourcePageType # deliveryOptimizationMaxCacheSize resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Delivery Optimization max cache size types. ## Properties |
v1.0 | Intune Deviceconfig Deliveryoptimizationmaxcachesizeabsolute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationmaxcachesizeabsolute.md | doc_type: resourcePageType # deliveryOptimizationMaxCacheSizeAbsolute resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Delivery Optimization max cache size absolute type. |
v1.0 | Intune Deviceconfig Deliveryoptimizationmaxcachesizepercentage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationmaxcachesizepercentage.md | doc_type: resourcePageType # deliveryOptimizationMaxCacheSizePercentage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Delivery Optimization Max cache size percentage types. |
v1.0 | Intune Deviceconfig Deliveryoptimizationrestrictpeerselectionbyoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deliveryoptimizationrestrictpeerselectionbyoptions.md | doc_type: enumPageType # deliveryOptimizationRestrictPeerSelectionByOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Values to restrict peer selection by. ## Members |
v1.0 | Intune Deviceconfig Derivedcredentialprovidertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-derivedcredentialprovidertype.md | doc_type: enumPageType # derivedCredentialProviderType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Provider type for Derived Credentials. ## Members |
v1.0 | Intune Deviceconfig Devicecomplianceactionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceactionitem.md | doc_type: resourcePageType # deviceComplianceActionItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scheduled Action Configuration ## Methods |
v1.0 | Intune Deviceconfig Devicecomplianceactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceactiontype.md | doc_type: enumPageType # deviceComplianceActionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scheduled Action Type Enum ## Members |
v1.0 | Intune Deviceconfig Devicecompliancedeviceoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancedeviceoverview.md | doc_type: resourcePageType # deviceComplianceDeviceOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecompliancedevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancedevicestatus.md | doc_type: resourcePageType # deviceComplianceDeviceStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicy.md | doc_type: resourcePageType # deviceCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This is the base class for Compliance policy. Compliance policies are platform specific and individual per-platform compliance policies inherit from here. ## Methods |
v1.0 | Intune Deviceconfig Devicecompliancepolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicyassignment.md | doc_type: resourcePageType # deviceCompliancePolicyAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device compliance policy assignment. ## Methods |
v1.0 | Intune Deviceconfig Devicecompliancepolicydevicestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicydevicestatesummary.md | doc_type: resourcePageType # deviceCompliancePolicyDeviceStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecompliancepolicyscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicyscript.md | doc_type: resourcePageType # deviceCompliancePolicyScript resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecompliancepolicysettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicysettingstate.md | doc_type: resourcePageType # deviceCompliancePolicySettingState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Compilance Policy Setting State for a given device. ## Properties |
v1.0 | Intune Deviceconfig Devicecompliancepolicysettingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancepolicysettingstatesummary.md | doc_type: resourcePageType # deviceCompliancePolicySettingStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Compilance Policy Setting State summary across the account. ## Methods Device Compilance Policy Setting State summary across the account. |id|String|Key of the entity.| |setting|String|The setting class name and property name.| |settingName|String|Name of the setting.|-|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Setting platform. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `all`.| +|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Setting platform. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `linux`, `all`.| |unknownDeviceCount|Int32|Number of unknown devices| |notApplicableDeviceCount|Int32|Number of not applicable devices| |compliantDeviceCount|Int32|Number of compliant devices| |
v1.0 | Intune Deviceconfig Devicecompliancescheduledactionforrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescheduledactionforrule.md | doc_type: resourcePageType # deviceComplianceScheduledActionForRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scheduled Action for Rule ## Methods |
v1.0 | Intune Deviceconfig Devicecompliancescripterror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescripterror.md | doc_type: resourcePageType # deviceComplianceScriptError resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecompliancescriptrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptrule.md | doc_type: resourcePageType # deviceComplianceScriptRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecompliancescriptruledatatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptruledatatype.md | doc_type: enumPageType # deviceComplianceScriptRuleDataType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Data types for rules. ## Members |
v1.0 | Intune Deviceconfig Devicecompliancescriptruleerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptruleerror.md | doc_type: resourcePageType # deviceComplianceScriptRuleError resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceComplianceScriptError](../resources/intune-deviceconfig-devicecompliancescripterror.md) ## Properties |
v1.0 | Intune Deviceconfig Devicecompliancescriptrulesvalidationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptrulesvalidationerror.md | doc_type: enumPageType # deviceComplianceScriptRulesValidationError enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Error code for rule validation. ## Members |
v1.0 | Intune Deviceconfig Devicecompliancescriptruloperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptruloperator.md | doc_type: enumPageType # deviceComplianceScriptRulOperator enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Operator for rules. ## Members |
v1.0 | Intune Deviceconfig Devicecompliancescriptvalidationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancescriptvalidationresult.md | doc_type: resourcePageType # deviceComplianceScriptValidationResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecompliancesettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecompliancesettingstate.md | doc_type: resourcePageType # deviceComplianceSettingState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device compliance setting State for a given device. ## Methods |
v1.0 | Intune Deviceconfig Devicecomplianceuseroverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceuseroverview.md | doc_type: resourcePageType # deviceComplianceUserOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicecomplianceuserstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicecomplianceuserstatus.md | doc_type: resourcePageType # deviceComplianceUserStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Deviceconfigassignmentintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigassignmentintent.md | doc_type: enumPageType # deviceConfigAssignmentIntent enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The administrator intent for the assignment of the profile. ## Members |
v1.0 | Intune Deviceconfig Deviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfiguration.md | doc_type: resourcePageType # deviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Configuration. ## Methods |
v1.0 | Intune Deviceconfig Deviceconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationassignment.md | doc_type: resourcePageType # deviceConfigurationAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The device configuration assignment entity assigns an AAD group to a specific device configuration. ## Methods |
v1.0 | Intune Deviceconfig Deviceconfigurationconflictsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationconflictsummary.md | doc_type: resourcePageType # deviceConfigurationConflictSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Conflict summary for a set of device configuration policies. ## Methods |
v1.0 | Intune Deviceconfig Deviceconfigurationdeviceoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationdeviceoverview.md | doc_type: resourcePageType # deviceConfigurationDeviceOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Deviceconfigurationdevicestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationdevicestatesummary.md | doc_type: resourcePageType # deviceConfigurationDeviceStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Deviceconfigurationdevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationdevicestatus.md | doc_type: resourcePageType # deviceConfigurationDeviceStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Support for this Entity is being deprecated starting May 2026 & will no longer be supported. ## Methods |
v1.0 | Intune Deviceconfig Deviceconfigurationgroupassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationgroupassignment.md | doc_type: resourcePageType # deviceConfigurationGroupAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device configuration group assignment. ## Methods |
v1.0 | Intune Deviceconfig Deviceconfigurationsettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationsettingstate.md | doc_type: resourcePageType # deviceConfigurationSettingState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Configuration Setting State for a given device. ## Properties |
v1.0 | Intune Deviceconfig Deviceconfigurationtargeteduseranddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationtargeteduseranddevice.md | doc_type: resourcePageType # deviceConfigurationTargetedUserAndDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Conflict summary for a set of device configuration policies. ## Properties |
v1.0 | Intune Deviceconfig Deviceconfigurationuseroverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationuseroverview.md | doc_type: resourcePageType # deviceConfigurationUserOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Deviceconfigurationuserstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationuserstatesummary.md | doc_type: resourcePageType # deviceConfigurationUserStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Deviceconfigurationuserstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceconfigurationuserstatus.md | doc_type: resourcePageType # deviceConfigurationUserStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Deviceguardlocalsystemauthoritycredentialguardtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceguardlocalsystemauthoritycredentialguardtype.md | doc_type: enumPageType # deviceGuardLocalSystemAuthorityCredentialGuardType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of Credential Guard settings. ## Members |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruledevicemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruledevicemode.md | doc_type: resourcePageType # deviceManagementApplicabilityRuleDeviceMode resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruleosedition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruleosedition.md | doc_type: resourcePageType # deviceManagementApplicabilityRuleOsEdition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruleosversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruleosversion.md | doc_type: resourcePageType # deviceManagementApplicabilityRuleOsVersion resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicemanagementapplicabilityruletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementapplicabilityruletype.md | doc_type: enumPageType # deviceManagementApplicabilityRuleType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported Applicability rule types for Device Configuration ## Members |
v1.0 | Intune Deviceconfig Devicemanagementcertificationauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementcertificationauthority.md | doc_type: enumPageType # deviceManagementCertificationAuthority enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Management Certification Authority Types. ## Members |
v1.0 | Intune Deviceconfig Devicemanagementderivedcredentialsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementderivedcredentialsettings.md | doc_type: resourcePageType # deviceManagementDerivedCredentialSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicemanagementsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementsettings.md | doc_type: resourcePageType # deviceManagementSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Devicemanagementuserrightslocaluserorgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementuserrightslocaluserorgroup.md | doc_type: resourcePageType # deviceManagementUserRightsLocalUserOrGroup resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents information for a local user or group used for user rights setting. ## Properties |
v1.0 | Intune Deviceconfig Devicemanagementuserrightssetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicemanagementuserrightssetting.md | doc_type: resourcePageType # deviceManagementUserRightsSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a user rights setting. ## Properties |
v1.0 | Intune Deviceconfig Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-deviceplatformtype.md | doc_type: enumPageType # devicePlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types. ## Members |
v1.0 | Intune Deviceconfig Devicethreatprotectionlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicethreatprotectionlevel.md | doc_type: enumPageType # deviceThreatProtectionLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device threat protection levels for the Device Threat Protection API. ## Members |
v1.0 | Intune Deviceconfig Devicetypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-devicetypes.md | doc_type: enumPageType # deviceTypes enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device type. ## Members |
v1.0 | Intune Deviceconfig Diagnosticdatasubmissionmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-diagnosticdatasubmissionmode.md | doc_type: enumPageType # diagnosticDataSubmissionMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Allow the device to send diagnostic and usage telemetry data, such as Watson. ## Members |
v1.0 | Intune Deviceconfig Diffiehellmangroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-diffiehellmangroup.md | doc_type: enumPageType # diffieHellmanGroup enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Diffie Hellman Group values for Windows10 VPN policies with IKEv2 connection type. ## Members |
v1.0 | Intune Deviceconfig Dmaguarddeviceenumerationpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-dmaguarddeviceenumerationpolicytype.md | doc_type: enumPageType # dmaGuardDeviceEnumerationPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of the DmaGuardDeviceEnumerationPolicy. ## Members |
v1.0 | Intune Deviceconfig Domainnamesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-domainnamesource.md | doc_type: enumPageType # domainNameSource enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Domainname source. ## Members |
v1.0 | Intune Deviceconfig Eapfastconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-eapfastconfiguration.md | doc_type: enumPageType # eapFastConfiguration enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Available settings for EAP-FAST Configuration. ## Members |
v1.0 | Intune Deviceconfig Eaptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-eaptype.md | doc_type: enumPageType # eapType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Extensible Authentication Protocol (EAP) configuration types. ## Members |
v1.0 | Intune Deviceconfig Easauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-easauthenticationmethod.md | doc_type: enumPageType # easAuthenticationMethod enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Exchange Active Sync authentication method. ## Members |
v1.0 | Intune Deviceconfig Easemailprofileconfigurationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-easemailprofileconfigurationbase.md | doc_type: resourcePageType # easEmailProfileConfigurationBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Apple device features configuration profile. |
v1.0 | Intune Deviceconfig Easservices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-easservices.md | doc_type: enumPageType # easServices enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Exchange Active Sync services. ## Members |
v1.0 | Intune Deviceconfig Edgecookiepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgecookiepolicy.md | doc_type: enumPageType # edgeCookiePolicy enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values to specify which cookies are allowed in Microsoft Edge. ## Members |
v1.0 | Intune Deviceconfig Edgehomebuttonconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonconfiguration.md | doc_type: resourcePageType # edgeHomeButtonConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The home button configuration base class used to identify the available options ## Properties |
v1.0 | Intune Deviceconfig Edgehomebuttonhidden | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonhidden.md | doc_type: resourcePageType # edgeHomeButtonHidden resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Hide the home button. |
v1.0 | Intune Deviceconfig Edgehomebuttonloadsstartpage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonloadsstartpage.md | doc_type: resourcePageType # edgeHomeButtonLoadsStartPage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Show the home button; clicking the home button loads the Start page - this is also the default value. |
v1.0 | Intune Deviceconfig Edgehomebuttonopenscustomurl | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonopenscustomurl.md | doc_type: resourcePageType # edgeHomeButtonOpensCustomURL resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Show the home button; clicking the home button loads a specific URL. |
v1.0 | Intune Deviceconfig Edgehomebuttonopensnewtab | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgehomebuttonopensnewtab.md | doc_type: resourcePageType # edgeHomeButtonOpensNewTab resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Show the home button; clicking the home button loads the New tab page. |
v1.0 | Intune Deviceconfig Edgekioskmoderestrictiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgekioskmoderestrictiontype.md | doc_type: enumPageType # edgeKioskModeRestrictionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specify how the Microsoft Edge settings are restricted based on kiosk mode. ## Members |
v1.0 | Intune Deviceconfig Edgeopenoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgeopenoptions.md | doc_type: enumPageType # edgeOpenOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for the EdgeOpensWith setting. ## Members |
v1.0 | Intune Deviceconfig Edgesearchengine | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchengine.md | doc_type: resourcePageType # edgeSearchEngine resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Allows IT admins to set a predefined default search engine for MDM-Controlled devices. |
v1.0 | Intune Deviceconfig Edgesearchenginebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchenginebase.md | doc_type: resourcePageType # edgeSearchEngineBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Allows IT admins to set a default search engine for MDM-Controlled devices. Users can override this and change their default search engine provided the AllowSearchEngineCustomization policy is not set. ## Properties |
v1.0 | Intune Deviceconfig Edgesearchenginecustom | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchenginecustom.md | doc_type: resourcePageType # edgeSearchEngineCustom resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Allows IT admins to set a custom default search engine for MDM-Controlled devices. |
v1.0 | Intune Deviceconfig Edgesearchenginetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgesearchenginetype.md | doc_type: enumPageType # edgeSearchEngineType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Allows IT admind to set a predefined default search engine for MDM-Controlled devices ## Members |
v1.0 | Intune Deviceconfig Edgetelemetrymode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-edgetelemetrymode.md | doc_type: enumPageType # edgeTelemetryMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of browsing data sent to Microsoft 365 analytics ## Members |
v1.0 | Intune Deviceconfig Editionupgradeconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-editionupgradeconfiguration.md | doc_type: resourcePageType # editionUpgradeConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Edition Upgrade configuration. |
v1.0 | Intune Deviceconfig Editionupgradelicensetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-editionupgradelicensetype.md | doc_type: enumPageType # editionUpgradeLicenseType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Edition Upgrade License type ## Members |
v1.0 | Intune Deviceconfig Emailcertificatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-emailcertificatetype.md | doc_type: enumPageType # emailCertificateType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported certificate sources for email signing and encryption. ## Members |
v1.0 | Intune Deviceconfig Emailsyncduration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-emailsyncduration.md | doc_type: enumPageType # emailSyncDuration enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for email sync duration. ## Members |
v1.0 | Intune Deviceconfig Emailsyncschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-emailsyncschedule.md | doc_type: enumPageType # emailSyncSchedule enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for email sync schedule. ## Members |
v1.0 | Intune Deviceconfig Enablement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-enablement.md | doc_type: enumPageType # enablement enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of a property ## Members |
v1.0 | Intune Deviceconfig Encryptionreadinessstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-encryptionreadinessstate.md | doc_type: enumPageType # encryptionReadinessState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Encryption readiness state ## Members |
v1.0 | Intune Deviceconfig Encryptionreportpolicydetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-encryptionreportpolicydetails.md | doc_type: resourcePageType # encryptionReportPolicyDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy Details for Encryption Report ## Properties |
v1.0 | Intune Deviceconfig Encryptionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-encryptionstate.md | doc_type: enumPageType # encryptionState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Encryption state ## Members |
v1.0 | Intune Deviceconfig Extendedkeyusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-extendedkeyusage.md | doc_type: resourcePageType # extendedKeyUsage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Custom Extended Key Usage definition ## Properties |
v1.0 | Intune Deviceconfig Filevaultstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-filevaultstate.md | doc_type: enumPageType # fileVaultState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - FileVault State ## Members |
v1.0 | Intune Deviceconfig Firewallcertificaterevocationlistcheckmethodtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-firewallcertificaterevocationlistcheckmethodtype.md | doc_type: enumPageType # firewallCertificateRevocationListCheckMethodType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for firewallCertificateRevocationListCheckMethod ## Members |
v1.0 | Intune Deviceconfig Firewallpacketqueueingmethodtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-firewallpacketqueueingmethodtype.md | doc_type: enumPageType # firewallPacketQueueingMethodType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for firewallPacketQueueingMethod ## Members |
v1.0 | Intune Deviceconfig Firewallpresharedkeyencodingmethodtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-firewallpresharedkeyencodingmethodtype.md | doc_type: enumPageType # firewallPreSharedKeyEncodingMethodType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for firewallPreSharedKeyEncodingMethod ## Members |
v1.0 | Intune Deviceconfig Folderprotectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-folderprotectiontype.md | doc_type: enumPageType # folderProtectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of Folder Protection ## Members |
v1.0 | Intune Deviceconfig Hardwareconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfiguration.md | doc_type: resourcePageType # hardwareConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - BIOS configuration and other settings provides customers the ability to configure hardware/bios settings on the enrolled Windows 10/11 Entra ID joined devices by uploading a configuration file generated with their OEM tool (e.g. Dell Command tool). A BIOS configuration policy can be assigned to multiple devices, allowing admins to remotely control a device's hardware properties (e.g. enable Secure Boot) from the Intune Portal. Supported for Dell only at this time. ## Methods |
v1.0 | Intune Deviceconfig Hardwareconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationassignment.md | doc_type: resourcePageType # hardwareConfigurationAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to assign a hardware configuration to a group. ## Methods |
v1.0 | Intune Deviceconfig Hardwareconfigurationdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationdevicestate.md | doc_type: resourcePageType # hardwareConfigurationDeviceState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for device run state of the hardware configuration ## Methods |
v1.0 | Intune Deviceconfig Hardwareconfigurationformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationformat.md | doc_type: enumPageType # hardwareConfigurationFormat enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the supported oems of hardware configuration ## Members |
v1.0 | Intune Deviceconfig Hardwareconfigurationrunsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationrunsummary.md | doc_type: resourcePageType # hardwareConfigurationRunSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the run summary of a hardware configuration script. ## Methods |
v1.0 | Intune Deviceconfig Hardwareconfigurationuserstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwareconfigurationuserstate.md | doc_type: resourcePageType # hardwareConfigurationUserState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for User state of the hardware configuration ## Methods |
v1.0 | Intune Deviceconfig Hardwarepassworddetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwarepassworddetail.md | doc_type: resourcePageType # hardwarePasswordDetail resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device BIOS password information for devices with managed BIOS and firmware configuration, which provides device serial number, list of previous passwords, and current password. ## Methods |
v1.0 | Intune Deviceconfig Hardwarepasswordinfo | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-hardwarepasswordinfo.md | doc_type: resourcePageType # hardwarePasswordInfo resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Intune will provide customer the ability to configure hardware/bios settings on the enrolled windows 10 Azure Active Directory joined devices. Starting from June, 2024 (Intune Release 2406), this type will no longer be supported and will be marked as deprecated ## Methods |
v1.0 | Intune Deviceconfig Inkaccesssetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-inkaccesssetting.md | doc_type: enumPageType # inkAccessSetting enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Values for the InkWorkspaceAccess setting. ## Members |
v1.0 | Intune Deviceconfig Intendedpurpose | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-intendedpurpose.md | doc_type: enumPageType # intendedPurpose enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - PFX Import Options. ## Members |
v1.0 | Intune Deviceconfig Internetexplorermessagesetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-internetexplorermessagesetting.md | doc_type: enumPageType # internetExplorerMessageSetting enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - What message will be displayed by Edge before switching to Internet Explorer. ## Members |
v1.0 | Intune Deviceconfig Internetsitesecuritylevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-internetsitesecuritylevel.md | doc_type: enumPageType # internetSiteSecurityLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for internet site security level. ## Members |
v1.0 | Intune Deviceconfig Iosazureadsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosazureadsinglesignonextension.md | doc_type: resourcePageType # iosAzureAdSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an Azure AD-type Single Sign-On extension profile for iOS devices. |
v1.0 | Intune Deviceconfig Iosbookmark | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosbookmark.md | doc_type: resourcePageType # iosBookmark resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS URL bookmark ## Properties |
v1.0 | Intune Deviceconfig Ioscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscertificateprofile.md | doc_type: resourcePageType # iosCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Configuration. |
v1.0 | Intune Deviceconfig Ioscertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscertificateprofilebase.md | doc_type: resourcePageType # iosCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS certificate profile base. |
v1.0 | Intune Deviceconfig Ioscompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscompliancepolicy.md | doc_type: resourcePageType # iosCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for IOS. |
v1.0 | Intune Deviceconfig Ioscredentialsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscredentialsinglesignonextension.md | doc_type: resourcePageType # iosCredentialSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Credential-type Single Sign-On extension profile for iOS devices. |
v1.0 | Intune Deviceconfig Ioscustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioscustomconfiguration.md | doc_type: resourcePageType # iosCustomConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the iosCustomConfiguration resource. |
v1.0 | Intune Deviceconfig Iosderivedcredentialauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosderivedcredentialauthenticationconfiguration.md | doc_type: resourcePageType # iosDerivedCredentialAuthenticationConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Derived Credential profile. |
v1.0 | Intune Deviceconfig Iosdevicefeaturesconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosdevicefeaturesconfiguration.md | doc_type: resourcePageType # iosDeviceFeaturesConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Device Features Configuration Profile. |
v1.0 | Intune Deviceconfig Ioseasemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioseasemailprofileconfiguration.md | doc_type: resourcePageType # iosEasEmailProfileConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the native email client on iOS devices to communicate with an Exchange server and get email, contacts, calendar, reminders, and notes. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Ioseducationdeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioseducationdeviceconfiguration.md | doc_type: resourcePageType # iosEducationDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Education configuration profile |
v1.0 | Intune Deviceconfig Ioseducertificatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioseducertificatesettings.md | doc_type: resourcePageType # iosEduCertificateSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Trusted Root and PFX certificates for iOS EDU. ## Properties |
v1.0 | Intune Deviceconfig Iosedudeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosedudeviceconfiguration.md | doc_type: resourcePageType # iosEduDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Education device configuration |
v1.0 | Intune Deviceconfig Iosenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosenterprisewificonfiguration.md | doc_type: resourcePageType # iosEnterpriseWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the iOS device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. |
v1.0 | Intune Deviceconfig Iosexpeditedcheckinconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosexpeditedcheckinconfiguration.md | doc_type: resourcePageType # iosExpeditedCheckinConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Experimental profile to increase the rate of device check-ins per day of iOS devices. This profile type is deprecated. |
v1.0 | Intune Deviceconfig Iosgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosgeneraldeviceconfiguration.md | doc_type: resourcePageType # iosGeneralDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the iosGeneralDeviceConfiguration resource. |
v1.0 | Intune Deviceconfig Ioshomescreenapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenapp.md | doc_type: resourcePageType # iosHomeScreenApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an icon for an app on the Home Screen |
v1.0 | Intune Deviceconfig Ioshomescreenfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenfolder.md | doc_type: resourcePageType # iosHomeScreenFolder resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A folder containing pages of apps and web clips on the Home Screen. |
v1.0 | Intune Deviceconfig Ioshomescreenfolderpage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenfolderpage.md | doc_type: resourcePageType # iosHomeScreenFolderPage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A page for a folder containing apps and web clips on the Home Screen. ## Properties |
v1.0 | Intune Deviceconfig Ioshomescreenitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenitem.md | doc_type: resourcePageType # iosHomeScreenItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an item on the iOS Home Screen ## Properties |
v1.0 | Intune Deviceconfig Ioshomescreenpage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioshomescreenpage.md | doc_type: resourcePageType # iosHomeScreenPage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A page containing apps, folders, and web clips on the Home Screen. ## Properties |
v1.0 | Intune Deviceconfig Iosikev2vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosikev2vpnconfiguration.md | doc_type: resourcePageType # iosikEv2VpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the iOS device to connect to desired IKEv2 VPN endpoint. |
v1.0 | Intune Deviceconfig Iosimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosimportedpfxcertificateprofile.md | doc_type: resourcePageType # iosImportedPFXCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS PFX Import certificate profile |
v1.0 | Intune Deviceconfig Ioskerberossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioskerberossinglesignonextension.md | doc_type: resourcePageType # iosKerberosSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Kerberos-type Single Sign-On extension profile for iOS devices. |
v1.0 | Intune Deviceconfig Ioskioskmodeapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioskioskmodeapptype.md | doc_type: enumPageType # iosKioskModeAppType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - App source options for iOS kiosk mode. ## Members |
v1.0 | Intune Deviceconfig Iosnetworkusagerule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnetworkusagerule.md | doc_type: resourcePageType # iosNetworkUsageRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Network Usage Rules allow enterprises to specify how managed apps use networks, such as cellular data networks. ## Properties |
v1.0 | Intune Deviceconfig Iosnotificationalerttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnotificationalerttype.md | doc_type: enumPageType # iosNotificationAlertType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Notification Settings Alert Type. ## Members |
v1.0 | Intune Deviceconfig Iosnotificationpreviewvisibility | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnotificationpreviewvisibility.md | doc_type: enumPageType # iosNotificationPreviewVisibility enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Determines when notification previews are visible on an iOS device. Previews can include things like text (from Messages and Mail) and invitation details (from Calendar). When configured, it will override the user's defined preview settings. ## Members |
v1.0 | Intune Deviceconfig Iosnotificationsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosnotificationsettings.md | doc_type: resourcePageType # iosNotificationSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An item describing notification setting. ## Properties |
v1.0 | Intune Deviceconfig Iospkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iospkcscertificateprofile.md | doc_type: resourcePageType # iosPkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS PKCS certificate profile. |
v1.0 | Intune Deviceconfig Iosredirectsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosredirectsinglesignonextension.md | doc_type: resourcePageType # iosRedirectSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Redirect-type Single Sign-On extension profile for iOS devices. |
v1.0 | Intune Deviceconfig Iosscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosscepcertificateprofile.md | doc_type: resourcePageType # iosScepCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS SCEP certificate profile. |
v1.0 | Intune Deviceconfig Iossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iossinglesignonextension.md | doc_type: resourcePageType # iosSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract base class for all iOS-specific single sign-on extension types. |
v1.0 | Intune Deviceconfig Iossinglesignonsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iossinglesignonsettings.md | doc_type: resourcePageType # iosSingleSignOnSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Kerberos authentication settings for single sign-on ## Properties |
v1.0 | Intune Deviceconfig Iossoftwareupdatescheduletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iossoftwareupdatescheduletype.md | doc_type: enumPageType # iosSoftwareUpdateScheduleType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Update schedule type for iOS software updates. ## Members |
v1.0 | Intune Deviceconfig Iostrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iostrustedrootcertificate.md | doc_type: resourcePageType # iosTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS Trusted Root Certificate configuration profile. |
v1.0 | Intune Deviceconfig Iosupdateconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosupdateconfiguration.md | doc_type: resourcePageType # iosUpdateConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - IOS Update Configuration, allows you to configure time window within week to install iOS updates |
v1.0 | Intune Deviceconfig Iosupdatedevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosupdatedevicestatus.md | doc_type: resourcePageType # iosUpdateDeviceStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Iosupdatesinstallstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosupdatesinstallstatus.md | doc_type: enumPageType # iosUpdatesInstallStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Iosvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosvpnconfiguration.md | doc_type: resourcePageType # iosVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the iOS device to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Iosvpnsecurityassociationparameters | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-iosvpnsecurityassociationparameters.md | doc_type: resourcePageType # iosVpnSecurityAssociationParameters resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Security Association Parameters ## Properties |
v1.0 | Intune Deviceconfig Ioswallpaperdisplaylocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswallpaperdisplaylocation.md | doc_type: enumPageType # iosWallpaperDisplayLocation enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum type for wallpaper display location specifier. ## Members |
v1.0 | Intune Deviceconfig Ioswebcontentfilterautofilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswebcontentfilterautofilter.md | doc_type: resourcePageType # iosWebContentFilterAutoFilter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an iOS Web Content Filter setting type, which enables iOS automatic filter feature and allows for additional URL access control. When constructed with no property values, the iOS device will enable the automatic filter regardless. |
v1.0 | Intune Deviceconfig Ioswebcontentfilterbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswebcontentfilterbase.md | doc_type: resourcePageType # iosWebContentFilterBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an iOS Web Content Filter setting base type. An empty and abstract base. Caller should use one of derived types for configurations. ## Properties |
v1.0 | Intune Deviceconfig Ioswebcontentfilterspecificwebsitesaccess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswebcontentfilterspecificwebsitesaccess.md | doc_type: resourcePageType # iosWebContentFilterSpecificWebsitesAccess resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an iOS Web Content Filter setting type, which installs URL bookmarks into iOS built-in browser. An example scenario is in the classroom where teachers would like the students to navigate websites through browser bookmarks configured on their iOS devices, and no access to other sites. |
v1.0 | Intune Deviceconfig Ioswificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ioswificonfiguration.md | doc_type: resourcePageType # iosWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the iOS device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. This profile provides limited and simpler security types than Enterprise Wi-Fi profile. |
v1.0 | Intune Deviceconfig Kerberossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-kerberossinglesignonextension.md | doc_type: resourcePageType # kerberosSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Kerberos-type Single Sign-On extension profile. |
v1.0 | Intune Deviceconfig Keybooleanvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keybooleanvaluepair.md | doc_type: resourcePageType # keyBooleanValuePair resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A key-value pair with a string key and a Boolean value. |
v1.0 | Intune Deviceconfig Keyintegervaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keyintegervaluepair.md | doc_type: resourcePageType # keyIntegerValuePair resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A key-value pair with a string key and an integer value. |
v1.0 | Intune Deviceconfig Keyrealvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keyrealvaluepair.md | doc_type: resourcePageType # keyRealValuePair resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A key-value pair with a string key and a real (floating-point) value. |
v1.0 | Intune Deviceconfig Keystringvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keystringvaluepair.md | doc_type: resourcePageType # keyStringValuePair resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A key-value pair with a string key and a string value. |
v1.0 | Intune Deviceconfig Keytypedvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keytypedvaluepair.md | doc_type: resourcePageType # keyTypedValuePair resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A key-value pair with a string key and a typed value. ## Properties |
v1.0 | Intune Deviceconfig Keyvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-keyvalue.md | doc_type: resourcePageType # keyValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Key Value definition. ## Properties |
v1.0 | Intune Deviceconfig Kioskmodemanagedhomescreenpincomplexity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-kioskmodemanagedhomescreenpincomplexity.md | doc_type: enumPageType # kioskModeManagedHomeScreenPinComplexity enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Complexity of PIN for Managed Home Screen sign-in session. ## Members |
v1.0 | Intune Deviceconfig Kioskmodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-kioskmodetype.md | doc_type: enumPageType # kioskModeType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of Android Kiosk Mode. ## Members |
v1.0 | Intune Deviceconfig Lanmanagerauthenticationlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-lanmanagerauthenticationlevel.md | doc_type: enumPageType # lanManagerAuthenticationLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LanManagerAuthenticationLevel ## Members |
v1.0 | Intune Deviceconfig Licensetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-licensetype.md | doc_type: enumPageType # licenseType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates whether tenant has a valid Intune Endpoint Privilege Management license. Possible value are : 0 - notPaid, 1 - paid, 2 - trial. See LicenseType enum for more details. Default notPaid . ## Members |
v1.0 | Intune Deviceconfig Localsecurityoptionsadministratorelevationpromptbehaviortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsadministratorelevationpromptbehaviortype.md | doc_type: enumPageType # localSecurityOptionsAdministratorElevationPromptBehaviorType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LocalSecurityOptionsAdministratorElevationPromptBehavior ## Members |
v1.0 | Intune Deviceconfig Localsecurityoptionsformatandejectofremovablemediaallowedusertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsformatandejectofremovablemediaallowedusertype.md | doc_type: enumPageType # localSecurityOptionsFormatAndEjectOfRemovableMediaAllowedUserType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LocalSecurityOptionsFormatAndEjectOfRemovableMediaAllowedUser ## Members |
v1.0 | Intune Deviceconfig Localsecurityoptionsinformationdisplayedonlockscreentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsinformationdisplayedonlockscreentype.md | doc_type: enumPageType # localSecurityOptionsInformationDisplayedOnLockScreenType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LocalSecurityOptionsInformationDisplayedOnLockScreen ## Members |
v1.0 | Intune Deviceconfig Localsecurityoptionsinformationshownonlockscreentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsinformationshownonlockscreentype.md | doc_type: enumPageType # localSecurityOptionsInformationShownOnLockScreenType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LocalSecurityOptionsInformationShownOnLockScreenType ## Members |
v1.0 | Intune Deviceconfig Localsecurityoptionsminimumsessionsecurity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsminimumsessionsecurity.md | doc_type: enumPageType # localSecurityOptionsMinimumSessionSecurity enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LocalSecurityOptionsMinimumSessionSecurity ## Members |
v1.0 | Intune Deviceconfig Localsecurityoptionssmartcardremovalbehaviortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionssmartcardremovalbehaviortype.md | doc_type: enumPageType # localSecurityOptionsSmartCardRemovalBehaviorType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LocalSecurityOptionsSmartCardRemovalBehaviorType ## Members |
v1.0 | Intune Deviceconfig Localsecurityoptionsstandarduserelevationpromptbehaviortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-localsecurityoptionsstandarduserelevationpromptbehaviortype.md | doc_type: enumPageType # localSecurityOptionsStandardUserElevationPromptBehaviorType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for LocalSecurityOptionsStandardUserElevationPromptBehavior ## Members |
v1.0 | Intune Deviceconfig Macaddressrandomizationmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macaddressrandomizationmode.md | doc_type: enumPageType # macAddressRandomizationMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum representing the possible values of Android MAC Address Randomization Mode. ## Members |
v1.0 | Intune Deviceconfig Macosappleeventreceiver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosappleeventreceiver.md | doc_type: resourcePageType # macOSAppleEventReceiver resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a process that can receive an Apple Event notification. ## Properties |
v1.0 | Intune Deviceconfig Macosassociateddomainsitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosassociateddomainsitem.md | doc_type: resourcePageType # macOSAssociatedDomainsItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A mapping of application identifiers to associated domains. ## Properties |
v1.0 | Intune Deviceconfig Macosazureadsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosazureadsinglesignonextension.md | doc_type: resourcePageType # macOSAzureAdSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an Azure AD-type Single Sign-On extension profile for macOS devices. |
v1.0 | Intune Deviceconfig Macoscertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscertificateprofilebase.md | doc_type: resourcePageType # macOSCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Mac OS certificate profile. |
v1.0 | Intune Deviceconfig Macoscompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscompliancepolicy.md | doc_type: resourcePageType # macOSCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Mac OS. |
v1.0 | Intune Deviceconfig Macoscontentcachingclientpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingclientpolicy.md | doc_type: enumPageType # macOSContentCachingClientPolicy enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Determines which clients a content cache will serve. ## Members |
v1.0 | Intune Deviceconfig Macoscontentcachingparentselectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingparentselectionpolicy.md | doc_type: enumPageType # macOSContentCachingParentSelectionPolicy enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Determines how content caches select a parent cache. ## Members |
v1.0 | Intune Deviceconfig Macoscontentcachingpeerpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingpeerpolicy.md | doc_type: enumPageType # macOSContentCachingPeerPolicy enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Determines which content caches other content caches will peer with. ## Members |
v1.0 | Intune Deviceconfig Macoscontentcachingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscontentcachingtype.md | doc_type: enumPageType # macOSContentCachingType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of content allowed to be cached by Apple's content caching service. ## Members |
v1.0 | Intune Deviceconfig Macoscredentialsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscredentialsinglesignonextension.md | doc_type: resourcePageType # macOSCredentialSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Credential-type Single Sign-On extension profile for macOS devices. |
v1.0 | Intune Deviceconfig Macoscustomappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscustomappconfiguration.md | doc_type: resourcePageType # macOSCustomAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the macOSCustomAppConfiguration resource. |
v1.0 | Intune Deviceconfig Macoscustomconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoscustomconfiguration.md | doc_type: resourcePageType # macOSCustomConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the macOSCustomConfiguration resource. |
v1.0 | Intune Deviceconfig Macosdevicefeaturesconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosdevicefeaturesconfiguration.md | doc_type: resourcePageType # macOSDeviceFeaturesConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS device features configuration profile. |
v1.0 | Intune Deviceconfig Macosendpointprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosendpointprotectionconfiguration.md | doc_type: resourcePageType # macOSEndpointProtectionConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS endpoint protection configuration profile. |
v1.0 | Intune Deviceconfig Macosenterprisewificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosenterprisewificonfiguration.md | doc_type: resourcePageType # macOSEnterpriseWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS Wi-Fi WPA-Enterprise/WPA2-Enterprise configuration profile. |
v1.0 | Intune Deviceconfig Macosextensionsconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosextensionsconfiguration.md | doc_type: resourcePageType # macOSExtensionsConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS extensions configuration profile. |
v1.0 | Intune Deviceconfig Macosfilevaultrecoverykeytypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosfilevaultrecoverykeytypes.md | doc_type: enumPageType # macOSFileVaultRecoveryKeyTypes enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Recovery key types for macOS FileVault ## Members |
v1.0 | Intune Deviceconfig Macosfirewallapplication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosfirewallapplication.md | doc_type: resourcePageType # macOSFirewallApplication resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an app in the list of macOS firewall applications ## Properties |
v1.0 | Intune Deviceconfig Macosgatekeeperappsources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosgatekeeperappsources.md | doc_type: enumPageType # macOSGatekeeperAppSources enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - App source options for macOS Gatekeeper. ## Members |
v1.0 | Intune Deviceconfig Macosgeneraldeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosgeneraldeviceconfiguration.md | doc_type: resourcePageType # macOSGeneralDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the macOSGeneralDeviceConfiguration resource. |
v1.0 | Intune Deviceconfig Macosimportedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosimportedpfxcertificateprofile.md | doc_type: resourcePageType # macOSImportedPFXCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS PFX Import certificate profile |
v1.0 | Intune Deviceconfig Macoskerberossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoskerberossinglesignonextension.md | doc_type: resourcePageType # macOSKerberosSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Kerberos-type Single Sign-On extension profile for macOS devices. |
v1.0 | Intune Deviceconfig Macoskernelextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoskernelextension.md | doc_type: resourcePageType # macOSKernelExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a specific macOS kernel extension. A macOS kernel extension can be described by its team identifier plus its bundle identifier. ## Properties |
v1.0 | Intune Deviceconfig Macoslaunchitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoslaunchitem.md | doc_type: resourcePageType # macOSLaunchItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an app in the list of macOS launch items ## Properties |
v1.0 | Intune Deviceconfig Macospkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macospkcscertificateprofile.md | doc_type: resourcePageType # macOSPkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS PKCS certificate profile. |
v1.0 | Intune Deviceconfig Macospriority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macospriority.md | doc_type: enumPageType # macOSPriority enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The scheduling priority options for downloading and preparing the requested mac OS update ## Members |
v1.0 | Intune Deviceconfig Macosprivacyaccesscontrolitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosprivacyaccesscontrolitem.md | doc_type: resourcePageType # macOSPrivacyAccessControlItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents per-process privacy preferences. ## Properties |
v1.0 | Intune Deviceconfig Macosprocessidentifiertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosprocessidentifiertype.md | doc_type: enumPageType # macOSProcessIdentifierType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Process identifier types for MacOS Privacy Preferences ## Members |
v1.0 | Intune Deviceconfig Macosredirectsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosredirectsinglesignonextension.md | doc_type: resourcePageType # macOSRedirectSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a Redirect-type Single Sign-On extension profile for macOS devices. |
v1.0 | Intune Deviceconfig Macosscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosscepcertificateprofile.md | doc_type: resourcePageType # macOSScepCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Mac OS SCEP certificate profile. |
v1.0 | Intune Deviceconfig Macossinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossinglesignonextension.md | doc_type: resourcePageType # macOSSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract base class for all macOS-specific single sign-on extension types. |
v1.0 | Intune Deviceconfig Macossoftwareupdateaccountsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdateaccountsummary.md | doc_type: resourcePageType # macOSSoftwareUpdateAccountSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS software update account summary report for a device and user ## Methods |
v1.0 | Intune Deviceconfig Macossoftwareupdatebehavior | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatebehavior.md | doc_type: enumPageType # macOSSoftwareUpdateBehavior enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Update behavior options for macOS software updates. ## Members |
v1.0 | Intune Deviceconfig Macossoftwareupdatecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatecategory.md | doc_type: enumPageType # macOSSoftwareUpdateCategory enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS Software Update Category ## Members |
v1.0 | Intune Deviceconfig Macossoftwareupdatecategorysummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatecategorysummary.md | doc_type: resourcePageType # macOSSoftwareUpdateCategorySummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS software update category summary report for a device and user ## Methods |
v1.0 | Intune Deviceconfig Macossoftwareupdateconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdateconfiguration.md | doc_type: resourcePageType # macOSSoftwareUpdateConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS Software Update Configuration |
v1.0 | Intune Deviceconfig Macossoftwareupdatedelaypolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatedelaypolicy.md | doc_type: enumPageType # macOSSoftwareUpdateDelayPolicy enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Flag enum to determine whether to delay software updates for macOS. ## Members |
v1.0 | Intune Deviceconfig Macossoftwareupdatescheduletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatescheduletype.md | doc_type: enumPageType # macOSSoftwareUpdateScheduleType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Update schedule type for macOS software updates. ## Members |
v1.0 | Intune Deviceconfig Macossoftwareupdatestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatestate.md | doc_type: enumPageType # macOSSoftwareUpdateState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS Software Update State ## Members |
v1.0 | Intune Deviceconfig Macossoftwareupdatestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossoftwareupdatestatesummary.md | doc_type: resourcePageType # macOSSoftwareUpdateStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS software update state summary for a device and user ## Methods |
v1.0 | Intune Deviceconfig Macossystemextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossystemextension.md | doc_type: resourcePageType # macOSSystemExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a specific macOS system extension. ## Properties |
v1.0 | Intune Deviceconfig Macossystemextensiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossystemextensiontype.md | doc_type: enumPageType # macOSSystemExtensionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Flag enum representing the allowed macOS system extension types. ## Members |
v1.0 | Intune Deviceconfig Macossystemextensiontypemapping | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macossystemextensiontypemapping.md | doc_type: resourcePageType # macOSSystemExtensionTypeMapping resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a mapping between team identifiers for macOS system extensions and system extension types. ## Properties |
v1.0 | Intune Deviceconfig Macostrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macostrustedrootcertificate.md | doc_type: resourcePageType # macOSTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OS X Trusted Root Certificate configuration profile. |
v1.0 | Intune Deviceconfig Macosvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macosvpnconfiguration.md | doc_type: resourcePageType # macOSVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Mac device to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Macoswificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoswificonfiguration.md | doc_type: resourcePageType # macOSWiFiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the macOS device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. |
v1.0 | Intune Deviceconfig Macoswirednetworkconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-macoswirednetworkconfiguration.md | doc_type: resourcePageType # macOSWiredNetworkConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MacOS wired network configuration profile. |
v1.0 | Intune Deviceconfig Managedalldevicecertificatestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-managedalldevicecertificatestate.md | doc_type: resourcePageType # managedAllDeviceCertificateState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Manageddevicecertificatestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddevicecertificatestate.md | doc_type: resourcePageType # managedDeviceCertificateState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Manageddeviceencryptionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddeviceencryptionstate.md | doc_type: resourcePageType # managedDeviceEncryptionState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Encryption report per device ## Methods |
v1.0 | Intune Deviceconfig Manageddevicemobileappconfigurationsettingstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddevicemobileappconfigurationsettingstate.md | doc_type: resourcePageType # managedDeviceMobileAppConfigurationSettingState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Managed Device Mobile App Configuration Setting State for a given device. ## Properties |
v1.0 | Intune Deviceconfig Manageddevicereportedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-manageddevicereportedapp.md | doc_type: resourcePageType # managedDeviceReportedApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Application data for reporting ## Properties |
v1.0 | Intune Deviceconfig Managementfeatureflightdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-managementfeatureflightdetail.md | + + Title: "managementFeatureFlightDetail resource type" +description: "Intune Deviceconfig Managementfeatureflightdetail Resources ." ++ms.localizationpriority: medium ++++# managementFeatureFlightDetail resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++++## Properties +|Property|Type|Description| +|:|:|:| +|flightId|String|Flight id/name.| +|flightValue|String|Flight value for the requestor.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.managementFeatureFlightDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.managementFeatureFlightDetail", + "flightId": "String", + "flightValue": "String" +} +``` |
v1.0 | Intune Deviceconfig Managementfeatureprojectdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-managementfeatureprojectdetail.md | + + Title: "managementFeatureProjectDetail resource type" +description: "Intune Deviceconfig Managementfeatureprojectdetail Resources ." ++ms.localizationpriority: medium ++++# managementFeatureProjectDetail resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++++## Properties +|Property|Type|Description| +|:|:|:| +|projectName|String|Flighting V2 project name| +|featureFlights|[managementFeatureFlightDetail](../resources/intune-deviceconfig-managementfeatureflightdetail.md) collection|List containing feature flighting details in the project| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.managementFeatureProjectDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.managementFeatureProjectDetail", + "projectName": "String", + "featureFlights": [ + { + "@odata.type": "microsoft.graph.managementFeatureFlightDetail", + "flightId": "String", + "flightValue": "String" + } + ] +} +``` |
v1.0 | Intune Deviceconfig Mediacontentratingaustralia | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingaustralia.md | doc_type: resourcePageType # mediaContentRatingAustralia resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratingcanada | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingcanada.md | doc_type: resourcePageType # mediaContentRatingCanada resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratingfrance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingfrance.md | doc_type: resourcePageType # mediaContentRatingFrance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratinggermany | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratinggermany.md | doc_type: resourcePageType # mediaContentRatingGermany resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratingireland | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingireland.md | doc_type: resourcePageType # mediaContentRatingIreland resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratingjapan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingjapan.md | doc_type: resourcePageType # mediaContentRatingJapan resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratingnewzealand | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingnewzealand.md | doc_type: resourcePageType # mediaContentRatingNewZealand resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratingunitedkingdom | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingunitedkingdom.md | doc_type: resourcePageType # mediaContentRatingUnitedKingdom resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Mediacontentratingunitedstates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-mediacontentratingunitedstates.md | doc_type: resourcePageType # mediaContentRatingUnitedStates resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Meteredconnectionlimittype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-meteredconnectionlimittype.md | doc_type: enumPageType # meteredConnectionLimitType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Metered Connection Limit Settings. ## Members |
v1.0 | Intune Deviceconfig Microsoftlauncherdockpresence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-microsoftlauncherdockpresence.md | doc_type: enumPageType # microsoftLauncherDockPresence enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Microsoft Launcher Dock Presence selection. ## Members |
v1.0 | Intune Deviceconfig Microsoftlaunchersearchbarplacement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-microsoftlaunchersearchbarplacement.md | doc_type: enumPageType # microsoftLauncherSearchBarPlacement enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Microsoft Launcher Search Bar Placement selection. ## Members |
v1.0 | Intune Deviceconfig Miracastchannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-miracastchannel.md | doc_type: enumPageType # miracastChannel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for Miracast channel. ## Members |
v1.0 | Intune Deviceconfig Ndesconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ndesconnector.md | doc_type: resourcePageType # ndesConnector resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity which represents an OnPrem Ndes connector. ## Methods |
v1.0 | Intune Deviceconfig Ndesconnectorstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ndesconnectorstate.md | doc_type: enumPageType # ndesConnectorState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The current status of the Ndes Connector. ## Members |
v1.0 | Intune Deviceconfig Networksinglesignontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-networksinglesignontype.md | doc_type: enumPageType # networkSingleSignOnType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wi-Fi Network Single Sign On Type Settings. ## Members |
v1.0 | Intune Deviceconfig Noneapauthenticationmethodforeapttlstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-noneapauthenticationmethodforeapttlstype.md | doc_type: enumPageType # nonEapAuthenticationMethodForEapTtlsType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Non-EAP methods for authentication. ## Members |
v1.0 | Intune Deviceconfig Noneapauthenticationmethodforpeap | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-noneapauthenticationmethodforpeap.md | doc_type: enumPageType # nonEapAuthenticationMethodForPeap enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Non-EAP methods for authentication when PEAP is the selected EAP type. ## Members |
v1.0 | Intune Deviceconfig Numberrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-numberrange.md | doc_type: resourcePageType # numberRange resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Number Range definition. ## Properties |
v1.0 | Intune Deviceconfig Omasetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasetting.md | doc_type: resourcePageType # omaSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings definition. ## Properties |
v1.0 | Intune Deviceconfig Omasettingbase64 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingbase64.md | doc_type: resourcePageType # omaSettingBase64 resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings Base64 definition. |
v1.0 | Intune Deviceconfig Omasettingboolean | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingboolean.md | doc_type: resourcePageType # omaSettingBoolean resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings Boolean definition. |
v1.0 | Intune Deviceconfig Omasettingdatetime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingdatetime.md | doc_type: resourcePageType # omaSettingDateTime resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings DateTime definition. |
v1.0 | Intune Deviceconfig Omasettingfloatingpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingfloatingpoint.md | doc_type: resourcePageType # omaSettingFloatingPoint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings Floating Point definition. |
v1.0 | Intune Deviceconfig Omasettinginteger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettinginteger.md | doc_type: resourcePageType # omaSettingInteger resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings Integer definition. |
v1.0 | Intune Deviceconfig Omasettingstring | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingstring.md | doc_type: resourcePageType # omaSettingString resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings String definition. |
v1.0 | Intune Deviceconfig Omasettingstringxml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-omasettingstringxml.md | doc_type: resourcePageType # omaSettingStringXml resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - OMA Settings StringXML definition. |
v1.0 | Intune Deviceconfig Operatingsystemversionrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-operatingsystemversionrange.md | doc_type: resourcePageType # operatingSystemVersionRange resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Operating System version range. ## Properties |
v1.0 | Intune Deviceconfig Operator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-operator.md | doc_type: enumPageType # operator enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Operator for rules. ## Members |
v1.0 | Intune Deviceconfig Perfectforwardsecrecygroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-perfectforwardsecrecygroup.md | doc_type: enumPageType # perfectForwardSecrecyGroup enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Forward Secrecy Group values for Windows10 VPN policies with IKEv2 connection type. ## Members |
v1.0 | Intune Deviceconfig Personalprofilepersonalplaystoremode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-personalprofilepersonalplaystoremode.md | doc_type: enumPageType # personalProfilePersonalPlayStoreMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Used together with personalApplications to control how apps in the personal profile are allowed or blocked. ## Members |
v1.0 | Intune Deviceconfig Policyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-policyplatformtype.md | doc_type: enumPageType # policyPlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types for policies. ## Members Supported platform types for policies. |androidWorkProfile|7|AndroidWorkProfile.| |windows10XProfile|8|Windows10XProfile.| |androidAOSP|9|AndroidAOSPProfile.|+|linux|10|Linux.| |all|100|All platforms.| |
v1.0 | Intune Deviceconfig Poweractiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-poweractiontype.md | doc_type: enumPageType # powerActionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Power action types ## Members |
v1.0 | Intune Deviceconfig Prereleasefeatures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-prereleasefeatures.md | doc_type: enumPageType # prereleaseFeatures enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for pre-release features. ## Members |
v1.0 | Intune Deviceconfig Ratingappstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingappstype.md | doc_type: enumPageType # ratingAppsType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Apps rating as in media content ## Members |
v1.0 | Intune Deviceconfig Ratingaustraliamoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingaustraliamoviestype.md | doc_type: enumPageType # ratingAustraliaMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in Australia ## Members |
v1.0 | Intune Deviceconfig Ratingaustraliatelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingaustraliatelevisiontype.md | doc_type: enumPageType # ratingAustraliaTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in Australia ## Members |
v1.0 | Intune Deviceconfig Ratingcanadamoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingcanadamoviestype.md | doc_type: enumPageType # ratingCanadaMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in Canada ## Members |
v1.0 | Intune Deviceconfig Ratingcanadatelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingcanadatelevisiontype.md | doc_type: enumPageType # ratingCanadaTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in Canada ## Members |
v1.0 | Intune Deviceconfig Ratingfrancemoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingfrancemoviestype.md | doc_type: enumPageType # ratingFranceMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in France ## Members |
v1.0 | Intune Deviceconfig Ratingfrancetelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingfrancetelevisiontype.md | doc_type: enumPageType # ratingFranceTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in France ## Members |
v1.0 | Intune Deviceconfig Ratinggermanymoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratinggermanymoviestype.md | doc_type: enumPageType # ratingGermanyMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in Germany ## Members |
v1.0 | Intune Deviceconfig Ratinggermanytelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratinggermanytelevisiontype.md | doc_type: enumPageType # ratingGermanyTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in Germany ## Members |
v1.0 | Intune Deviceconfig Ratingirelandmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingirelandmoviestype.md | doc_type: enumPageType # ratingIrelandMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in Ireland ## Members |
v1.0 | Intune Deviceconfig Ratingirelandtelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingirelandtelevisiontype.md | doc_type: enumPageType # ratingIrelandTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in Ireland ## Members |
v1.0 | Intune Deviceconfig Ratingjapanmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingjapanmoviestype.md | doc_type: enumPageType # ratingJapanMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in Japan ## Members |
v1.0 | Intune Deviceconfig Ratingjapantelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingjapantelevisiontype.md | doc_type: enumPageType # ratingJapanTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in Japan ## Members |
v1.0 | Intune Deviceconfig Ratingnewzealandmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingnewzealandmoviestype.md | doc_type: enumPageType # ratingNewZealandMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in New Zealand ## Members |
v1.0 | Intune Deviceconfig Ratingnewzealandtelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingnewzealandtelevisiontype.md | doc_type: enumPageType # ratingNewZealandTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in New Zealand ## Members |
v1.0 | Intune Deviceconfig Ratingunitedkingdommoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedkingdommoviestype.md | doc_type: enumPageType # ratingUnitedKingdomMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in United Kingdom ## Members |
v1.0 | Intune Deviceconfig Ratingunitedkingdomtelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedkingdomtelevisiontype.md | doc_type: enumPageType # ratingUnitedKingdomTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in United Kingdom ## Members |
v1.0 | Intune Deviceconfig Ratingunitedstatesmoviestype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedstatesmoviestype.md | doc_type: enumPageType # ratingUnitedStatesMoviesType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Movies rating labels in United States ## Members |
v1.0 | Intune Deviceconfig Ratingunitedstatestelevisiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-ratingunitedstatestelevisiontype.md | doc_type: enumPageType # ratingUnitedStatesTelevisionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - TV content rating labels in United States ## Members |
v1.0 | Intune Deviceconfig Redirectsinglesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-redirectsinglesignonextension.md | doc_type: resourcePageType # redirectSingleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an Apple Single Sign-On Extension. |
v1.0 | Intune Deviceconfig Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-report.md | doc_type: resourcePageType # report resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Configuration profile History reports. ## Properties |
v1.0 | Intune Deviceconfig Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-reportroot.md | doc_type: resourcePageType # reportRoot resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The resource that represents an instance of History Reports. ## Methods |
v1.0 | Intune Deviceconfig Requiredpasswordtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-requiredpasswordtype.md | doc_type: enumPageType # requiredPasswordType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of required passwords. ## Members |
v1.0 | Intune Deviceconfig Restrictedappsstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-restrictedappsstate.md | doc_type: enumPageType # restrictedAppsState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Restricted apps state ## Members |
v1.0 | Intune Deviceconfig Restrictedappsviolation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-restrictedappsviolation.md | doc_type: resourcePageType # restrictedAppsViolation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Violation of restricted apps configuration profile per device per user ## Methods Violation of restricted apps configuration profile per device per user |deviceName|String|Device name| |deviceConfigurationId|String|Device configuration profile unique identifier, must be Guid| |deviceConfigurationName|String|Device configuration profile name|-|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Platform type. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `all`.| +|platformType|[policyPlatformType](../resources/intune-deviceconfig-policyplatformtype.md)|Platform type. Possible values are: `android`, `androidForWork`, `iOS`, `macOS`, `windowsPhone81`, `windows81AndLater`, `windows10AndLater`, `androidWorkProfile`, `windows10XProfile`, `androidAOSP`, `linux`, `all`.| |restrictedAppsState|[restrictedAppsState](../resources/intune-deviceconfig-restrictedappsstate.md)|Restricted apps state. Possible values are: `prohibitedApps`, `notApprovedApps`.| |restrictedApps|[managedDeviceReportedApp](../resources/intune-deviceconfig-manageddevicereportedapp.md) collection|List of violated restricted apps| |
v1.0 | Intune Deviceconfig Retirescheduledmanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-retirescheduledmanageddevice.md | doc_type: resourcePageType # retireScheduledManagedDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ManagedDevices that are scheduled for retire ## Properties |
v1.0 | Intune Deviceconfig Safesearchfiltertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-safesearchfiltertype.md | doc_type: enumPageType # safeSearchFilterType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specifies what level of safe search (filtering adult content) is required ## Members |
v1.0 | Intune Deviceconfig Scheduledretirestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-scheduledretirestate.md | doc_type: enumPageType # scheduledRetireState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Cancel or confirm scheduled retire ## Members |
v1.0 | Intune Deviceconfig Secureassessmentaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-secureassessmentaccounttype.md | doc_type: enumPageType # secureAssessmentAccountType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of accounts that are allowed for Windows10SecureAssessment ConfigurationAccount. ## Members |
v1.0 | Intune Deviceconfig Securebootwithdmatype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-securebootwithdmatype.md | doc_type: enumPageType # secureBootWithDMAType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of Secure Boot with DMA ## Members |
v1.0 | Intune Deviceconfig Servicestarttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-servicestarttype.md | doc_type: enumPageType # serviceStartType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values of xbox service start type ## Members |
v1.0 | Intune Deviceconfig Settingsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-settingsource.md | doc_type: resourcePageType # settingSource resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Settingstatedevicesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-settingstatedevicesummary.md | doc_type: resourcePageType # settingStateDeviceSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Compilance Policy and Configuration for a Setting State summary ## Methods |
v1.0 | Intune Deviceconfig Sharedpcaccountdeletionpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcaccountdeletionpolicytype.md | doc_type: enumPageType # sharedPCAccountDeletionPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for when accounts are deleted on a shared PC. ## Members |
v1.0 | Intune Deviceconfig Sharedpcaccountmanagerpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcaccountmanagerpolicy.md | doc_type: resourcePageType # sharedPCAccountManagerPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - SharedPC Account Manager Policy. Only applies when the account manager is enabled. ## Properties |
v1.0 | Intune Deviceconfig Sharedpcallowedaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcallowedaccounttype.md | doc_type: enumPageType # sharedPCAllowedAccountType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of accounts that are allowed to share the PC. ## Members |
v1.0 | Intune Deviceconfig Sharedpcconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sharedpcconfiguration.md | doc_type: resourcePageType # sharedPCConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the sharedPCConfiguration resource. |
v1.0 | Intune Deviceconfig Signinassistantoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-signinassistantoptions.md | doc_type: enumPageType # signInAssistantOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Values for the SignInAssistantSettings. ## Members |
v1.0 | Intune Deviceconfig Singlesignonextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-singlesignonextension.md | doc_type: resourcePageType # singleSignOnExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an Apple Single Sign-On Extension. ## Properties |
v1.0 | Intune Deviceconfig Sitesecuritylevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-sitesecuritylevel.md | doc_type: enumPageType # siteSecurityLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for site security level. ## Members |
v1.0 | Intune Deviceconfig Softwareupdatestatussummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-softwareupdatestatussummary.md | doc_type: resourcePageType # softwareUpdateStatusSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Specifiedcaptivenetworkplugins | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-specifiedcaptivenetworkplugins.md | doc_type: resourcePageType # specifiedCaptiveNetworkPlugins resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specifies all the Captive network plugins allowed during the IKEv2 AlwaysOn VPN connection ## Properties |
v1.0 | Intune Deviceconfig Statemanagementsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-statemanagementsetting.md | doc_type: enumPageType # stateManagementSetting enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - State Management Setting. ## Members |
v1.0 | Intune Deviceconfig Subjectnameformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-subjectnameformat.md | doc_type: enumPageType # subjectNameFormat enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Subject Name Format Options. ## Members |
v1.0 | Intune Deviceconfig Unsupporteddeviceconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-unsupporteddeviceconfiguration.md | doc_type: resourcePageType # unsupportedDeviceConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - UnsupportedDeviceConfiguration is used when an entity cannot be mapped to another model-compliant subtype of deviceConfiguration. |
v1.0 | Intune Deviceconfig Unsupporteddeviceconfigurationdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-unsupporteddeviceconfigurationdetail.md | doc_type: resourcePageType # unsupportedDeviceConfigurationDetail resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A description of why an entity is unsupported. ## Properties |
v1.0 | Intune Deviceconfig Updateclassification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-updateclassification.md | doc_type: enumPageType # updateClassification enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for automatic update classification. ## Members |
v1.0 | Intune Deviceconfig Useremailsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-useremailsource.md | doc_type: enumPageType # userEmailSource enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for username source or email source. ## Members |
v1.0 | Intune Deviceconfig Usernamesource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-usernamesource.md | doc_type: enumPageType # usernameSource enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Username source. ## Members |
v1.0 | Intune Deviceconfig Visibilitysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-visibilitysetting.md | doc_type: enumPageType # visibilitySetting enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Generic visibility state. ## Members |
v1.0 | Intune Deviceconfig Vpnauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnauthenticationmethod.md | doc_type: enumPageType # vpnAuthenticationMethod enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Authentication Method. ## Members |
v1.0 | Intune Deviceconfig Vpnclientauthenticationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnclientauthenticationtype.md | doc_type: enumPageType # vpnClientAuthenticationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of VPN client authentication type ## Members |
v1.0 | Intune Deviceconfig Vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnconfiguration.md | doc_type: resourcePageType # vpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base VPN Configuration profile. |
v1.0 | Intune Deviceconfig Vpndeadpeerdetectionrate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpndeadpeerdetectionrate.md | doc_type: enumPageType # vpnDeadPeerDetectionRate enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Determines how often to check if a peer connection is still alive ## Members |
v1.0 | Intune Deviceconfig Vpndnsrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpndnsrule.md | doc_type: resourcePageType # vpnDnsRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN DNS Rule definition. ## Properties |
v1.0 | Intune Deviceconfig Vpnencryptionalgorithmtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnencryptionalgorithmtype.md | doc_type: enumPageType # vpnEncryptionAlgorithmType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of VPN security association encryption algorithm ## Members |
v1.0 | Intune Deviceconfig Vpnintegrityalgorithmtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnintegrityalgorithmtype.md | doc_type: enumPageType # vpnIntegrityAlgorithmType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of VPN security association integrity algorithm ## Members |
v1.0 | Intune Deviceconfig Vpnlocalidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnlocalidentifier.md | doc_type: enumPageType # vpnLocalIdentifier enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of VPN local identifier ## Members |
v1.0 | Intune Deviceconfig Vpnondemandrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandrule.md | doc_type: resourcePageType # vpnOnDemandRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN On-Demand Rule definition. ## Properties |
v1.0 | Intune Deviceconfig Vpnondemandruleconnectionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandruleconnectionaction.md | doc_type: enumPageType # vpnOnDemandRuleConnectionAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN On-Demand Rule Connection Action. ## Members |
v1.0 | Intune Deviceconfig Vpnondemandruleconnectiondomainaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandruleconnectiondomainaction.md | doc_type: enumPageType # vpnOnDemandRuleConnectionDomainAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN On-Demand Rule Connection Domain Action. ## Members |
v1.0 | Intune Deviceconfig Vpnondemandruleinterfacetypematch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnondemandruleinterfacetypematch.md | doc_type: enumPageType # vpnOnDemandRuleInterfaceTypeMatch enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN On-Demand Rule Connection network interface type. ## Members |
v1.0 | Intune Deviceconfig Vpnprovidertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnprovidertype.md | doc_type: enumPageType # vpnProviderType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Provider type for per-app VPN. ## Members |
v1.0 | Intune Deviceconfig Vpnproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnproxyserver.md | doc_type: resourcePageType # vpnProxyServer resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Proxy Server. ## Properties |
v1.0 | Intune Deviceconfig Vpnroute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnroute.md | doc_type: resourcePageType # vpnRoute resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Route definition. ## Properties |
v1.0 | Intune Deviceconfig Vpnserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnserver.md | doc_type: resourcePageType # vpnServer resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Server definition. ## Properties |
v1.0 | Intune Deviceconfig Vpnservercertificatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnservercertificatetype.md | doc_type: enumPageType # vpnServerCertificateType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of certificate the VPN server will present to the VPN client for authentication ## Members |
v1.0 | Intune Deviceconfig Vpnserviceexceptionaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpnserviceexceptionaction.md | doc_type: enumPageType # vpnServiceExceptionAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The VPN action to take for a specific service. ## Members |
v1.0 | Intune Deviceconfig Vpntrafficdirection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficdirection.md | doc_type: enumPageType # vpnTrafficDirection enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specify whether the rule applies to inbound traffic or outbound traffic. ## Members |
v1.0 | Intune Deviceconfig Vpntrafficrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficrule.md | doc_type: resourcePageType # vpnTrafficRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Traffic Rule definition. ## Properties |
v1.0 | Intune Deviceconfig Vpntrafficruleapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficruleapptype.md | doc_type: enumPageType # vpnTrafficRuleAppType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of app that a VPN traffic rule is associated with. ## Members |
v1.0 | Intune Deviceconfig Vpntrafficruleroutingpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntrafficruleroutingpolicytype.md | doc_type: enumPageType # vpnTrafficRuleRoutingPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specifies the routing policy for a VPN traffic rule. ## Members |
v1.0 | Intune Deviceconfig Vpntunnelconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-vpntunnelconfigurationtype.md | doc_type: enumPageType # vpnTunnelConfigurationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of tunnels that will be present to the VPN client for configuration ## Members |
v1.0 | Intune Deviceconfig Webbrowsercookiesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-webbrowsercookiesettings.md | doc_type: enumPageType # webBrowserCookieSettings enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Web Browser Cookie Settings. ## Members |
v1.0 | Intune Deviceconfig Weeklyschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-weeklyschedule.md | doc_type: enumPageType # weeklySchedule enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for a weekly schedule. ## Members |
v1.0 | Intune Deviceconfig Welcomescreenmeetinginformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-welcomescreenmeetinginformation.md | doc_type: enumPageType # welcomeScreenMeetingInformation enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for welcome screen meeting information. ## Members |
v1.0 | Intune Deviceconfig Wifiauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifiauthenticationmethod.md | doc_type: enumPageType # wiFiAuthenticationMethod enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wi-Fi authentication method. ## Members |
v1.0 | Intune Deviceconfig Wifiauthenticationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifiauthenticationtype.md | doc_type: enumPageType # wifiAuthenticationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wi-Fi Authentication Type Settings. ## Members |
v1.0 | Intune Deviceconfig Wifiproxysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifiproxysetting.md | doc_type: enumPageType # wiFiProxySetting enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wi-Fi Proxy Settings. ## Members |Member|Value|Description| |:|:|:|-|none|0|No Proxy.| -|manual|1|Manual Proxy Settings via Address and Port.| -|automatic|2|Automatic Proxy Settings via URL.| -|unknownFutureValue|3|Unknown future value for evolvable enum patterns.| +|none|0|Default. Indicates Wi-Fi Proxy is not set.| +|manual|1|Indicates Wi-Fi Proxy is set by manually specifying an address and port as well as an optional list of hostnames that are exculded. This value is not supported for AndroidWorkProfileWiFiConfigurations.| +|automatic|2|Indicates Wi-Fi Proxy is set automatically by providing the URL to a PAC (Proxy Auto Configuration) file which contains a list of proxy servers to use.| +|unknownFutureValue|3|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfig Wifisecuritytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wifisecuritytype.md | doc_type: enumPageType # wiFiSecurityType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wi-Fi Security Types. ## Members |
v1.0 | Intune Deviceconfig Windows10appsforceupdateschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10appsforceupdateschedule.md | doc_type: resourcePageType # windows10AppsForceUpdateSchedule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 force update schedule for Apps ## Properties |
v1.0 | Intune Deviceconfig Windows10appsupdaterecurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10appsupdaterecurrence.md | doc_type: enumPageType # windows10AppsUpdateRecurrence enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for App update on Windows10 recurrence. ## Members |
v1.0 | Intune Deviceconfig Windows10apptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10apptype.md | doc_type: enumPageType # windows10AppType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Application type. ## Members |
v1.0 | Intune Deviceconfig Windows10associatedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10associatedapps.md | doc_type: resourcePageType # windows10AssociatedApps resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Associated Application definition. ## Properties |
v1.0 | Intune Deviceconfig Windows10certificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10certificateprofilebase.md | doc_type: resourcePageType # windows10CertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base class for Windows 10 certificate profile. |
v1.0 | Intune Deviceconfig Windows10compliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10compliancepolicy.md | doc_type: resourcePageType # windows10CompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Windows 10. Inherits from [deviceCompliancePolicy](../resources/intune-shared-devicecomplian |configurationManagerComplianceRequired|Boolean|Require to consider SCCM Compliance state into consideration for Intune Compliance State.| |tpmRequired|Boolean|Require Trusted Platform Module(TPM) to be present.| |deviceCompliancePolicyScript|[deviceCompliancePolicyScript](../resources/intune-deviceconfig-devicecompliancepolicyscript.md)||+|wslDistributions|[wslDistributionConfiguration](../resources/intune-deviceconfig-wsldistributionconfiguration.md) collection|| ## Relationships |Relationship|Type|Description| Here is a JSON representation of the resource. "@odata.type": "microsoft.graph.deviceCompliancePolicyScript", "deviceComplianceScriptId": "String", "rulesContent": "binary"- } + }, + "wslDistributions": [ + { + "@odata.type": "microsoft.graph.wslDistributionConfiguration", + "distribution": "String", + "minimumOSVersion": "String", + "maximumOSVersion": "String" + } + ] } ``` |
v1.0 | Intune Deviceconfig Windows10customconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10customconfiguration.md | doc_type: resourcePageType # windows10CustomConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the windows10CustomConfiguration resource. |
v1.0 | Intune Deviceconfig Windows10devicefirmwareconfigurationinterface | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10devicefirmwareconfigurationinterface.md | doc_type: resourcePageType # windows10DeviceFirmwareConfigurationInterface resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Graph properties for Device Firmware Configuration Interface |
v1.0 | Intune Deviceconfig Windows10devicemodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10devicemodetype.md | doc_type: enumPageType # windows10DeviceModeType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Device Mode type. ## Members |
v1.0 | Intune Deviceconfig Windows10easemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10easemailprofileconfiguration.md | doc_type: resourcePageType # windows10EasEmailProfileConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the native email client (Outlook) on Windows 10 devices to communicate with an Exchange server and get email, contacts, calendar, and tasks. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Windows10editiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10editiontype.md | doc_type: enumPageType # windows10EditionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Edition type. ## Members |
v1.0 | Intune Deviceconfig Windows10endpointprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10endpointprotectionconfiguration.md | doc_type: resourcePageType # windows10EndpointProtectionConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the Windows10EndpointProtectionConfiguration resource. |
v1.0 | Intune Deviceconfig Windows10enterprisemodernappmanagementconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10enterprisemodernappmanagementconfiguration.md | doc_type: resourcePageType # windows10EnterpriseModernAppManagementConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows10 Enterprise Modern App Management Configuration. |
v1.0 | Intune Deviceconfig Windows10generalconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10generalconfiguration.md | doc_type: resourcePageType # windows10GeneralConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the windows10GeneralConfiguration resource. |
v1.0 | Intune Deviceconfig Windows10importedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10importedpfxcertificateprofile.md | doc_type: resourcePageType # windows10ImportedPFXCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Desktop and Mobile PFX Import certificate profile |
v1.0 | Intune Deviceconfig Windows10mobilecompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10mobilecompliancepolicy.md | doc_type: resourcePageType # windows10MobileCompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Windows 10 Mobile. |
v1.0 | Intune Deviceconfig Windows10networkboundaryconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10networkboundaryconfiguration.md | doc_type: resourcePageType # windows10NetworkBoundaryConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows10 Network Boundary Configuration |
v1.0 | Intune Deviceconfig Windows10networkproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10networkproxyserver.md | doc_type: resourcePageType # windows10NetworkProxyServer resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Network Proxy Server Policy. ## Properties |
v1.0 | Intune Deviceconfig Windows10pfximportcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10pfximportcertificateprofile.md | doc_type: resourcePageType # windows10PFXImportCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Deprecated |
v1.0 | Intune Deviceconfig Windows10pkcscertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10pkcscertificateprofile.md | doc_type: resourcePageType # windows10PkcsCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Desktop and Mobile PKCS certificate profile |
v1.0 | Intune Deviceconfig Windows10secureassessmentconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10secureassessmentconfiguration.md | doc_type: resourcePageType # windows10SecureAssessmentConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the secureAssessment resource. |
v1.0 | Intune Deviceconfig Windows10teamgeneralconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10teamgeneralconfiguration.md | doc_type: resourcePageType # windows10TeamGeneralConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the windows10TeamGeneralConfiguration resource. |
v1.0 | Intune Deviceconfig Windows10vpnauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnauthenticationmethod.md | doc_type: enumPageType # windows10VpnAuthenticationMethod enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 VPN connection types. ## Members |
v1.0 | Intune Deviceconfig Windows10vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnconfiguration.md | doc_type: resourcePageType # windows10VpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Windows 10 device (desktop or mobile) to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Windows10vpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnconnectiontype.md | doc_type: enumPageType # windows10VpnConnectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN connection types. ## Members |
v1.0 | Intune Deviceconfig Windows10vpnprofiletarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnprofiletarget.md | doc_type: enumPageType # windows10VpnProfileTarget enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 VPN profile target types. ## Members |
v1.0 | Intune Deviceconfig Windows10vpnproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows10vpnproxyserver.md | doc_type: resourcePageType # windows10VpnProxyServer resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Proxy Server. |
v1.0 | Intune Deviceconfig Windows81certificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81certificateprofilebase.md | doc_type: resourcePageType # windows81CertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Configuration. |
v1.0 | Intune Deviceconfig Windows81compliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81compliancepolicy.md | doc_type: resourcePageType # windows81CompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Windows 8.1. |
v1.0 | Intune Deviceconfig Windows81generalconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81generalconfiguration.md | doc_type: resourcePageType # windows81GeneralConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the windows81GeneralConfiguration resource. |
v1.0 | Intune Deviceconfig Windows81scepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81scepcertificateprofile.md | doc_type: resourcePageType # windows81SCEPCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 8.1+ SCEP certificate profile |
v1.0 | Intune Deviceconfig Windows81trustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81trustedrootcertificate.md | doc_type: resourcePageType # windows81TrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 8.1 Trusted Certificate configuration profile |
v1.0 | Intune Deviceconfig Windows81vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81vpnconfiguration.md | doc_type: resourcePageType # windows81VpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Windows 8.1 (and later) devices to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Windows81vpnproxyserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81vpnproxyserver.md | doc_type: resourcePageType # windows81VpnProxyServer resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - VPN Proxy Server. |
v1.0 | Intune Deviceconfig Windows81wifiimportconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windows81wifiimportconfiguration.md | doc_type: resourcePageType # windows81WifiImportConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 8.1+ Wi-Fi import configuration. By configuring this profile you can instruct Windows 8.1 (and later) devices to connect to desired Wi-Fi endpoint. Connect a Windows 8.1 device to the desired Wi-Fi network and extract the XML from that device to later embed into this Wi-Fi profile. |
v1.0 | Intune Deviceconfig Windowsappstartlayouttilesize | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsappstartlayouttilesize.md | doc_type: enumPageType # windowsAppStartLayoutTileSize enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The tile size of Windows app in the start layout. ## Members |
v1.0 | Intune Deviceconfig Windowscertificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowscertificateprofilebase.md | doc_type: resourcePageType # windowsCertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Configuration. |
v1.0 | Intune Deviceconfig Windowsdefenderadvancedthreatprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdefenderadvancedthreatprotectionconfiguration.md | doc_type: resourcePageType # windowsDefenderAdvancedThreatProtectionConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Defender AdvancedThreatProtection Configuration. |
v1.0 | Intune Deviceconfig Windowsdefendertamperprotectionoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdefendertamperprotectionoptions.md | doc_type: enumPageType # windowsDefenderTamperProtectionOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Defender TamperProtection setting options ## Members |
v1.0 | Intune Deviceconfig Windowsdeliveryoptimizationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdeliveryoptimizationconfiguration.md | doc_type: resourcePageType # windowsDeliveryOptimizationConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Delivery Optimization configuration |
v1.0 | Intune Deviceconfig Windowsdeliveryoptimizationmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdeliveryoptimizationmode.md | doc_type: enumPageType # windowsDeliveryOptimizationMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Delivery optimization mode for peer distribution ## Members |
v1.0 | Intune Deviceconfig Windowsdomainjoinconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsdomainjoinconfiguration.md | doc_type: resourcePageType # windowsDomainJoinConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Domain Join device configuration. |
v1.0 | Intune Deviceconfig Windowsedgekiosktype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsedgekiosktype.md | doc_type: enumPageType # windowsEdgeKioskType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Edge kiosk type ## Members |
v1.0 | Intune Deviceconfig Windowsfirewallnetworkprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallnetworkprofile.md | doc_type: resourcePageType # windowsFirewallNetworkProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Firewall Profile Policies. ## Properties |
v1.0 | Intune Deviceconfig Windowsfirewallrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallrule.md | doc_type: resourcePageType # windowsFirewallRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A rule controlling traffic through the Windows Firewall. ## Properties |
v1.0 | Intune Deviceconfig Windowsfirewallruleinterfacetypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallruleinterfacetypes.md | doc_type: enumPageType # windowsFirewallRuleInterfaceTypes enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Flags representing firewall rule interface types. ## Members |
v1.0 | Intune Deviceconfig Windowsfirewallrulenetworkprofiletypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallrulenetworkprofiletypes.md | doc_type: enumPageType # windowsFirewallRuleNetworkProfileTypes enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Flags representing which network profile types apply to a firewall rule. ## Members |
v1.0 | Intune Deviceconfig Windowsfirewallruletrafficdirectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsfirewallruletrafficdirectiontype.md | doc_type: enumPageType # windowsFirewallRuleTrafficDirectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Firewall rule traffic directions. ## Members |
v1.0 | Intune Deviceconfig Windowshealthmonitoringconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowshealthmonitoringconfiguration.md | doc_type: resourcePageType # windowsHealthMonitoringConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows device health monitoring configuration |
v1.0 | Intune Deviceconfig Windowshealthmonitoringscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowshealthmonitoringscope.md | doc_type: enumPageType # windowsHealthMonitoringScope enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device health monitoring scope ## Members |
v1.0 | Intune Deviceconfig Windowsidentityprotectionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsidentityprotectionconfiguration.md | doc_type: resourcePageType # windowsIdentityProtectionConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity provides descriptions of the declared methods, properties and relationships exposed by Windows Hello for Business. |
v1.0 | Intune Deviceconfig Windowskioskactivedirectorygroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskactivedirectorygroup.md | doc_type: resourcePageType # windowsKioskActiveDirectoryGroup resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify an Azure Directory group for the kiosk configuration |
v1.0 | Intune Deviceconfig Windowskioskappbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskappbase.md | doc_type: resourcePageType # windowsKioskAppBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The base class for a type of apps ## Properties |
v1.0 | Intune Deviceconfig Windowskioskappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskappconfiguration.md | doc_type: resourcePageType # windowsKioskAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The app base class used to identify the application info for the kiosk configuration ## Properties |
v1.0 | Intune Deviceconfig Windowskioskapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskapptype.md | doc_type: enumPageType # windowsKioskAppType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of Windows kiosk app. ## Members |
v1.0 | Intune Deviceconfig Windowskioskautologon | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskautologon.md | doc_type: resourcePageType # windowsKioskAutologon resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify an autologon kiosk configuration |
v1.0 | Intune Deviceconfig Windowskioskazureadgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskazureadgroup.md | doc_type: resourcePageType # windowsKioskAzureADGroup resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify an AzureAD group for the kiosk configuration |
v1.0 | Intune Deviceconfig Windowskioskazureaduser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskazureaduser.md | doc_type: resourcePageType # windowsKioskAzureADUser resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify an AzureAD user account for the kiosk configuration |
v1.0 | Intune Deviceconfig Windowskioskconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskconfiguration.md | doc_type: resourcePageType # windowsKioskConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity provides descriptions of the declared methods, properties and relationships exposed by the kiosk resource. |
v1.0 | Intune Deviceconfig Windowskioskdesktopapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskdesktopapp.md | doc_type: resourcePageType # windowsKioskDesktopApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The base class for a type of apps |
v1.0 | Intune Deviceconfig Windowskioskforceupdateschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskforceupdateschedule.md | doc_type: resourcePageType # windowsKioskForceUpdateSchedule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 force update schedule for Kiosk devices. ## Properties |
v1.0 | Intune Deviceconfig Windowskiosklocalgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosklocalgroup.md | doc_type: resourcePageType # windowsKioskLocalGroup resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify a local group for the kiosk configuration |
v1.0 | Intune Deviceconfig Windowskiosklocaluser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosklocaluser.md | doc_type: resourcePageType # windowsKioskLocalUser resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify a local account for the kiosk configuration |
v1.0 | Intune Deviceconfig Windowskioskmultipleapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskmultipleapps.md | doc_type: resourcePageType # windowsKioskMultipleApps resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify the MultiMode app configuration for the kiosk configuration |
v1.0 | Intune Deviceconfig Windowskioskprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskprofile.md | doc_type: resourcePageType # windowsKioskProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Windowskiosksingleuwpapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosksingleuwpapp.md | doc_type: resourcePageType # windowsKioskSingleUWPApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify the UWP app info for the kiosk configuration |
v1.0 | Intune Deviceconfig Windowskiosksinglewin32app | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskiosksinglewin32app.md | doc_type: resourcePageType # windowsKioskSingleWin32App resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify the single app configuration for the kiosk win32 configuration |
v1.0 | Intune Deviceconfig Windowskioskuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskuser.md | doc_type: resourcePageType # windowsKioskUser resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user base class used to identify the account info for the kiosk configuration ## Properties |
v1.0 | Intune Deviceconfig Windowskioskuwpapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskuwpapp.md | doc_type: resourcePageType # windowsKioskUWPApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The base class for a type of apps |
v1.0 | Intune Deviceconfig Windowskioskvisitor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskvisitor.md | doc_type: resourcePageType # windowsKioskVisitor resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The class used to identify a visitor kiosk account |
v1.0 | Intune Deviceconfig Windowskioskwin32app | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowskioskwin32app.md | doc_type: resourcePageType # windowsKioskWin32App resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - KioskModeApp v4 for Win32 app support |
v1.0 | Intune Deviceconfig Windowsnetworkisolationpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsnetworkisolationpolicy.md | doc_type: resourcePageType # windowsNetworkIsolationPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Network Isolation Policy ## Properties |
v1.0 | Intune Deviceconfig Windowsphone81certificateprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81certificateprofilebase.md | doc_type: resourcePageType # windowsPhone81CertificateProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base Windows Phone 8.1+ certificate profile. |
v1.0 | Intune Deviceconfig Windowsphone81compliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81compliancepolicy.md | doc_type: resourcePageType # windowsPhone81CompliancePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This class contains compliance settings for Windows 8.1 Mobile. |
v1.0 | Intune Deviceconfig Windowsphone81customconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81customconfiguration.md | doc_type: resourcePageType # windowsPhone81CustomConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the windowsPhone81CustomConfiguration resource. |
v1.0 | Intune Deviceconfig Windowsphone81generalconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81generalconfiguration.md | doc_type: resourcePageType # windowsPhone81GeneralConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This topic provides descriptions of the declared methods, properties and relationships exposed by the windowsPhone81GeneralConfiguration resource. |
v1.0 | Intune Deviceconfig Windowsphone81importedpfxcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81importedpfxcertificateprofile.md | doc_type: resourcePageType # windowsPhone81ImportedPFXCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 8.1 Phone and Mobile PFX Import certificate profile |
v1.0 | Intune Deviceconfig Windowsphone81scepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81scepcertificateprofile.md | doc_type: resourcePageType # windowsPhone81SCEPCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Phone 8.1+ SCEP certificate profile |
v1.0 | Intune Deviceconfig Windowsphone81trustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81trustedrootcertificate.md | doc_type: resourcePageType # windowsPhone81TrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Phone 8.1+ Trusted Root Certificate configuration profile |
v1.0 | Intune Deviceconfig Windowsphone81vpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphone81vpnconfiguration.md | doc_type: resourcePageType # windowsPhone81VpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing the configurations in this profile you can instruct the Windows Phone 8.1 to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user. |
v1.0 | Intune Deviceconfig Windowsphoneeasemailprofileconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsphoneeasemailprofileconfiguration.md | doc_type: resourcePageType # windowsPhoneEASEmailProfileConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - By providing configurations in this profile you can instruct the native email client on Windows Phone to communicate with an Exchange server and get email, contacts, calendar, and tasks. Furthermore, you can also specify how much email to sync and how often the device should sync. |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesscontrolitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsprivacydataaccesscontrolitem.md | doc_type: resourcePageType # windowsPrivacyDataAccessControlItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specify access control level per privacy data category ## Methods |
v1.0 | Intune Deviceconfig Windowsprivacydataaccesslevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsprivacydataaccesslevel.md | doc_type: enumPageType # windowsPrivacyDataAccessLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Determine the access level to specific Windows privacy data category. ## Members |
v1.0 | Intune Deviceconfig Windowsprivacydatacategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsprivacydatacategory.md | doc_type: enumPageType # windowsPrivacyDataCategory enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows privacy data category specifier for privacy data access. ## Members |
v1.0 | Intune Deviceconfig Windowssmodeconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowssmodeconfiguration.md | doc_type: enumPageType # windowsSModeConfiguration enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The possible options to configure S mode unlock ## Members |
v1.0 | Intune Deviceconfig Windowsspotlightenablementsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsspotlightenablementsettings.md | doc_type: enumPageType # windowsSpotlightEnablementSettings enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Allows IT admind to set a predefined default search engine for MDM-Controlled devices ## Members |
v1.0 | Intune Deviceconfig Windowsstartmenuapplistvisibilitytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsstartmenuapplistvisibilitytype.md | doc_type: enumPageType # windowsStartMenuAppListVisibilityType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of start menu app list visibility. ## Members |
v1.0 | Intune Deviceconfig Windowsstartmenumodetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsstartmenumodetype.md | doc_type: enumPageType # windowsStartMenuModeType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of display modes for the start menu. ## Members |
v1.0 | Intune Deviceconfig Windowsupdateactivehoursinstall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateactivehoursinstall.md | doc_type: resourcePageType # windowsUpdateActiveHoursInstall resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [windowsUpdateInstallScheduleType](../resources/intune-deviceconfig-windowsupdateinstallscheduletype.md) ## Properties |
v1.0 | Intune Deviceconfig Windowsupdateforbusinessconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateforbusinessconfiguration.md | doc_type: resourcePageType # windowsUpdateForBusinessConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Update for business configuration, allows you to specify how and when Windows as a Service updates your Windows 10/11 devices with feature and quality updates. Supports ODATA clauses that DeviceConfiguration entity supports: $filter by types of DeviceConfiguration, $top, $select only DeviceConfiguration base properties, $orderby only DeviceConfiguration base properties, and $skip. The query parameter '$search' is not supported. |
v1.0 | Intune Deviceconfig Windowsupdateforbusinessupdateweeks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateforbusinessupdateweeks.md | doc_type: enumPageType # windowsUpdateForBusinessUpdateWeeks enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scheduled the update installation on the weeks of the month ## Members |
v1.0 | Intune Deviceconfig Windowsupdateinstallscheduletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdateinstallscheduletype.md | doc_type: resourcePageType # windowsUpdateInstallScheduleType resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfig Windowsupdatenotificationdisplayoption | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatenotificationdisplayoption.md | doc_type: enumPageType # windowsUpdateNotificationDisplayOption enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Update Notification Display Options ## Members |
v1.0 | Intune Deviceconfig Windowsupdatescheduledinstall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatescheduledinstall.md | doc_type: resourcePageType # windowsUpdateScheduledInstall resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [windowsUpdateInstallScheduleType](../resources/intune-deviceconfig-windowsupdateinstallscheduletype.md) ## Properties |
v1.0 | Intune Deviceconfig Windowsupdatestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatestatus.md | doc_type: enumPageType # windowsUpdateStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows update for business configuration device states ## Members |
v1.0 | Intune Deviceconfig Windowsupdatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsupdatetype.md | doc_type: enumPageType # windowsUpdateType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Which branch devices will receive their updates from ## Members |
v1.0 | Intune Deviceconfig Windowsuseraccountcontrolsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsuseraccountcontrolsettings.md | doc_type: enumPageType # windowsUserAccountControlSettings enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for Windows user account control settings. ## Members |
v1.0 | Intune Deviceconfig Windowsvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsvpnconfiguration.md | doc_type: resourcePageType # windowsVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows VPN configuration profile. |
v1.0 | Intune Deviceconfig Windowsvpnconnectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowsvpnconnectiontype.md | doc_type: enumPageType # windowsVpnConnectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows VPN connection type. ## Members |
v1.0 | Intune Deviceconfig Windowswificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowswificonfiguration.md | doc_type: resourcePageType # windowsWifiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Configuration. |
v1.0 | Intune Deviceconfig Windowswifienterpriseeapconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowswifienterpriseeapconfiguration.md | doc_type: resourcePageType # windowsWifiEnterpriseEAPConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity provides descriptions of the declared methods, properties and relationships exposed by the Wifi CSP. |
v1.0 | Intune Deviceconfig Windowswirednetworkconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-windowswirednetworkconfiguration.md | doc_type: resourcePageType # windowsWiredNetworkConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity provides descriptions of the declared methods, properties and relationships exposed by the Wired Network CSP. |
v1.0 | Intune Deviceconfig Wirednetworkauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wirednetworkauthenticationmethod.md | doc_type: enumPageType # wiredNetworkAuthenticationMethod enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wired Network authentication method. ## Members |
v1.0 | Intune Deviceconfig Wirednetworkauthenticationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wirednetworkauthenticationtype.md | doc_type: enumPageType # wiredNetworkAuthenticationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Wired Network Authentication Type Settings. ## Members |
v1.0 | Intune Deviceconfig Wirednetworkinterface | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wirednetworkinterface.md | doc_type: enumPageType # wiredNetworkInterface enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Apple network interface type. ## Members |
v1.0 | Intune Deviceconfig Wsldistributionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfig-wsldistributionconfiguration.md | + + Title: "wslDistributionConfiguration resource type" +description: "Intune Deviceconfig Wsldistributionconfiguration Resources ." ++ms.localizationpriority: medium ++++# wslDistributionConfiguration resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++++## Properties +|Property|Type|Description| +|:|:|:| +|distribution|String|Linux distribution like Debian, Fedora, Ubuntu etc.| +|minimumOSVersion|String|Minimum supported operating system version of the linux version.| +|maximumOSVersion|String|Maximum supported operating system version of the linux version.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.wslDistributionConfiguration" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.wslDistributionConfiguration", + "distribution": "String", + "minimumOSVersion": "String", + "maximumOSVersion": "String" +} +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods Singleton entity that acts as a container for all device management functionalit |complianceCategories|[deviceManagementConfigurationCategory](../resources/intune-deviceconfigv2-devicemanagementconfigurationcategory.md) collection|List of all compliance categories| |reusablePolicySettings|[deviceManagementReusablePolicySetting](../resources/intune-deviceconfigv2-devicemanagementreusablepolicysetting.md) collection|List of all reusable settings that can be referred in a policy| |templateInsights|[deviceManagementTemplateInsightsDefinition](../resources/intune-deviceconfigv2-devicemanagementtemplateinsightsdefinition.md) collection|List of setting insights in a template|-|inventoryPolicies|[deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) collection|List of all inventory policies| |inventorySettings|[deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md) collection|List of all inventory settings| |inventoryCategories|[deviceManagementConfigurationCategory](../resources/intune-deviceconfigv2-devicemanagementconfigurationcategory.md) collection|List of all inventory categories| |
v1.0 | Intune Deviceconfigv2 Devicemanagementcomplianceactionitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementcomplianceactionitem.md | doc_type: resourcePageType # deviceManagementComplianceActionItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scheduled Action for Rule ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementcomplianceactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementcomplianceactiontype.md | doc_type: enumPageType # deviceManagementComplianceActionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scheduled Action Type Enum ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementcompliancepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementcompliancepolicy.md | Device Management Compliance Policy |id|String|Key of the policy document. Automatically generated.| |name|String|Policy name| |description|String|Policy description|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |createdDateTime|DateTimeOffset|Policy creation date and time. This property is read-only.| |lastModifiedDateTime|DateTimeOffset|Policy last modification date and time. This property is read-only.| |settingCount|Int32|Number of settings. This property is read-only.| Device Management Compliance Policy |Relationship|Type|Description| |:|:|:| |settings|[deviceManagementConfigurationSetting](../resources/intune-deviceconfigv2-devicemanagementconfigurationsetting.md) collection|Policy settings|+|assignments|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|Policy assignments| |scheduledActionsForRule|[deviceManagementComplianceScheduledActionForRule](../resources/intune-deviceconfigv2-devicemanagementcompliancescheduledactionforrule.md) collection|The list of scheduled action for this rule| ## JSON Representation Here is a JSON representation of the resource. ], "isAssigned": true }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementcompliancescheduledactionforrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementcompliancescheduledactionforrule.md | doc_type: resourcePageType # deviceManagementComplianceScheduledActionForRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scheduled Action for Rule ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationapplicationsettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationapplicationsettingapplicability.md | doc_type: resourcePageType # deviceManagementConfigurationApplicationSettingApplicability resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Applicability for a setting that can be targeted on managed Applications by Intune Inherits from [deviceManagementConfigurationSettingApplicability](../resources/i |Property|Type|Description| |:|:|:| |description|String|description of the setting Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md)|-|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| +|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| |deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-deviceconfigv2-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `kiosk`.|-|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| ## Relationships None |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationazureadtrusttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationazureadtrusttype.md | doc_type: enumPageType # deviceManagementConfigurationAzureAdTrustType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Required AAD Trust Type ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationcategory.md | doc_type: resourcePageType # deviceManagementConfigurationCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Management Configuration Policy ## Methods Device Management Configuration Policy |helpText|String|Help text of the category. Give more details of the category.| |name|String|Name of the item| |displayName|String|Name of the category. For example: Device Lock|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms types, which settings in the category have. Possible values are: none. android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies types, which settings in the category have. Possible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms types, which settings in the category have. Possible values are: none. android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies types, which settings in the category have. Possible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. If this property is not set, or set to none, returns categories in all platforms. Supports: $filters, $select. Read-only. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |settingUsage|[deviceManagementConfigurationSettingUsage](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md)|Indicates that the category contains settings that are used for compliance, configuration, or reusable settings. Possible values are: configuration, compliance, reusableSetting. Each setting usage has separate API end-point to call. Read-only. Possible values are: `none`, `configuration`, `compliance`, `unknownFutureValue`, `inventory`.| |parentCategoryId|String|Direct parent id of the category. If the category is the root, the parent id is same as its id.| |rootCategoryId|String|Root id of the category.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectiondefinition.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingCollectionDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationChoiceSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition.md) ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectioninstance.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingCollectionInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting instance within policy |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingcollectioninstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingcollectioninstancetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingCollectionInstanceTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Choice Setting Collection Instance Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingdefinition.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md) ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettinginstance.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting instance within policy |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettinginstancetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingInstanceTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Choice Setting Instance Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting value |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvalueconstantdefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvalueconstantdefaulttemplate.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingValueConstantDefaultTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Choice Setting Value Constant Default Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvaluedefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvaluedefaulttemplate.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingValueDefaultTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Choice Setting Value Default Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvaluedefinitiontemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvaluedefinitiontemplate.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingValueDefinitionTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Choice Setting Value Definition Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationchoicesettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationchoicesettingvaluetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingValueTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Choice Setting Value Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationcontroltype.md | doc_type: enumPageType # deviceManagementConfigurationControlType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting control type representation in the UX ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationdevicemode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationdevicemode.md | doc_type: enumPageType # deviceManagementConfigurationDeviceMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes applicability for the mode the device is in ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationexchangeonlinesettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationexchangeonlinesettingapplicability.md | doc_type: resourcePageType # deviceManagementConfigurationExchangeOnlineSettingApplicability resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Applicability for an Exchange Online Setting Inherits from [deviceManagementConfigurationSettingApplicability](../resources/i |Property|Type|Description| |:|:|:| |description|String|description of the setting Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md)|-|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| +|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| |deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-deviceconfigv2-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `kiosk`.|-|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| ## Relationships None |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingcollectioninstance.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingCollectionInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Instance of a GroupSettingCollection |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingcollectioninstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingcollectioninstancetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingCollectionInstanceTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Group Setting Collection Instance Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettinginstance.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Instance of a GroupSetting |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettinginstancetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingInstanceTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Group Setting Instance Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Value of the GroupSetting |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationgroupsettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationgroupsettingvaluetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingValueTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Group Setting Value Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationIntegerSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting value |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvalueconstantdefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvalueconstantdefaulttemplate.md | doc_type: resourcePageType # deviceManagementConfigurationIntegerSettingValueConstantDefaultTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Integer Setting Value Constant Default Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluedefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluedefaulttemplate.md | doc_type: resourcePageType # deviceManagementConfigurationIntegerSettingValueDefaultTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Integer Setting Value Default Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluedefinition.md | doc_type: resourcePageType # deviceManagementConfigurationIntegerSettingValueDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSettingValueDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvaluedefinition.md) ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluedefinitiontemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluedefinitiontemplate.md | doc_type: resourcePageType # deviceManagementConfigurationIntegerSettingValueDefinitionTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Integer Setting Value Definition Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationintegersettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationintegersettingvaluetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationIntegerSettingValueTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Integer Setting Value Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationjustintimeassignmentpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationjustintimeassignmentpolicy.md | - Title: "deviceManagementConfigurationJustInTimeAssignmentPolicy resource type" -description: "The DeviceManagementConfigurationJustInTimeAssignmentPolicy entity is used to create a just-in-time assignment of specific DeviceManagementConfigurationPolicy to an AAD group." ---doc_type: resourcePageType ---# deviceManagementConfigurationJustInTimeAssignmentPolicy resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---The DeviceManagementConfigurationJustInTimeAssignmentPolicy entity is used to create a just-in-time assignment of specific DeviceManagementConfigurationPolicy to an AAD group. --## Properties -|Property|Type|Description| -|:|:|:| -|targetType|[deviceManagementConfigurationJustInTimeAssignmentPolicyType](../resources/intune-deviceconfigv2-devicemanagementconfigurationjustintimeassignmentpolicytype.md)|Type of the target. Possible values are Entra Security Group. Default value : unknown. Possible values are: `unknown`, `entraSecurityGroup`, `unknownFutureValue`.| -|target|String collection|A list of unique identifiers representing static Entra Security Group IDs to create the just-in-time assignment for newly enrolled devices.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.deviceManagementConfigurationJustInTimeAssignmentPolicy" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceManagementConfigurationJustInTimeAssignmentPolicy", - "targetType": "String", - "target": [ - "String" - ] -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationjustintimeassignmentpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationjustintimeassignmentpolicytype.md | - Title: "deviceManagementConfigurationJustInTimeAssignmentPolicyType enum type" -description: "Represents the type of target (i.e. unique identifier of Entra Security Group) used to create the just-in-time assignment." ---doc_type: enumPageType ---# deviceManagementConfigurationJustInTimeAssignmentPolicyType enum type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Represents the type of target (i.e. unique identifier of Entra Security Group) used to create the just-in-time assignment. --## Members -|Member|Value|Description| -|:|:|:| -|unknown|0|Default value. Do not use.| -|entraSecurityGroup|1|Entra security group.| -|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationoptiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationoptiondefinition.md | doc_type: resourcePageType # deviceManagementConfigurationOptionDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationoptiondefinitiontemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationoptiondefinitiontemplate.md | doc_type: resourcePageType # deviceManagementConfigurationOptionDefinitionTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Option Definition Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationplatforms | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md | doc_type: enumPageType # deviceManagementConfigurationPlatforms enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types. ## Members Supported platform types. |windows10|32|Settings for Windows 10 platform.| |linux|128|Settings for Linux platform.| |unknownFutureValue|256|Evolvable enumeration sentinel value. Do not use.|+|androidEnterprise|512|Settings for Corporate Owned Android Enterprise devices.| +|aosp|1024|Settings for Android Open Source Project platform.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationpolicy.md | Device Management Configuration Policy |[retrieveLatestUpgradeDefaultBaselinePolicy function](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-retrievelatestupgradedefaultbaselinepolicy.md)|[deviceManagementConfigurationPolicy](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicy.md)|| |[retrieveJustInTimeConfiguration action](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-retrievejustintimeconfiguration.md)|[deviceManagementConfigurationJustInTimeAssignmentPolicy](../resources/intune-deviceconfigv2-devicemanagementconfigurationjustintimeassignmentpolicy.md)|| |[assignJustInTimeConfiguration action](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-assignjustintimeconfiguration.md)|Boolean||+|[retrieveEnrollmentTimeDeviceMembershipTarget action](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-retrieveenrollmenttimedevicemembershiptarget.md)|[enrollmentTimeDeviceMembershipTargetResult](../resources/intune-shared-enrollmenttimedevicemembershiptargetresult.md)|| +|[setEnrollmentTimeDeviceMembershipTarget action](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-setenrollmenttimedevicemembershiptarget.md)|[enrollmentTimeDeviceMembershipTargetResult](../resources/intune-shared-enrollmenttimedevicemembershiptargetresult.md)|| +|[clearEnrollmentTimeDeviceMembershipTarget action](../api/intune-deviceconfigv2-devicemanagementconfigurationpolicy-clearenrollmenttimedevicemembershiptarget.md)|Boolean|| ## Properties |Property|Type|Description| Device Management Configuration Policy |id|String|Key of the policy document. Automatically generated.| |name|String|Policy name| |description|String|Policy description|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |createdDateTime|DateTimeOffset|Policy creation date and time| |lastModifiedDateTime|DateTimeOffset|Policy last modification date and time| |settingCount|Int32|Number of settings| Device Management Configuration Policy |Relationship|Type|Description| |:|:|:| |settings|[deviceManagementConfigurationSetting](../resources/intune-deviceconfigv2-devicemanagementconfigurationsetting.md) collection|Policy settings|+|assignments|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|Policy assignments| ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. "priority": 1024 } }-``` +``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicytemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationpolicytemplate.md | doc_type: resourcePageType # deviceManagementConfigurationPolicyTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Management Configuration Policy Template ## Methods Device Management Configuration Policy Template |description|String|Template description| |displayVersion|String|Description of template version| |lifecycleState|[deviceManagementTemplateLifecycleState](../resources/intune-deviceconfigv2-devicemanagementtemplatelifecyclestate.md)|Indicate current lifecycle state of template. Possible values are: `invalid`, `draft`, `active`, `superseded`, `deprecated`, `retired`.|-|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this template. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this template. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this template. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this template. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |templateFamily|[deviceManagementConfigurationTemplateFamily](../resources/intune-deviceconfigv2-devicemanagementconfigurationtemplatefamily.md)|TemplateFamily for this template. Possible values are: `none`, `endpointSecurityAntivirus`, `endpointSecurityDiskEncryption`, `endpointSecurityFirewall`, `endpointSecurityEndpointDetectionAndResponse`, `endpointSecurityAttackSurfaceReduction`, `endpointSecurityAccountProtection`, `endpointSecurityApplicationControl`, `endpointSecurityEndpointPrivilegeManagement`, `enrollmentConfiguration`, `appQuietTime`, `baseline`, `unknownFutureValue`, `deviceConfigurationScripts`, `deviceConfigurationPolicies`, `windowsOsRecoveryPolicies`, `companyPortal`.| |allowUnmanagedSettings|Boolean|Allow unmanaged setting templates| |settingTemplateCount|Int32|Number of setting templates. Valid values 0 to 2147483647. This property is read-only.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationpolicytemplatereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationpolicytemplatereference.md | doc_type: resourcePageType # deviceManagementConfigurationPolicyTemplateReference resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy template reference information ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationredirectsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationredirectsettingdefinition.md | doc_type: resourcePageType # deviceManagementConfigurationRedirectSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md) ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationreferencesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationreferencesettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationReferenceSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Model for ReferenceSettingValue |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationreferredsettinginformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationreferredsettinginformation.md | doc_type: resourcePageType # deviceManagementConfigurationReferredSettingInformation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Referred setting information about reusable setting ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsecretsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsecretsettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationSecretSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Graph model for a secret setting value |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsecretsettingvaluestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsecretsettingvaluestate.md | doc_type: enumPageType # deviceManagementConfigurationSecretSettingValueState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - type tracking the encryption state of a secret setting value ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsetting.md | doc_type: resourcePageType # deviceManagementConfigurationSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting instance within policy ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingaccesstypes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingaccesstypes.md | doc_type: enumPageType # deviceManagementConfigurationSettingAccessTypes enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md | doc_type: resourcePageType # deviceManagementConfigurationSettingApplicability resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |description|String|description of the setting|-|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| +|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| |deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-deviceconfigv2-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on. Possible values are: `none`, `kiosk`.|-|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| ## Relationships None |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md | doc_type: resourcePageType # deviceManagementConfigurationSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupcollectiondefinition.md | doc_type: resourcePageType # deviceManagementConfigurationSettingGroupCollectionDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSettingGroupDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition.md) ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinggroupdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinggroupdefinition.md | doc_type: resourcePageType # deviceManagementConfigurationSettingGroupDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md) ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettinginstancetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationSettingInstanceTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting Instance Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingoccurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingoccurrence.md | doc_type: resourcePageType # deviceManagementConfigurationSettingOccurrence resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingtemplate.md | doc_type: resourcePageType # deviceManagementConfigurationSettingTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting Template ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingusage.md | doc_type: enumPageType # deviceManagementConfigurationSettingUsage enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported setting types ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting value ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvaluedefinition.md | doc_type: resourcePageType # deviceManagementConfigurationSettingValueDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvaluetemplatereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvaluetemplatereference.md | doc_type: resourcePageType # deviceManagementConfigurationSettingValueTemplateReference resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting value template reference information ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsettingvisibility | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsettingvisibility.md | doc_type: enumPageType # deviceManagementConfigurationSettingVisibility enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported setting types ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingcollectiondefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectiondefinition.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingCollectionDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSimpleSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition.md) ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectioninstance.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingCollectionInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting collection instance |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingcollectioninstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingcollectioninstancetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingCollectionInstanceTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple Setting Collection Instance Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingdefinition.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSettingDefinition](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingdefinition.md) ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettinginstance.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting instance |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettinginstancetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettinginstancetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingInstanceTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple Setting Instance Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting value |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationsimplesettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationsimplesettingvaluetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingValueTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple Setting Value Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringformat.md | doc_type: enumPageType # deviceManagementConfigurationStringFormat enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationStringSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting value |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvalueconstantdefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvalueconstantdefaulttemplate.md | doc_type: resourcePageType # deviceManagementConfigurationStringSettingValueConstantDefaultTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - String Setting Value Constant Default Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvaluedefaulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvaluedefaulttemplate.md | doc_type: resourcePageType # deviceManagementConfigurationStringSettingValueDefaultTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - String Setting Value Default Template ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvaluedefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvaluedefinition.md | doc_type: resourcePageType # deviceManagementConfigurationStringSettingValueDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - String constraints |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationstringsettingvaluetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationstringsettingvaluetemplate.md | doc_type: resourcePageType # deviceManagementConfigurationStringSettingValueTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - String Setting Value Template |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationtechnologies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md | doc_type: enumPageType # deviceManagementConfigurationTechnologies enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes which technology this setting can be deployed with ## Members |Member|Value|Description| |:|:|:|-|none|0|Default. Setting cannot be deployed through any channel.| -|mdm|1|Setting can be deployed through the MDM channel.| -|windows10XManagement|2|Setting can be deployed through the Windows10XManagement channel| -|configManager|4|Setting can be deployed through the ConfigManager channel.| -|appleRemoteManagement|64|Setting can be deployed through the AppleRemoteManagement channel.| -|microsoftSense|128|Setting can be deployed through the SENSE agent channel.| -|exchangeOnline|256|Setting can be deployed through the Exchange Online agent channel.| -|mobileApplicationManagement|512|Setting can be deployed through the Mobile Application Management (MAM) channel| -|linuxMdm|1024|Setting can be deployed through the Linux Mdm channel.| -|extensibility|2048|Setting can be deployed through the Extensibility channel.| -|enrollment|4096|Setting can be deployed through device enrollment.| -|endpointPrivilegeManagement|8192|Setting can be deployed using the Endpoint privilege management channel| +|none|0|Default. Indicates the setting cannot be deployed through any channel.| +|mdm|1|Indicates the settings that can be deployed through the Mobile Device Management (MDM) channel.| +|windows10XManagement|2|Indicates the settings that can be deployed through the Windows10XManagement channel.| +|configManager|4|Indicates the settings that can be deployed through the ConfigManager channel.| +|appleRemoteManagement|64|Indicates the settings that can be deployed through the AppleRemoteManagement channel.| +|microsoftSense|128|Indicates the settings that can be deployed through the SENSE agent channel.| +|exchangeOnline|256|Indicates the settings that can be deployed through the Exchange Online agent channel.| +|mobileApplicationManagement|512|Indicates the settings that can be deployed through the Mobile Application Management (MAM) channel.| +|linuxMdm|1024|Indicates the settings that can be deployed through the Linux Mobile Device Management (MDM) channel.| +|extensibility|2048|Indicates the settings that can be deployed through the Extensibility channel.| +|enrollment|4096|Indicates the settings that can be deployed through device enrollment.| +|endpointPrivilegeManagement|8192|Indicates the settings that can be deployed through the Endpoint privilege management channel.| |unknownFutureValue|16384|Evolvable enumeration sentinel value. Do not use.|-|windowsOsRecovery|32768|Setting can be deployed using the Operating System Recovery channel| +|windowsOsRecovery|32768|Indicates the settings that can be applied during a Windows operating system recovery. Such as accept license, base language, create recovery partition, format disk, keyboard settings.| +|android|65536|Indicates the settings that can be deployed through the Android channel.| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationtemplatefamily | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationtemplatefamily.md | doc_type: enumPageType # deviceManagementConfigurationTemplateFamily enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes the TemplateFamily for the Template entity ## Members |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationwindowssettingapplicability | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationwindowssettingapplicability.md | doc_type: resourcePageType # deviceManagementConfigurationWindowsSettingApplicability resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md) ## Properties |Property|Type|Description| |:|:|:| |description|String|description of the setting Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md)|-|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| +|platform|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platform setting can be applied on. Posible values are: none, android, androidEnterprise, iOs, macOs, windows10X, windows10, aosp, and linux. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| |deviceMode|[deviceManagementConfigurationDeviceMode](../resources/intune-deviceconfigv2-devicemanagementconfigurationdevicemode.md)|Device Mode that setting can be applied on Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `kiosk`.|-|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| +|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Which technology channels this setting can be deployed through. Posible values are: none, mdm, configManager, intuneManagementExtension, thirdParty, documentGateway, appleRemoteManagement, microsoftSense, exchangeOnline, edgeMam, linuxMdm, extensibility, enrollment, endpointPrivilegeManagement. Inherited from [deviceManagementConfigurationSettingApplicability](../resources/intune-deviceconfigv2-devicemanagementconfigurationsettingapplicability.md). Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`, `android`.| |configurationServiceProviderVersion|String|Version of CSP setting is a part of| |maximumSupportedVersion|String|Maximum supported version of Windows| |minimumSupportedVersion|String|Minimum supported version of Windows| |
v1.0 | Intune Deviceconfigv2 Devicemanagementconfigurationwindowsskus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementconfigurationwindowsskus.md | doc_type: enumPageType # deviceManagementConfigurationWindowsSkus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Deviceconfigv2 Devicemanagementinventorypolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md | - Title: "deviceManagementInventoryPolicy resource type" -description: "Device Management Inventory Policy" ---doc_type: resourcePageType ---# deviceManagementInventoryPolicy resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Device Management Inventory Policy --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceManagementInventoryPolicies](../api/intune-deviceconfigv2-devicemanagementinventorypolicy-list.md)|[deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) collection|List properties and relationships of the [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) objects.| -|[Get deviceManagementInventoryPolicy](../api/intune-deviceconfigv2-devicemanagementinventorypolicy-get.md)|[deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md)|Read properties and relationships of the [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object.| -|[Create deviceManagementInventoryPolicy](../api/intune-deviceconfigv2-devicemanagementinventorypolicy-create.md)|[deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md)|Create a new [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object.| -|[Delete deviceManagementInventoryPolicy](../api/intune-deviceconfigv2-devicemanagementinventorypolicy-delete.md)|None|Deletes a [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md).| -|[Update deviceManagementInventoryPolicy](../api/intune-deviceconfigv2-devicemanagementinventorypolicy-update.md)|[deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md)|Update the properties of a [deviceManagementInventoryPolicy](../resources/intune-deviceconfigv2-devicemanagementinventorypolicy.md) object.| -|[assign action](../api/intune-deviceconfigv2-devicemanagementinventorypolicy-assign.md)|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|Key of the policy document. Automatically generated.| -|name|String|Policy name| -|description|String|Policy description| -|platforms|[deviceManagementConfigurationPlatforms](../resources/intune-deviceconfigv2-devicemanagementconfigurationplatforms.md)|Platforms for this policy. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`.| -|technologies|[deviceManagementConfigurationTechnologies](../resources/intune-deviceconfigv2-devicemanagementconfigurationtechnologies.md)|Technologies for this policy. Possible values are: `none`, `mdm`, `windows10XManagement`, `configManager`, `appleRemoteManagement`, `microsoftSense`, `exchangeOnline`, `mobileApplicationManagement`, `linuxMdm`, `extensibility`, `enrollment`, `endpointPrivilegeManagement`, `unknownFutureValue`, `windowsOsRecovery`.| -|createdDateTime|DateTimeOffset|Policy creation date and time. This property is read-only.| -|lastModifiedDateTime|DateTimeOffset|Policy last modification date and time. This property is read-only.| -|settingCount|Int32|Number of settings. This property is read-only.| -|creationSource|String|Policy creation source| -|roleScopeTagIds|String collection|List of Scope Tags for this Entity instance.| -|isAssigned|Boolean|Policy assignment status. This property is read-only.| -|version|Int32|Version of the Policy. Valid values 0 to 1000. This property is read-only.| --## Relationships -|Relationship|Type|Description| -|:|:|:| -|settings|[deviceManagementConfigurationSetting](../resources/intune-deviceconfigv2-devicemanagementconfigurationsetting.md) collection|Policy settings| -|assignments|[deviceManagementConfigurationPolicyAssignment](../resources/intune-deviceconfigv2-devicemanagementconfigurationpolicyassignment.md) collection|Policy assignments| --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceManagementInventoryPolicy" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceManagementInventoryPolicy", - "id": "String (identifier)", - "name": "String", - "description": "String", - "platforms": "String", - "technologies": "String", - "createdDateTime": "String (timestamp)", - "lastModifiedDateTime": "String (timestamp)", - "settingCount": 1024, - "creationSource": "String", - "roleScopeTagIds": [ - "String" - ], - "isAssigned": true, - "version": 1024 -} -``` |
v1.0 | Intune Deviceconfigv2 Devicemanagementprioritymetadata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementprioritymetadata.md | doc_type: resourcePageType # deviceManagementPriorityMetaData resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Priority metadata of the policy. ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementreusablepolicysetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementreusablepolicysetting.md | doc_type: resourcePageType # deviceManagementReusablePolicySetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Graph model for a reusable setting ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementsettinginsightsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementsettinginsightsdefinition.md | doc_type: resourcePageType # deviceManagementSettingInsightsDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting Insights ## Properties |
v1.0 | Intune Deviceconfigv2 Devicemanagementtemplateinsightsdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementtemplateinsightsdefinition.md | doc_type: resourcePageType # deviceManagementTemplateInsightsDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - template insights definition ## Methods |
v1.0 | Intune Deviceconfigv2 Devicemanagementtemplatelifecyclestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceconfigv2-devicemanagementtemplatelifecyclestate.md | doc_type: enumPageType # deviceManagementTemplateLifecycleState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes current lifecycle state of a template ## Members |
v1.0 | Intune Deviceintent Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a Container for all device management functionality ## Methods |
v1.0 | Intune Deviceintent Devicemanagementabstractcomplexsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementabstractcomplexsettingdefinition.md | doc_type: resourcePageType # deviceManagementAbstractComplexSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing the defintion for an abstract complex setting |
v1.0 | Intune Deviceintent Devicemanagementabstractcomplexsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementabstractcomplexsettinginstance.md | doc_type: resourcePageType # deviceManagementAbstractComplexSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A setting instance representing a complex value for an abstract setting |
v1.0 | Intune Deviceintent Devicemanagementbooleansettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementbooleansettinginstance.md | doc_type: resourcePageType # deviceManagementBooleanSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A setting instance representing a boolean value |
v1.0 | Intune Deviceintent Devicemanagementcollectionsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcollectionsettingdefinition.md | doc_type: resourcePageType # deviceManagementCollectionSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing the defintion for a collection setting |
v1.0 | Intune Deviceintent Devicemanagementcollectionsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcollectionsettinginstance.md | doc_type: resourcePageType # deviceManagementCollectionSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A setting instance representing a collection of values |
v1.0 | Intune Deviceintent Devicemanagementcomparisonresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcomparisonresult.md | doc_type: enumPageType # deviceManagementComparisonResult enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting comparison result type ## Members |
v1.0 | Intune Deviceintent Devicemanagementcomplexsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcomplexsettingdefinition.md | doc_type: resourcePageType # deviceManagementComplexSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing the defintion for a complex setting |
v1.0 | Intune Deviceintent Devicemanagementcomplexsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementcomplexsettinginstance.md | doc_type: resourcePageType # deviceManagementComplexSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A setting instance representing a complex value |
v1.0 | Intune Deviceintent Devicemanagementconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementconstraint.md | doc_type: resourcePageType # deviceManagementConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base entity for a constraint ## Properties |
v1.0 | Intune Deviceintent Devicemanagementenumconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementenumconstraint.md | doc_type: resourcePageType # deviceManagementEnumConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint that enforces the setting value is from a permitted set of strings |
v1.0 | Intune Deviceintent Devicemanagementenumvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementenumvalue.md | doc_type: resourcePageType # deviceManagementEnumValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Definition information for an enum value ## Properties |
v1.0 | Intune Deviceintent Devicemanagementintegersettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintegersettinginstance.md | doc_type: resourcePageType # deviceManagementIntegerSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A setting instance representing an integer value |
v1.0 | Intune Deviceintent Devicemanagementintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintent.md | doc_type: resourcePageType # deviceManagementIntent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents an intent to apply settings to a device ## Methods |
v1.0 | Intune Deviceintent Devicemanagementintentassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentassignment.md | doc_type: resourcePageType # deviceManagementIntentAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Intent assignment entity ## Methods |
v1.0 | Intune Deviceintent Devicemanagementintentcustomizedsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentcustomizedsetting.md | doc_type: resourcePageType # deviceManagementIntentCustomizedSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Default and customized value of a setting in a Security Baseline ## Properties |
v1.0 | Intune Deviceintent Devicemanagementintentdevicesettingstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentdevicesettingstatesummary.md | doc_type: resourcePageType # deviceManagementIntentDeviceSettingStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents device setting state summary for an intent ## Methods |
v1.0 | Intune Deviceintent Devicemanagementintentdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentdevicestate.md | doc_type: resourcePageType # deviceManagementIntentDeviceState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents device state for an intent ## Methods |
v1.0 | Intune Deviceintent Devicemanagementintentdevicestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentdevicestatesummary.md | doc_type: resourcePageType # deviceManagementIntentDeviceStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents device state summary for an intent ## Methods |
v1.0 | Intune Deviceintent Devicemanagementintentsettingcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentsettingcategory.md | doc_type: resourcePageType # deviceManagementIntentSettingCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing an intent setting category |
v1.0 | Intune Deviceintent Devicemanagementintentsettingsecretconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentsettingsecretconstraint.md | doc_type: resourcePageType # deviceManagementIntentSettingSecretConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint indicating that this value is a secret and will be encrypted. |
v1.0 | Intune Deviceintent Devicemanagementintentuserstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentuserstate.md | doc_type: resourcePageType # deviceManagementIntentUserState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents user state for an intent ## Methods |
v1.0 | Intune Deviceintent Devicemanagementintentuserstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementintentuserstatesummary.md | doc_type: resourcePageType # deviceManagementIntentUserStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents user state summary for an intent ## Methods |
v1.0 | Intune Deviceintent Devicemanagementsettingabstractimplementationconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingabstractimplementationconstraint.md | doc_type: resourcePageType # deviceManagementSettingAbstractImplementationConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint that enforces an AbstractComplex type has or is set to a particular value |
v1.0 | Intune Deviceintent Devicemanagementsettingappconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingappconstraint.md | doc_type: resourcePageType # deviceManagementSettingAppConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing the setting contains only vaild app types. |
v1.0 | Intune Deviceintent Devicemanagementsettingbooleanconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingbooleanconstraint.md | doc_type: resourcePageType # deviceManagementSettingBooleanConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint the enforces a particular boolean value |
v1.0 | Intune Deviceintent Devicemanagementsettingcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingcategory.md | doc_type: resourcePageType # deviceManagementSettingCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing a setting category ## Methods |
v1.0 | Intune Deviceintent Devicemanagementsettingcollectionconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingcollectionconstraint.md | doc_type: resourcePageType # deviceManagementSettingCollectionConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint that enforces the maximum number of elements a collection |
v1.0 | Intune Deviceintent Devicemanagementsettingcomparison | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingcomparison.md | doc_type: resourcePageType # deviceManagementSettingComparison resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing setting comparison result ## Properties |
v1.0 | Intune Deviceintent Devicemanagementsettingdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingdefinition.md | doc_type: resourcePageType # deviceManagementSettingDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing the defintion for a given setting ## Methods |
v1.0 | Intune Deviceintent Devicemanagementsettingdependency | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingdependency.md | doc_type: resourcePageType # deviceManagementSettingDependency resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Dependency information for a setting ## Properties |
v1.0 | Intune Deviceintent Devicemanagementsettingenrollmenttypeconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingenrollmenttypeconstraint.md | doc_type: resourcePageType # deviceManagementSettingEnrollmentTypeConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint that enforces the enrollment types applied to a setting |
v1.0 | Intune Deviceintent Devicemanagementsettingfileconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingfileconstraint.md | doc_type: resourcePageType # deviceManagementSettingFileConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing the file extension is acceptable for a given setting |
v1.0 | Intune Deviceintent Devicemanagementsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettinginstance.md | doc_type: resourcePageType # deviceManagementSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base type for a setting instance ## Methods |
v1.0 | Intune Deviceintent Devicemanagementsettingintegerconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingintegerconstraint.md | doc_type: resourcePageType # deviceManagementSettingIntegerConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing the permitted value range for an integer setting |
v1.0 | Intune Deviceintent Devicemanagementsettingprofileconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingprofileconstraint.md | doc_type: resourcePageType # deviceManagementSettingProfileConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing a given profile metadata |
v1.0 | Intune Deviceintent Devicemanagementsettingregexconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingregexconstraint.md | doc_type: resourcePageType # deviceManagementSettingRegexConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing the setting matches against a given RegEx pattern |
v1.0 | Intune Deviceintent Devicemanagementsettingrequiredconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingrequiredconstraint.md | doc_type: resourcePageType # deviceManagementSettingRequiredConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint that enforces a particular required setting that is not null/undefined/empty string/not configured |
v1.0 | Intune Deviceintent Devicemanagementsettingsddlconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingsddlconstraint.md | doc_type: resourcePageType # deviceManagementSettingSddlConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing the setting is well formed SDDL |
v1.0 | Intune Deviceintent Devicemanagementsettingstringlengthconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingstringlengthconstraint.md | doc_type: resourcePageType # deviceManagementSettingStringLengthConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing a given string length range |
v1.0 | Intune Deviceintent Devicemanagementsettingxmlconstraint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementsettingxmlconstraint.md | doc_type: resourcePageType # deviceManagementSettingXmlConstraint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Constraint enforcing the setting is well formed XML |
v1.0 | Intune Deviceintent Devicemanagementstringsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementstringsettinginstance.md | doc_type: resourcePageType # deviceManagementStringSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A setting instance representing a string value |
v1.0 | Intune Deviceintent Devicemanagementtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplate.md | doc_type: resourcePageType # deviceManagementTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents a defined collection of device settings ## Methods |
v1.0 | Intune Deviceintent Devicemanagementtemplatesettingcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplatesettingcategory.md | doc_type: resourcePageType # deviceManagementTemplateSettingCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing a template setting category |
v1.0 | Intune Deviceintent Devicemanagementtemplatesubtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplatesubtype.md | doc_type: enumPageType # deviceManagementTemplateSubtype enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Template subtype ## Members |
v1.0 | Intune Deviceintent Devicemanagementtemplatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanagementtemplatetype.md | doc_type: enumPageType # deviceManagementTemplateType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Template type ## Members |
v1.0 | Intune Deviceintent Devicemanangementintentvaluetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-devicemanangementintentvaluetype.md | doc_type: enumPageType # deviceManangementIntentValueType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Deviceintent Policyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-policyplatformtype.md | doc_type: enumPageType # policyPlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types for policies. ## Members |
v1.0 | Intune Deviceintent Securitybaselinecategorystatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinecategorystatesummary.md | doc_type: resourcePageType # securityBaselineCategoryStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The security baseline per category compliance state summary for the security baseline of the account. |
v1.0 | Intune Deviceintent Securitybaselinecompliancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinecompliancestate.md | doc_type: enumPageType # securityBaselineComplianceState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Security Baseline Compliance State ## Members |
v1.0 | Intune Deviceintent Securitybaselinecontributingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinecontributingpolicy.md | doc_type: resourcePageType # securityBaselineContributingPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The security baseline compliance state of a setting for a device ## Properties |
v1.0 | Intune Deviceintent Securitybaselinedevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinedevicestate.md | doc_type: resourcePageType # securityBaselineDeviceState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The security baseline compliance state summary of the security baseline for a device. ## Methods |
v1.0 | Intune Deviceintent Securitybaselinepolicysourcetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinepolicysourcetype.md | doc_type: enumPageType # securityBaselinePolicySourceType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Authoring source of a policy ## Members |
v1.0 | Intune Deviceintent Securitybaselinestatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinestatesummary.md | doc_type: resourcePageType # securityBaselineStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The security baseline compliance state summary for the security baseline of the account. ## Methods |
v1.0 | Intune Deviceintent Securitybaselinetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-deviceintent-securitybaselinetemplate.md | doc_type: resourcePageType # securityBaselineTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The security baseline template of the account |
v1.0 | Intune Devices Activatedeviceesimactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-activatedeviceesimactionresult.md | doc_type: resourcePageType # activateDeviceEsimActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Activate device eSIM action result |
v1.0 | Intune Devices Adminconsent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-adminconsent.md | doc_type: resourcePageType # adminConsent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Admin consent information. ## Properties |
v1.0 | Intune Devices Adminconsentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-adminconsentstate.md | doc_type: enumPageType # adminConsentState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Admin consent state. ## Members |
v1.0 | Intune Devices Applepushnotificationcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applepushnotificationcertificate.md | doc_type: resourcePageType # applePushNotificationCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Apple push notification certificate. ## Methods |
v1.0 | Intune Devices Applogcollectiondownloaddetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applogcollectiondownloaddetails.md | doc_type: resourcePageType # appLogCollectionDownloadDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Devices Applogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applogcollectionrequest.md | doc_type: resourcePageType # appLogCollectionRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity for AppLogCollectionRequest contains all logs values. ## Methods |
v1.0 | Intune Devices Applogdecryptionalgorithm | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-applogdecryptionalgorithm.md | doc_type: enumPageType # appLogDecryptionAlgorithm enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Apploguploadstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-apploguploadstate.md | doc_type: enumPageType # appLogUploadState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - AppLogUploadStatus ## Members |
v1.0 | Intune Devices Azureattestationsettingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-azureattestationsettingstatus.md | doc_type: enumPageType # azureAttestationSettingStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible Azure Attestation states for a device. Azure Attestation setting status is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "enabled" or "disabled". Windows 10 devices will have value "notApplicable". ## Members |
v1.0 | Intune Devices Bulkmanageddeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-bulkmanageddeviceactionresult.md | doc_type: resourcePageType # bulkManagedDeviceActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Devices Changeassignmentsactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-changeassignmentsactionresult.md | doc_type: resourcePageType # changeAssignmentsActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ChangeAssignmentsActionResult represents the result of executing the changeAssignments action on tracking the live reporting data for applications or configuration regarding their removal or restoration process |
v1.0 | Intune Devices Chassistype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-chassistype.md | doc_type: enumPageType # chassisType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Chassis type. ## Members |
v1.0 | Intune Devices Chromeosdeviceproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-chromeosdeviceproperty.md | doc_type: resourcePageType # chromeOSDeviceProperty resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a property of the ChromeOS device. ## Properties |
v1.0 | Intune Devices Cloudpcconnectivityissue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-cloudpcconnectivityissue.md | doc_type: resourcePageType # cloudPCConnectivityIssue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analyte connectivity issue entity. ## Methods |
v1.0 | Intune Devices Comanageddevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanageddevicessummary.md | doc_type: resourcePageType # comanagedDevicesSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Summary data for co managed devices ## Properties |
v1.0 | Intune Devices Comanagementeligibledevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanagementeligibledevice.md | doc_type: resourcePageType # comanagementEligibleDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Co-Management eligibility state ## Methods |
v1.0 | Intune Devices Comanagementeligibledevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanagementeligibledevicessummary.md | doc_type: resourcePageType # comanagementEligibleDevicesSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Devices Comanagementeligibletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-comanagementeligibletype.md | doc_type: enumPageType # comanagementEligibleType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Compliancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-compliancestate.md | doc_type: enumPageType # complianceState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Compliance state. ## Members |
v1.0 | Intune Devices Configurationmanageraction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageraction.md | doc_type: resourcePageType # configurationManagerAction resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Parameter for action triggerConfigurationManagerAction ## Properties |
v1.0 | Intune Devices Configurationmanageractiondeliverystatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageractiondeliverystatus.md | doc_type: enumPageType # configurationManagerActionDeliveryStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Delivery state of Configuration Manager device action ## Members |
v1.0 | Intune Devices Configurationmanageractionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageractionresult.md | doc_type: resourcePageType # configurationManagerActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Result of the ConfigurationManager action |
v1.0 | Intune Devices Configurationmanageractiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanageractiontype.md | doc_type: enumPageType # configurationManagerActionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Action type on Configuration Manager client ## Members |
v1.0 | Intune Devices Configurationmanagerclientenabledfeatures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclientenabledfeatures.md | doc_type: resourcePageType # configurationManagerClientEnabledFeatures resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - configuration Manager client enabled features ## Properties |
v1.0 | Intune Devices Configurationmanagerclienthealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclienthealthstate.md | doc_type: resourcePageType # configurationManagerClientHealthState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Configuration manager client health state ## Properties |
v1.0 | Intune Devices Configurationmanagerclientinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclientinformation.md | doc_type: resourcePageType # configurationManagerClientInformation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Configuration Manager client information synced from SCCM ## Properties |
v1.0 | Intune Devices Configurationmanagerclientstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-configurationmanagerclientstate.md | doc_type: enumPageType # configurationManagerClientState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Configuration manager client state ## Members |
v1.0 | Intune Devices Dataprocessorserviceforwindowsfeaturesonboarding | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-dataprocessorserviceforwindowsfeaturesonboarding.md | doc_type: resourcePageType # dataProcessorServiceForWindowsFeaturesOnboarding resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A configuration entity for MEM features that utilize Data Processor Service for Windows (DPSW) data. ## Properties |
v1.0 | Intune Devices Datasharingconsent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-datasharingconsent.md | doc_type: resourcePageType # dataSharingConsent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Data sharing consent information. ## Methods |
v1.0 | Intune Devices Deleteuserfromsharedappledeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deleteuserfromsharedappledeviceactionresult.md | doc_type: resourcePageType # deleteUserFromSharedAppleDeviceActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Delete user from shared apple device action result |
v1.0 | Intune Devices Detectedapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-detectedapp.md | Here is a JSON representation of the resource. "publisher": "String", "platform": "String" }-``` +``` |
v1.0 | Intune Devices Detectedappplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-detectedappplatformtype.md | doc_type: enumPageType # detectedAppPlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the operating system / platform of the discovered application. Some possible values are Windows, iOS, macOS. The default value is unknown (0). ## Members |
v1.0 | Intune Devices Deviceactioncategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceactioncategory.md | + + Title: "deviceActionCategory enum type" +description: "Enum type used for DeviceActionCategory" ++ms.localizationpriority: medium ++++# deviceActionCategory enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Enum type used for DeviceActionCategory ++## Members +|Member|Value|Description| +|:|:|:| +|single|0|Action is performed on a single device alone| +|bulk|1|Action is performed for a set of devices| |
v1.0 | Intune Devices Deviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceactionresult.md | doc_type: resourcePageType # deviceActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device action result ## Properties |
v1.0 | Intune Devices Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceappmanagement.md | doc_type: resourcePageType # deviceAppManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device app management functionality. ## Methods |
v1.0 | Intune Devices Deviceassignmentitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceassignmentitem.md | doc_type: resourcePageType # deviceAssignmentItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the application or configuration included in the ChangeAssignments action execution or result. For action execution, it represents the application or configuration intended to be uninstalled or removed on the managed device. For action result, it represents the live reporting data for this application or configuration regarding its removal or restoration process. ## Properties |
v1.0 | Intune Devices Deviceassignmentitemintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceassignmentitemintent.md | doc_type: enumPageType # deviceAssignmentItemIntent enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible assignment item action intent values on the application or configuration when executing this action on the managed device. For example, if the application or configuration is intended to be removed on the managed device, then the intent value is remove, and if the application or configuration already under removal through previous actions and is now intended to be restored on the managed device, then the intent value is restore ## Members |
v1.0 | Intune Devices Deviceassignmentitemstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceassignmentitemstatus.md | doc_type: enumPageType # deviceAssignmentItemStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible assignment item action status values for the application or configuration regarding their executed action on the managed device. For example, a configuration included in the deviceAssignmentItems list has just been executed the action. Its status starts with inProgress until it's successfully removed to reflect as removed status or failed to be removed to reflect as error status on the managed device. Similar status change happens for restoration process ## Members |
v1.0 | Intune Devices Deviceassignmentitemtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceassignmentitemtype.md | doc_type: enumPageType # deviceAssignmentItemType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible device assignment item types to execute this action on the managed device. Device assignment item represents existing assigned Intune resource such as application or configuration. Currently supported device assignment item types are Application, DeviceConfiguration, DeviceManagementConfigurationPolicy and MobileAppConfiguration ## Members |
v1.0 | Intune Devices Devicecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecategory.md | doc_type: resourcePageType # deviceCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Devices Devicecleanupruleplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecleanupruleplatformtype.md | doc_type: enumPageType # deviceCleanupRulePlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Define the platform type for which the admin wants to create the device clean up rule ## Members |
v1.0 | Intune Devices Devicecompliancescript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecompliancescript.md | doc_type: resourcePageType # deviceComplianceScript resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Intune will provide customer the ability to run their Powershell Compliance scripts (detection) on the enrolled windows 10 Azure Active Directory joined devices. ## Methods |
v1.0 | Intune Devices Devicecompliancescriptdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecompliancescriptdevicestate.md | doc_type: resourcePageType # deviceComplianceScriptDeviceState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Here is a JSON representation of the resource. "scriptOutput": "String", "scriptError": "String" }-``` +``` |
v1.0 | Intune Devices Devicecompliancescriptrunsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecompliancescriptrunsummary.md | doc_type: resourcePageType # deviceComplianceScriptRunSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the run summary of a device management script. ## Methods |
v1.0 | Intune Devices Devicecustomattributeshellscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecustomattributeshellscript.md | doc_type: resourcePageType # deviceCustomAttributeShellScript resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents a custom attribute script for macOS. ## Methods |
v1.0 | Intune Devices Devicecustomattributevaluetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicecustomattributevaluetype.md | doc_type: enumPageType # deviceCustomAttributeValueType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the expected type for a macOS custom attribute script value. ## Members |
v1.0 | Intune Devices Deviceenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceenrollmenttype.md | doc_type: enumPageType # deviceEnrollmentType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible ways of adding a mobile device to management. ## Members Possible ways of adding a mobile device to management. |windowsBulkAzureDomainJoin|8|Windows 10 bulk Azure AD Join.| |windowsCoManagement|9|Windows 10 Co-Management triggered by AutoPilot or Group Policy.| |windowsAzureADJoinUsingDeviceAuth|10|Windows 10 Azure AD Join using Device Auth.|-|appleUserEnrollment|11|Device managed by Apple user enrollment| -|appleUserEnrollmentWithServiceAccount|12|Device managed by Apple user enrollment with service account| +|appleUserEnrollment|11|Indicates the device is enrolled via Apple User Enrollment with Company Portal. It results in an enrollment with a new partition for managed apps and data and which supports a limited set of management capabilities| +|appleUserEnrollmentWithServiceAccount|12|Indicates the device is enrolled via Apple User Enrollment with Company Portal using a device enrollment manager user. It results in an enrollment with a new partition for managed apps and data and which supports a limited set of management capabilities| |azureAdJoinUsingAzureVmExtension|14|Azure AD Join enrollment when an Azure VM is provisioned| |androidEnterpriseDedicatedDevice|15|Android Enterprise Dedicated Device| |androidEnterpriseFullyManaged|16|Android Enterprise Fully Managed| Possible ways of adding a mobile device to management. |appleACMEDEPUDACompanyPortal|22|Apple ACME DEP UDA enrollment at CP| |appleACMEDEPUDASetupAsstLegacy|23|Apple ACME DEP UDA enrollment at Setup Asst (legacy)| |appleACMEDEPUDAModernAuth|24|Apple ACME DEP UDA enrollment at Setup Asst (Modern Auth)|+|appleAccountDrivenUserEnrollment|25|Indicates the device is enrolled via Apple Account Driven User Enrollment, a form of enrollment where the user enrolls via iOS Settings without using the iOS Company Portal. It results in an enrollment with a new partition for managed apps and data and which supports a limited set of management capabilities.| +|unknownFutureValue|26|Evolvable enum member| |
v1.0 | Intune Devices Deviceeventlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceeventlevel.md | doc_type: enumPageType # deviceEventLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates device event level. Possible values are: None, Verbose, Information, Warning, Error, Critical ## Members |
v1.0 | Intune Devices Deviceexchangeaccessstatesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceexchangeaccessstatesummary.md | doc_type: resourcePageType # deviceExchangeAccessStateSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Exchange Access State summary ## Properties |
v1.0 | Intune Devices Devicegeolocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicegeolocation.md | doc_type: resourcePageType # deviceGeoLocation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device location ## Properties |
v1.0 | Intune Devices Deviceguardlocalsystemauthoritycredentialguardstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceguardlocalsystemauthoritycredentialguardstate.md | doc_type: enumPageType # deviceGuardLocalSystemAuthorityCredentialGuardState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Deviceguardvirtualizationbasedsecurityhardwarerequirementstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceguardvirtualizationbasedsecurityhardwarerequirementstate.md | doc_type: enumPageType # deviceGuardVirtualizationBasedSecurityHardwareRequirementState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Deviceguardvirtualizationbasedsecuritystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceguardvirtualizationbasedsecuritystate.md | doc_type: enumPageType # deviceGuardVirtualizationBasedSecurityState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Devicehealthattestationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthattestationstate.md | doc_type: resourcePageType # deviceHealthAttestationState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Devices Devicehealthscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscript.md | doc_type: resourcePageType # deviceHealthScript resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Intune will provide customer the ability to run their Powershell Health scripts (remediation + detection) on the enrolled windows 10 Azure Active Directory joined devices. ## Methods |
v1.0 | Intune Devices Devicehealthscriptbooleanparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptbooleanparameter.md | doc_type: resourcePageType # deviceHealthScriptBooleanParameter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Properties of the Booolean script parameter. |
v1.0 | Intune Devices Devicehealthscriptdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptdevicestate.md | Contains properties for device run state of the device health script. |Method|Return Type|Description| |:|:|:| |[List deviceHealthScriptDeviceStates](../api/intune-devices-devicehealthscriptdevicestate-list.md)|[deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md) collection|List properties and relationships of the [deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md) objects.|-|[Get deviceHealthScriptDeviceState](../api/intune-devices-devicehealthscriptdevicestate-get.md)|[deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md)|Read properties and relationships of the [deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md) object.| -|[Create deviceHealthScriptDeviceState](../api/intune-devices-devicehealthscriptdevicestate-create.md)|[deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md)|Create a new [deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md) object.| -|[Delete deviceHealthScriptDeviceState](../api/intune-devices-devicehealthscriptdevicestate-delete.md)|None|Deletes a [deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md).| -|[Update deviceHealthScriptDeviceState](../api/intune-devices-devicehealthscriptdevicestate-update.md)|[deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md)|Update the properties of a [deviceHealthScriptDeviceState](../resources/intune-devices-devicehealthscriptdevicestate.md) object.| ## Properties |Property|Type|Description| |
v1.0 | Intune Devices Devicehealthscriptintegerparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptintegerparameter.md | doc_type: resourcePageType # deviceHealthScriptIntegerParameter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Properties of the Integer script parameter. |
v1.0 | Intune Devices Devicehealthscriptparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptparameter.md | doc_type: resourcePageType # deviceHealthScriptParameter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base properties of the script parameter. ## Properties |
v1.0 | Intune Devices Devicehealthscriptpolicystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptpolicystate.md | doc_type: resourcePageType # deviceHealthScriptPolicyState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for policy run state of the device health script. ## Methods |
v1.0 | Intune Devices Devicehealthscriptremediationhistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptremediationhistory.md | doc_type: resourcePageType # deviceHealthScriptRemediationHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The number of devices remediated by a device health script on a given date with the last modified time. ## Properties |
v1.0 | Intune Devices Devicehealthscriptremediationhistorydata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptremediationhistorydata.md | doc_type: resourcePageType # deviceHealthScriptRemediationHistoryData resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The number of devices remediated by a device health script on a given date. ## Properties |
v1.0 | Intune Devices Devicehealthscriptremediationsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptremediationsummary.md | doc_type: resourcePageType # deviceHealthScriptRemediationSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The number of device health scripts deployed and the number of devices the scripts remediated. ## Properties |
v1.0 | Intune Devices Devicehealthscriptrunsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptrunsummary.md | doc_type: resourcePageType # deviceHealthScriptRunSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the run summary of a device management script. ## Methods |
v1.0 | Intune Devices Devicehealthscriptstringparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscriptstringparameter.md | doc_type: resourcePageType # deviceHealthScriptStringParameter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Properties of the String script parameter. |
v1.0 | Intune Devices Devicehealthscripttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicehealthscripttype.md | doc_type: enumPageType # deviceHealthScriptType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of device script. ## Members |
v1.0 | Intune Devices Deviceidentityattestationdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceidentityattestationdetail.md | doc_type: resourcePageType # deviceIdentityAttestationDetail resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the attestation status of the managed device ## Properties |
v1.0 | Intune Devices Deviceidentityattestationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceidentityattestationstatus.md | doc_type: enumPageType # deviceIdentityAttestationStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the state of the anomaly. Eg: anomaly severity can be new, active, disabled, removed or other. ## Members |
v1.0 | Intune Devices Deviceinventory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventory.md | - Title: "deviceInventory resource type" -description: "Represents the data collected on a device for a particular inventory type. These device inventory types may include Disk Drives, Network Adapters, etc." ---doc_type: resourcePageType ---# deviceInventory resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Represents the data collected on a device for a particular inventory type. These device inventory types may include Disk Drives, Network Adapters, etc. --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceInventories](../api/intune-devices-deviceinventory-list.md)|[deviceInventory](../resources/intune-devices-deviceinventory.md) collection|List properties and relationships of the [deviceInventory](../resources/intune-devices-deviceinventory.md) objects.| -|[Get deviceInventory](../api/intune-devices-deviceinventory-get.md)|[deviceInventory](../resources/intune-devices-deviceinventory.md)|Read properties and relationships of the [deviceInventory](../resources/intune-devices-deviceinventory.md) object.| -|[Create deviceInventory](../api/intune-devices-deviceinventory-create.md)|[deviceInventory](../resources/intune-devices-deviceinventory.md)|Create a new [deviceInventory](../resources/intune-devices-deviceinventory.md) object.| -|[Delete deviceInventory](../api/intune-devices-deviceinventory-delete.md)|None|Deletes a [deviceInventory](../resources/intune-devices-deviceinventory.md).| -|[Update deviceInventory](../api/intune-devices-deviceinventory-update.md)|[deviceInventory](../resources/intune-devices-deviceinventory.md)|Update the properties of a [deviceInventory](../resources/intune-devices-deviceinventory.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The unique catalog id for this inventory entity type| -|displayName|String|The localized display name of the entity. Example: "Disk Drives". This property is read-only.| -|lastSyncDateTime|DateTimeOffset|The date and time that the inventory data was last synced with Intune. The value cannot be modified and is automatically populated when the device performs a sync. The Timestamp type represents date and time information and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Read-only. This property is read-only.| --## Relationships -|Relationship|Type|Description| -|:|:|:| -|instances|[deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) collection|The data on the client device that have been collected for this inventory type. This property is read-only.| --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceInventory" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventory", - "id": "String (identifier)", - "displayName": "String", - "lastSyncDateTime": "String (timestamp)" -} -``` |
v1.0 | Intune Devices Deviceinventorybooleanvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventorybooleanvalue.md | - Title: "deviceInventoryBooleanValue resource type" -description: "Inherited type of DeviceInventoryValue where the value is a boolean" ---doc_type: resourcePageType ---# deviceInventoryBooleanValue resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryValue where the value is a boolean ---Inherits from [deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) --## Properties -|Property|Type|Description| -|:|:|:| -|value|Boolean|Boolean value of a property. This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.deviceInventoryBooleanValue" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryBooleanValue", - "value": true -} -``` |
v1.0 | Intune Devices Deviceinventorycollectionproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventorycollectionproperty.md | - Title: "deviceInventoryCollectionProperty resource type" -description: "Inherited type of DeviceInventoryProperty where the property contains a collection of values" ---doc_type: resourcePageType ---# deviceInventoryCollectionProperty resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryProperty where the property contains a collection of values ---Inherits from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceInventoryCollectionProperties](../api/intune-devices-deviceinventorycollectionproperty-list.md)|[deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) collection|List properties and relationships of the [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) objects.| -|[Get deviceInventoryCollectionProperty](../api/intune-devices-deviceinventorycollectionproperty-get.md)|[deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md)|Read properties and relationships of the [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object.| -|[Create deviceInventoryCollectionProperty](../api/intune-devices-deviceinventorycollectionproperty-create.md)|[deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md)|Create a new [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object.| -|[Delete deviceInventoryCollectionProperty](../api/intune-devices-deviceinventorycollectionproperty-delete.md)|None|Deletes a [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md).| -|[Update deviceInventoryCollectionProperty](../api/intune-devices-deviceinventorycollectionproperty-update.md)|[deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md)|Update the properties of a [deviceInventoryCollectionProperty](../resources/intune-devices-deviceinventorycollectionproperty.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The catalog id for this inventory property type Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|displayName|String|The localized display name of the property. Example: "Size (MB)". This property is read-only. Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|values|[deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) collection|Collection value of the property. This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceInventoryCollectionProperty" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryCollectionProperty", - "id": "String (identifier)", - "displayName": "String", - "values": [ - { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "String (timestamp)" - } - ] -} -``` |
v1.0 | Intune Devices Deviceinventorydatetimevalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventorydatetimevalue.md | - Title: "deviceInventoryDateTimeValue resource type" -description: "Inherited type of DeviceInventoryValue where the value is a dateTime" ---doc_type: resourcePageType ---# deviceInventoryDateTimeValue resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryValue where the value is a dateTime ---Inherits from [deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) --## Properties -|Property|Type|Description| -|:|:|:| -|value|DateTimeOffset|The date and time value of a property. This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryDateTimeValue", - "value": "String (timestamp)" -} -``` |
v1.0 | Intune Devices Deviceinventorydoublevalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventorydoublevalue.md | - Title: "deviceInventoryDoubleValue resource type" -description: "Inherited type of DeviceInventoryValue where the value is a double" ---doc_type: resourcePageType ---# deviceInventoryDoubleValue resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryValue where the value is a double ---Inherits from [deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) --## Properties -|Property|Type|Description| -|:|:|:| -|value|Double|Double value of a property. This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.deviceInventoryDoubleValue" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryDoubleValue", - "value": "4.2" -} -``` |
v1.0 | Intune Devices Deviceinventoryint64value | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventoryint64value.md | - Title: "deviceInventoryInt64Value resource type" -description: "Inherited type of DeviceInventoryValue where the value is an int64" ---doc_type: resourcePageType ---# deviceInventoryInt64Value resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryValue where the value is an int64 ---Inherits from [deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) --## Properties -|Property|Type|Description| -|:|:|:| -|value|Int64|Int64 value of a property. This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.deviceInventoryInt64Value" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryInt64Value", - "value": 1024 -} -``` |
v1.0 | Intune Devices Deviceinventoryitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventoryitem.md | - Title: "deviceInventoryItem resource type" -description: "Abstract type to represent a single piece of inventory data that was collected on a device. For example, this could represent a single network adapter that was present on a device" ---doc_type: resourcePageType ---# deviceInventoryItem resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Abstract type to represent a single piece of inventory data that was collected on a device. For example, this could represent a single network adapter that was present on a device --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceInventoryItems](../api/intune-devices-deviceinventoryitem-list.md)|[deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) collection|List properties and relationships of the [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) objects.| -|[Get deviceInventoryItem](../api/intune-devices-deviceinventoryitem-get.md)|[deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md)|Read properties and relationships of the [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the inventory data| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceInventoryItem" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryItem", - "id": "String (identifier)" -} -``` |
v1.0 | Intune Devices Deviceinventoryproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventoryproperty.md | - Title: "deviceInventoryProperty resource type" -description: "Abstract type to represent a single property of an inventory entity" ---doc_type: resourcePageType ---# deviceInventoryProperty resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Abstract type to represent a single property of an inventory entity --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceInventoryProperties](../api/intune-devices-deviceinventoryproperty-list.md)|[deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) collection|List properties and relationships of the [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) objects.| -|[Get deviceInventoryProperty](../api/intune-devices-deviceinventoryproperty-get.md)|[deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)|Read properties and relationships of the [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The catalog id for this inventory property type| -|displayName|String|The localized display name of the property. Example: "Size (MB)". This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceInventoryProperty" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryProperty", - "id": "String (identifier)", - "displayName": "String" -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventorysimpleitem.md | - Title: "deviceInventorySimpleItem resource type" -description: "Inherited type of DeviceInventoryItem where the instance only has a list of properties that can be displayed in a table format" ---doc_type: resourcePageType ---# deviceInventorySimpleItem resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryItem where the instance only has a list of properties that can be displayed in a table format ---Inherits from [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md) --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceInventorySimpleItems](../api/intune-devices-deviceinventorysimpleitem-list.md)|[deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) collection|List properties and relationships of the [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) objects.| -|[Get deviceInventorySimpleItem](../api/intune-devices-deviceinventorysimpleitem-get.md)|[deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md)|Read properties and relationships of the [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object.| -|[Create deviceInventorySimpleItem](../api/intune-devices-deviceinventorysimpleitem-create.md)|[deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md)|Create a new [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object.| -|[Delete deviceInventorySimpleItem](../api/intune-devices-deviceinventorysimpleitem-delete.md)|None|Deletes a [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md).| -|[Update deviceInventorySimpleItem](../api/intune-devices-deviceinventorysimpleitem-update.md)|[deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md)|Update the properties of a [deviceInventorySimpleItem](../resources/intune-devices-deviceinventorysimpleitem.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|A unique identifier for the inventory data Inherited from [deviceInventoryItem](../resources/intune-devices-deviceinventoryitem.md)| --## Relationships -|Relationship|Type|Description| -|:|:|:| -|properties|[deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) collection|The list of properties for this inventory data. This property is read-only.| --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceInventorySimpleItem" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleItem", - "id": "String (identifier)" -} -``` |
v1.0 | Intune Devices Deviceinventorysimpleproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventorysimpleproperty.md | - Title: "deviceInventorySimpleProperty resource type" -description: "Inherited type of DeviceInventoryProperty where the property contains a single value" ---doc_type: resourcePageType ---# deviceInventorySimpleProperty resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryProperty where the property contains a single value ---Inherits from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md) --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceInventorySimpleProperties](../api/intune-devices-deviceinventorysimpleproperty-list.md)|[deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) collection|List properties and relationships of the [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) objects.| -|[Get deviceInventorySimpleProperty](../api/intune-devices-deviceinventorysimpleproperty-get.md)|[deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md)|Read properties and relationships of the [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object.| -|[Create deviceInventorySimpleProperty](../api/intune-devices-deviceinventorysimpleproperty-create.md)|[deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md)|Create a new [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object.| -|[Delete deviceInventorySimpleProperty](../api/intune-devices-deviceinventorysimpleproperty-delete.md)|None|Deletes a [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md).| -|[Update deviceInventorySimpleProperty](../api/intune-devices-deviceinventorysimpleproperty-update.md)|[deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md)|Update the properties of a [deviceInventorySimpleProperty](../resources/intune-devices-deviceinventorysimpleproperty.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|The catalog id for this inventory property type Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|displayName|String|The localized display name of the property. Example: "Size (MB)". This property is read-only. Inherited from [deviceInventoryProperty](../resources/intune-devices-deviceinventoryproperty.md)| -|value|[deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md)|Value of the property. This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceInventorySimpleProperty" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventorySimpleProperty", - "id": "String (identifier)", - "displayName": "String", - "value": { - "@odata.type": "microsoft.graph.deviceInventoryDateTimeValue", - "value": "String (timestamp)" - } -} -``` |
v1.0 | Intune Devices Deviceinventorystringvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventorystringvalue.md | - Title: "deviceInventoryStringValue resource type" -description: "Inherited type of DeviceInventoryValue where the value is a string" ---doc_type: resourcePageType ---# deviceInventoryStringValue resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Inherited type of DeviceInventoryValue where the value is a string ---Inherits from [deviceInventoryValue](../resources/intune-devices-deviceinventoryvalue.md) --## Properties -|Property|Type|Description| -|:|:|:| -|value|String|String value of a property. Example: "Size (MB)". This property is read-only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.deviceInventoryStringValue" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryStringValue", - "value": "String" -} -``` |
v1.0 | Intune Devices Deviceinventoryvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceinventoryvalue.md | - Title: "deviceInventoryValue resource type" -description: "An empty abstract type that will represent a single value" ---doc_type: resourcePageType ---# deviceInventoryValue resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---An empty abstract type that will represent a single value --## Properties -|Property|Type|Description| -|:|:|:| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.deviceInventoryValue" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceInventoryValue" -} -``` |
v1.0 | Intune Devices Devicelicensingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelicensingstatus.md | doc_type: enumPageType # deviceLicensingStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the device licensing status after Windows device based subscription has been enabled. ## Members |
v1.0 | Intune Devices Devicelogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelogcollectionrequest.md | doc_type: resourcePageType # deviceLogCollectionRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Log Collection request entity. ## Properties |
v1.0 | Intune Devices Devicelogcollectionresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelogcollectionresponse.md | doc_type: resourcePageType # deviceLogCollectionResponse resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Log Collection request entity. ## Methods |
v1.0 | Intune Devices Devicelogcollectiontemplatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicelogcollectiontemplatetype.md | doc_type: enumPageType # deviceLogCollectionTemplateType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enum for the template type used for collecting logs ## Members |
v1.0 | Intune Devices Devicemanagementexchangeaccessstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementexchangeaccessstate.md | doc_type: enumPageType # deviceManagementExchangeAccessState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Exchange Access State. ## Members |
v1.0 | Intune Devices Devicemanagementexchangeaccessstatereason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementexchangeaccessstatereason.md | doc_type: enumPageType # deviceManagementExchangeAccessStateReason enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Exchange Access State Reason. ## Members |
v1.0 | Intune Devices Devicemanagementscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscript.md | doc_type: resourcePageType # deviceManagementScript resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Intune will provide customer the ability to run their Powershell scripts on the enrolled windows 10 Azure Active Directory joined devices. The script can be run once or periodically. ## Methods |
v1.0 | Intune Devices Devicemanagementscriptassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptassignment.md | doc_type: resourcePageType # deviceManagementScriptAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to assign a device management script to a group. ## Methods |
v1.0 | Intune Devices Devicemanagementscriptdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptdevicestate.md | Here is a JSON representation of the resource. "errorCode": 1024, "errorDescription": "String" }-``` +``` |
v1.0 | Intune Devices Devicemanagementscriptgroupassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptgroupassignment.md | doc_type: resourcePageType # deviceManagementScriptGroupAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to assign a device management script to a group. ## Methods |
v1.0 | Intune Devices Devicemanagementscriptrunsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptrunsummary.md | doc_type: resourcePageType # deviceManagementScriptRunSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the run summary of a device management script. ## Methods |
v1.0 | Intune Devices Devicemanagementscriptuserstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementscriptuserstate.md | doc_type: resourcePageType # deviceManagementScriptUserState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for user run state of the device management script. ## Methods |
v1.0 | Intune Devices Devicemanagementsubscriptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementsubscriptions.md | doc_type: enumPageType # deviceManagementSubscriptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Tenant mobile device management subscriptions. ## Members |
v1.0 | Intune Devices Devicemanagementsubscriptionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicemanagementsubscriptionstate.md | doc_type: enumPageType # deviceManagementSubscriptionState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Tenant mobile device management subscription state. ## Members |
v1.0 | Intune Devices Deviceoperatingsystemsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceoperatingsystemsummary.md | doc_type: resourcePageType # deviceOperatingSystemSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device operating system summary. ## Properties |
v1.0 | Intune Devices Deviceprotectionoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceprotectionoverview.md | doc_type: resourcePageType # deviceProtectionOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Hardware information of a given device. ## Properties |
v1.0 | Intune Devices Deviceregistrationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceregistrationstate.md | doc_type: enumPageType # deviceRegistrationState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device registration status. ## Members |
v1.0 | Intune Devices Devicescopeactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeactionresult.md | doc_type: resourcePageType # deviceScopeActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The result of the triggered device scope action. ## Properties |
v1.0 | Intune Devices Devicescopeactionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeactionstatus.md | doc_type: enumPageType # deviceScopeActionStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the status of the attempted device scope action ## Members |
v1.0 | Intune Devices Devicescopeoperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeoperator.md | doc_type: enumPageType # deviceScopeOperator enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device scope configuration query operator. Possible values are: equals, notEquals, contains, notContains, greaterThan, lessThan. Default value: equals. ## Members |
v1.0 | Intune Devices Devicescopeparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopeparameter.md | doc_type: enumPageType # deviceScopeParameter enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device scope configuration parameter. It will be expend in future to add more parameter. Eg: device scope parameter can be OS version, Disk Type, Device manufacturer, device model or Scope tag. Default value: scopeTag. ## Members |
v1.0 | Intune Devices Devicescopestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-devicescopestatus.md | doc_type: enumPageType # deviceScopeStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the device scope status after the device scope has been enabled. Possible values are: none, computing, insufficientData or completed. Default value is none. ## Members |
v1.0 | Intune Devices Deviceshellscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-deviceshellscript.md | doc_type: resourcePageType # deviceShellScript resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Intune will provide customer the ability to run their Shell scripts on the enrolled Mac OS devices. The script can be run once or periodically. ## Methods |
v1.0 | Intune Devices Disktype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-disktype.md | doc_type: enumPageType # diskType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Firmwareprotectiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-firmwareprotectiontype.md | doc_type: enumPageType # firmwareProtectionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible Firmware protection type for a device. Firmware protection is a set of features that helps to ensure attackers can't get your device to start with untrusted or malicious firmware. Firmware protection type is determined by report sent from Microsoft Azure Attestation service. Only Windows 11 devices will have values "systemGuardSecureLaunch" or "firmwareAttackSurfaceReduction" or "disabled". Windows 10 devices will have value "notApplicable". ## Members |
v1.0 | Intune Devices Globaldevicehealthscriptstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-globaldevicehealthscriptstate.md | doc_type: enumPageType # globalDeviceHealthScriptState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates whether global device health scripts are enabled and are in which state ## Members |
v1.0 | Intune Devices Hardwareinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-hardwareinformation.md | doc_type: resourcePageType # hardwareInformation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Hardware information of a given device. ## Properties |
v1.0 | Intune Devices Healthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-healthstate.md | doc_type: enumPageType # healthState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates health state of the Windows management app. ## Members |
v1.0 | Intune Devices Insightvaluedouble | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-insightvaluedouble.md | doc_type: resourcePageType # insightValueDouble resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The value in an user experience analytics insight. |
v1.0 | Intune Devices Insightvalueint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-insightvalueint.md | doc_type: resourcePageType # insightValueInt resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The value in an user experience analytics insight. |
v1.0 | Intune Devices Jointype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-jointype.md | doc_type: enumPageType # joinType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device enrollment join type. ## Members |
v1.0 | Intune Devices Keyvaluepair_2Ofstring_String | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-keyvaluepair_2ofstring_string.md | + + Title: "keyValuePair_2OfString_String resource type" +description: "Intune Devices Keyvaluepair_2Ofstring_String Resources ." ++ms.localizationpriority: medium ++++# keyValuePair_2OfString_String resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++++## Properties +|Property|Type|Description| +|:|:|:| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.keyValuePair_2OfString_String" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.keyValuePair_2OfString_String" +} +``` |
v1.0 | Intune Devices Locatedeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-locatedeviceactionresult.md | doc_type: resourcePageType # locateDeviceActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Locate device action result |
v1.0 | Intune Devices Loggedonuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-loggedonuser.md | doc_type: resourcePageType # loggedOnUser resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Logged On User ## Properties |
v1.0 | Intune Devices Lostmodestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-lostmodestate.md | doc_type: enumPageType # lostModeState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - State of lost mode, indicating if lost mode is enabled or disabled ## Members |
v1.0 | Intune Devices Malwarestateforwindowsdevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-malwarestateforwindowsdevice.md | doc_type: resourcePageType # malwareStateForWindowsDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware state for a windows device ## Methods |
v1.0 | Intune Devices Manageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevice.md | Devices that are managed or pre-enrolled through Intune |:|:|:| |id|String|Unique Identifier for the device. This property is read-only.| |userId|String|Unique Identifier for the user associated with the device. This property is read-only.|-|deviceName|String|Name of the device. This property is read-only.| +|deviceName|String|Name of the device. Supports $filter operator 'eq' and 'contains'. This property is read-only.| |hardwareInformation|[hardwareInformation](../resources/intune-devices-hardwareinformation.md)|The hardward details for the device. Includes information such as storage space, manufacturer, serial number, etc. By default most property of this type are set to null/0/false and enum defaults for associated types. To retrieve actual values GET call needs to be made, with device id and included in select parameter. Supports: $select. $Search is not supported. Read-only. This property is read-only.| |ownerType|[ownerType](../resources/intune-shared-ownertype.md)|Ownership of the device. Possible values are, 'company' or 'personal'. Default is unknown. Supports $filter operator 'eq' and 'or'. Possible values are: `unknown`, `company`, `personal`.| |managedDeviceOwnerType|[managedDeviceOwnerType](../resources/intune-shared-manageddeviceownertype.md)|Ownership of the device. Can be 'company' or 'personal'. Possible values are: `unknown`, `company`, `personal`.| Here is a JSON representation of the resource. "deviceIdentityAttestationStatus": "String" } }-``` +``` |
v1.0 | Intune Devices Manageddevicecleanuprule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicecleanuprule.md | doc_type: resourcePageType # managedDeviceCleanupRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Define the rule when the admin wants the devices to be cleaned up. ## Methods |
v1.0 | Intune Devices Manageddevicecleanupsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicecleanupsettings.md | doc_type: resourcePageType # managedDeviceCleanupSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Define the rule when the admin wants the devices to be cleaned up. ## Properties |
v1.0 | Intune Devices Manageddevicelogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicelogcollectionrequest.md | - Title: "managedDeviceLogCollectionRequest resource type" -description: "Windows Log Collection request" ---doc_type: resourcePageType ---# managedDeviceLogCollectionRequest resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Windows Log Collection request --## Properties -|Property|Type|Description| -|:|:|:| -|requestId|String|The unique identifier in the form of tenantId_deviceId_requestId.| -|status|[appLogUploadState](../resources/intune-devices-apploguploadstate.md)|Indicates the status for the app log collection request if it is pending, completed or failed, Default is pending. Possible values are: `pending`, `completed`, `failed`, `unknownFutureValue`.| -|managedDeviceId|Guid|Indicates Intune device unique identifier.| -|errorCode|Int64|The error code, if any. Valid values -9.22337203685478E+18 to 9.22337203685478E+18| -|requestedDateTimeUTC|DateTimeOffset|The DateTime of the request was created.| -|completedDateTimeUTC|DateTimeOffset|The DateTime the request was completed.| -|initiatedByUserPrincipalName|String|The UPN for who initiated the request.| -|expirationDateTimeUTC|DateTimeOffset|The DateTime of the expiration of the logs.| -|size|Double|The size of the logs. Valid values -1.79769313486232E+308 to 1.79769313486232E+308| -|sizeInKB|Double|The size of the logs in KB. Valid values -1.79769313486232E+308 to 1.79769313486232E+308| -|enrolledByUserPrincipalName|String|The User Principal Name (UPN) of the user that enrolled the device.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.managedDeviceLogCollectionRequest" -} >-``` json -{ - "@odata.type": "#microsoft.graph.managedDeviceLogCollectionRequest", - "requestId": "String", - "status": "String", - "managedDeviceId": "Guid", - "errorCode": 1024, - "requestedDateTimeUTC": "String (timestamp)", - "completedDateTimeUTC": "String (timestamp)", - "initiatedByUserPrincipalName": "String", - "expirationDateTimeUTC": "String (timestamp)", - "size": "4.2", - "sizeInKB": "4.2", - "enrolledByUserPrincipalName": "String" -} -``` |
v1.0 | Intune Devices Manageddevicemanagementfeatures | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicemanagementfeatures.md | doc_type: enumPageType # managedDeviceManagementFeatures enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device management features. ## Members |
v1.0 | Intune Devices Manageddevicemodelsandmanufacturers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicemodelsandmanufacturers.md | doc_type: resourcePageType # managedDeviceModelsAndManufacturers resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Models and Manufactures meatadata for managed devices in the account ## Properties |
v1.0 | Intune Devices Manageddeviceoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddeviceoverview.md | doc_type: resourcePageType # managedDeviceOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Summary data for managed devices ## Methods |
v1.0 | Intune Devices Manageddevicepartnerreportedhealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddevicepartnerreportedhealthstate.md | doc_type: enumPageType # managedDevicePartnerReportedHealthState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Available health states for the Device Health API ## Members |
v1.0 | Intune Devices Manageddeviceremoteaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-manageddeviceremoteaction.md | doc_type: enumPageType # managedDeviceRemoteAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Managedinstallerstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-managedinstallerstatus.md | doc_type: enumPageType # managedInstallerStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ManagedInstallerStatus ## Members |
v1.0 | Intune Devices Managementstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-managementstate.md | doc_type: enumPageType # managementState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Management state of device in Microsoft Intune. ## Members |
v1.0 | Intune Devices Mobileapptroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-mobileapptroubleshootingevent.md | doc_type: resourcePageType # mobileAppTroubleshootingEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MobileAppTroubleshootingEvent Entity. ## Methods |
v1.0 | Intune Devices Obliterationbehavior | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-obliterationbehavior.md | doc_type: enumPageType # obliterationBehavior enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - In macOS 12 and later, this command uses Erase All Content and Settings (EACS) on Mac computers with the Apple M1 chip or the Apple T2 Security Chip. On those devices, if EACS canΓÇÖt run, the device can use obliteration (macOS 11.x behavior). This key has no effect on machines prior to the T2 chip. Upon receiving this command, the device performs preflight checks to determine if the device is in a state that allows EACS. The ObliterationBehavior value defines the device's fallback behavior. ## Members |
v1.0 | Intune Devices Operatingsystemupgradeeligibility | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-operatingsystemupgradeeligibility.md | doc_type: enumPageType # operatingSystemUpgradeEligibility enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Work From Anywhere windows device upgrade eligibility status. ## Members |
v1.0 | Intune Devices Osversioncount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-osversioncount.md | doc_type: resourcePageType # osVersionCount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Count of devices with malware for each OS version ## Properties |
v1.0 | Intune Devices Powerliftappdiagnosticdownloadrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-powerliftappdiagnosticdownloadrequest.md | + + Title: "powerliftAppDiagnosticDownloadRequest resource type" +description: "This type contains request details to download app diagnostic files." ++ms.localizationpriority: medium ++++# powerliftAppDiagnosticDownloadRequest resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++This type contains request details to download app diagnostic files. ++## Properties +|Property|Type|Description| +|:|:|:| +|powerliftId|String|The unique id for the request that serves as an identifer for the diagnostic to be downloaded.| +|files|String collection|The list of files to download which is associated with the diagnostic.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.powerliftAppDiagnosticDownloadRequest" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.powerliftAppDiagnosticDownloadRequest", + "powerliftId": "String", + "files": [ + "String" + ] +} +``` |
v1.0 | Intune Devices Powerliftdownloadrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-powerliftdownloadrequest.md | doc_type: resourcePageType # powerliftDownloadRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Request used to download app diagnostic files. ## Properties |
v1.0 | Intune Devices Powerliftincidentdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-powerliftincidentdetail.md | + + Title: "powerliftIncidentDetail resource type" +description: "This type contains specific information regarding a Powerlift incident, such as when it was uploaded, the platform the device was on, and a string array of files associated to the incident." ++ms.localizationpriority: medium ++++# powerliftIncidentDetail resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++This type contains specific information regarding a Powerlift incident, such as when it was uploaded, the platform the device was on, and a string array of files associated to the incident. ++## Properties +|Property|Type|Description| +|:|:|:| +|powerliftId|String|The unique identifier of the app diagnostic. This id is assigned to a diagnostic when it is uploaded to Powerlift. Example: 8520467a-49a9-44a4-8447-8dfb8bec6726| +|easyId|String|The unique app diagnostic identifier as a user friendly 8 character hexadecimal string. This id is smaller compared to the powerliftId. Th Example: 8520467A| +|createdDateTime|DateTimeOffset|The time the app diagnostic was created. The value cannot be modified and is automatically populated when the diagnostic is uploaded. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.Example: 2022-04-19T17:24:45.313Z| +|platformDisplayName|String|The operating system of the device from which diagnostics are collected. Example: iOS| +|applicationName|String|TThe name of the application for which the diagnostic is collected. Example: com.microsoft.CompanyPortal | No| +|clientApplicationVersion|String|The version of the application for which the diagnostic is collected. Example: 5.2203.1| +|locale|String|The locale information of the application for which the diagnostic is collected. Example: en-US| +|fileNames|String collection|A list of files that are associated with the diagnostic.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.powerliftIncidentDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.powerliftIncidentDetail", + "powerliftId": "String", + "easyId": "String", + "createdDateTime": "String (timestamp)", + "platformDisplayName": "String", + "applicationName": "String", + "clientApplicationVersion": "String", + "locale": "String", + "fileNames": [ + "String" + ] +} +``` |
v1.0 | Intune Devices Powerliftincidentmetadata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-powerliftincidentmetadata.md | doc_type: resourcePageType # powerliftIncidentMetadata resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Collection of app diagnostics associated with a user. ## Properties |
v1.0 | Intune Devices Privilegemanagementendusertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-privilegemanagementendusertype.md | doc_type: enumPageType # privilegeManagementEndUserType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of user account on Windows that was used to performed the elevation. ## Members |
v1.0 | Intune Devices Privilegemanagementprocesstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-privilegemanagementprocesstype.md | doc_type: enumPageType # privilegeManagementProcessType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of elevated process ## Members |
v1.0 | Intune Devices Remediationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remediationstate.md | doc_type: enumPageType # remediationState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of execution status of the device management script. ## Members |
v1.0 | Intune Devices Remoteaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remoteaction.md | doc_type: enumPageType # remoteAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Remote actions Intune supports. ## Members |
v1.0 | Intune Devices Remoteactionaudit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remoteactionaudit.md | doc_type: resourcePageType # remoteActionAudit resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Report of remote actions initiated on the devices belonging to a certain tenant. ## Methods Report of remote actions initiated on the devices belonging to a certain tenant. |actionState|[actionState](../resources/intune-shared-actionstate.md)|Action state. Possible values are: `none`, `pending`, `canceled`, `active`, `done`, `failed`, `notSupported`.| |managedDeviceId|String|Action target.| |deviceActionDetails|[keyValuePair_2OfString_String](../resources/intune-devices-keyvaluepair_2ofstring_string.md) collection|DeviceAction details|-|deviceActionCategory|[actionCategory](../resources/intune-devices-actioncategory.md)|DeviceAction category. Possible values are: `single`, `bulk`.| +|deviceActionCategory|[deviceActionCategory](../resources/intune-devices-deviceactioncategory.md)|DeviceAction category. Possible values are: `single`, `bulk`.| |bulkDeviceActionId|String|BulkAction ID| ## Relationships |
v1.0 | Intune Devices Remotelockactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-remotelockactionresult.md | doc_type: resourcePageType # remoteLockActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Lock action result with a pin to unlock |
v1.0 | Intune Devices Resetpasscodeactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-resetpasscodeactionresult.md | doc_type: resourcePageType # resetPasscodeActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Reset passcode action result |
v1.0 | Intune Devices Revokeapplevpplicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-revokeapplevpplicensesactionresult.md | doc_type: resourcePageType # revokeAppleVppLicensesActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Revoke Apple Vpp licenses action result |
v1.0 | Intune Devices Rotatebitlockerkeysdeviceactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-rotatebitlockerkeysdeviceactionresult.md | doc_type: resourcePageType # rotateBitLockerKeysDeviceActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - RotateBitLockerKeys device action result |
v1.0 | Intune Devices Runasaccounttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-runasaccounttype.md | doc_type: enumPageType # runAsAccountType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the type of execution context the device management script runs in. ## Members |
v1.0 | Intune Devices Sharedappledeviceuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-sharedappledeviceuser.md | doc_type: resourcePageType # sharedAppleDeviceUser resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Devices Supplementaldevicedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-supplementaldevicedetail.md | - Title: "supplementalDeviceDetail resource type" -description: "Represents a property of the device." ---doc_type: resourcePageType ---# supplementalDeviceDetail resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Represents a property of the device. --## Properties -|Property|Type|Description| -|:|:|:| -|propertyName|String|The name of a property provided by the device, e.g. `SupplementalDeviceOSVersion`, `DiagnosticSubmissionEnabled`, `IsActivationLockSupported`, etc. This will directly match what is provided by the device. Read only.| -|propertyValue|String|The value of a property provided by the device, e.g. `(a)`, `true`. This will directly match what is provided by the device. Read only.| -|propertyType|String|The object type of a property provided by the device, e.g. `boolean`, `string`, `datetime`, '`dictionary`. Any complex type will be represented as a dictionary. Read only.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "@odata.type": "microsoft.graph.supplementalDeviceDetail" -} >-``` json -{ - "@odata.type": "#microsoft.graph.supplementalDeviceDetail", - "propertyName": "String", - "propertyValue": "String", - "propertyType": "String" -} -``` |
v1.0 | Intune Devices Systemmanagementmodelevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-systemmanagementmodelevel.md | doc_type: enumPageType # systemManagementModeLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A list of possible System Management Mode levels for a device. System Management Mode levels is determined by report sent from Microsoft Azure Attestation service. Only specific hardwares support System Management Mode. Windows 11 devices will have values "notApplicable", "level1", "level2" or "level3". Windows 10 devices will have value "notApplicable". ## Members |
v1.0 | Intune Devices Tenantattachrbac | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-tenantattachrbac.md | doc_type: resourcePageType # tenantAttachRBAC resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for tenant attach enablement functionality. ## Methods |
v1.0 | Intune Devices Tenantattachrbacstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-tenantattachrbacstate.md | doc_type: resourcePageType # tenantAttachRBACState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents result of GetState API. ## Properties |
v1.0 | Intune Devices Updatewindowsdeviceaccountactionparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-updatewindowsdeviceaccountactionparameter.md | doc_type: resourcePageType # updateWindowsDeviceAccountActionParameter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Devices User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-user.md | Namespace: microsoft.graph ## Methods |Method|Return Type|Description| |:|:|:|-|[List users](../api/intune-devices-user-list.md)|[user](../resources/intune-shared-user.md) collection|List properties and relationships of the [user](../resources/intune-shared-user.md) objects.| -|[Get user](../api/intune-devices-user-get.md)|[user](../resources/intune-shared-user.md)|Read properties and relationships of the [user](../resources/intune-shared-user.md) object.| -|[Create user](../api/intune-devices-user-create.md)|[user](../resources/intune-shared-user.md)|Create a new [user](../resources/intune-shared-user.md) object.| -|[Delete user](../api/intune-devices-user-delete.md)|None|Deletes a [user](../resources/intune-shared-user.md).| -|[Update user](../api/intune-devices-user-update.md)|[user](../resources/intune-shared-user.md)|Update the properties of a [user](../resources/intune-shared-user.md) object.| +|[List users](../api/intune-devices-user-list.md)|[user](../resources/intune-devices-user.md) collection|List properties and relationships of the [user](../resources/intune-devices-user.md) objects.| +|[Get user](../api/intune-devices-user-get.md)|[user](../resources/intune-devices-user.md)|Read properties and relationships of the [user](../resources/intune-devices-user.md) object.| +|[Create user](../api/intune-devices-user-create.md)|[user](../resources/intune-devices-user.md)|Create a new [user](../resources/intune-devices-user.md) object.| +|[Delete user](../api/intune-devices-user-delete.md)|None|Deletes a [user](../resources/intune-devices-user.md).| +|[Update user](../api/intune-devices-user-update.md)|[user](../resources/intune-devices-user.md)|Update the properties of a [user](../resources/intune-devices-user.md) object.| |[removeAllDevicesFromManagement action](../api/intune-devices-user-removealldevicesfrommanagement.md)|None|Retire all devices from management for this user| |[getLoggedOnManagedDevices function](../api/intune-devices-user-getloggedonmanageddevices.md)|[managedDevice](../resources/intune-devices-manageddevice.md) collection|| Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.user", "id": "String (identifier)" }-``` +``` |
v1.0 | Intune Devices Userexperienceanalyticsanomaly | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomaly.md | doc_type: resourcePageType # userExperienceAnalyticsAnomaly resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics anomaly entity contains anomaly details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsanomalycorrelationgroupfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalycorrelationgroupfeature.md | doc_type: resourcePageType # userExperienceAnalyticsAnomalyCorrelationGroupFeature resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes the features of a device that are shared between all devices in a correlation group. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsanomalycorrelationgroupoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalycorrelationgroupoverview.md | doc_type: resourcePageType # userExperienceAnalyticsAnomalyCorrelationGroupOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics anomaly correlation group overview entity contains the information for each correlation group of an anomaly. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsanomalycorrelationgroupprevalence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalycorrelationgroupprevalence.md | doc_type: enumPageType # userExperienceAnalyticsAnomalyCorrelationGroupPrevalence enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the level of prevalence of the correlation group features in the anomaly. Possible values are: high, medium or low ## Members |
v1.0 | Intune Devices Userexperienceanalyticsanomalydevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalydevice.md | doc_type: resourcePageType # userExperienceAnalyticsAnomalyDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics anomaly entity contains device details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsanomalydevicefeaturetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalydevicefeaturetype.md | doc_type: enumPageType # userExperienceAnalyticsAnomalyDeviceFeatureType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the device's feature type. Possible values are: manufacturer, model, osVersion, application or driver. ## Members |
v1.0 | Intune Devices Userexperienceanalyticsanomalyseverity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalyseverity.md | doc_type: enumPageType # userExperienceAnalyticsAnomalySeverity enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the severity of the anomaly. Eg: anomaly severity can be high, medium, low, informational or other. ## Members |
v1.0 | Intune Devices Userexperienceanalyticsanomalyseverityoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalyseverityoverview.md | doc_type: resourcePageType # userExperienceAnalyticsAnomalySeverityOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics anomaly severity overview entity contains the count information for each severity of anomaly. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsanomalystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalystate.md | doc_type: enumPageType # userExperienceAnalyticsAnomalyState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the state of the anomaly. Eg: anomaly severity can be new, active, disabled, removed or other. ## Members |
v1.0 | Intune Devices Userexperienceanalyticsanomalytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsanomalytype.md | doc_type: enumPageType # userExperienceAnalyticsAnomalyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the category of the anomaly. Eg: anomaly type can be device, application, stop error, driver or other. ## Members |
v1.0 | Intune Devices Userexperienceanalyticsapphealthapplicationperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthapplicationperformance.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthApplicationPerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics application performance entity contains application performance details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyappversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversion.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthAppPerformanceByAppVersion resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics application performance entity contains app performance details by app version. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyappversiondetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondetails.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics application performance entity contains application performance by application version details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyappversiondeviceid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyappversiondeviceid.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthAppPerformanceByAppVersionDeviceId resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics application performance entity contains application performance by application version device id. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthappperformancebyosversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthappperformancebyosversion.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthAppPerformanceByOSVersion resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics application performance entity contains app performance details by OS version. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthdevicemodelperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthdevicemodelperformance.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthDeviceModelPerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device model performance entity contains device model performance details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthdeviceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthdeviceperformance.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthDevicePerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device performance entity contains device performance details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthdeviceperformancedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthdeviceperformancedetails.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthDevicePerformanceDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device performance entity contains device performance details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsapphealthosversionperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsapphealthosversionperformance.md | doc_type: resourcePageType # userExperienceAnalyticsAppHealthOSVersionPerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device OS version performance entity contains OS version performance details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsautopilotdevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsautopilotdevicessummary.md | doc_type: resourcePageType # userExperienceAnalyticsAutopilotDevicesSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics summary of Devices not windows autopilot ready. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsbaseline | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbaseline.md | doc_type: resourcePageType # userExperienceAnalyticsBaseline resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics baseline entity contains baseline values against which to compare the user experience analytics scores. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthappimpact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthappimpact.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthAppImpact resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health app impact entity contains battery usage related information at an app level for the tenant. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthcapacitydetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthcapacitydetails.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthCapacityDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health capacity entity contains count of devices broken down into 3 categories - devices with capacity > 80%, devices with capacity 50-80% and devices with capacity < 50 %.This API provides the count of devices in these 3 categories.. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthdeviceappimpact | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceappimpact.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthDeviceAppImpact resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health device app impact entity contains battery usage related information at an app level for a given device. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthdeviceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceperformance.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthDevicePerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health device performance entity contains device level battery information. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthdeviceruntimehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthdeviceruntimehistory.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthDeviceRuntimeHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health runtime history entity contains the trend of runtime of a device over a period of 30 days ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthmodelperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthmodelperformance.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthModelPerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health model performance entity contains battery related information for all unique device models in their organization. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthosperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthosperformance.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthOsPerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health os performance entity contains battery related information for all operating system versions in their organization. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsbatteryhealthruntimedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsbatteryhealthruntimedetails.md | doc_type: resourcePageType # userExperienceAnalyticsBatteryHealthRuntimeDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics battery health runtime entity contains count of devices broken down into 3 categories - devices with runtime > 5 hours, devices with runtime 3-5 hours and devices with runtime < 3 hours.This API provides the count of devices in these 3 categories. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticscategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticscategory.md | doc_type: resourcePageType # userExperienceAnalyticsCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics category entity contains the scores and insights for the various metrics of a category. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticscloudidentitydevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticscloudidentitydevicessummary.md | doc_type: resourcePageType # userExperienceAnalyticsCloudIdentityDevicesSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics work from anywhere cloud identity devices summary. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticscloudmanagementdevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticscloudmanagementdevicessummary.md | doc_type: resourcePageType # userExperienceAnalyticsCloudManagementDevicesSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience work from anywhere Cloud management devices summary. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsdevicebatterydetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicebatterydetail.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceBatteryDetail resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Collection of properties describing the current status of the battery. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsdeviceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdeviceperformance.md | doc_type: resourcePageType # userExperienceAnalyticsDevicePerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device performance entity contains device boot performance details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsdevicescope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicescope.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceScope resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device scope entity contains device scope configuration values use to apply filtering on the endpoint analytics reports. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsdevicescopesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicescopesummary.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceScopeSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics tenant level information for all the device scope configurations ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsdevicescores | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicescores.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceScores resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device scores entity consolidates the various Endpoint Analytics scores. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsdevicestartuphistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestartuphistory.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceStartupHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device startup history entity contains device boot performance history details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsdevicestartupprocess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestartupprocess.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceStartupProcess resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device startup process details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsdevicestartupprocessperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestartupprocessperformance.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceStartupProcessPerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device startup process performance. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsdevicestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicestatus.md | doc_type: enumPageType # userExperienceAnalyticsDeviceStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the status of the device in the correlation group. Eg: Device status can be anomalous, affected, at risk. ## Members |
v1.0 | Intune Devices Userexperienceanalyticsdevicetimelineevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicetimelineevent.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceTimelineEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device event entity contains NRT device event details. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsdevicewithoutcloudidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsdevicewithoutcloudidentity.md | doc_type: resourcePageType # userExperienceAnalyticsDeviceWithoutCloudIdentity resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics Device without Cloud Identity. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticshealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticshealthstate.md | doc_type: enumPageType # userExperienceAnalyticsHealthState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Devices Userexperienceanalyticsimpactingprocess | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsimpactingprocess.md | doc_type: resourcePageType # userExperienceAnalyticsImpactingProcess resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics top impacting process entity. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsinsight | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsinsight.md | doc_type: resourcePageType # userExperienceAnalyticsInsight resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics insight is the recomendation to improve the user experience analytics score. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsinsightseverity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsinsightseverity.md | doc_type: enumPageType # userExperienceAnalyticsInsightSeverity enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates severity of insights. Possible values are: None, Informational, Warning, Error. ## Members |
v1.0 | Intune Devices Userexperienceanalyticsinsightvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsinsightvalue.md | doc_type: resourcePageType # userExperienceAnalyticsInsightValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The value in an user experience analytics insight. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsmachinetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmachinetype.md | doc_type: enumPageType # userExperienceAnalyticsMachineType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates if machine is physical or virtual. Possible values are: physical or virtual ## Members |
v1.0 | Intune Devices Userexperienceanalyticsmetric | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmetric.md | doc_type: resourcePageType # userExperienceAnalyticsMetric resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics metric contains the score and units of a metric of a user experience anlaytics category. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsmetrichistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmetrichistory.md | doc_type: resourcePageType # userExperienceAnalyticsMetricHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics metric history. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsmodelscores | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsmodelscores.md | doc_type: resourcePageType # userExperienceAnalyticsModelScores resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics model scores entity consolidates the various Endpoint Analytics scores. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsnotautopilotreadydevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsnotautopilotreadydevice.md | doc_type: resourcePageType # userExperienceAnalyticsNotAutopilotReadyDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics Device not windows autopilot ready. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsoperatingsystemrestartcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsoperatingsystemrestartcategory.md | doc_type: enumPageType # userExperienceAnalyticsOperatingSystemRestartCategory enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Operating System restart category. ## Members |
v1.0 | Intune Devices Userexperienceanalyticsoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsoverview.md | doc_type: resourcePageType # userExperienceAnalyticsOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics overview entity contains the overall score and the scores and insights of every metric of all categories. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsremoteconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsremoteconnection.md | Title: "userExperienceAnalyticsRemoteConnection resource type" -description: "The user experience analyte remote connection entity." +description: "The user experience analytics remote connection entity. The report will be retired on December 31, 2024. You can start using the Cloud PC connection quality report now via https://learn.microsoft.com/windows-365/enterprise/report-cloud-pc-connection-quality." ms.localizationpriority: medium doc_type: resourcePageType # userExperienceAnalyticsRemoteConnection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --The user experience analyte remote connection entity. +The user experience analytics remote connection entity. The report will be retired on December 31, 2024. You can start using the Cloud PC connection quality report now via https://learn.microsoft.com/windows-365/enterprise/report-cloud-pc-connection-quality. ## Methods |Method|Return Type|Description| |
v1.0 | Intune Devices Userexperienceanalyticsresourceperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsresourceperformance.md | doc_type: resourcePageType # userExperienceAnalyticsResourcePerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics resource performance entity. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsscorehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsscorehistory.md | doc_type: resourcePageType # userExperienceAnalyticsScoreHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device startup score history. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticssettings.md | doc_type: resourcePageType # userExperienceAnalyticsSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics insight is the recomendation to improve the user experience analytics score. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticssummarizedby | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticssummarizedby.md | doc_type: enumPageType # userExperienceAnalyticsSummarizedBy enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates type of summarization. Possible values are: None, Model, AllRegressions, ModelRegression, ManufacturerRegression, OperatingSystemVersionRegression. ## Members |
v1.0 | Intune Devices Userexperienceanalyticswindows10devicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticswindows10devicessummary.md | doc_type: resourcePageType # userExperienceAnalyticsWindows10DevicesSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics work from anywhere Windows 10 devices summary. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheredevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheredevice.md | doc_type: resourcePageType # userExperienceAnalyticsWorkFromAnywhereDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics device for work from anywhere report. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheredevicessummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheredevicessummary.md | doc_type: resourcePageType # userExperienceAnalyticsWorkFromAnywhereDevicesSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics Work From Anywhere metrics devices summary. ## Properties |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywherehardwarereadinessmetric | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywherehardwarereadinessmetric.md | doc_type: resourcePageType # userExperienceAnalyticsWorkFromAnywhereHardwareReadinessMetric resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics hardware readiness entity contains account level information about hardware blockers for windows upgrade. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheremetric | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheremetric.md | doc_type: resourcePageType # userExperienceAnalyticsWorkFromAnywhereMetric resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics metric for work from anywhere report. ## Methods |
v1.0 | Intune Devices Userexperienceanalyticsworkfromanywheremodelperformance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-userexperienceanalyticsworkfromanywheremodelperformance.md | doc_type: resourcePageType # userExperienceAnalyticsWorkFromAnywhereModelPerformance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The user experience analytics work from anywhere model performance. ## Methods |
v1.0 | Intune Devices Windowsdefenderproductstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdefenderproductstatus.md | doc_type: enumPageType # windowsDefenderProductStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Product Status of Windows Defender ## Members |
v1.0 | Intune Devices Windowsdefenderscanactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdefenderscanactionresult.md | doc_type: resourcePageType # windowsDefenderScanActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Defender last scan result |
v1.0 | Intune Devices Windowsdeviceaccount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdeviceaccount.md | doc_type: resourcePageType # windowsDeviceAccount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Devices Windowsdeviceadaccount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdeviceadaccount.md | doc_type: resourcePageType # windowsDeviceADAccount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [windowsDeviceAccount](../resources/intune-devices-windowsdeviceaccount.md) ## Properties |
v1.0 | Intune Devices Windowsdeviceazureadaccount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdeviceazureadaccount.md | doc_type: resourcePageType # windowsDeviceAzureADAccount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [windowsDeviceAccount](../resources/intune-devices-windowsdeviceaccount.md) ## Properties |
v1.0 | Intune Devices Windowsdevicehealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdevicehealthstate.md | doc_type: enumPageType # windowsDeviceHealthState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Computer endpoint protection state ## Members |
v1.0 | Intune Devices Windowsdevicemalwarestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsdevicemalwarestate.md | doc_type: resourcePageType # windowsDeviceMalwareState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware detection entity. ## Methods |
v1.0 | Intune Devices Windowsmalwarecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarecategory.md | doc_type: enumPageType # windowsMalwareCategory enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware category id ## Members |
v1.0 | Intune Devices Windowsmalwarecategorycount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarecategorycount.md | doc_type: resourcePageType # windowsMalwareCategoryCount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware category device count ## Properties |
v1.0 | Intune Devices Windowsmalwareexecutionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareexecutionstate.md | doc_type: enumPageType # windowsMalwareExecutionState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware execution status ## Members |
v1.0 | Intune Devices Windowsmalwareexecutionstatecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareexecutionstatecount.md | doc_type: resourcePageType # windowsMalwareExecutionStateCount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows malware execution state summary. ## Properties |
v1.0 | Intune Devices Windowsmalwareinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareinformation.md | doc_type: resourcePageType # windowsMalwareInformation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware information entity. ## Methods |
v1.0 | Intune Devices Windowsmalwarenamecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarenamecount.md | doc_type: resourcePageType # windowsMalwareNameCount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware name device count ## Properties |
v1.0 | Intune Devices Windowsmalwareoverview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareoverview.md | doc_type: resourcePageType # windowsMalwareOverview resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows device malware overview. ## Properties |
v1.0 | Intune Devices Windowsmalwareseverity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareseverity.md | doc_type: enumPageType # windowsMalwareSeverity enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware severity ## Members |
v1.0 | Intune Devices Windowsmalwareseveritycount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwareseveritycount.md | doc_type: resourcePageType # windowsMalwareSeverityCount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Malware Severity Count Summary ## Properties |
v1.0 | Intune Devices Windowsmalwarestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarestate.md | doc_type: enumPageType # windowsMalwareState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware current status ## Members |
v1.0 | Intune Devices Windowsmalwarestatecount | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarestatecount.md | doc_type: resourcePageType # windowsMalwareStateCount resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Malware State Summary. ## Properties |
v1.0 | Intune Devices Windowsmalwarethreatstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmalwarethreatstate.md | doc_type: enumPageType # windowsMalwareThreatState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Malware threat status ## Members |
v1.0 | Intune Devices Windowsmanagementapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmanagementapp.md | doc_type: resourcePageType # windowsManagementApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows management app entity. ## Methods |
v1.0 | Intune Devices Windowsmanagementapphealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsmanagementapphealthstate.md | doc_type: resourcePageType # windowsManagementAppHealthState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows management app health state entity. ## Methods |
v1.0 | Intune Devices Windowsprotectionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-devices-windowsprotectionstate.md | doc_type: resourcePageType # windowsProtectionState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device protection status entity. ## Methods |
v1.0 | Intune Enrollment Activedirectorywindowsautopilotdeploymentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-activedirectorywindowsautopilotdeploymentprofile.md | doc_type: resourcePageType # activeDirectoryWindowsAutopilotDeploymentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Autopilot Deployment Profile |
v1.0 | Intune Enrollment Appleenrollmentprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleenrollmentprofileassignment.md | doc_type: resourcePageType # appleEnrollmentProfileAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An assignment of an Apple profile. ## Methods |
v1.0 | Intune Enrollment Appleownertypeenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleownertypeenrollmenttype.md | doc_type: resourcePageType # appleOwnerTypeEnrollmentType resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Enrollment Appleuserinitiatedenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleuserinitiatedenrollmentprofile.md | doc_type: resourcePageType # appleUserInitiatedEnrollmentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The enrollmentProfile resource represents a collection of configurations which must be provided pre-enrollment to enable enrolling certain devices whose identities have been pre-staged. Pre-staged device identities are assigned to this type of profile to apply the profile's configurations at enrollment of the corresponding device. ## Methods |
v1.0 | Intune Enrollment Appleuserinitiatedenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-appleuserinitiatedenrollmenttype.md | doc_type: enumPageType # appleUserInitiatedEnrollmentType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Azureadwindowsautopilotdeploymentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-azureadwindowsautopilotdeploymentprofile.md | doc_type: resourcePageType # azureADWindowsAutopilotDeploymentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Autopilot Deployment Profile |
v1.0 | Intune Enrollment Deletedwindowsautopilotdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deletedwindowsautopilotdevicestate.md | doc_type: resourcePageType # deletedWindowsAutopilotDeviceState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Enrollment Depenrollmentbaseprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depenrollmentbaseprofile.md | doc_type: resourcePageType # depEnrollmentBaseProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The DepEnrollmentBaseProfile resource represents an Apple Device Enrollment Program (DEP) enrollment profile. This type of profile must be assigned to Apple DEP serial numbers before the corresponding devices can enroll via DEP. |
v1.0 | Intune Enrollment Depenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depenrollmentprofile.md | doc_type: resourcePageType # depEnrollmentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The depEnrollmentProfile resource represents an Apple Device Enrollment Program (DEP) enrollment profile. This type of profile must be assigned to Apple DEP serial numbers before the corresponding devices can enroll via DEP. |
v1.0 | Intune Enrollment Depiosenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depiosenrollmentprofile.md | doc_type: resourcePageType # depIOSEnrollmentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The DepIOSEnrollmentProfile resource represents an Apple Device Enrollment Program (DEP) enrollment profile specific to iOS configuration. This type of profile must be assigned to Apple DEP serial numbers before the corresponding devices can enroll via DEP. |
v1.0 | Intune Enrollment Depmacosenrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-depmacosenrollmentprofile.md | doc_type: resourcePageType # depMacOSEnrollmentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The DepMacOSEnrollmentProfile resource represents an Apple Device Enrollment Program (DEP) enrollment profile specific to macOS configuration. This type of profile must be assigned to Apple DEP serial numbers before the corresponding devices can enroll via DEP. |
v1.0 | Intune Enrollment Deponboardingsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deponboardingsetting.md | doc_type: resourcePageType # depOnboardingSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The depOnboardingSetting represents an instance of the Apple DEP service being onboarded to Intune. The onboarded service instance manages an Apple Token used to synchronize data between Apple and Intune. ## Methods |
v1.0 | Intune Enrollment Deptokentype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deptokentype.md | doc_type: enumPageType # depTokenType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The deviceManagement resource represents a tenant's collection device identities that have been pre-staged in Intune, and the enrollment profiles that may be assigned to device identities that support pre-enrollment configuration. ## Methods |
v1.0 | Intune Enrollment Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-deviceplatformtype.md | doc_type: enumPageType # devicePlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types. ## Members Supported platform types. |androidWorkProfile|7|Indicates device platform type is Android Work Profile.| |unknown|8|This is the default value when device platform type resolution fails| |androidAOSP|9|Indicates device platform type is Android AOSP.|-|androidMobileApplicationManagement|10|Indicates Mobile Application Management (MAM) for android devices.| -|iOSMobileApplicationManagement|11|Indicates Mobile Application Management (MAM) for iOS devices.| +|androidMobileApplicationManagement|10|Indicates device platform type associated with Mobile Application Management (MAM) for android devices.| +|iOSMobileApplicationManagement|11|Indicates device platform type associated with Mobile Application Management (MAM) for iOS devices.| |unknownFutureValue|12|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Enrollment Discoverysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-discoverysource.md | doc_type: enumPageType # discoverySource enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Enrollmentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-enrollmentprofile.md | doc_type: resourcePageType # enrollmentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The enrollmentProfile resource represents a collection of configurations which must be provided pre-enrollment to enable enrolling certain devices whose identities have been pre-staged. Pre-staged device identities are assigned to this type of profile to apply the profile's configurations at enrollment of the corresponding device. ## Methods |
v1.0 | Intune Enrollment Enrollmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-enrollmentstate.md | doc_type: enumPageType # enrollmentState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Importedappledeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedappledeviceidentity.md | doc_type: resourcePageType # importedAppleDeviceIdentity resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The importedAppleDeviceIdentity resource represents the imported device identity of an Apple device . ## Methods |
v1.0 | Intune Enrollment Importedappledeviceidentityresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedappledeviceidentityresult.md | doc_type: resourcePageType # importedAppleDeviceIdentityResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The importedAppleDeviceIdentityResult resource represents the result of attempting to import Apple devices identities. |
v1.0 | Intune Enrollment Importeddeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importeddeviceidentity.md | doc_type: resourcePageType # importedDeviceIdentity resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The importedDeviceIdentity resource represents a unique hardware identity of a device that has been pre-staged for pre-enrollment configuration. ## Methods |
v1.0 | Intune Enrollment Importeddeviceidentityresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importeddeviceidentityresult.md | doc_type: resourcePageType # importedDeviceIdentityResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The importedDeviceIdentityResult resource represents the result of attempting to import a device identity. |
v1.0 | Intune Enrollment Importeddeviceidentitytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importeddeviceidentitytype.md | doc_type: enumPageType # importedDeviceIdentityType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentity.md | doc_type: resourcePageType # importedWindowsAutopilotDeviceIdentity resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Imported windows autopilot devices. ## Methods |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentityimportstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentityimportstatus.md | doc_type: enumPageType # importedWindowsAutopilotDeviceIdentityImportStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentitystate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentitystate.md | doc_type: resourcePageType # importedWindowsAutopilotDeviceIdentityState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Enrollment Importedwindowsautopilotdeviceidentityuploadstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-importedwindowsautopilotdeviceidentityuploadstatus.md | doc_type: enumPageType # importedWindowsAutopilotDeviceIdentityUploadStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Itunespairingmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-itunespairingmode.md | doc_type: enumPageType # iTunesPairingMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Managementcertificatewiththumbprint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-managementcertificatewiththumbprint.md | doc_type: resourcePageType # managementCertificateWithThumbprint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Enrollment Outofboxexperiencesetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-outofboxexperiencesetting.md | doc_type: resourcePageType # outOfBoxExperienceSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Windows Autopilot Deployment Profile settings used by the device for the out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. ## Properties The Windows Autopilot Deployment Profile settings used by the device for the out |:|:|:| |privacySettingsHidden|Boolean|When TRUE, privacy settings is hidden to the end user during OOBE. When FALSE, privacy settings is shown to the end user during OOBE. Default value is FALSE.| |eulaHidden|Boolean|When TRUE, EULA is hidden to the end user during OOBE. When FALSE, EULA is shown to the end user during OOBE. Default value is FALSE.|-|userType|[windowsUserType](../resources/intune-enrollment-windowsusertype.md)|The type of user. Possible values are administrator and standard. Default value is administrator. Yes No. Possible values are: `administrator`, `standard`, `unknownFutureValue`.| +|userType|[windowsUserType](../resources/intune-enrollment-windowsusertype.md)|The type of user. Possible values are administrator and standard. Default value is administrator. Yes No +. Possible values are: `administrator`, `standard`, `unknownFutureValue`.| |deviceUsageType|[windowsDeviceUsageType](../resources/intune-enrollment-windowsdeviceusagetype.md)|The Entra join authentication type. Possible values are singleUser and shared. The default is singleUser. Possible values are: `singleUser`, `shared`, `unknownFutureValue`.| |keyboardSelectionPageSkipped|Boolean|When TRUE, the keyboard selection page is hidden to the end user during OOBE if Language and Region are set. When FALSE, the keyboard selection page is skipped during OOBE.| |escapeLinkHidden|Boolean|When TRUE, the link that allows user to start over with a different account on company sign-in is hidden. When false, the link that allows user to start over with a different account on company sign-in is available. Default value is FALSE.| |
v1.0 | Intune Enrollment Outofboxexperiencesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-outofboxexperiencesettings.md | doc_type: resourcePageType # outOfBoxExperienceSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Windows Autopilot Deployment Profile settings used by the Autopilot device for out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use outOfBoxExperienceSetting instead. ## Properties |
v1.0 | Intune Enrollment Platform | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-platform.md | doc_type: enumPageType # platform enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Suggestedenrollmentlimit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-suggestedenrollmentlimit.md | doc_type: resourcePageType # suggestedEnrollmentLimit resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The suggestedEnrollmentLimit resource represents the suggested enrollment limit when given an enrollment type. ## Properties |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeploymentprofile.md | doc_type: resourcePageType # windowsAutopilotDeploymentProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Autopilot Deployment Profile ## Methods |
v1.0 | Intune Enrollment Windowsautopilotdeploymentprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeploymentprofileassignment.md | doc_type: resourcePageType # windowsAutopilotDeploymentProfileAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An assignment of a Windows Autopilot deployment profile to an AAD group. ## Methods |
v1.0 | Intune Enrollment Windowsautopilotdevicedeletionstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdevicedeletionstate.md | doc_type: enumPageType # windowsAutopilotDeviceDeletionState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Windowsautopilotdeviceidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeviceidentity.md | doc_type: resourcePageType # windowsAutopilotDeviceIdentity resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The windowsAutopilotDeviceIdentity resource represents a Windows Autopilot Device. ## Methods |
v1.0 | Intune Enrollment Windowsautopilotdeviceremediationstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdeviceremediationstate.md | doc_type: enumPageType # windowsAutopilotDeviceRemediationState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device remediation status, indicating whether or not hardware has been changed for an Autopilot-registered device. ## Members |
v1.0 | Intune Enrollment Windowsautopilotdevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotdevicetype.md | doc_type: enumPageType # windowsAutopilotDeviceType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Windowsautopilotprofileassignmentdetailedstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotprofileassignmentdetailedstatus.md | doc_type: enumPageType # windowsAutopilotProfileAssignmentDetailedStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Windowsautopilotprofileassignmentstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotprofileassignmentstatus.md | doc_type: enumPageType # windowsAutopilotProfileAssignmentStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Windowsautopilotsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotsettings.md | doc_type: resourcePageType # windowsAutopilotSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The windowsAutopilotSettings resource represents a Windows Autopilot Account to sync data with Windows device data sync service. ## Methods |
v1.0 | Intune Enrollment Windowsautopilotsyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotsyncstatus.md | doc_type: enumPageType # windowsAutopilotSyncStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Windowsautopilotuserlessenrollmentstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsautopilotuserlessenrollmentstatus.md | doc_type: enumPageType # windowsAutopilotUserlessEnrollmentStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Userless enrollment block status, indicating whether the next device enrollment will be blocked. ## Members |
v1.0 | Intune Enrollment Windowsdeviceusagetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsdeviceusagetype.md | doc_type: enumPageType # windowsDeviceUsageType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Enrollment Windowsdomainjoinconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsdomainjoinconfiguration.md | doc_type: resourcePageType # windowsDomainJoinConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Enrollment Windowsenrollmentstatusscreensettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsenrollmentstatusscreensettings.md | doc_type: resourcePageType # windowsEnrollmentStatusScreenSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enrollment status screen setting ## Properties |
v1.0 | Intune Enrollment Windowsusertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-enrollment-windowsusertype.md | doc_type: enumPageType # windowsUserType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Epmgraphapiservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Epmgraphapiservice Elevationrequestapplicationdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-elevationrequestapplicationdetail.md | doc_type: resourcePageType # elevationRequestApplicationDetail resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The details of the application which the user has requested to elevate ## Properties |
v1.0 | Intune Epmgraphapiservice Elevationrequeststate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-elevationrequeststate.md | doc_type: enumPageType # elevationRequestState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates state of elevation request ## Members |
v1.0 | Intune Epmgraphapiservice Privilegemanagementelevationrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-epmgraphapiservice-privilegemanagementelevationrequest.md | doc_type: resourcePageType # privilegeManagementElevationRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - These are elevation approval requests for EPM support arbitrated scenario initiated by IW user that admins can take action on. ## Methods |
v1.0 | Intune Esim Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Esim Embeddedsimactivationcode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimactivationcode.md | doc_type: resourcePageType # embeddedSIMActivationCode resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The embedded SIM activation code as provided by the mobile operator. ## Properties |
v1.0 | Intune Esim Embeddedsimactivationcodepool | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimactivationcodepool.md | doc_type: resourcePageType # embeddedSIMActivationCodePool resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A pool represents a group of embedded SIM activation codes. ## Methods |
v1.0 | Intune Esim Embeddedsimactivationcodepoolassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimactivationcodepoolassignment.md | doc_type: resourcePageType # embeddedSIMActivationCodePoolAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The embedded SIM activation code pool assignment entity assigns a specific embeddedSIMActivationCodePool to an AAD device group. ## Methods |
v1.0 | Intune Esim Embeddedsimdevicestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimdevicestate.md | doc_type: resourcePageType # embeddedSIMDeviceState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes the embedded SIM activation code deployment state in relation to a device. ## Methods |
v1.0 | Intune Esim Embeddedsimdevicestatevalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-embeddedsimdevicestatevalue.md | doc_type: enumPageType # embeddedSIMDeviceStateValue enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes the various states for an embedded SIM activation code. ## Members |
v1.0 | Intune Esim Platformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-platformtype.md | doc_type: enumPageType # platformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Esim Tuple_2Ofexecutiontype_Icollection_1Ofoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-esim-tuple_2ofexecutiontype_icollection_1ofoperation.md | doc_type: resourcePageType # tuple_2OfExecutionType_ICollection_1OfOperation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Gpanalyticsservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Gpanalyticsservice Grouppolicymigrationreadiness | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicymigrationreadiness.md | doc_type: enumPageType # groupPolicyMigrationReadiness enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates if the Group Policy Object file is covered and ready for Intune migration. ## Members |
v1.0 | Intune Gpanalyticsservice Grouppolicymigrationreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicymigrationreport.md | doc_type: resourcePageType # groupPolicyMigrationReport resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Group Policy migration report. ## Methods |
v1.0 | Intune Gpanalyticsservice Grouppolicyobjectfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicyobjectfile.md | doc_type: resourcePageType # groupPolicyObjectFile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Group Policy Object file uploaded by admin. ## Methods |
v1.0 | Intune Gpanalyticsservice Grouppolicysettingmapping | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicysettingmapping.md | doc_type: resourcePageType # groupPolicySettingMapping resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Group Policy setting to MDM/Intune mapping. ## Methods |
v1.0 | Intune Gpanalyticsservice Grouppolicysettingscope | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicysettingscope.md | doc_type: enumPageType # groupPolicySettingScope enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Scope of the group policy setting. ## Members |
v1.0 | Intune Gpanalyticsservice Grouppolicysettingtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-grouppolicysettingtype.md | doc_type: enumPageType # groupPolicySettingType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting type of the group policy. ## Members |
v1.0 | Intune Gpanalyticsservice Mdmsupportedstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-mdmsupportedstate.md | doc_type: enumPageType # mdmSupportedState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Mdm Support Status of the setting. ## Members |
v1.0 | Intune Gpanalyticsservice Unsupportedgrouppolicyextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-gpanalyticsservice-unsupportedgrouppolicyextension.md | doc_type: resourcePageType # unsupportedGroupPolicyExtension resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Unsupported Group Policy Extension. ## Methods |
v1.0 | Intune Grouppolicy Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Grouppolicy Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-devicemanagementreports.md | doc_type: resourcePageType # deviceManagementReports resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all reports functionality. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicycategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicycategory.md | doc_type: resourcePageType # groupPolicyCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The category entity stores the category of a group policy definition ## Methods |
v1.0 | Intune Grouppolicy Grouppolicyconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfiguration.md | doc_type: resourcePageType # groupPolicyConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The group policy configuration entity contains the configured values for one or more group policy definitions. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicyconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfigurationassignment.md | doc_type: resourcePageType # groupPolicyConfigurationAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The group policy configuration assignment entity assigns one or more AAD groups to a specific group policy configuration. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicyconfigurationingestiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfigurationingestiontype.md | doc_type: enumPageType # groupPolicyConfigurationIngestionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Group Policy Configuration Ingestion Type ## Members |
v1.0 | Intune Grouppolicy Grouppolicyconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyconfigurationtype.md | doc_type: enumPageType # groupPolicyConfigurationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Group Policy Configuration Type ## Members |
v1.0 | Intune Grouppolicy Grouppolicydefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinition.md | doc_type: resourcePageType # groupPolicyDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity describes all of the information about a single group policy. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicydefinitionclasstype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinitionclasstype.md | doc_type: enumPageType # groupPolicyDefinitionClassType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Group Policy Definition Class Type. ## Members |
v1.0 | Intune Grouppolicy Grouppolicydefinitionfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinitionfile.md | doc_type: resourcePageType # groupPolicyDefinitionFile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents an ADMX (Administrative Template) XML file. The ADMX file contains a collection of group policy definitions and their locations by category path. The group policy definition file also contains the languages supported as determined by the language dependent ADML (Administrative Template) language files. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicydefinitionvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicydefinitionvalue.md | doc_type: resourcePageType # groupPolicyDefinitionValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The definition value entity stores the value for a single group policy definition. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicyoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyoperation.md | doc_type: resourcePageType # groupPolicyOperation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents an group policy operation. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicyoperationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyoperationstatus.md | doc_type: enumPageType # groupPolicyOperationStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of Group Policy operation status. ## Members |
v1.0 | Intune Grouppolicy Grouppolicyoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyoperationtype.md | doc_type: enumPageType # groupPolicyOperationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of Group Policy operation. ## Members |
v1.0 | Intune Grouppolicy Grouppolicypresentation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentation.md | doc_type: resourcePageType # groupPolicyPresentation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The base entity for the display presentation of any of the additional options in a group policy definition. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicypresentationcheckbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationcheckbox.md | doc_type: resourcePageType # groupPolicyPresentationCheckBox resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX checkBox element and an ADMX boolean element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationcombobox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationcombobox.md | doc_type: resourcePageType # groupPolicyPresentationComboBox resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX comboBox element and an ADMX text element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationdecimaltextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationdecimaltextbox.md | doc_type: resourcePageType # groupPolicyPresentationDecimalTextBox resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX decimalTextBox element and an ADMX decimal element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationdropdownlist | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationdropdownlist.md | doc_type: resourcePageType # groupPolicyPresentationDropdownList resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX dropdownList element and an ADMX enum element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationdropdownlistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationdropdownlistitem.md | doc_type: resourcePageType # groupPolicyPresentationDropdownListItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Grouppolicy Grouppolicypresentationlistbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationlistbox.md | doc_type: resourcePageType # groupPolicyPresentationListBox resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX listBox element and an ADMX list element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationlongdecimaltextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationlongdecimaltextbox.md | doc_type: resourcePageType # groupPolicyPresentationLongDecimalTextBox resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX longDecimalTextBox element and an ADMX longDecimal element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationmultitextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationmultitextbox.md | doc_type: resourcePageType # groupPolicyPresentationMultiTextBox resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX multiTextBox element and an ADMX multiText element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationtext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationtext.md | doc_type: resourcePageType # groupPolicyPresentationText resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX text element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationtextbox | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationtextbox.md | doc_type: resourcePageType # groupPolicyPresentationTextBox resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX textBox element and an ADMX text element. |
v1.0 | Intune Grouppolicy Grouppolicypresentationvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvalue.md | doc_type: resourcePageType # groupPolicyPresentationValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The base presentation value entity that stores the value for a single group policy presentation. ## Methods |
v1.0 | Intune Grouppolicy Grouppolicypresentationvalueboolean | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvalueboolean.md | doc_type: resourcePageType # groupPolicyPresentationValueBoolean resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents a Boolean value of a checkbox presentation on a policy definition. |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluedecimal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluedecimal.md | doc_type: resourcePageType # groupPolicyPresentationValueDecimal resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents an unsigned integer value of a decimal text box presentation on a policy definition. |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluelist | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluelist.md | doc_type: resourcePageType # groupPolicyPresentationValueList resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents a collection of name/value pairs of a list box presentation on a policy definition. |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluelongdecimal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluelongdecimal.md | doc_type: resourcePageType # groupPolicyPresentationValueLongDecimal resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents an unsigned long value of a long decimal text box presentation on a policy definition. |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluemultitext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluemultitext.md | doc_type: resourcePageType # groupPolicyPresentationValueMultiText resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents a string value of a multi-line text box presentation on a policy definition. |
v1.0 | Intune Grouppolicy Grouppolicypresentationvaluetext | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicypresentationvaluetext.md | doc_type: resourcePageType # groupPolicyPresentationValueText resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents a string value for a drop-down list, combo box, or text box presentation on a policy definition. |
v1.0 | Intune Grouppolicy Grouppolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicytype.md | doc_type: enumPageType # groupPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of Group Policy File or Definition. ## Members |
v1.0 | Intune Grouppolicy Grouppolicyuploadedcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadedcategory.md | doc_type: resourcePageType # groupPolicyUploadedCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The category entity stores the category of a group policy definition |
v1.0 | Intune Grouppolicy Grouppolicyuploadeddefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadeddefinition.md | doc_type: resourcePageType # groupPolicyUploadedDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity describes all of the information about a single group policy. |
v1.0 | Intune Grouppolicy Grouppolicyuploadeddefinitionfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadeddefinitionfile.md | doc_type: resourcePageType # groupPolicyUploadedDefinitionFile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents an ADMX (Administrative Template) XML file uploaded by Administrator. The ADMX file contains a collection of group policy definitions and their locations by category path. The group policy definition file also contains the languages supported as determined by the language dependent ADML (Administrative Template) language files. |
v1.0 | Intune Grouppolicy Grouppolicyuploadeddefinitionfilestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadeddefinitionfilestatus.md | doc_type: enumPageType # groupPolicyUploadedDefinitionFileStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of Group Policy uploaded definition file status. ## Members |
v1.0 | Intune Grouppolicy Grouppolicyuploadedlanguagefile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadedlanguagefile.md | doc_type: resourcePageType # groupPolicyUploadedLanguageFile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The entity represents an ADML (Administrative Template language) XML file uploaded by Administrator. ## Properties |
v1.0 | Intune Grouppolicy Grouppolicyuploadedpresentation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-grouppolicyuploadedpresentation.md | doc_type: resourcePageType # groupPolicyUploadedPresentation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an ADMX checkBox element and an ADMX boolean element. |
v1.0 | Intune Grouppolicy Ingestionsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-grouppolicy-ingestionsource.md | doc_type: enumPageType # ingestionSource enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Category Ingestion source ## Members |
v1.0 | Intune Mam Androidmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappprotection.md | doc_type: resourcePageType # androidManagedAppProtection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy used to configure detailed management settings targeted to specific security groups and for a specified set of apps on an Android device Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman |exemptedAppPackages|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|App packages in this list will be exempt from the policy and will be able to receive data from managed apps.| |minimumWipePatchVersion|String|Android security patch level less than or equal to the specified value will wipe the managed app and the associated company data.| |allowedAndroidDeviceManufacturers|String|Semicolon seperated list of device manufacturers allowed, as a string, for the managed app to work.|-|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfSamsungKnoxAttestationRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines the behavior of a managed app when Samsung Knox Attestation is required. Possible values are null, warn, block & wipe. If the admin does not set this action, the default is null, which indicates this setting is not configured. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfSamsungKnoxAttestationRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines the behavior of a managed app when Samsung Knox Attestation is required. Possible values are null, warn, block & wipe. If the admin does not set this action, the default is null, which indicates this setting is not configured. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetDeviceAttestationType|[androidManagedAppSafetyNetDeviceAttestationType](../resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md)|Defines the Android SafetyNet Device Attestation requirement for a managed app to work. Possible values are: `none`, `basicIntegrity`, `basicIntegrityAndDeviceCertification`.|-|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetAppsVerificationType|[androidManagedAppSafetyNetAppsVerificationType](../resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md)|Defines the Android SafetyNet Apps Verification requirement for a managed app to work. Possible values are: `none`, `enabled`.|-|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customBrowserPackageId|String|Unique identifier of the preferred custom browser to open weblink on Android. When this property is configured, ManagedBrowserToOpenLinksRequired should be true.| |customBrowserDisplayName|String|Friendly name of the preferred custom browser to open weblink on Android. When this property is configured, ManagedBrowserToOpenLinksRequired should be true.| |minimumRequiredCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or app access will be blocked| Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman |keyboardsRestricted|Boolean|Indicates if keyboard restriction is enabled. If enabled list of approved keyboards must be provided as well.| |approvedKeyboards|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|If Keyboard Restriction is enabled, only keyboards in this approved list will be allowed. A key should be Android package id for a keyboard and value should be a friendly name| |allowedAndroidDeviceModels|String collection|List of device models allowed, as a string, for the managed app to work.|-|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customDialerAppPackageId|String|PackageId of a custom dialer app to click-to-open a phone number on Android.| |customDialerAppDisplayName|String|Friendly name of a custom dialer app to click-to-open a phone number on Android.| |biometricAuthenticationBlocked|Boolean|Indicates whether use of the biometric authentication is allowed in place of a pin if PinRequired is set to True.| Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman |warnAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the user will receive the warning| |wipeAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the company data on the app will be wiped| |deviceLockRequired|Boolean|Defines if any kind of lock must be required on android device|-|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on android device but is not set. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on android device but is not set. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |connectToVpnOnLaunch|Boolean|Whether the app should connect to the configured VPN on launch.|-|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requireClass3Biometrics|Boolean|Require user to apply Class 3 Biometrics on their Android device.| |requirePinAfterBiometricChange|Boolean|A PIN prompt will override biometric prompts if class 3 biometrics are updated on the device.| |fingerprintAndBiometricEnabled|Boolean|If null, this setting will be ignored. If false both fingerprints and biometrics will not be enabled. If true, both fingerprints and biometrics will be enabled.| |
v1.0 | Intune Mam Androidmanagedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappregistration.md | doc_type: resourcePageType # androidManagedAppRegistration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the synchronization details of an android app, with management capabilities, for a specific user. The ManagedAppRegistration resource represents the details of an app, with management capability, used by a member of the organization. |
v1.0 | Intune Mam Androidmanagedappsafetynetappsverificationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md | doc_type: enumPageType # androidManagedAppSafetyNetAppsVerificationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An admin enforced Android SafetyNet Device Attestation requirement on a managed app. ## Members |
v1.0 | Intune Mam Androidmanagedappsafetynetdeviceattestationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md | doc_type: enumPageType # androidManagedAppSafetyNetDeviceAttestationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An admin enforced Android SafetyNet Device Attestation requirement on a managed app. ## Members |
v1.0 | Intune Mam Androidmanagedappsafetynetevaluationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmanagedappsafetynetevaluationtype.md | doc_type: enumPageType # androidManagedAppSafetyNetEvaluationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An admin enforced Android SafetyNet evaluation type requirement on a managed app. ## Members |
v1.0 | Intune Mam Androidmobileappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-androidmobileappidentifier.md | doc_type: resourcePageType # androidMobileAppIdentifier resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The identifier for an Android app. |
v1.0 | Intune Mam Appmanagementlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-appmanagementlevel.md | doc_type: enumPageType # appManagementLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Management levels for apps ## Members |
v1.0 | Intune Mam Defaultmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-defaultmanagedappprotection.md | doc_type: resourcePageType # defaultManagedAppProtection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy used to configure detailed management settings for a specified set of apps for all users not targeted by a TargetedManagedAppProtection Policy Inherits from [managedAppProtection](../resources/intune-mam-managedappprotectio |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| Inherits from [managedAppProtection](../resources/intune-mam-managedappprotectio |minimumWipeSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data.| |minimumWipePatchVersion|String|Android security patch level less than or equal to the specified value will wipe the managed app and the associated company data. (Android only)| |allowedIosDeviceModels|String|Semicolon seperated list of device models allowed, as a string, for the managed app to work. (iOS Only)|-|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (iOS Only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (iOS Only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |allowedAndroidDeviceManufacturers|String|Semicolon seperated list of device manufacturers allowed, as a string, for the managed app to work. (Android only)|-|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. (Android only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceManufacturerNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device manufacturer is not allowed. (Android only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |thirdPartyKeyboardsBlocked|Boolean|Defines if third party keyboards are allowed while accessing a managed app. (iOS Only)| |filterOpenInToOnlyManagedApps|Boolean|Defines if open-in operation is supported from the managed app to the filesharing locations selected. This setting only applies when AllowedOutboundDataTransferDestinations is set to ManagedApps and DisableProtectionOfManagedOutboundOpenInData is set to False. (iOS Only)| |disableProtectionOfManagedOutboundOpenInData|Boolean|Disable protection of data transferred to other apps through IOS OpenIn option. This setting is only allowed to be True when AllowedOutboundDataTransferDestinations is set to ManagedApps. (iOS Only)| |protectInboundDataFromUnknownSources|Boolean|Protect incoming data from unknown source. This setting is only allowed to be True when AllowedInboundDataTransferSources is set to AllApps. (iOS Only)| |requiredAndroidSafetyNetDeviceAttestationType|[androidManagedAppSafetyNetDeviceAttestationType](../resources/intune-mam-androidmanagedappsafetynetdeviceattestationtype.md)|Defines the Android SafetyNet Device Attestation requirement for a managed app to work. Possible values are: `none`, `basicIntegrity`, `basicIntegrityAndDeviceCertification`.|-|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetDeviceAttestationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android SafetyNet Attestation requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requiredAndroidSafetyNetAppsVerificationType|[androidManagedAppSafetyNetAppsVerificationType](../resources/intune-mam-androidmanagedappsafetynetappsverificationtype.md)|Defines the Android SafetyNet Apps Verification requirement for a managed app to work. Possible values are: `none`, `enabled`.|-|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidSafetyNetAppsVerificationFailed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn or block, if the specified Android App Verification requirement fails. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customBrowserProtocol|String|A custom browser protocol to open weblink on iOS. (iOS only)| |customBrowserPackageId|String|Unique identifier of a custom browser to open weblink on Android. (Android only)| |customBrowserDisplayName|String|Friendly name of the preferred custom browser to open weblink on Android. (Android only)| Inherits from [managedAppProtection](../resources/intune-mam-managedappprotectio |minimumWarningCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or the user will receive a warning| |minimumWipeCompanyPortalVersion|String|Minimum version of the Company portal that must be installed on the device or the company data on the app will be wiped| |allowedAndroidDeviceModels|String collection|List of device models allowed, as a string, for the managed app to work. (Android Only)|-|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (Android Only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfAndroidDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. (Android Only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |customDialerAppProtocol|String|Protocol of a custom dialer app to click-to-open a phone number on iOS, for example, skype:.| |customDialerAppPackageId|String|PackageId of a custom dialer app to click-to-open a phone number on Android.| |customDialerAppDisplayName|String|Friendly name of a custom dialer app to click-to-open a phone number on Android.| Inherits from [managedAppProtection](../resources/intune-mam-managedappprotectio |warnAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the user will receive the warning| |wipeAfterCompanyPortalUpdateDeferralInDays|Int32|Maximum number of days Company Portal update can be deferred on the device or the company data on the app will be wiped| |deviceLockRequired|Boolean|Defines if any kind of lock must be required on device. (android only)|-|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on device but is not set. (android only). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceLockNotSet|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either warn, block or wipe, if the screen lock is required on device but is not set. (android only). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |connectToVpnOnLaunch|Boolean|Whether the app should connect to the configured VPN on launch (Android only).|-|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDevicePasscodeComplexityLessThanLow|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of low complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanMedium|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of medium complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfDevicePasscodeComplexityLessThanHigh|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If the device does not have a passcode of high complexity or higher, trigger the stored action. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |requireClass3Biometrics|Boolean|Require user to apply Class 3 Biometrics on their Android device.| |requirePinAfterBiometricChange|Boolean|A PIN prompt will override biometric prompts if class 3 biometrics are updated on the device.| |fingerprintAndBiometricEnabled|Boolean|Indicate to the client to enable both biometrics and fingerprints for the app.| |
v1.0 | Intune Mam Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-deviceappmanagement.md | doc_type: resourcePageType # deviceAppManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device app management singleton entity. ## Methods |
v1.0 | Intune Mam Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationchoicesettingcollectioninstance.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingCollectionInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting instance within policy |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationchoicesettinginstance.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting instance within policy |
v1.0 | Intune Mam Devicemanagementconfigurationchoicesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationchoicesettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationChoiceSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Setting value |
v1.0 | Intune Mam Devicemanagementconfigurationgroupsettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationgroupsettingcollectioninstance.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingCollectionInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Instance of a GroupSettingCollection |
v1.0 | Intune Mam Devicemanagementconfigurationgroupsettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationgroupsettinginstance.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Instance of a GroupSetting |
v1.0 | Intune Mam Devicemanagementconfigurationgroupsettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationgroupsettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationGroupSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Value of the GroupSetting |
v1.0 | Intune Mam Devicemanagementconfigurationsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsetting.md | doc_type: resourcePageType # deviceManagementConfigurationSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingcollectioninstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsimplesettingcollectioninstance.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingCollectionInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting collection instance |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettinginstance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsimplesettinginstance.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingInstance resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting instance |
v1.0 | Intune Mam Devicemanagementconfigurationsimplesettingvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementconfigurationsimplesettingvalue.md | doc_type: resourcePageType # deviceManagementConfigurationSimpleSettingValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Simple setting value |
v1.0 | Intune Mam Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-devicemanagementreports.md | doc_type: resourcePageType # deviceManagementReports resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Mam Iosmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-iosmanagedappprotection.md | doc_type: resourcePageType # iosManagedAppProtection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy used to configure detailed management settings targeted to specific security groups and for a specified set of apps on an iOS device Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| Inherits from [targetedManagedAppProtection](../resources/intune-mam-targetedman |exemptedAppProtocols|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|Apps in this list will be exempt from the policy and will be able to receive data from managed apps.| |minimumWipeSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data.| |allowedIosDeviceModels|String|Semicolon seperated list of device models allowed, as a string, for the managed app to work.|-|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfIosDeviceModelNotAllowed|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, if the specified device model is not allowed. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfAccountIsClockedOut|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or warn, if the user is clocked out (non-working time). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |thirdPartyKeyboardsBlocked|Boolean|Defines if third party keyboards are allowed while accessing a managed app| |filterOpenInToOnlyManagedApps|Boolean|Defines if open-in operation is supported from the managed app to the filesharing locations selected. This setting only applies when AllowedOutboundDataTransferDestinations is set to ManagedApps and DisableProtectionOfManagedOutboundOpenInData is set to False.| |disableProtectionOfManagedOutboundOpenInData|Boolean|Disable protection of data transferred to other apps through IOS OpenIn option. This setting is only allowed to be True when AllowedOutboundDataTransferDestinations is set to ManagedApps.| |
v1.0 | Intune Mam Iosmanagedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-iosmanagedappregistration.md | doc_type: resourcePageType # iosManagedAppRegistration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the synchronization details of an ios app, with management capabilities, for a specific user. The ManagedAppRegistration resource represents the details of an app, with management capability, used by a member of the organization. |
v1.0 | Intune Mam Iosmobileappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-iosmobileappidentifier.md | doc_type: resourcePageType # iosMobileAppIdentifier resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The identifier for an iOS app. |
v1.0 | Intune Mam Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-json.md | doc_type: resourcePageType # Json resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents data returned in JSON format ## Properties |
v1.0 | Intune Mam Macappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-macappidentifier.md | doc_type: resourcePageType # macAppIdentifier resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The identifier for a Mac app. |
v1.0 | Intune Mam Managedappclipboardsharinglevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappclipboardsharinglevel.md | doc_type: enumPageType # managedAppClipboardSharingLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the level to which the device's clipboard may be shared between apps ## Members |
v1.0 | Intune Mam Managedappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappconfiguration.md | doc_type: resourcePageType # managedAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Configuration used to deliver a set of custom settings as-is to apps for users to whom the configuration is scoped |
v1.0 | Intune Mam Managedappdataencryptiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdataencryptiontype.md | doc_type: enumPageType # managedAppDataEncryptionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the level to which app data is encrypted for managed apps ## Members |
v1.0 | Intune Mam Managedappdataingestionlocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdataingestionlocation.md | doc_type: enumPageType # managedAppDataIngestionLocation enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Locations which can be used to bring data into organization documents ## Members |
v1.0 | Intune Mam Managedappdatastoragelocation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdatastoragelocation.md | doc_type: enumPageType # managedAppDataStorageLocation enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Storage locations where managed apps can potentially store their data ## Members |
v1.0 | Intune Mam Managedappdatatransferlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdatatransferlevel.md | doc_type: enumPageType # managedAppDataTransferLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Data can be transferred from/to these classes of apps ## Members |
v1.0 | Intune Mam Managedappdevicethreatlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdevicethreatlevel.md | doc_type: enumPageType # managedAppDeviceThreatLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The maxium threat level allowed for an app to be compliant. ## Members |
v1.0 | Intune Mam Managedappdiagnosticstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappdiagnosticstatus.md | doc_type: resourcePageType # managedAppDiagnosticStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents diagnostics status. ## Properties |
v1.0 | Intune Mam Managedappflaggedreason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappflaggedreason.md | doc_type: enumPageType # managedAppFlaggedReason enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The reason for which a user has been flagged ## Members |
v1.0 | Intune Mam Managedapplogcollectionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapplogcollectionrequest.md | doc_type: resourcePageType # managedAppLogCollectionRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Managed App log collection response ## Methods |
v1.0 | Intune Mam Managedapplogupload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapplogupload.md | doc_type: resourcePageType # managedAppLogUpload resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A `managedAppLogUpload` represents the log upload result for a given Mobile Application Management (MAM) Logs Uploading Component. Such components can be the application itself, the MAM SDK, and other on-device components that are capable of uploading diagnostic logs. ## Properties |
v1.0 | Intune Mam Managedapploguploadconsent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapploguploadconsent.md | doc_type: enumPageType # managedAppLogUploadConsent enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the current consent status of the associated `managedAppLogCollectionRequest`. ## Members |
v1.0 | Intune Mam Managedapploguploadstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapploguploadstate.md | doc_type: enumPageType # managedAppLogUploadState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the current status of the associated `managedAppLogCollectionRequest`. ## Members |
v1.0 | Intune Mam Managedappnotificationrestriction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappnotificationrestriction.md | doc_type: enumPageType # managedAppNotificationRestriction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Restrict managed app notification ## Members |
v1.0 | Intune Mam Managedappoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappoperation.md | doc_type: resourcePageType # managedAppOperation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an operation applied against an app registration. ## Methods |
v1.0 | Intune Mam Managedappphonenumberredirectlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappphonenumberredirectlevel.md | doc_type: enumPageType # managedAppPhoneNumberRedirectLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The classes of apps that are allowed to click-to-open a phone number, for making phone calls or sending text messages. ## Members |
v1.0 | Intune Mam Managedapppincharacterset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppincharacterset.md | doc_type: enumPageType # managedAppPinCharacterSet enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Character set which is to be used for a user's app PIN ## Members |
v1.0 | Intune Mam Managedapppolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppolicy.md | doc_type: resourcePageType # managedAppPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The ManagedAppPolicy resource represents a base type for platform specific policies. ## Methods |
v1.0 | Intune Mam Managedapppolicydeploymentsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppolicydeploymentsummary.md | doc_type: resourcePageType # managedAppPolicyDeploymentSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The ManagedAppEntity is the base entity type for all other entity types under app management workflow. ## Methods |
v1.0 | Intune Mam Managedapppolicydeploymentsummaryperapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedapppolicydeploymentsummaryperapp.md | doc_type: resourcePageType # managedAppPolicyDeploymentSummaryPerApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents policy deployment summary per app. ## Properties |
v1.0 | Intune Mam Managedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappprotection.md | doc_type: resourcePageType # managedAppProtection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy used to configure detailed management settings for a specified set of apps Inherits from [managedAppPolicy](../resources/intune-mam-managedapppolicy.md) |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app.| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data.| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data.|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed.| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction. Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property.| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app. Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null. Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents.| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours.| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| |
v1.0 | Intune Mam Managedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappregistration.md | doc_type: resourcePageType # managedAppRegistration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The ManagedAppEntity is the base entity type for all other entity types under app management workflow. The ManagedAppRegistration resource represents the details of an app, with management capability, used by a member of the organization. |
v1.0 | Intune Mam Managedappremediationaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappremediationaction.md | doc_type: enumPageType # managedAppRemediationAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An admin initiated action to be applied on a managed app. ## Members |Member|Value|Description| |:|:|:|-|block|0|app and the corresponding company data to be blocked| -|wipe|1|app and the corresponding company data to be wiped| -|warn|2|app and the corresponding user to be warned| +|block|0|Indicates the user will be blocked from accessing the app and corporate data| +|wipe|1|Indicates the corporate data will be removed from the app| +|warn|2|Indicates user will be warned the when accessing the app| +|blockWhenSettingIsSupported|3|Indicates user will be blocked from accessing the app and corporate data if devices supports this setting| |
v1.0 | Intune Mam Managedappstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappstatus.md | doc_type: resourcePageType # managedAppStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents app protection and configuration status for the organization. ## Methods |
v1.0 | Intune Mam Managedappstatusraw | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedappstatusraw.md | doc_type: resourcePageType # managedAppStatusRaw resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an un-typed status report about organizations app protection and configuration. |
v1.0 | Intune Mam Managedbrowsertype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedbrowsertype.md | doc_type: enumPageType # managedBrowserType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Type of managed browser ## Members |
v1.0 | Intune Mam Managedmobileapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-managedmobileapp.md | doc_type: resourcePageType # managedMobileApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The identifier for the deployment an app. ## Methods |
v1.0 | Intune Mam Mdmwindowsinformationprotectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-mdmwindowsinformationprotectionpolicy.md | doc_type: resourcePageType # mdmWindowsInformationProtectionPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy for Windows information protection with MDM |
v1.0 | Intune Mam Messagingredirectapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-messagingredirectapptype.md | doc_type: enumPageType # messagingRedirectAppType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. ## Members |
v1.0 | Intune Mam Mobileappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-mobileappidentifier.md | doc_type: resourcePageType # mobileAppIdentifier resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The identifier for a mobile app. ## Properties |
v1.0 | Intune Mam Mobilethreatdefensepartnerpriority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-mobilethreatdefensepartnerpriority.md | doc_type: enumPageType # mobileThreatDefensePartnerPriority enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Determines the conflict resolution strategy, when more than one Mobile Threat Defense provider is enabled. ## Members |
v1.0 | Intune Mam Targetedmanagedappconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-targetedmanagedappconfiguration.md | doc_type: resourcePageType # targetedManagedAppConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Configuration used to deliver a set of custom settings as-is to all users in the targeted security group |
v1.0 | Intune Mam Targetedmanagedappgrouptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-targetedmanagedappgrouptype.md | doc_type: enumPageType # targetedManagedAppGroupType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates a collection of apps to target which can be one of several pre-defined lists of apps or a manually selected list of apps ## Members |
v1.0 | Intune Mam Targetedmanagedapppolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-targetedmanagedapppolicyassignment.md | doc_type: resourcePageType # targetedManagedAppPolicyAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type for deployment of groups or apps. ## Methods Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.targetedManagedAppPolicyAssignment", "id": "String (identifier)", "target": {- "@odata.type": "microsoft.graph.configurationManagerCollectionAssignmentTarget", + "@odata.type": "microsoft.graph.scopeTagGroupAssignmentTarget", "deviceAndAppManagementAssignmentFilterId": "String", "deviceAndAppManagementAssignmentFilterType": "String",- "collectionId": "String" + "targetType": "String", + "entraObjectId": "String" }, "source": "String", "sourceId": "String" |
v1.0 | Intune Mam Targetedmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-targetedmanagedappprotection.md | doc_type: resourcePageType # targetedManagedAppProtection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy used to configure detailed management settings targeted to specific security groups Inherits from [managedAppProtection](../resources/intune-mam-managedappprotectio |minimumWarningAppVersion|String|Versions less than the specified version will result in warning message on the managed app. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeOsVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |minimumWipeAppVersion|String|Versions less than or equal to the specified version will wipe the managed app and the associated company data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| -|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfDeviceComplianceRequired|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, when the device is either rooted or jailbroken, if DeviceComplianceRequired is set to true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| +|appActionIfMaximumPinRetriesExceeded|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Defines a managed app behavior, either block or wipe, based on maximum number of incorrect pin retry attempts. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |pinRequiredInsteadOfBiometricTimeout|Duration|Timeout in minutes for an app pin instead of non biometrics passcode Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedOutboundClipboardSharingExceptionLength|Int32|Specify the number of characters that may be cut or copied from Org data and accounts to any application. This setting overrides the AllowedOutboundClipboardSharingLevel restriction. Default value of '0' means no exception is allowed. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |notificationRestriction|[managedAppNotificationRestriction](../resources/intune-mam-managedappnotificationrestriction.md)|Specify app notification restriction Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allow`, `blockOrganizationalData`, `block`.| |previousPinBlockCount|Int32|Requires a pin to be unique from the number specified in this property. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |managedBrowser|[managedBrowserType](../resources/intune-mam-managedbrowsertype.md)|Indicates in which managed browser(s) that internet links should be opened. When this property is configured, ManagedBrowserToOpenLinksRequired should be true. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `microsoftEdge`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the MTD app Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Warn isn't a supported value for this property Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |mobileThreatDefensePartnerPriority|[mobileThreatDefensePartnerPriority](../resources/intune-mam-mobilethreatdefensepartnerpriority.md)| Indicates how to prioritize which Mobile Threat Defense (MTD) partner is enabled for a given platform, when more than one is enabled. An app can only be actively using a single Mobile Threat Defense partner. When NULL, Microsoft Defender will be given preference. Otherwise setting the value to defenderOverThirdPartyPartner or thirdPartyPartnerOverDefender will make explicit which partner to prioritize. Possible values are: null, defenderOverThirdPartyPartner, thirdPartyPartnerOverDefender and unknownFutureValue. Default value is null Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `defenderOverThirdPartyPartner`, `thirdPartyPartnerOverDefender`, `unknownFutureValue`.| |blockDataIngestionIntoOrganizationDocuments|Boolean|Indicates whether a user can bring data into org documents. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |allowedDataIngestionLocations|[managedAppDataIngestionLocation](../resources/intune-mam-managedappdataingestionlocation.md) collection|Data storage locations where a user may store managed data. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |dialerRestrictionLevel|[managedAppPhoneNumberRedirectLevel](../resources/intune-mam-managedappphonenumberredirectlevel.md)|The classes of dialer apps that are allowed to click-to-open a phone number. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `allApps`, `managedApps`, `customApp`, `blocked`.| |gracePeriodToBlockAppsDuringOffClockHours|Duration|A grace period before blocking app access during off clock hours. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md)| |protectedMessagingRedirectAppType|[messagingRedirectAppType](../resources/intune-mam-messagingredirectapptype.md)|Defines how app messaging redirection is protected by an App Protection Policy. Default is anyApp. Inherited from [managedAppProtection](../resources/intune-mam-managedappprotection.md). Possible values are: `anyApp`, `anyManagedApp`, `specificApps`, `blocked`.| |
v1.0 | Intune Mam User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-user.md | doc_type: resourcePageType # user resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an Azure Active Directory user object. ## Methods |
v1.0 | Intune Mam Windowsappidentifier | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsappidentifier.md | doc_type: resourcePageType # windowsAppIdentifier resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The identifier for a Windows app. |
v1.0 | Intune Mam Windowsinformationprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotection.md | doc_type: resourcePageType # windowsInformationProtection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy for Windows information protection to configure detailed management settings |
v1.0 | Intune Mam Windowsinformationprotectionapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionapp.md | doc_type: resourcePageType # windowsInformationProtectionApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - App for Windows information protection ## Properties |
v1.0 | Intune Mam Windowsinformationprotectionapplockerfile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionapplockerfile.md | doc_type: resourcePageType # windowsInformationProtectionAppLockerFile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Information Protection AppLocker File ## Methods |
v1.0 | Intune Mam Windowsinformationprotectiondatarecoverycertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectiondatarecoverycertificate.md | doc_type: resourcePageType # windowsInformationProtectionDataRecoveryCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Information Protection DataRecoveryCertificate ## Properties |
v1.0 | Intune Mam Windowsinformationprotectiondesktopapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectiondesktopapp.md | doc_type: resourcePageType # windowsInformationProtectionDesktopApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Desktop App for Windows information protection |
v1.0 | Intune Mam Windowsinformationprotectiondeviceregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectiondeviceregistration.md | doc_type: resourcePageType # windowsInformationProtectionDeviceRegistration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents device registration records for Bring-Your-Own-Device(BYOD) Windows devices. ## Methods |
v1.0 | Intune Mam Windowsinformationprotectionenforcementlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionenforcementlevel.md | doc_type: enumPageType # windowsInformationProtectionEnforcementLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible values for WIP Protection enforcement levels ## Members |
v1.0 | Intune Mam Windowsinformationprotectioniprangecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectioniprangecollection.md | doc_type: resourcePageType # windowsInformationProtectionIPRangeCollection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Information Protection IP Range Collection ## Properties |
v1.0 | Intune Mam Windowsinformationprotectionpincharacterrequirements | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionpincharacterrequirements.md | doc_type: enumPageType # windowsInformationProtectionPinCharacterRequirements enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Pin Character Requirements ## Members |
v1.0 | Intune Mam Windowsinformationprotectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionpolicy.md | doc_type: resourcePageType # windowsInformationProtectionPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy for Windows information protection without MDM |
v1.0 | Intune Mam Windowsinformationprotectionproxieddomaincollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionproxieddomaincollection.md | doc_type: resourcePageType # windowsInformationProtectionProxiedDomainCollection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Information Protection Proxied Domain Collection ## Properties |
v1.0 | Intune Mam Windowsinformationprotectionresourcecollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionresourcecollection.md | doc_type: resourcePageType # windowsInformationProtectionResourceCollection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Information Protection Resource Collection ## Properties |
v1.0 | Intune Mam Windowsinformationprotectionstoreapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionstoreapp.md | doc_type: resourcePageType # windowsInformationProtectionStoreApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Store App for Windows information protection |
v1.0 | Intune Mam Windowsinformationprotectionwipeaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsinformationprotectionwipeaction.md | doc_type: resourcePageType # windowsInformationProtectionWipeAction resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents wipe requests issued by tenant admin for Bring-Your-Own-Device(BYOD) Windows devices. ## Methods |
v1.0 | Intune Mam Windowsmanagedappclipboardsharinglevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappclipboardsharinglevel.md | doc_type: enumPageType # windowsManagedAppClipboardSharingLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the level to which the device's clipboard may be shared between apps ## Members |
v1.0 | Intune Mam Windowsmanagedappdatatransferlevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappdatatransferlevel.md | doc_type: enumPageType # windowsManagedAppDataTransferLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Data can be transferred from/to these classes of apps ## Members |
v1.0 | Intune Mam Windowsmanagedappprotection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappprotection.md | doc_type: resourcePageType # windowsManagedAppProtection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Policy used to configure detailed management settings targeted to specific security groups and for a specified set of apps on a Windows device Inherits from [managedAppPolicy](../resources/intune-mam-managedapppolicy.md) |allowedInboundDataTransferSources|[windowsManagedAppDataTransferLevel](../resources/intune-mam-windowsmanagedappdatatransferlevel.md)|Indicates the sources from which data is allowed to be transferred. Some possible values are allApps or none. Possible values are: `allApps`, `none`.| |allowedOutboundClipboardSharingLevel|[windowsManagedAppClipboardSharingLevel](../resources/intune-mam-windowsmanagedappclipboardsharinglevel.md)|Indicates the level to which the clipboard may be shared across org & non-org resources. Some possible values are anyDestinationAnySource or none. Possible values are: `anyDestinationAnySource`, `none`.| |allowedOutboundDataTransferDestinations|[windowsManagedAppDataTransferLevel](../resources/intune-mam-windowsmanagedappdatatransferlevel.md)|Indicates the destinations to which data is allowed to be transferred. Some possible values are allApps or none. Possible values are: `allApps`, `none`.|-|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Some possible values are block or wipe. If this property is not set, no action will be taken. Possible values are: `block`, `wipe`, `warn`.| +|appActionIfUnableToAuthenticateUser|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|If set, it will specify what action to take in the case where the user is unable to checkin because their authentication token is invalid. This happens when the user is deleted or disabled in AAD. Some possible values are block or wipe. If this property is not set, no action will be taken. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |maximumAllowedDeviceThreatLevel|[managedAppDeviceThreatLevel](../resources/intune-mam-managedappdevicethreatlevel.md)|Maximum allowed device threat level, as reported by the Mobile Threat Defense app. Possible values are: `notConfigured`, `secured`, `low`, `medium`, `high`.|-|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Some possible values are block or wipe. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`.| +|mobileThreatDefenseRemediationAction|[managedAppRemediationAction](../resources/intune-mam-managedappremediationaction.md)|Determines what action to take if the mobile threat defense threat threshold isn't met. Some possible values are block or wipe. Warn isn't a supported value for this property. Possible values are: `block`, `wipe`, `warn`, `blockWhenSettingIsSupported`.| |minimumRequiredSdkVersion|String|Versions less than the specified version will block the managed app from accessing company data. For example: '8.1.0' or '13.1.1'.| |minimumWipeSdkVersion|String|Versions less than the specified version will wipe the managed app and the associated company data. For example: '8.1.0' or '13.1.1'.| |minimumRequiredOsVersion|String|Versions less than the specified version will block the managed app from accessing company data. For example: '8.1.0' or '13.1.1'.| |
v1.0 | Intune Mam Windowsmanagedappregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mam-windowsmanagedappregistration.md | doc_type: resourcePageType # windowsManagedAppRegistration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the synchronization details of a Windows app, with management capabilities, for a specific user. The ManagedAppRegistration resource represents the details of an app, with management capability, used by a member of the organization. |
v1.0 | Intune Mstunnel Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton that acts as container for a collection of Resource Access entities. ## Methods |
v1.0 | Intune Mstunnel Metrictimeseriesdatapoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-metrictimeseriesdatapoint.md | doc_type: resourcePageType # metricTimeSeriesDataPoint resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Metric Time series data point ## Properties |
v1.0 | Intune Mstunnel Microsofttunnelconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelconfiguration.md | doc_type: resourcePageType # microsoftTunnelConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents a collection of Microsoft Tunnel settings ## Methods |
v1.0 | Intune Mstunnel Microsofttunneldeploymentmode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunneldeploymentmode.md | doc_type: enumPageType # microsoftTunnelDeploymentMode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The available deployment modes for a managed Tunnel server. The deployment mode is determined during the deployment depending on the Tunnel containers, namely standalone or as part of a pod, and whether the containers are running in rootful or rootless mode. ## Members |
v1.0 | Intune Mstunnel Microsofttunnelhealththreshold | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelhealththreshold.md | doc_type: resourcePageType # microsoftTunnelHealthThreshold resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents the health thresholds of a health metric ## Methods |
v1.0 | Intune Mstunnel Microsofttunnellogcollectionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnellogcollectionstatus.md | doc_type: enumPageType # microsoftTunnelLogCollectionStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enum type that represent the status of log collection ## Members |
v1.0 | Intune Mstunnel Microsofttunnelserver | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelserver.md | doc_type: resourcePageType # microsoftTunnelServer resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents a single Microsoft Tunnel server ## Methods |
v1.0 | Intune Mstunnel Microsofttunnelserverhealthstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelserverhealthstatus.md | doc_type: enumPageType # microsoftTunnelServerHealthStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enum of possible MicrosoftTunnelServer health status types ## Members |
v1.0 | Intune Mstunnel Microsofttunnelserverlogcollectionresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelserverlogcollectionresponse.md | doc_type: resourcePageType # microsoftTunnelServerLogCollectionResponse resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that stores the server log collection status. ## Methods |
v1.0 | Intune Mstunnel Microsofttunnelsite | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-mstunnel-microsofttunnelsite.md | doc_type: resourcePageType # microsoftTunnelSite resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that represents a Microsoft Tunnel site ## Methods |
v1.0 | Intune Notification Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Notification Localizednotificationmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-localizednotificationmessage.md | doc_type: resourcePageType # localizedNotificationMessage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The text content of a Notification Message Template for the specified locale. ## Methods |
v1.0 | Intune Notification Notificationmessagetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-notificationmessagetemplate.md | doc_type: resourcePageType # notificationMessageTemplate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Notification messages are messages that are sent to end users who are determined to be not-compliant with the compliance policies defined by the administrator. Administrators choose notifications and configure them in the Intune Admin Console using the compliance policy creation page under the ΓÇ£Actions for non-complianceΓÇ¥ section. Use the notificationMessageTemplate object to create your own custom notifications for administrators to choose while configuring actions for non-compliance. ## Methods |
v1.0 | Intune Notification Notificationtemplatebrandingoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-notification-notificationtemplatebrandingoptions.md | doc_type: enumPageType # notificationTemplateBrandingOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Branding Options for the Message Template. Branding is defined in the Intune Admin Console. ## Members |
v1.0 | Intune Odj Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-odj-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all domain join connector entities ## Methods |
v1.0 | Intune Odj Devicemanagementdomainjoinconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-odj-devicemanagementdomainjoinconnector.md | doc_type: resourcePageType # deviceManagementDomainJoinConnector resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A Domain Join Connector is a connector that is responsible to allocate (and delete) machine account blobs ## Methods |
v1.0 | Intune Odj Devicemanagementdomainjoinconnectorstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-odj-devicemanagementdomainjoinconnectorstate.md | doc_type: enumPageType # deviceManagementDomainJoinConnectorState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The ODJ request states. ## Members |
v1.0 | Intune Onboarding Certificateconnectorsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-certificateconnectorsetting.md | doc_type: resourcePageType # certificateConnectorSetting resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Certificate connector settings. ## Properties |
v1.0 | Intune Onboarding Compliancemanagementpartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-compliancemanagementpartner.md | doc_type: resourcePageType # complianceManagementPartner resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Compliance management partner for all platforms ## Methods |
v1.0 | Intune Onboarding Compliancemanagementpartnerassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-compliancemanagementpartnerassignment.md | doc_type: resourcePageType # complianceManagementPartnerAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - User group targeting for Compliance Management Partner ## Properties |
v1.0 | Intune Onboarding Deviceandappmanagementdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceandappmanagementdata.md | doc_type: resourcePageType # deviceAndAppManagementData resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Exported Data ## Properties |
v1.0 | Intune Onboarding Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceappmanagement.md | doc_type: resourcePageType # deviceAppManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device app management functionality. ## Methods |
v1.0 | Intune Onboarding Devicecategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicecategory.md | doc_type: resourcePageType # deviceCategory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device categories provides a way to organize your devices. Using device categories, company administrators can define their own categories that make sense to their company. These categories can then be applied to a device in the Intune Azure console or selected by a user during device enrollment. You can filter reports and create dynamic Azure Active Directory device groups based on device categories. ## Methods |
v1.0 | Intune Onboarding Devicecomanagementauthorityconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicecomanagementauthorityconfiguration.md | doc_type: resourcePageType # deviceComanagementAuthorityConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Co-Management Authority Page Configuration |
v1.0 | Intune Onboarding Deviceenrollmentconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentconfiguration.md | doc_type: resourcePageType # deviceEnrollmentConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Base Class of Device Enrollment Configuration ## Methods |
v1.0 | Intune Onboarding Deviceenrollmentconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentconfigurationtype.md | doc_type: enumPageType # deviceEnrollmentConfigurationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes the TemplateFamily for the Template entity ## Members |
v1.0 | Intune Onboarding Deviceenrollmentlimitconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentlimitconfiguration.md | doc_type: resourcePageType # deviceEnrollmentLimitConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Enrollment Configuration that restricts the number of devices a user can enroll |
v1.0 | Intune Onboarding Deviceenrollmentnotificationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentnotificationconfiguration.md | doc_type: resourcePageType # deviceEnrollmentNotificationConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enrollment Notification Configuration which is used to send notification |
v1.0 | Intune Onboarding Deviceenrollmentplatformrestriction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentplatformrestriction.md | doc_type: resourcePageType # deviceEnrollmentPlatformRestriction resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Platform specific enrollment restrictions ## Properties |
v1.0 | Intune Onboarding Deviceenrollmentplatformrestrictionconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentplatformrestrictionconfiguration.md | doc_type: resourcePageType # deviceEnrollmentPlatformRestrictionConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Enrollment Configuration that restricts the types of devices a user can enroll for a single platform |
v1.0 | Intune Onboarding Deviceenrollmentplatformrestrictionsconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentplatformrestrictionsconfiguration.md | doc_type: resourcePageType # deviceEnrollmentPlatformRestrictionsConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Enrollment Configuration that restricts the types of devices a user can enroll |
v1.0 | Intune Onboarding Deviceenrollmentwindowshelloforbusinessconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceenrollmentwindowshelloforbusinessconfiguration.md | doc_type: resourcePageType # deviceEnrollmentWindowsHelloForBusinessConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Hello for Business settings lets users access their devices using a gesture, such as biometric authentication, or a PIN. Configure settings for enrolled Windows 10, Windows 10 Mobile and later. |
v1.0 | Intune Onboarding Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Onboarding Devicemanagementexchangeaccesslevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeaccesslevel.md | doc_type: enumPageType # deviceManagementExchangeAccessLevel enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Access Level in Exchange. ## Members |
v1.0 | Intune Onboarding Devicemanagementexchangeaccessrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeaccessrule.md | doc_type: resourcePageType # deviceManagementExchangeAccessRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Access Rules in Exchange. ## Properties |
v1.0 | Intune Onboarding Devicemanagementexchangeaccessruletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeaccessruletype.md | doc_type: enumPageType # deviceManagementExchangeAccessRuleType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Criteria which defines the type of device this access rule will apply to ## Members |
v1.0 | Intune Onboarding Devicemanagementexchangeconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnector.md | doc_type: resourcePageType # deviceManagementExchangeConnector resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity which represents a connection to an Exchange environment. ## Methods |
v1.0 | Intune Onboarding Devicemanagementexchangeconnectorstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnectorstatus.md | doc_type: enumPageType # deviceManagementExchangeConnectorStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The current status of the Exchange Connector. ## Members |
v1.0 | Intune Onboarding Devicemanagementexchangeconnectorsynctype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnectorsynctype.md | doc_type: enumPageType # deviceManagementExchangeConnectorSyncType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of Exchange Connector sync requested. ## Members |
v1.0 | Intune Onboarding Devicemanagementexchangeconnectortype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeconnectortype.md | doc_type: enumPageType # deviceManagementExchangeConnectorType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The type of Exchange Connector. ## Members |
v1.0 | Intune Onboarding Devicemanagementexchangedeviceclass | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangedeviceclass.md | doc_type: resourcePageType # deviceManagementExchangeDeviceClass resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device Class in Exchange. ## Properties |
v1.0 | Intune Onboarding Devicemanagementexchangeonpremisespolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementexchangeonpremisespolicy.md | doc_type: resourcePageType # deviceManagementExchangeOnPremisesPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity which represents the Exchange OnPremises policy configured for a tenant. ## Methods |
v1.0 | Intune Onboarding Devicemanagementpartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartner.md | doc_type: resourcePageType # deviceManagementPartner resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity which represents a connection to device management partner. ## Methods |
v1.0 | Intune Onboarding Devicemanagementpartnerapptype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartnerapptype.md | doc_type: enumPageType # deviceManagementPartnerAppType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Partner App Type. ## Members |
v1.0 | Intune Onboarding Devicemanagementpartnerassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartnerassignment.md | doc_type: resourcePageType # deviceManagementPartnerAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - User group targeting for Device Management Partner ## Properties |
v1.0 | Intune Onboarding Devicemanagementpartnertenantstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-devicemanagementpartnertenantstate.md | doc_type: enumPageType # deviceManagementPartnerTenantState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Partner state of this tenant. ## Members |
v1.0 | Intune Onboarding Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-deviceplatformtype.md | doc_type: enumPageType # devicePlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types. ## Members |
v1.0 | Intune Onboarding Enablement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enablement.md | doc_type: enumPageType # enablement enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Onboarding Enrollmentconfigurationassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentconfigurationassignment.md | doc_type: resourcePageType # enrollmentConfigurationAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enrollment Configuration Assignment ## Methods |
v1.0 | Intune Onboarding Enrollmentnotificationbrandingoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentnotificationbrandingoptions.md | doc_type: enumPageType # enrollmentNotificationBrandingOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Branding Options for the Message Template. Branding is defined in the Intune Admin Console. ## Members |
v1.0 | Intune Onboarding Enrollmentnotificationtemplatetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentnotificationtemplatetype.md | doc_type: enumPageType # enrollmentNotificationTemplateType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This enum indicates the Template type for which the enrollment notification applies. ## Members |
v1.0 | Intune Onboarding Enrollmentrestrictionplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-enrollmentrestrictionplatformtype.md | doc_type: enumPageType # enrollmentRestrictionPlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This enum indicates the platform type for which the enrollment restriction applies. ## Members |
v1.0 | Intune Onboarding Intunebrand | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-intunebrand.md | doc_type: resourcePageType # intuneBrand resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - intuneBrand contains data which is used in customizing the appearance of the Company Portal applications as well as the end user web portal. ## Properties |
v1.0 | Intune Onboarding Mdmauthority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-mdmauthority.md | doc_type: enumPageType # mdmAuthority enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Mobile device management authority. ## Members |
v1.0 | Intune Onboarding Microsoftstoreforbusinessportalselectionoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-microsoftstoreforbusinessportalselectionoptions.md | doc_type: enumPageType # microsoftStoreForBusinessPortalSelectionOptions enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Portal to which admin syncs available Microsoft Store for Business apps. This is available in the Intune Admin Console. ## Members |
v1.0 | Intune Onboarding Mobilethreatdefenseconnector | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-mobilethreatdefenseconnector.md | doc_type: resourcePageType # mobileThreatDefenseConnector resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity which represents a connection to Mobile Threat Defense partner. ## Methods |
v1.0 | Intune Onboarding Mobilethreatpartnertenantstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-mobilethreatpartnertenantstate.md | doc_type: enumPageType # mobileThreatPartnerTenantState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Partner state of this tenant. ## Members |
v1.0 | Intune Onboarding Onpremisesconditionalaccesssettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-onpremisesconditionalaccesssettings.md | doc_type: resourcePageType # onPremisesConditionalAccessSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity which represents the Exchange OnPremises Conditional Access Settings for a tenant. ## Methods |
v1.0 | Intune Onboarding Organization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-organization.md | doc_type: resourcePageType # organization resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The organization resource represents an instance of global settings and resources which operate and are provisioned at the tenant-level. ## Methods |
v1.0 | Intune Onboarding User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-user.md | doc_type: resourcePageType # user resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Onboarding Vpptokenlicensesummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vppTokenLicenseSummary.md | doc_type: resourcePageType # vppTokenLicenseSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - License summary of a given app in a token. ## Properties |
v1.0 | Intune Onboarding Vpptoken | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptoken.md | doc_type: resourcePageType # vppToken resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - You purchase multiple licenses for iOS apps through the Apple Volume Purchase Program for Business or Education. This involves setting up an Apple VPP account from the Apple website and uploading the Apple VPP Business or Education token to Intune. You can then synchronize your volume purchase information with Intune and track your volume-purchased app use. You can upload multiple Apple VPP Business or Education tokens. ## Methods |
v1.0 | Intune Onboarding Vpptokenactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokenactionresult.md | doc_type: resourcePageType # vppTokenActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The status of the action performed with an Apple Volume Purchase Program token. ## Properties |
v1.0 | Intune Onboarding Vpptokenrevokelicensesactionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokenrevokelicensesactionresult.md | doc_type: resourcePageType # vppTokenRevokeLicensesActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The status of the revoke licenses action performed on the Apple Volume Purchase Program token. |
v1.0 | Intune Onboarding Vpptokenstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokenstate.md | doc_type: enumPageType # vppTokenState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible states associated with an Apple Volume Purchase Program token. ## Members |
v1.0 | Intune Onboarding Vpptokensyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-vpptokensyncstatus.md | doc_type: enumPageType # vppTokenSyncStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible sync statuses associated with an Apple Volume Purchase Program token. ## Members |
v1.0 | Intune Onboarding Windows10enrollmentcompletionpageconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-windows10enrollmentcompletionpageconfiguration.md | doc_type: resourcePageType # windows10EnrollmentCompletionPageConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows 10 Enrollment Status Page Configuration |
v1.0 | Intune Onboarding Windowshelloforbusinesspinusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-onboarding-windowshelloforbusinesspinusage.md | doc_type: enumPageType # windowsHelloForBusinessPinUsage enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Hello for Business pin usage options ## Members |
v1.0 | Intune Osprovisioninggraphservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton that acts as container for a collection of Resource Access entities. ## Methods |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemedition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemedition.md | doc_type: resourcePageType # managedDeviceWindowsOperatingSystemEdition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Different Windows' versions have Edition specific support timelines. This complex type defines the date until which a particular edition is supported in a Windows' version. ## Properties |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemeditiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemeditiontype.md | doc_type: enumPageType # managedDeviceWindowsOperatingSystemEditionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Operating System is available in different editions, which have a specific set of features available. This enum type defines the corresponding edition. ## Members |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemimage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemimage.md | doc_type: resourcePageType # managedDeviceWindowsOperatingSystemImage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity defines different Windows Operating System products, like 'Windows 11 22H1', 'Windows 11 22H2' etc., along with their available configurations. ## Methods |
v1.0 | Intune Osprovisioninggraphservice Manageddevicewindowsoperatingsystemupdate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-osprovisioninggraphservice-manageddevicewindowsoperatingsystemupdate.md | doc_type: resourcePageType # managedDeviceWindowsOperatingSystemUpdate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Updates for different Windows' versions are usually released on the Patch Tuesday or B-week of each month. This complex type defines the Build-version and the release-date for a particular B-week update of the Windows' version. ## Properties |
v1.0 | Intune Partnerintegration Appvulnerabilitymanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitymanageddevice.md | doc_type: resourcePageType # appVulnerabilityManagedDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An app vulnerability managed device. ## Methods |
v1.0 | Intune Partnerintegration Appvulnerabilitymobileapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitymobileapp.md | doc_type: resourcePageType # appVulnerabilityMobileApp resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An app vulnerability mobile app. ## Methods |
v1.0 | Intune Partnerintegration Appvulnerabilitytask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitytask.md | doc_type: resourcePageType # appVulnerabilityTask resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An app vulnerability task. |
v1.0 | Intune Partnerintegration Appvulnerabilitytaskmitigationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-appvulnerabilitytaskmitigationtype.md | doc_type: enumPageType # appVulnerabilityTaskMitigationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device app management task mitigation type. ## Members |
v1.0 | Intune Partnerintegration Configmanagercollection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-configmanagercollection.md | doc_type: resourcePageType # configManagerCollection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A ConfigManager defined collection of devices or users. ## Methods |
v1.0 | Intune Partnerintegration Configmanagerpolicysummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-configmanagerpolicysummary.md | doc_type: resourcePageType # configManagerPolicySummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A ConfigManager policy summary. ## Properties |
v1.0 | Intune Partnerintegration Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagement.md | doc_type: resourcePageType # deviceAppManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device app management singleton entity. ## Methods |
v1.0 | Intune Partnerintegration Deviceappmanagementtask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtask.md | doc_type: resourcePageType # deviceAppManagementTask resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A device app management task. ## Methods |
v1.0 | Intune Partnerintegration Deviceappmanagementtaskcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtaskcategory.md | doc_type: enumPageType # deviceAppManagementTaskCategory enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device app management task category. ## Members |
v1.0 | Intune Partnerintegration Deviceappmanagementtaskpriority | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtaskpriority.md | doc_type: enumPageType # deviceAppManagementTaskPriority enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device app management task priority. ## Members |
v1.0 | Intune Partnerintegration Deviceappmanagementtaskstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-deviceappmanagementtaskstatus.md | doc_type: enumPageType # deviceAppManagementTaskStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device app management task status. ## Members |
v1.0 | Intune Partnerintegration Endpointsecurityconfigurationapplicableplatform | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-endpointsecurityconfigurationapplicableplatform.md | doc_type: enumPageType # endpointSecurityConfigurationApplicablePlatform enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The endpoint security configuration applicable platform. ## Members |
v1.0 | Intune Partnerintegration Endpointsecurityconfigurationprofiletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-endpointsecurityconfigurationprofiletype.md | doc_type: enumPageType # endpointSecurityConfigurationProfileType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The endpoint security policy profile type. ## Members |
v1.0 | Intune Partnerintegration Endpointsecurityconfigurationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-endpointsecurityconfigurationtype.md | doc_type: enumPageType # endpointSecurityConfigurationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The endpoint security policy type. ## Members |
v1.0 | Intune Partnerintegration Securityconfigurationtask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-securityconfigurationtask.md | doc_type: resourcePageType # securityConfigurationTask resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A security configuration task. Inherits from [deviceAppManagementTask](../resources/intune-partnerintegration-d |applicablePlatform|[endpointSecurityConfigurationApplicablePlatform](../resources/intune-partnerintegration-endpointsecurityconfigurationapplicableplatform.md)|The applicable platform. Possible values are: `unknown`, `macOS`, `windows10AndLater`, `windows10AndWindowsServer`.| |endpointSecurityPolicyProfile|[endpointSecurityConfigurationProfileType](../resources/intune-partnerintegration-endpointsecurityconfigurationprofiletype.md)|The endpoint security policy profile. Possible values are: `unknown`, `antivirus`, `windowsSecurity`, `bitLocker`, `fileVault`, `firewall`, `firewallRules`, `endpointDetectionAndResponse`, `deviceControl`, `appAndBrowserIsolation`, `exploitProtection`, `webProtection`, `applicationControl`, `attackSurfaceReductionRules`, `accountProtection`.| |insights|String|Information about the mitigation.|-|managedDeviceCount|Int32|The number of vulnerable devices. Valid values 0 to 65536| +|managedDeviceCount|Int32|The number of vulnerable devices.| |intendedSettings|[keyValuePair](../resources/intune-shared-keyvaluepair.md) collection|The intended settings and their values.| ## Relationships |
v1.0 | Intune Partnerintegration Unmanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-unmanageddevice.md | doc_type: resourcePageType # unmanagedDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Unmanaged device discovered in the network. ## Properties |
v1.0 | Intune Partnerintegration Unmanageddevicediscoverytask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-unmanageddevicediscoverytask.md | doc_type: resourcePageType # unmanagedDeviceDiscoveryTask resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This task derived type represents a list of unmanaged devices discovered in the network. |
v1.0 | Intune Partnerintegration Vulnerablemanageddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-partnerintegration-vulnerablemanageddevice.md | doc_type: resourcePageType # vulnerableManagedDevice resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity represents a device associated with a task. ## Methods |
v1.0 | Intune Policylistingservice Deviceconfigurationprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policylistingservice-deviceconfigurationprofile.md | - Title: "deviceConfigurationProfile resource type" -description: "The listing service profile entity contains the meta data of an Intune configuration profile " ---doc_type: resourcePageType ---# deviceConfigurationProfile resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---The listing service profile entity contains the meta data of an Intune configuration profile --## Methods -|Method|Return Type|Description| -|:|:|:| -|[List deviceConfigurationProfiles](../api/intune-policylistingservice-deviceconfigurationprofile-list.md)|[deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) collection|List properties and relationships of the [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) objects.| -|[Get deviceConfigurationProfile](../api/intune-policylistingservice-deviceconfigurationprofile-get.md)|[deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md)|Read properties and relationships of the [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object.| -|[Create deviceConfigurationProfile](../api/intune-policylistingservice-deviceconfigurationprofile-create.md)|[deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md)|Create a new [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object.| -|[Delete deviceConfigurationProfile](../api/intune-policylistingservice-deviceconfigurationprofile-delete.md)|None|Deletes a [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md).| -|[Update deviceConfigurationProfile](../api/intune-policylistingservice-deviceconfigurationprofile-update.md)|[deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md)|Update the properties of a [deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| -|id|String|Profile Id of the object.| -|accountId|String|Account Id.| -|lastModifiedDateTime|DateTimeOffset|The date and time the entity was last modified.| -|createdDateTime|DateTimeOffset|The date and time the object was created.| -|profileName|String|Profile name| -|profileType|[profileType](../resources/intune-policylistingservice-profiletype.md)|Profile Type. Possible values are: `settingsCatalog`, `administrativeTemplates`, `importedADMXTemplates`, `oemAppConfig`, `hardwareConfig`, `dcV1EndpointProtection`, `dcV1DeviceRestrictions`.| -|platformType|[platformType](../resources/intune-policylistingservice-platformtype.md)|Platform Type. Possible values are: `none`, `android`, `iOS`, `macOS`, `windows10X`, `windows10`, `linux`, `unknownFutureValue`, `androidEnterprise`, `aosp`.| -|configurationTechnologies|Int32|Configuration Technologies for Settins Catalog Policies| -|templateId|String|TemplateId for Settings Catalog Policies| -|roleScopeTagIds|String collection|The list of scope tags for the configuration.| --## Relationships -None --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceConfigurationProfile" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceConfigurationProfile", - "id": "String (identifier)", - "accountId": "String", - "lastModifiedDateTime": "String (timestamp)", - "createdDateTime": "String (timestamp)", - "profileName": "String", - "profileType": "String", - "platformType": "String", - "configurationTechnologies": 1024, - "templateId": "String", - "roleScopeTagIds": [ - "String" - ] -} -``` |
v1.0 | Intune Policylistingservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policylistingservice-devicemanagement.md | - Title: "deviceManagement resource type" -description: "Singleton entity that acts as a container for all device management functionality." ---doc_type: resourcePageType ---# deviceManagement resource type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Singleton entity that acts as a container for all device management functionality. --## Methods -|Method|Return Type|Description| -|:|:|:| -|[Get deviceManagement](../api/intune-policylistingservice-devicemanagement-get.md)|[deviceManagement](../resources/intune-policylistingservice-devicemanagement.md)|Read properties and relationships of the [deviceManagement](../resources/intune-policylistingservice-devicemanagement.md) object.| -|[Update deviceManagement](../api/intune-policylistingservice-devicemanagement-update.md)|[deviceManagement](../resources/intune-policylistingservice-devicemanagement.md)|Update the properties of a [deviceManagement](../resources/intune-policylistingservice-devicemanagement.md) object.| --## Properties -|Property|Type|Description| -|:|:|:| --## Relationships -|Relationship|Type|Description| -|:|:|:| -|deviceConfigurationProfiles|[deviceConfigurationProfile](../resources/intune-policylistingservice-deviceconfigurationprofile.md) collection|Profile Id of the object.| --## JSON Representation -Here is a JSON representation of the resource. -<!-- { - "blockType": "resource", - "keyProperty": "id", - "@odata.type": "microsoft.graph.deviceManagement" -} >-``` json -{ - "@odata.type": "#microsoft.graph.deviceManagement" -} -``` |
v1.0 | Intune Policylistingservice Platformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policylistingservice-platformtype.md | - Title: "platformType enum type" -description: "Platform Type" ---doc_type: enumPageType ---# platformType enum type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Platform Type --## Members -|Member|Value|Description| -|:|:|:| -|none|0|None| -|android|1|Android| -|iOS|4|iOS| -|macOS|8|MacOS| -|windows10X|16|Windows 10X Platform Type| -|windows10|32|Windows 10| -|linux|128|Linux| -|unknownFutureValue|256|UnknownFutureValue| -|androidEnterprise|512|AndroidEnterprise| -|aosp|1024|Android Open Source Project| |
v1.0 | Intune Policylistingservice Profiletype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policylistingservice-profiletype.md | - Title: "profileType enum type" -description: "Profile Type" ---doc_type: enumPageType ---# profileType enum type --Namespace: microsoft.graph -> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. --> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ---Profile Type --## Members -|Member|Value|Description| -|:|:|:| -|settingsCatalog|0|Settings catalog profile type| -|administrativeTemplates|1|Administrative Templates Profile Type| -|importedADMXTemplates|2|Imported Administrative Templates Profile Type| -|oemAppConfig|3|OEM Device related App Config Profile Type| -|hardwareConfig|4|Hardware Configuration Profile Type| -|dcV1EndpointProtection|5|DCV1 Endpoint Protection Profile Type| -|dcV1DeviceRestrictions|6|DCV1 Device Restrictions Profile Type| |
v1.0 | Intune Policyset Assignmentfilterevaluaterequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterevaluaterequest.md | doc_type: resourcePageType # assignmentFilterEvaluateRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Request for assignment filter evaluation for devices. ## Properties |
v1.0 | Intune Policyset Assignmentfilterevaluationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterevaluationresult.md | doc_type: enumPageType # assignmentFilterEvaluationResult enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported evaluation results for filter. ## Members |
v1.0 | Intune Policyset Assignmentfilterevaluationsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterevaluationsummary.md | doc_type: resourcePageType # assignmentFilterEvaluationSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represent result summary for assignment filter evaluation ## Properties |
v1.0 | Intune Policyset Assignmentfiltermanagementtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltermanagementtype.md | doc_type: enumPageType # assignmentFilterManagementType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported filter management types whether its devices or apps. ## Members |
v1.0 | Intune Policyset Assignmentfilteroperator | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilteroperator.md | doc_type: enumPageType # assignmentFilterOperator enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the different type of operators which can be used to craft the AssignmentFilter rule. ## Members |
v1.0 | Intune Policyset Assignmentfilterpayloadtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterpayloadtype.md | doc_type: enumPageType # assignmentFilterPayloadType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the payload type AssignmentFilter is being assigned to. ## Members |
v1.0 | Intune Policyset Assignmentfilterstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterstate.md | doc_type: resourcePageType # assignmentFilterState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents result of GetState API. ## Properties |
v1.0 | Intune Policyset Assignmentfilterstatusdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfilterstatusdetails.md | doc_type: resourcePageType # assignmentFilterStatusDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represent status details for device and payload and all associated applied filters. ## Properties |
v1.0 | Intune Policyset Assignmentfiltersupportedproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltersupportedproperty.md | doc_type: resourcePageType # assignmentFilterSupportedProperty resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the information about the property which is supported in crafting the rule of AssignmentFilter. ## Properties |
v1.0 | Intune Policyset Assignmentfiltertypeandevaluationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltertypeandevaluationresult.md | doc_type: resourcePageType # assignmentFilterTypeAndEvaluationResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents the filter type and evalaution result of the filter. ## Properties |
v1.0 | Intune Policyset Assignmentfiltervalidationresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-assignmentfiltervalidationresult.md | doc_type: resourcePageType # assignmentFilterValidationResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents result of Validation API. ## Properties |
v1.0 | Intune Policyset Associatedassignmentpayloadtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-associatedassignmentpayloadtype.md | doc_type: enumPageType # associatedAssignmentPayloadType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This enum represents associated assignment payload type ## Members |
v1.0 | Intune Policyset Deviceandappmanagementassignmentfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceandappmanagementassignmentfilter.md | doc_type: resourcePageType # deviceAndAppManagementAssignmentFilter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for Assignment Filter. ## Methods |
v1.0 | Intune Policyset Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceappmanagement.md | doc_type: resourcePageType # deviceAppManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device and app management functionality. ## Methods |
v1.0 | Intune Policyset Devicecompliancepolicypolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicecompliancepolicypolicysetitem.md | doc_type: resourcePageType # deviceCompliancePolicyPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for device compliance policy PolicySetItem. |
v1.0 | Intune Policyset Deviceconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceconfigurationpolicysetitem.md | doc_type: resourcePageType # deviceConfigurationPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for device configuration PolicySetItem. |
v1.0 | Intune Policyset Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device and app management functionality. ## Methods |
v1.0 | Intune Policyset Devicemanagementconfigurationpolicypolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicemanagementconfigurationpolicypolicysetitem.md | doc_type: resourcePageType # deviceManagementConfigurationPolicyPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for DeviceManagementConfiguration PolicySetItem. |
v1.0 | Intune Policyset Devicemanagementscriptpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-devicemanagementscriptpolicysetitem.md | doc_type: resourcePageType # deviceManagementScriptPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for device management script PolicySetItem. |
v1.0 | Intune Policyset Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-deviceplatformtype.md | doc_type: enumPageType # devicePlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types. ## Members |
v1.0 | Intune Policyset Enrollmentrestrictionsconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-enrollmentrestrictionsconfigurationpolicysetitem.md | doc_type: resourcePageType # enrollmentRestrictionsConfigurationPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for enrollment restriction PolicySetItem. |
v1.0 | Intune Policyset Errorcode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-errorcode.md | doc_type: enumPageType # errorCode enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Policyset Haspayloadlinkresultitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-haspayloadlinkresultitem.md | doc_type: resourcePageType # hasPayloadLinkResultItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the result of HasPayloadLinks action. ## Properties |
v1.0 | Intune Policyset Ioslobappprovisioningconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-ioslobappprovisioningconfigurationpolicysetitem.md | doc_type: resourcePageType # iosLobAppProvisioningConfigurationPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for iOS lob app provisioning configuration PolicySetItem. |
v1.0 | Intune Policyset Managedappprotectionpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-managedappprotectionpolicysetitem.md | doc_type: resourcePageType # managedAppProtectionPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for managed app protection PolicySetItem. |
v1.0 | Intune Policyset Manageddevicemobileappconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-manageddevicemobileappconfigurationpolicysetitem.md | doc_type: resourcePageType # managedDeviceMobileAppConfigurationPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for managed device mobile app configuration PolicySetItem. |
v1.0 | Intune Policyset Mdmwindowsinformationprotectionpolicypolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-mdmwindowsinformationprotectionpolicypolicysetitem.md | doc_type: resourcePageType # mdmWindowsInformationProtectionPolicyPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for mdm windows information protection policy PolicySetItem. |
v1.0 | Intune Policyset Mobileapppolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-mobileapppolicysetitem.md | doc_type: resourcePageType # mobileAppPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for mobile app PolicySetItem. |
v1.0 | Intune Policyset Payloadbyfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-payloadbyfilter.md | doc_type: resourcePageType # payloadByFilter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity represents a single payload with requested assignment filter Id ## Properties |
v1.0 | Intune Policyset Payloadcompatibleassignmentfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-payloadcompatibleassignmentfilter.md | doc_type: resourcePageType # payloadCompatibleAssignmentFilter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for Payload Compatible Assignment Filter. |
v1.0 | Intune Policyset Policyset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policyset.md | doc_type: resourcePageType # policySet resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for PolicySet. ## Methods |
v1.0 | Intune Policyset Policysetassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policysetassignment.md | doc_type: resourcePageType # policySetAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for PolicySet Assignment. ## Methods |
v1.0 | Intune Policyset Policysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policysetitem.md | doc_type: resourcePageType # policySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for PolicySet Item. ## Methods |
v1.0 | Intune Policyset Policysetstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-policysetstatus.md | doc_type: enumPageType # policySetStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The enum to specify the status of PolicySet. ## Members |
v1.0 | Intune Policyset Targetedmanagedappconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-targetedmanagedappconfigurationpolicysetitem.md | doc_type: resourcePageType # targetedManagedAppConfigurationPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for Targeted managed app configuration PolicySetItem. |
v1.0 | Intune Policyset Win32lobappassignmentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-win32lobappassignmentsettings.md | doc_type: resourcePageType # win32LobAppAssignmentSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to assign an Win32 LOB mobile app to a group. |
v1.0 | Intune Policyset Win32lobappautoupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-win32lobappautoupdatesettings.md | doc_type: resourcePageType # win32LobAppAutoUpdateSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties used to perform the auto-update of an application. ## Properties |
v1.0 | Intune Policyset Win32lobappautoupdatesupersededapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-win32lobappautoupdatesupersededapps.md | doc_type: enumPageType # win32LobAppAutoUpdateSupersededApps enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains value for auto-update superseded apps. ## Members |
v1.0 | Intune Policyset Windows10enrollmentcompletionpageconfigurationpolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-windows10enrollmentcompletionpageconfigurationpolicysetitem.md | doc_type: resourcePageType # windows10EnrollmentCompletionPageConfigurationPolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for Windows10EnrollmentCompletionPageConfiguration PolicySetItem. |
v1.0 | Intune Policyset Windowsautopilotdeploymentprofilepolicysetitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-policyset-windowsautopilotdeploymentprofilepolicysetitem.md | doc_type: resourcePageType # windowsAutopilotDeploymentProfilePolicySetItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for windows autopilot deployment profile PolicySetItem. |
v1.0 | Intune Raimportcerts Certificateconnectordetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-certificateconnectordetails.md | doc_type: resourcePageType # certificateConnectorDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity used to retrieve information about Intune Certificate Connectors. ## Methods |
v1.0 | Intune Raimportcerts Certificateconnectorhealthmetricvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-certificateconnectorhealthmetricvalue.md | doc_type: resourcePageType # certificateConnectorHealthMetricValue resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Metric snapshot value returned in response to a GetHealthMetricTimeSeries request. ## Properties |
v1.0 | Intune Raimportcerts Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton that acts as container for a collection of UserPFXCertificate entities. ## Methods |
v1.0 | Intune Raimportcerts Onpremencryptedpayload | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-onpremencryptedpayload.md | doc_type: resourcePageType # onPremEncryptedPayload resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Raimportcerts Pfxrecryptionrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-pfxrecryptionrequest.md | doc_type: resourcePageType # pfxRecryptionRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Raimportcerts Pfxusercertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-pfxusercertificate.md | doc_type: resourcePageType # pfxUserCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Raimportcerts Timeseriesparameter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-timeseriesparameter.md | doc_type: resourcePageType # timeSeriesParameter resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Parameter passed to GetHealthMetricTimeSeries when requesting snapshot time series. ## Properties |
v1.0 | Intune Raimportcerts Userpfxcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-userpfxcertificate.md | doc_type: resourcePageType # userPFXCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that encapsulates all information required for a user's PFX certificates. ## Methods |
v1.0 | Intune Raimportcerts Userpfxintendedpurpose | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-userpfxintendedpurpose.md | doc_type: enumPageType # userPfxIntendedPurpose enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported values for the intended purpose of a user PFX certificate. ## Members |
v1.0 | Intune Raimportcerts Userpfxpaddingscheme | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-raimportcerts-userpfxpaddingscheme.md | doc_type: enumPageType # userPfxPaddingScheme enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported values for the padding scheme used by encryption provider. ## Members |
v1.0 | Intune Rapolicy Applicabilityrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-applicabilityrule.md | doc_type: resourcePageType # applicabilityRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Intune Rapolicy Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton that acts as container for a collection of Resource Access entities. ## Methods |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialissuer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementderivedcredentialissuer.md | doc_type: enumPageType # deviceManagementDerivedCredentialIssuer enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported values for the derived credential issuer. ## Members |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialnotificationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementderivedcredentialnotificationtype.md | doc_type: enumPageType # deviceManagementDerivedCredentialNotificationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported values for the notification type to use. ## Members |
v1.0 | Intune Rapolicy Devicemanagementderivedcredentialsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementderivedcredentialsettings.md | doc_type: resourcePageType # deviceManagementDerivedCredentialSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that describes tenant level settings for derived credentials ## Methods |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementresourceaccessprofileassignment.md | doc_type: resourcePageType # deviceManagementResourceAccessProfileAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity that describes tenant level settings for derived credentials ## Methods |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofilebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementresourceaccessprofilebase.md | doc_type: resourcePageType # deviceManagementResourceAccessProfileBase resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base Profile Type for Resource Access ## Methods |
v1.0 | Intune Rapolicy Devicemanagementresourceaccessprofileintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-devicemanagementresourceaccessprofileintent.md | doc_type: enumPageType # deviceManagementResourceAccessProfileIntent enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The administrator intent for the assignment of the profile. ## Members |
v1.0 | Intune Rapolicy Extendedkeyusage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-extendedkeyusage.md | doc_type: resourcePageType # extendedKeyUsage resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Custom Extended Key Usage definition ## Properties |
v1.0 | Intune Rapolicy Filterassociationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-filterassociationtype.md | doc_type: enumPageType # filterAssociationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Rapolicy Oseditionapplicabilityrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-oseditionapplicabilityrule.md | doc_type: resourcePageType # osEditionApplicabilityRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) ## Properties |
v1.0 | Intune Rapolicy Osversionapplicabilityrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-osversionapplicabilityrule.md | doc_type: resourcePageType # osVersionApplicabilityRule resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. Namespace: microsoft.graph - Inherits from [applicabilityRule](../resources/intune-rapolicy-applicabilityrule.md) ## Properties |
v1.0 | Intune Rapolicy Policyplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-policyplatformtype.md | doc_type: enumPageType # policyPlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types for policies. ## Members Supported platform types for policies. |androidWorkProfile|7|AndroidWorkProfile.| |windows10XProfile|8|Windows10XProfile.| |androidAOSP|9|AndroidAOSPProfile.|+|linux|10|Linux.| |all|100|All platforms.| |
v1.0 | Intune Rapolicy Windows10xcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xcertificateprofile.md | doc_type: resourcePageType # windows10XCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base Profile Type for Authentication Certificates (SCEP or PFX Create) |
v1.0 | Intune Rapolicy Windows10xcustomsubjectalternativename | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xcustomsubjectalternativename.md | doc_type: resourcePageType # windows10XCustomSubjectAlternativeName resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Base Profile Type for Authentication Certificates (SCEP or PFX Create) ## Properties |
v1.0 | Intune Rapolicy Windows10xscepcertificateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xscepcertificateprofile.md | doc_type: resourcePageType # windows10XSCEPCertificateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows X SCEP Certificate configuration profile |
v1.0 | Intune Rapolicy Windows10xtrustedrootcertificate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xtrustedrootcertificate.md | doc_type: resourcePageType # windows10XTrustedRootCertificate resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows X Trusted Root Certificate configuration profile |
v1.0 | Intune Rapolicy Windows10xvpnconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xvpnconfiguration.md | doc_type: resourcePageType # windows10XVpnConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows X VPN configuration profile |
v1.0 | Intune Rapolicy Windows10xwificonfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rapolicy-windows10xwificonfiguration.md | doc_type: resourcePageType # windows10XWifiConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows X WifiXml configuration profile |
v1.0 | Intune Rbac Deviceandappmanagementassignedroledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementassignedroledefinition.md | + + Title: "deviceAndAppManagementAssignedRoleDefinition resource type" +description: "Complex type to represent the role that is assigned to the user. This type contains the ID, the display name, and the permissions of the role." ++ms.localizationpriority: medium ++++# deviceAndAppManagementAssignedRoleDefinition resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Complex type to represent the role that is assigned to the user. This type contains the ID, the display name, and the permissions of the role. ++## Properties +|Property|Type|Description| +|:|:|:| +|roleDefinitionDisplayName|String|The RoleDefinitionDisplayName property represents the human-readable name of a specific role definition in Microsoft Intune. This property provides a clear and descriptive name that indicates the purpose or scope of the role, helping administrators identify and assign appropriate roles to users or groups.Some example values for RoleDefinitionDisplayName might include: "Helpdesk Operator," "Application Manager," or "Policy Administrator." This display name is primarily used in the Intune console or Graph API to present roles in a user-friendly manner, making it easier for administrators to manage role-based access control (RBAC) efficiently. This property is read-only.| +|permissions|String collection|A list of permissions based on its associated role. Each permission defines the specific actions the user can perform on Intune resources, such as managing devices, applications, or configurations. Some possible values are: Microsoft.Intune/MobileApps/Read, Microsoft.Intune/DeviceConfigurations/Write, Microsoft.Intune/ManagedDevices/Retire, and Microsoft.Intune/DeviceCompliancePolicies/Assign. This Permissions property offers a comprehensive view of the user's effective access rights, ensuring that they can only perform actions relevant to their assigned roles. This property is read-only.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.deviceAndAppManagementAssignedRoleDefinition" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.deviceAndAppManagementAssignedRoleDefinition", + "roleDefinitionDisplayName": "String", + "permissions": [ + "String" + ] +} +``` |
v1.0 | Intune Rbac Deviceandappmanagementassignedroledetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementassignedroledetail.md | + + Title: "deviceAndAppManagementAssignedRoleDetail resource type" +description: "The DeviceAndAppManagementAssignedRoleDetail is a complex type in Microsoft Intune used to represent the Role Definitions and Permissions that are assigned to a specific user. This type provides a detailed view of the roles a user holds, along with the associated permissions that determine the specific actions the user can perform within Intune environment." ++ms.localizationpriority: medium ++++# deviceAndAppManagementAssignedRoleDetail resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++The DeviceAndAppManagementAssignedRoleDetail is a complex type in Microsoft Intune used to represent the Role Definitions and Permissions that are assigned to a specific user. This type provides a detailed view of the roles a user holds, along with the associated permissions that determine the specific actions the user can perform within Intune environment. ++## Properties +|Property|Type|Description| +|:|:|:| +|roleDefinitions|[deviceAndAppManagementAssignedRoleDefinition](../resources/intune-rbac-deviceandappmanagementassignedroledefinition.md) collection|A collection of RoleDefinitions represents the various administrative roles that define permissions and access levels within Microsoft Intune. Each RoleDefinition outlines a set of permissions that determine the actions an admin or user can perform in the Intune environment. These permissions can include actions like reading or writing to specific resources, managing device configurations, deploying policies, or handling user data. RoleDefinitions are critical for enforcing role-based access control (RBAC), ensuring that administrators can only interact with the features and data relevant to their responsibilities. RoleDefinitions in Intune can either be built-in roles provided by Microsoft or custom roles created by an organization to tailor access based on specific needs. These definitions are referenced when assigning roles to users or groups, effectively controlling the scope of their administrative privileges. The collection of RoleDefinitions is managed through the Intune console or the Graph API, allowing for scalable role management across large environments. This property is read-only.| +|permissions|String collection|The list of permissions assigned to a specific user based on their associated role definitions. Each permission defines the specific actions the user can perform on Intune resources, such as managing devices, applications, or configurations. Some possible values are: Microsoft.Intune/MobileApps/Read, Microsoft.Intune/DeviceConfigurations/Write, Microsoft.Intune/ManagedDevices/Retire, and Microsoft.Intune/DeviceCompliancePolicies/Assign. This Permissions property provides a comprehensive view of the user's effective access rights, ensuring that they can only perform actions relevant to their assigned roles. This property is read-only.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.deviceAndAppManagementAssignedRoleDetail" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.deviceAndAppManagementAssignedRoleDetail", + "roleDefinitions": [ + { + "@odata.type": "microsoft.graph.deviceAndAppManagementAssignedRoleDefinition", + "roleDefinitionDisplayName": "String", + "permissions": [ + "String" + ] + } + ], + "permissions": [ + "String" + ] +} +``` |
v1.0 | Intune Rbac Deviceandappmanagementassignedroledetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementassignedroledetails.md | doc_type: resourcePageType # deviceAndAppManagementAssignedRoleDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The set of Role Definitions and Role Assignments assigned to a user. ## Properties |
v1.0 | Intune Rbac Deviceandappmanagementroleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementroleassignment.md | doc_type: resourcePageType # deviceAndAppManagementRoleAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Role Assignment resource. Role assignments tie together a role definition with members and scopes. There can be one or more role assignments per role. This applies to custom and built-in roles. |
v1.0 | Intune Rbac Deviceandappmanagementroledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-deviceandappmanagementroledefinition.md | doc_type: resourcePageType # deviceAndAppManagementRoleDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Role Definition resource. The role definition is the foundation of role based access in Intune. The role combines an Intune resource such as a Mobile App and associated role permissions such as Create or Read for the resource. There are two types of roles, built-in and custom. Built-in roles cannot be modified. Both built-in roles and custom roles must have assignments to be enforced. Create custom roles if you want to define a role that allows any of the available resources and role permissions to be combined into a single role. |
v1.0 | Intune Rbac Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Rbac Identity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-identity.md | doc_type: resourcePageType # identity resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Identity ## Properties |
v1.0 | Intune Rbac Identityset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-identityset.md | doc_type: resourcePageType # identitySet resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Identity Set ## Properties |
v1.0 | Intune Rbac Operationapprovalpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicy.md | doc_type: resourcePageType # operationApprovalPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The OperationApprovalPolicy entity allows an administrator to configure which operations require admin approval and the set of admins who can perform that approval. Creating a policy enables the multiple admin approval service to catch requests which are targeted by the specific policy type defined. ## Methods |
v1.0 | Intune Rbac Operationapprovalpolicyplatform | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicyplatform.md | doc_type: enumPageType # operationApprovalPolicyPlatform enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The set of available platforms for the OperationApprovalPolicy. Allows configuration of a policy to specific platform(s) for approval. If no specific platform is required or applicable, the platform is `notApplicable`. ## Members |
v1.0 | Intune Rbac Operationapprovalpolicyset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicyset.md | doc_type: resourcePageType # operationApprovalPolicySet resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains the pair of OperationApprovalPolicyType and OperationApprovalPolicyPlatform determining the set of applicable OperationApprovalPolicies for a user. The OperationApprovalPolicySet complex type is used to indicate to the UX which policies are enabled for the current logged in user in order to correctly show the expected experience. ## Properties |
v1.0 | Intune Rbac Operationapprovalpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalpolicytype.md | doc_type: enumPageType # operationApprovalPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The set of available policy types that can be configured for approval. The policy type must always be defined in an OperationApprovalRequest. ## Members |
v1.0 | Intune Rbac Operationapprovalrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalrequest.md | doc_type: resourcePageType # operationApprovalRequest resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The OperationApprovalRequest entity encompasses the operation an admin wishes to perform and is requesting approval to complete. It contains the detail of the operation one wishes to perform, user metadata of the requestor, and a justification for the change. It allows for several operations for both the requestor and the potential approver to either approve, deny, or cancel the request and a response justification to provide information for the decision. ## Methods |
v1.0 | Intune Rbac Operationapprovalrequestentitystatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalrequestentitystatus.md | doc_type: resourcePageType # operationApprovalRequestEntityStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The operationApprovalRequestEntityStatus complex type is used to provide the basic infortmation relating to the status of a request without revealing too much information to the calling user as it may be an object out of scope. ## Properties |
v1.0 | Intune Rbac Operationapprovalrequeststatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalrequeststatus.md | doc_type: enumPageType # operationApprovalRequestStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the status of the Approval Request. The status of a request will change when an action is successfully performed on it, such as when it is `approved` or `rejected`, or when the request's expiration DateTime passes and the result is `expired`. ## Members |
v1.0 | Intune Rbac Operationapprovalsource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-operationapprovalsource.md | doc_type: enumPageType # operationApprovalSource enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Source of the action on the approval request. ## Members |
v1.0 | Intune Rbac Rbacapplicationmultiple | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rbacapplicationmultiple.md | doc_type: resourcePageType # rbacApplicationMultiple resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Rbac Resourceaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-resourceaction.md | doc_type: resourcePageType # resourceAction resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Set of allowed and not allowed actions for a resource. ## Properties |
v1.0 | Intune Rbac Resourceoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-resourceoperation.md | doc_type: resourcePageType # resourceOperation resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Describes the resourceOperation resource (entity) of the Microsoft Graph API (REST), which supports Intune workflows related to role-based access control (RBAC). ## Methods |
v1.0 | Intune Rbac Roleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-roleassignment.md | doc_type: resourcePageType # roleAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Role Assignment resource. Role assignments tie together a role definition with members and scopes. There can be one or more role assignments per role. This applies to custom and built-in roles. ## Methods |
v1.0 | Intune Rbac Roleassignmentscopetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-roleassignmentscopetype.md | doc_type: enumPageType # roleAssignmentScopeType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Specifies the type of scope for a Role Assignment. ## Members |
v1.0 | Intune Rbac Roledefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-roledefinition.md | doc_type: resourcePageType # roleDefinition resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The Role Definition resource. The role definition is the foundation of role based access in Intune. The role combines an Intune resource such as a Mobile App and associated role permissions such as Create or Read for the resource. There are two types of roles, built-in and custom. Built-in roles cannot be modified. Both built-in roles and custom roles must have assignments to be enforced. Create custom roles if you want to define a role that allows any of the available resources and role permissions to be combined into a single role. ## Methods |
v1.0 | Intune Rbac Rolemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolemanagement.md | doc_type: resourcePageType # roleManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Rbac Rolepermission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolepermission.md | doc_type: resourcePageType # rolePermission resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains the set of ResourceActions determining the allowed and not allowed permissions for each role. ## Properties |
v1.0 | Intune Rbac Rolescopetag | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolescopetag.md | doc_type: resourcePageType # roleScopeTag resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Role Scope Tag ## Methods |
v1.0 | Intune Rbac Rolescopetagautoassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-rbac-rolescopetagautoassignment.md | doc_type: resourcePageType # roleScopeTagAutoAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains the properties for auto-assigning a Role Scope Tag to a group to be applied to Devices. ## Methods |
v1.0 | Intune Remoteassistance Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Remoteassistance Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-devicemanagementreports.md | doc_type: resourcePageType # deviceManagementReports resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - DeviceManagementReports class for Reporting V2 ## Methods |
v1.0 | Intune Remoteassistance Enrollmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-enrollmentstate.md | doc_type: enumPageType # enrollmentState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This status denotes the current enrollent state of the device ## Members |
v1.0 | Intune Remoteassistance Remoteassistanceonboardingstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistanceonboardingstatus.md | doc_type: enumPageType # remoteAssistanceOnboardingStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The current TeamViewer connector status ## Members |
v1.0 | Intune Remoteassistance Remoteassistancepartner | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistancepartner.md | doc_type: resourcePageType # remoteAssistancePartner resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - RemoteAssistPartner resources represent the metadata and status of a given Remote Assistance partner service. ## Methods |
v1.0 | Intune Remoteassistance Remoteassistancesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistancesettings.md | doc_type: resourcePageType # remoteAssistanceSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Remote assistance settings for the account ## Methods |
v1.0 | Intune Remoteassistance Remoteassistancestate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-remoteassistance-remoteassistancestate.md | doc_type: enumPageType # remoteAssistanceState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - State of remote assistance for the account ## Members |
v1.0 | Intune Reporting Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Reporting Devicemanagementcachedreportconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementcachedreportconfiguration.md | doc_type: resourcePageType # deviceManagementCachedReportConfiguration resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing the configuration of a cached report. ## Methods |
v1.0 | Intune Reporting Devicemanagementexportjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementexportjob.md | doc_type: resourcePageType # deviceManagementExportJob resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Entity representing a job to export a report. ## Methods |
v1.0 | Intune Reporting Devicemanagementexportjoblocalizationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementexportjoblocalizationtype.md | doc_type: enumPageType # deviceManagementExportJobLocalizationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Configures how the requested export job is localized. ## Members |
v1.0 | Intune Reporting Devicemanagementreportfileformat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementreportfileformat.md | Title: "deviceManagementReportFileFormat enum type" -description: "Possible values for the file format of a report." +description: "Possible values for the file format of a report to be exported." ms.localizationpriority: medium doc_type: enumPageType # deviceManagementReportFileFormat enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Possible values for the file format of a report. +Possible values for the file format of a report to be exported. ## Members |Member|Value|Description| |
v1.0 | Intune Reporting Devicemanagementreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementreports.md | doc_type: resourcePageType # deviceManagementReports resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all reports functionality. ## Methods |
v1.0 | Intune Reporting Devicemanagementreportstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-reporting-devicemanagementreportstatus.md | doc_type: enumPageType # deviceManagementReportStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible statuses associated with a generated report. ## Members |
v1.0 | Intune Servicenowconnectorservice Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton that acts as container for a collection of Resource Access entities. ## Methods |
v1.0 | Intune Servicenowconnectorservice Servicenowauthenticationmethod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowauthenticationmethod.md | doc_type: resourcePageType # serviceNowAuthenticationMethod resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An abstract base class for all serviceNow authentication methods. ## Properties |
v1.0 | Intune Servicenowconnectorservice Servicenowconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowconnection.md | doc_type: resourcePageType # serviceNowConnection resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ServiceNow properties including the ServiceNow instanceUrl, connection credentials and other metadata. ## Methods |
v1.0 | Intune Servicenowconnectorservice Servicenowconnectionstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowconnectionstatus.md | doc_type: enumPageType # serviceNowConnectionStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Status of ServiceNow Connection ## Members |
v1.0 | Intune Servicenowconnectorservice Servicenowoauthsecretauthentication | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-servicenowconnectorservice-servicenowoauthsecretauthentication.md | doc_type: resourcePageType # serviceNowOauthSecretAuthentication resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - App id for the ServiceNow client app. |
v1.0 | Intune Shared Deviceandappmanagementassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-deviceandappmanagementassignmenttarget.md | Base type for assignment targets. ## Properties |Property|Type|Description| |:|:|:|-|deviceAndAppManagementAssignmentFilterId|String|The Id of the filter for the target assignment.| +|deviceAndAppManagementAssignmentFilterId|String|The ID of the filter for the target assignment.| |deviceAndAppManagementAssignmentFilterType|[deviceAndAppManagementAssignmentFilterType](../resources/intune-shared-deviceandappmanagementassignmentfiltertype.md)|The type of filter of the target assignment i.e. Exclude or Include. Possible values are: `none`, `include`, `exclude`.| ## Relationships-None +None. ## JSON Representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget" |
v1.0 | Intune Shared Enrollmenttimedevicemembershiptarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enrollmenttimedevicemembershiptarget.md | + + Title: "enrollmentTimeDeviceMembershipTarget resource type" +description: "The EnrollmentTimeDeviceMembershipTarget entity represents the targets that devices will become members of when enrolled with the associated profile. The only device membership targets supported at this time is static security groups." ++ms.localizationpriority: medium ++++# enrollmentTimeDeviceMembershipTarget resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++The EnrollmentTimeDeviceMembershipTarget entity represents the targets that devices will become members of when enrolled with the associated profile. The only device membership targets supported at this time is static security groups. ++## Properties +|Property|Type|Description| +|:|:|:| +|targetType|[enrollmentTimeDeviceMembershipTargetType](../resources/intune-shared-enrollmenttimedevicemembershiptargettype.md)|The type of the targets that devices will become members of when enrolled with the asociated profile. Possible values are staticSecurityGroup. Default value : unknown. Possible values are: `unknown`, `staticSecurityGroup`, `unknownFutureValue`.| +|targetId|String|The unique identifiers of the targets that devices will become members of when enrolled with the asociated profile.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.enrollmentTimeDeviceMembershipTarget" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.enrollmentTimeDeviceMembershipTarget", + "targetType": "String", + "targetId": "String" +} +``` |
v1.0 | Intune Shared Enrollmenttimedevicemembershiptargetresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enrollmenttimedevicemembershiptargetresult.md | + + Title: "enrollmentTimeDeviceMembershipTargetResult resource type" +description: "The EnrollmentTimeDeviceMembershipTargetResult entity represents the results of the set/get EnrollmentTimeDeviceMembershipTarget request. The set/get EnrollmentTimeDeviceMembershipTarget API validates the device membership targets specified by the admin to ensure that they exist, that they are of the proper type, and any other target requirements are met such as that the Intune Device Provisioning First Party App is an owner of the target. Failures other than validation will result in 500 else validationSucceeded will be true or false if any of the validation fails for EnrollmentTimeDeviceMembershipTarget." ++ms.localizationpriority: medium ++++# enrollmentTimeDeviceMembershipTargetResult resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++The EnrollmentTimeDeviceMembershipTargetResult entity represents the results of the set/get EnrollmentTimeDeviceMembershipTarget request. The set/get EnrollmentTimeDeviceMembershipTarget API validates the device membership targets specified by the admin to ensure that they exist, that they are of the proper type, and any other target requirements are met such as that the Intune Device Provisioning First Party App is an owner of the target. Failures other than validation will result in 500 else validationSucceeded will be true or false if any of the validation fails for EnrollmentTimeDeviceMembershipTarget. ++## Properties +|Property|Type|Description| +|:|:|:| +|validationSucceeded|Boolean|Indicates if validations succeeded for the device membership target. When 'true', the device membership target validation found no issues. When 'false', the device membership target validation found issues. default - false| +|enrollmentTimeDeviceMembershipTargetValidationStatuses|[enrollmentTimeDeviceMembershipTargetStatus](../resources/intune-shared-enrollmenttimedevicemembershiptargetstatus.md) collection|A list of validation status of the memberships targetted to profile. This collection can contain a maximum of 1 elements.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.enrollmentTimeDeviceMembershipTargetResult" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.enrollmentTimeDeviceMembershipTargetResult", + "validationSucceeded": true, + "enrollmentTimeDeviceMembershipTargetValidationStatuses": [ + { + "@odata.type": "microsoft.graph.enrollmentTimeDeviceMembershipTargetStatus", + "targetId": "String", + "validationSucceeded": true, + "targetValidationErrorCode": "String" + } + ] +} +``` |
v1.0 | Intune Shared Enrollmenttimedevicemembershiptargetstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enrollmenttimedevicemembershiptargetstatus.md | + + Title: "enrollmentTimeDeviceMembershipTargetStatus resource type" +description: "Represents the Validation status of the device membership targets. The set/get EnrollmentTimeDeviceMembershipTarget API validates the device membership targets specified by the admin to ensure that they exist, that they are of the proper type, and any other target requirements are met such as that the Intune Device Provisioning First Party App is an owner of the target." ++ms.localizationpriority: medium ++++# enrollmentTimeDeviceMembershipTargetStatus resource type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Represents the Validation status of the device membership targets. The set/get EnrollmentTimeDeviceMembershipTarget API validates the device membership targets specified by the admin to ensure that they exist, that they are of the proper type, and any other target requirements are met such as that the Intune Device Provisioning First Party App is an owner of the target. ++## Properties +|Property|Type|Description| +|:|:|:| +|targetId|String|The unique identifiers of the targets that devices will become members of when enrolled with the asociated profile.| +|validationSucceeded|Boolean|Indicates if validations succeeded for the device membership target. When 'true', the device membership target validation found no issues. When 'false', the device membership target validation found issues. default - false| +|targetValidationErrorCode|[enrollmentTimeDeviceMembershipTargetValidationErrorCode](../resources/intune-shared-enrollmenttimedevicemembershiptargetvalidationerrorcode.md)|The Validation Error of target that devices will become members of when enrolled with the asociated profile. When there are validation issues are found this property is set with the associated error code of the failure and validationSucceeded property is set to is false. When there are no validation issues found this property will have default value: unknown and validationSucceeded property is set to is true. Possible validation values are unknown,securityGroupNotFound,notSecurityGroup,notStaticSecurityGroup,firstPartyAppNotAnOwner. Default value : unknown. Possible values are: `unknown`, `securityGroupNotFound`, `notSecurityGroup`, `notStaticSecurityGroup`, `firstPartyAppNotAnOwner`, `securityGroupNotInCallerScope`, `unknownFutureValue`.| ++## Relationships +None ++## JSON Representation +Here is a JSON representation of the resource. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.enrollmentTimeDeviceMembershipTargetStatus" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.enrollmentTimeDeviceMembershipTargetStatus", + "targetId": "String", + "validationSucceeded": true, + "targetValidationErrorCode": "String" +} +``` |
v1.0 | Intune Shared Enrollmenttimedevicemembershiptargettype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enrollmenttimedevicemembershiptargettype.md | + + Title: "enrollmentTimeDeviceMembershipTargetType enum type" +description: "Represents the type of the targets that devices will become members of when enrolled with the associated profile. Possible values are staticSecurityGroup." ++ms.localizationpriority: medium ++++# enrollmentTimeDeviceMembershipTargetType enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Represents the type of the targets that devices will become members of when enrolled with the associated profile. Possible values are staticSecurityGroup. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default value. Do not use.| +|staticSecurityGroup|1|Indicates the device membership target specified refer to static Entra Security Groups.| +|unknownFutureValue|2|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Shared Enrollmenttimedevicemembershiptargetvalidationerrorcode | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-shared-enrollmenttimedevicemembershiptargetvalidationerrorcode.md | + + Title: "enrollmentTimeDeviceMembershipTargetValidationErrorCode enum type" +description: "Represents the Validation error of the device membership target.The API will validate the device membership targets specified by the admin to ensure that they exist, that they are of the proper type, and any other target requirements are met such as that the Intune Device Provisioning First Party App is an owner of the target." ++ms.localizationpriority: medium ++++# enrollmentTimeDeviceMembershipTargetValidationErrorCode enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Represents the Validation error of the device membership target.The API will validate the device membership targets specified by the admin to ensure that they exist, that they are of the proper type, and any other target requirements are met such as that the Intune Device Provisioning First Party App is an owner of the target. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default. Indicates the status of device membership target is not specified. Do not use.| +|securityGroupNotFound|1|Indicates device membership target cannot be found.| +|notSecurityGroup|2|Indicates device membership target is not a security group.| +|notStaticSecurityGroup|3|Indicates device membership target which is security group but not a static one.| +|firstPartyAppNotAnOwner|4|Indicates required first party app not the owner of that device membership target.| +|securityGroupNotInCallerScope|5|Indicates that device membership target of type security group is not in the RBAC scope of the caller.| +|unknownFutureValue|6|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Softwareupdate Bulkdriveractionresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-bulkdriveractionresult.md | doc_type: resourcePageType # bulkDriverActionResult resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to represent the result of bulk driver action. ## Properties |
v1.0 | Intune Softwareupdate Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Softwareupdate Driverapprovalaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-driverapprovalaction.md | doc_type: enumPageType # driverApprovalAction enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum type to represent approval actions of single or list of drivers. ## Members |
v1.0 | Intune Softwareupdate Driverapprovalstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-driverapprovalstatus.md | doc_type: enumPageType # driverApprovalStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum type to represent approval status of a driver. ## Members |
v1.0 | Intune Softwareupdate Drivercategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-drivercategory.md | doc_type: enumPageType # driverCategory enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum type to represent which category a driver belongs to. ## Members |
v1.0 | Intune Softwareupdate Driverupdateprofileapprovaltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-driverupdateprofileapprovaltype.md | doc_type: enumPageType # driverUpdateProfileApprovalType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - An enum type to represent approval type of a driver update profile. ## Members |
v1.0 | Intune Softwareupdate Expeditedwindowsqualityupdatesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-expeditedwindowsqualityupdatesettings.md | doc_type: resourcePageType # expeditedWindowsQualityUpdateSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to store the expedited quality update settings such as release date and days until forced reboot. ## Properties |
v1.0 | Intune Softwareupdate Iosavailableupdateversion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-iosavailableupdateversion.md | doc_type: resourcePageType # iosAvailableUpdateVersion resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - iOS available update version details ## Properties |
v1.0 | Intune Softwareupdate Windowsdriverupdateinventory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateinventory.md | doc_type: resourcePageType # windowsDriverUpdateInventory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A new entity to represent driver inventories. ## Methods |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofile.md | doc_type: resourcePageType # windowsDriverUpdateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Driver Update Profile ## Methods |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofileassignment.md | doc_type: resourcePageType # windowsDriverUpdateProfileAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity contains the properties used to assign a windows driver update profile to a group. ## Methods |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofileinventorysyncstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofileinventorysyncstate.md | doc_type: enumPageType # windowsDriverUpdateProfileInventorySyncState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows DnF update inventory sync state. ## Members |
v1.0 | Intune Softwareupdate Windowsdriverupdateprofileinventorysyncstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsdriverupdateprofileinventorysyncstatus.md | doc_type: resourcePageType # windowsDriverUpdateProfileInventorySyncStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to store the status of a driver and firmware profile inventory sync. The status includes the last successful sync date time and the state of the last sync. ## Properties |
v1.0 | Intune Softwareupdate Windowsfeatureupdatecatalogitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsfeatureupdatecatalogitem.md | doc_type: resourcePageType # windowsFeatureUpdateCatalogItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows update catalog item entity |
v1.0 | Intune Softwareupdate Windowsfeatureupdateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsfeatureupdateprofile.md | doc_type: resourcePageType # windowsFeatureUpdateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Feature Update Profile ## Methods |
v1.0 | Intune Softwareupdate Windowsfeatureupdateprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsfeatureupdateprofileassignment.md | doc_type: resourcePageType # windowsFeatureUpdateProfileAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity contains the properties used to assign a windows feature update profile to a group. ## Methods |
v1.0 | Intune Softwareupdate Windowsqualityupdatecatalogitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdatecatalogitem.md | doc_type: resourcePageType # windowsQualityUpdateCatalogItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows update catalog item entity |
v1.0 | Intune Softwareupdate Windowsqualityupdateclassification | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdateclassification.md | doc_type: enumPageType # windowsQualityUpdateClassification enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows quality update classification ## Members |
v1.0 | Intune Softwareupdate Windowsqualityupdatepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdatepolicy.md | doc_type: resourcePageType # windowsQualityUpdatePolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Quality Update Policy ## Methods |
v1.0 | Intune Softwareupdate Windowsqualityupdatepolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdatepolicyassignment.md | doc_type: resourcePageType # windowsQualityUpdatePolicyAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity contains the properties used to assign a Windows quality update policy to a group. ## Methods |
v1.0 | Intune Softwareupdate Windowsqualityupdateprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdateprofile.md | doc_type: resourcePageType # windowsQualityUpdateProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Quality Update Profile ## Methods |
v1.0 | Intune Softwareupdate Windowsqualityupdateprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsqualityupdateprofileassignment.md | doc_type: resourcePageType # windowsQualityUpdateProfileAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity contains the properties used to assign a windows quality update profile to a group. ## Methods |
v1.0 | Intune Softwareupdate Windowsupdatecatalogitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsupdatecatalogitem.md | doc_type: resourcePageType # windowsUpdateCatalogItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows update catalog item entity ## Methods |
v1.0 | Intune Softwareupdate Windowsupdaterolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-softwareupdate-windowsupdaterolloutsettings.md | doc_type: resourcePageType # windowsUpdateRolloutSettings resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A complex type to store the windows update rollout settings including offer start date time, offer end date time, and days between each set of offers. ## Properties |
v1.0 | Intune Troubleshooting Applevpptokentroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-applevpptokentroubleshootingevent.md | doc_type: resourcePageType # appleVppTokenTroubleshootingEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Event representing an Apple Vpp Token Troubleshooting Event. |
v1.0 | Intune Troubleshooting Connectorhealthstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-connectorhealthstate.md | doc_type: enumPageType # connectorHealthState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Connector health state for connector status ## Members |
v1.0 | Intune Troubleshooting Connectorname | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-connectorname.md | doc_type: enumPageType # connectorName enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Connectors name for connector status ## Members |
v1.0 | Intune Troubleshooting Connectorstatusdetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-connectorstatusdetails.md | doc_type: resourcePageType # connectorStatusDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represent connector status ## Properties |
v1.0 | Intune Troubleshooting Deviceenrollmentfailurereason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-deviceenrollmentfailurereason.md | doc_type: enumPageType # deviceEnrollmentFailureReason enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Top level failure categories for enrollment. ## Members |
v1.0 | Intune Troubleshooting Deviceenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-deviceenrollmenttype.md | doc_type: enumPageType # deviceEnrollmentType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible ways of adding a mobile device to management. ## Members |
v1.0 | Intune Troubleshooting Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Troubleshooting Devicemanagementautopilotevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementautopilotevent.md | doc_type: resourcePageType # deviceManagementAutopilotEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Represents an Autopilot flow event. ## Methods Represents an Autopilot flow event. |:|:|:| |id|String|UUID for the object| |deviceId|String|Device id associated with the object|+|userId|String|UserId id associated with the object| |eventDateTime|DateTimeOffset|Time when the event occurred .| |deviceRegisteredDateTime|DateTimeOffset|Device registration date.| |enrollmentStartDateTime|DateTimeOffset|Device enrollment start date.| Represents an Autopilot flow event. |osVersion|String|Device operating system version.| |deploymentDuration|Duration|Autopilot deployment duration including enrollment.| |deploymentTotalDuration|Duration|Total deployment duration from enrollment to Desktop screen.|-|devicePreparationDuration|Duration|Time spent in device enrollment.| |deviceSetupDuration|Duration|Time spent in device ESP.| |accountSetupDuration|Duration|Time spent in user ESP.| |deploymentStartDateTime|DateTimeOffset|Deployment start time.| |deploymentEndDateTime|DateTimeOffset|Deployment end time.|-|targetedAppCount|Int32|Count of applications targeted.| -|targetedPolicyCount|Int32|Count of policies targeted.| |enrollmentFailureDetails|String|Enrollment failure details.| ## Relationships-|Relationship|Type|Description| -|:|:|:| -|policyStatusDetails|[deviceManagementAutopilotPolicyStatusDetail](../resources/intune-troubleshooting-devicemanagementautopilotpolicystatusdetail.md) collection|Policy and application status details for this device.| +None ## JSON Representation Here is a JSON representation of the resource. Here is a JSON representation of the resource. "@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent", "id": "String (identifier)", "deviceId": "String",+ "userId": "String", "eventDateTime": "String (timestamp)", "deviceRegisteredDateTime": "String (timestamp)", "enrollmentStartDateTime": "String (timestamp)", Here is a JSON representation of the resource. "osVersion": "String", "deploymentDuration": "String (duration)", "deploymentTotalDuration": "String (duration)",- "devicePreparationDuration": "String (duration)", "deviceSetupDuration": "String (duration)", "accountSetupDuration": "String (duration)", "deploymentStartDateTime": "String (timestamp)", "deploymentEndDateTime": "String (timestamp)",- "targetedAppCount": 1024, - "targetedPolicyCount": 1024, "enrollmentFailureDetails": "String" } ``` |
v1.0 | Intune Troubleshooting Devicemanagementautopilotpolicycompliancestatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementautopilotpolicycompliancestatus.md | doc_type: enumPageType # deviceManagementAutopilotPolicyComplianceStatus enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Troubleshooting Devicemanagementautopilotpolicytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementautopilotpolicytype.md | doc_type: enumPageType # deviceManagementAutopilotPolicyType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Troubleshooting Devicemanagementscriptrunstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementscriptrunstate.md | + + Title: "deviceManagementScriptRunState enum type" +description: "Indicates the type of execution status of the device management script. This status provides insights into whether the script has been successfully executed, encountered errors, or is pending execution." ++ms.localizationpriority: medium ++++# deviceManagementScriptRunState enum type ++Namespace: microsoft.graph ++> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. ++> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. ++Indicates the type of execution status of the device management script. This status provides insights into whether the script has been successfully executed, encountered errors, or is pending execution. ++## Members +|Member|Value|Description| +|:|:|:| +|unknown|0|Default value. Indicates that the script execution status is unknown for the device.| +|success|1|Indicates that the script ran successfully for the device.| +|fail|2|Indicates that the script resulted in failure for the device.| +|scriptError|3|Indicates that the discovery script was unable to complete on the device.| +|pending|4|Indicates that the script has not yet started running on the device.| +|notApplicable|5|Indicates that the script is not applicable for this device.| +|unknownFutureValue|6|Evolvable enumeration sentinel value. Do not use.| |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingerrordetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementtroubleshootingerrordetails.md | doc_type: resourcePageType # deviceManagementTroubleshootingErrorDetails resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Object containing detailed information about the error and its remediation. ## Properties |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingerrorresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementtroubleshootingerrorresource.md | doc_type: resourcePageType # deviceManagementTroubleshootingErrorResource resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Object representing a link to troubleshooting information, the link could be to the Azure Portal or a Microsoft doc. ## Properties |
v1.0 | Intune Troubleshooting Devicemanagementtroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-devicemanagementtroubleshootingevent.md | doc_type: resourcePageType # deviceManagementTroubleshootingEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Event representing an general failure. ## Methods |
v1.0 | Intune Troubleshooting Enrollmentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-enrollmentstate.md | doc_type: enumPageType # enrollmentState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Troubleshooting Enrollmenttroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-enrollmenttroubleshootingevent.md | doc_type: resourcePageType # enrollmentTroubleshootingEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Event representing an enrollment failure. |
v1.0 | Intune Troubleshooting Manageddevicesummarizedappstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-manageddevicesummarizedappstate.md | Title: "managedDeviceSummarizedAppState resource type" -description: "Event representing a user's devices with failed or pending apps." +description: "The summarized information associated with managed device app installation status." ms.localizationpriority: medium doc_type: resourcePageType # managedDeviceSummarizedAppState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. --Event representing a user's devices with failed or pending apps. +The summarized information associated with managed device app installation status. ## Properties |Property|Type|Description| |:|:|:|-|summarizedAppState|[runState](../resources/intune-shared-runstate.md)|runState for the object. Possible values are: `unknown`, `success`, `fail`, `scriptError`, `pending`, `notApplicable`.| -|deviceId|String|DeviceId of device represented by this object| +|summarizedAppState|[deviceManagementScriptRunState](../resources/intune-troubleshooting-devicemanagementscriptrunstate.md)|The device management script run state for the device, which summarizes the overall status of apps installation on the devices. If any app installation encounters an error, the state will be marked as fail; otherwise, if any app is pending installation, the state will be marked as pending. All possible values include: unknown, fail, pending, notApplicable. Possible values are: `unknown`, `success`, `fail`, `scriptError`, `pending`, `notApplicable`, `unknownFutureValue`.| +|deviceId|String|The unique identifier (DeviceId) associated with the device.| ## Relationships None |
v1.0 | Intune Troubleshooting Mobileappactiontype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappactiontype.md | doc_type: enumPageType # mobileAppActionType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Defines the Action Types for an Intune Application. ## Members |
v1.0 | Intune Troubleshooting Mobileappintent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappintent.md | doc_type: enumPageType # mobileAppIntent enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Indicates the status of the mobile app on the device. ## Members |
v1.0 | Intune Troubleshooting Mobileappintentandstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappintentandstate.md | doc_type: resourcePageType # mobileAppIntentAndState resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - MobileApp Intent and Install State for a given device. ## Methods |
v1.0 | Intune Troubleshooting Mobileappintentandstatedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappintentandstatedetail.md | doc_type: resourcePageType # mobileAppIntentAndStateDetail resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Mobile App Intent and Install State for a given device. ## Properties |
v1.0 | Intune Troubleshooting Mobileappsupporteddevicetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileappsupporteddevicetype.md | doc_type: resourcePageType # mobileAppSupportedDeviceType resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Device properties ## Properties |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingapppolicycreationhistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingapppolicycreationhistory.md | doc_type: resourcePageType # mobileAppTroubleshootingAppPolicyCreationHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - History Item contained in the Mobile App Troubleshooting Event. |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingappstatehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingappstatehistory.md | doc_type: resourcePageType # mobileAppTroubleshootingAppStateHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - History Item contained in the Mobile App Troubleshooting Event. |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingapptargethistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingapptargethistory.md | doc_type: resourcePageType # mobileAppTroubleshootingAppTargetHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - History Item contained in the Mobile App Troubleshooting Event. |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingappupdatehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingappupdatehistory.md | doc_type: resourcePageType # mobileAppTroubleshootingAppUpdateHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - History Item contained in the Mobile App Troubleshooting Event. |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingdevicecheckinhistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingdevicecheckinhistory.md | doc_type: resourcePageType # mobileAppTroubleshootingDeviceCheckinHistory resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - History Item contained in the Mobile App Troubleshooting Event. |
v1.0 | Intune Troubleshooting Mobileapptroubleshootingevent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootingevent.md | doc_type: resourcePageType # mobileAppTroubleshootingEvent resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Event representing a users device application install status. |
v1.0 | Intune Troubleshooting Mobileapptroubleshootinghistoryitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-mobileapptroubleshootinghistoryitem.md | doc_type: resourcePageType # mobileAppTroubleshootingHistoryItem resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - History Item contained in the Mobile App Troubleshooting Event. ## Properties |
v1.0 | Intune Troubleshooting Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-report.md | doc_type: resourcePageType # report resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enrollment failure reports. ## Properties |
v1.0 | Intune Troubleshooting Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-reportroot.md | doc_type: resourcePageType # reportRoot resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - The resource that represents an instance of Enrollment Failure Reports. ## Methods |
v1.0 | Intune Troubleshooting User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-user.md | doc_type: resourcePageType # user resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| Namespace: microsoft.graph |[Update user](../api/intune-troubleshooting-user-update.md)|[user](../resources/intune-troubleshooting-user.md)|Update the properties of a [user](../resources/intune-troubleshooting-user.md) object.| |[getManagedDevicesWithAppFailures function](../api/intune-troubleshooting-user-getmanageddeviceswithappfailures.md)|String collection|Retrieves the list of devices with failed apps| |[getManagedDevicesWithFailedOrPendingApps function](../api/intune-troubleshooting-user-getmanageddeviceswithfailedorpendingapps.md)|[managedDeviceSummarizedAppState](../resources/intune-troubleshooting-manageddevicesummarizedappstate.md) collection|Retrieves the list of devices with failed or pending apps|+|[retrieveManagedDevicesWithAppInstallationIssues function](../api/intune-troubleshooting-user-retrievemanageddeviceswithappinstallationissues.md)|[managedDeviceSummarizedAppState](../resources/intune-troubleshooting-manageddevicesummarizedappstate.md) collection|Retrieves the list of devices with failed or pending apps| ## Properties |Property|Type|Description| |
v1.0 | Intune Troubleshooting Windowsautopilotdeploymentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-windowsautopilotdeploymentstate.md | doc_type: enumPageType # windowsAutopilotDeploymentState enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Deployment states for Autopilot devices ## Members |
v1.0 | Intune Troubleshooting Windowsautopilotenrollmenttype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-troubleshooting-windowsautopilotenrollmenttype.md | doc_type: enumPageType # windowsAutopilotEnrollmentType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Members |Member|Value|Description| |:|:|:| |
v1.0 | Intune Unlock Deviceappmanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-deviceappmanagement.md | doc_type: resourcePageType # deviceAppManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device and app management functionality. ## Methods |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicy.md | doc_type: resourcePageType # windowsDefenderApplicationControlSupplementalPolicy resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - ## Methods |Method|Return Type|Description| |:|:|:| |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicyassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicyassignment.md | doc_type: resourcePageType # windowsDefenderApplicationControlSupplementalPolicyAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - A class containing the properties used for assignment of a WindowsDefenderApplicationControl supplemental policy to a group. ## Methods |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentstatus.md | doc_type: resourcePageType # windowsDefenderApplicationControlSupplementalPolicyDeploymentStatus resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the deployment state of a WindowsDefenderApplicationControl supplemental policy for a device. ## Methods |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicydeploymentsummary.md | doc_type: resourcePageType # windowsDefenderApplicationControlSupplementalPolicyDeploymentSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Contains properties for the deployment summary of a WindowsDefenderApplicationControl supplemental policy. ## Methods |
v1.0 | Intune Unlock Windowsdefenderapplicationcontrolsupplementalpolicystatuses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-unlock-windowsdefenderapplicationcontrolsupplementalpolicystatuses.md | doc_type: enumPageType # windowsDefenderApplicationControlSupplementalPolicyStatuses enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Enum values for the various WindowsDefenderApplicationControl supplemental policy deployment statuses. ## Members |
v1.0 | Intune Wip Applicationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-applicationtype.md | doc_type: enumPageType # applicationType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Possible types of Application ## Members |
v1.0 | Intune Wip Devicemanagement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-devicemanagement.md | doc_type: resourcePageType # deviceManagement resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Singleton entity that acts as a container for all device management functionality. ## Methods |
v1.0 | Intune Wip Deviceplatformtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-deviceplatformtype.md | doc_type: enumPageType # devicePlatformType enum type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Supported platform types. ## Members |
v1.0 | Intune Wip Intunebrandingprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-intunebrandingprofile.md | doc_type: resourcePageType # intuneBrandingProfile resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity contains data which is used in customizing the tenant level appearance of the Company Portal applications as well as the end user web portal. ## Methods |
v1.0 | Intune Wip Intunebrandingprofileassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-intunebrandingprofileassignment.md | doc_type: resourcePageType # intuneBrandingProfileAssignment resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - This entity contains the properties used to assign a branding profile to a group. ## Methods |
v1.0 | Intune Wip Windowsinformationprotectionapplearningsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-windowsinformationprotectionapplearningsummary.md | doc_type: resourcePageType # windowsInformationProtectionAppLearningSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Information Protection AppLearning Summary entity. ## Methods |
v1.0 | Intune Wip Windowsinformationprotectionnetworklearningsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/intune-wip-windowsinformationprotectionnetworklearningsummary.md | doc_type: resourcePageType # windowsInformationProtectionNetworkLearningSummary resource type Namespace: microsoft.graph+ > **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. > **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. - Windows Information Protection Network learning Summary entity. ## Methods |
v1.0 | Invalidlicensealertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invalidlicensealertconfiguration.md | Represents an alert configuration that's triggered if the tenant doesn't have a Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md). ++## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Invalidlicensealertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/invalidlicensealertincident.md | Represents the details of an alert incident that is triggered if the current ten Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Keycredential | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/keycredential.md | To add a keyCredential using Microsoft Graph, see [Add a certificate to an app u | Property | Type |Description| |:|:--|:-| |customKeyIdentifier|Binary| A 40-character binary type that can be used to identify the credential. Optional. When not provided in the payload, defaults to the thumbprint of the certificate. |-| displayName | String | Friendly name for the key. Optional. | +| displayName | String | The friendly name for the key, with a maximum length of 90 characters. Longer values are accepted but shortened. Optional. | |endDateTime|DateTimeOffset|The date and time at which the credential expires. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|-|key|Binary| Value for the key credential. Should be a Base64 encoded value. Returned only on `$select` for a single object, that is, `GET applications/{applicationId}?$select=keyCredentials` or `GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials`; otherwise, it is always `null`. <br/><br> From a *.cer* certificate, you can read the key using the **Convert.ToBase64String()** method. For more information, see [Get the certificate key](/graph/applications-how-to-add-certificate). | +|key|Binary| Value for the key credential. Should be a Base64 encoded value. Returned only on `$select` for a single object, that is, `GET applications/{applicationId}?$select=keyCredentials` or `GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials`; otherwise, it's always `null`. <br/><br> From a *.cer* certificate, you can read the key using the **Convert.ToBase64String()** method. For more information, see [Get the certificate key](/graph/applications-how-to-add-certificate). | |keyId|Guid|The unique identifier for the key.| |startDateTime|DateTimeOffset|The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |type|String|The type of key credential; for example, `Symmetric`, `AsymmetricX509Cert`, or `X509CertAndPassword`.| |
v1.0 | Keycredentialconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/keycredentialconfiguration.md | Represents a key credential configuration object that contains properties to con | Property | Type | Description | | : | : | : |-| certificateBasedApplicationConfigurationIds | Collection(String) | Collection of GUIDs that represent [certificateBasedApplicationConfiguration](../resources/certificatebasedapplicationconfiguration.md) that is allowed as root and intermediate certificate authorities.| +| certificateBasedApplicationConfigurationIds | String collection | Collection of GUIDs that represent [certificateBasedApplicationConfiguration](../resources/certificatebasedapplicationconfiguration.md) that is allowed as root and intermediate certificate authorities.| | maxLifetime | Duration | String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, `P4DT12H30M5S` represents four days, 12 hours, 30 minutes, and five seconds. This property is required when **restrictionType** is set to `keyLifetime`.| | restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.| | restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.| The following JSON representation shows the resource type. "@odata.type": "microsoft.graph.appManagementRestrictionState" }, "restrictForAppsCreatedAfterDateTime": "String (DateTime)",- "maxLifetime": "String (ISO 8601 duration)", + "maxLifetime": "String (duration)", "certificateBasedApplicationConfigurationIds": [ "String (Guid)" ] |
v1.0 | Listitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/listitem.md | All examples are relative to a **[list][]**; for example, `https://graph.microso | [Restore document set version](../api/documentsetversion-restore.md) | No Content | Restore the document set item to a specific version. | | [Get delta](../api/listitem-delta.md) | [listItem](../resources/listitem.md) collection | Get newly created, updated, or deleted [list items](../resources/listitem.md) without having to perform a full read of the entire items collection. | | [List permissions](../api/listitem-list-permissions.md)| [permission](../resources/permission.md) |Get a list of the [permission](../resources/permission.md) objects associated with a [listItem](../resources/listitem.md).|-| [Create permission](../api/listitem-list-permissions.md)| [permission](../resources/permission.md) |Get a list of the [permission](../resources/permission.md) objects associated with a [listItem](../resources/listitem.md).| -| [Get permission](../api/listitem-post-permissions.md)| [permission](../resources/permission.md) |Create a new [permission](../resources/permission.md) object on a [listItem](../resources/listitem.md).| +| [Create permission](../api/listitem-post-permissions.md)| [permission](../resources/permission.md) |Create a new [permission](../resources/permission.md) object on a [listItem](../resources/listitem.md).| +| [Get permission](../api/listitem-get-permissions.md)| [permission](../resources/permission.md) |Get a list of the [permission](../resources/permission.md) objects associated with a [listItem](../resources/listitem.md).| | [Update permission](../api/listitem-update-permissions.md)| [permission](../resources/permission.md) |Update a [permission](../resources/permission.md) object on a [listItem](../resources/listitem.md).| | [Delete permission](../api/listitem-delete-permissions.md)| None |Delete a [permission](../resources/permission.md) object on a [listItem](../resources/listitem.md).| |
v1.0 | Mailboxprotectionrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailboxprotectionrule.md | Inherits from [protectionRuleBase](../resources/protectionrulebase.md). |createdBy|[identitySet](../resources/identityset.md)|The identity of the person who created the rule.| |createdDateTime|DateTimeOffset|The date and time that the rule was created.| |error|[publicError](../resources/publicerror.md)|Contains error details if an operation on a rule expression fails.|-|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic. Static rules run one time and dynamic rules listen to all changes in the system and update the protection unit list.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Static rules run one time while dynamic rules listen to all changes in the system and update the protection unit list. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified this rule.| |lastModifiedDateTime|DateTimeOffset|Timestamp of last modification to the rule.| |mailboxExpression|String|Contains a mailbox expression. For examples, see [mailboxExpression examples](../resources/mailboxprotectionrule.md#mailboxexpression-examples).|-|status|[protectionRuleStatus](../resources/mailboxprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| +|status|[protectionRuleStatus](../resources/mailboxprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. The `draft` member is currently unsupported. | ### mailboxExpression examples The following table shows the possible formats for the mailbox expression. |Member | Description | |:|:|-|draft | The initial status of the protection rule upon creation.| +|draft | The initial status of the protection rule upon creation. The `draft` member is currently unsupported. | |active | The status of the protection rule upon using the `/run` API.|-|completed |The status of the protection rule after it is successfully applied to the corresponding policy.| -|completedWithErrors | The status of the protection rule after it is applied to the corresponding policy and any failures occurred.| -|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.| +|completed |The status of the protection rule after it's successfully applied to the corresponding policy.| +|completedWithErrors | The status of the protection rule after it's applied to the corresponding policy and any failures occurred.| +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Mailboxprotectionunitsbulkadditionjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailboxprotectionunitsbulkadditionjob.md | + + Title: "mailboxProtectionUnitsBulkAdditionJob resource type" +description: "Represents the list of mailboxes and directory object IDs of Exchange users to be added into the corresponding Exchange protection policy." ++ms.localizationpriority: medium ++++# mailboxProtectionUnitsBulkAdditionJob resource type ++Namespace: microsoft.graph +++Represents the properties of a mailboxProtectionUnitsBulkAdditionJob associated with a [exchangeProtectionPolicy](../resources/exchangeprotectionpolicy.md). It contains a list of email addresses and a list of directory object IDs to be added to the Exchange Protection Policy for backup. ++Inherits from [protectionUnitsBulkJobBase](../resources/protectionunitsbulkjobbase.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List](../api/exchangeprotectionpolicy-list-mailboxprotectionunitsbulkadditionjobs.md)|[mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) collection|Get a list of [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md) objects and their properties.| +|[Create](../api/mailboxprotectionunitsbulkadditionjobs-post.md)|[mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md)|Create a new [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md).| +|[Get](../api/mailboxprotectionunitsbulkadditionjobs-get.md)|[mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md)|Read the properties and relationships of a [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md).| ++## Properties ++|Property|Type|Description| +|:|:|:| +|createdBy|[identitySet](../resources/identityset.md)|The identity of the person who created the job.| +|createdDateTime|DateTimeOffset|The date and time that the job was created.| +|directoryObjectIds|Collection(String)|The list of Exchange directoryObjectIds to add to the Exchange protection policy.| +|displayName|String|The name of the job.| +|error|[publicError](../resources/publicerror.md)|Contains error details if any email address resolution fails.| +|id|String|The unique identifier of the job associated with the Exchange protection policy.| +|lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified the job.| +|lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification to the job.| +|mailboxes|Collection(String)|The list of Exchange email addresses to add to the Exchange protection policy.| +|status|[protectionUnitsBulkJobStatus](../resources/protectionunitsbulkjobbase.md#protectionunitsbulkjobstatus-values )|Status of the job. The possible values are: `unknown`, `active`, `completed`, `completedWithErrors`, and `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.mailboxProtectionUnitsBulkAdditionJob", + "baseType": "microsoft.graph.protectionUnitsBulkJobBase", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.mailboxProtectionUnitsBulkAdditionJob", + "id": "String (identifier)", + "displayName": "String", + "status": "String", + "createdDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "error": { + "@odata.type": "microsoft.graph.publicError" + }, + "mailboxes": [ + "String" + ], + "directoryObjectIds": [ + "String" + ] +} +``` |
v1.0 | Mailfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailfolder.md | by providing a [delta](../api/mailfolder-delta.md) function. **Well-known folder names** -Outlook creates certain folders for users by default. Instead of using the corresponding folder **id** value, for convenience, you can use -the well-known folder names from the table below when accessing these folders. For example, you can get the Drafts folder using its well-known name with the following query. +Outlook creates certain folders for users by default. Instead of using the corresponding folder **id** value, for convenience, you can use the well-known folder names from the table below when accessing these folders. For example, you can get the Drafts folder using its well-known name with the following query. <!-- { "blockType": "ignored" } --> ```http GET /me/mailFolders/drafts ``` -Well-known names work regardless of the locale of the user's mailbox, so the above query will always return the user's Drafts folder regardless of how it's named. +Well-known names work regardless of the locale of the user's mailbox, so the above query will always return the user's Drafts folder regardless of its name. | Well-known folder name | Description | |:--|:| Well-known names work regardless of the locale of the user's mailbox, so the abo |[Copy mail folder](../api/mailfolder-copy.md)|[mailFolder](mailfolder.md)|Copy a mailFolder and its contents to another mailFolder.| |[Get folder delta](../api/mailfolder-delta.md)|[mailFolder](mailfolder.md) collection|Get a set of mail folders that have been added, deleted, or removed from the user's mailbox.| |[Move mail folder](../api/mailfolder-move.md)|[mailFolder](mailfolder.md)|Move a mailFolder and its contents to another mailFolder.|+|[Permanently delete](../api/mailfolder-permanentdelete.md)|None|Permanently delete a mail folder and remove its items from the user's mailbox.| |**Extended properties**| | | |[Create single-value property](../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md) |[mailFolder](mailfolder.md) |Create one or more single-value extended properties in a new or existing mailFolder. | |[Get single-value property](../api/singlevaluelegacyextendedproperty-get.md) | [mailFolder](mailfolder.md) | Get mailFolders that contain a single-value extended property by using `$expand` or `$filter`. | |
v1.0 | Mailsearchfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/mailsearchfolder.md | Namespace: microsoft.graph A **mailSearchFolder** is a virtual folder in the user's mailbox that contains all the email items matching specified search criteria. **mailSearchFolder** inherits from [mailFolder](mailfolder.md). Search folders can be created in any folder in a user's Exchange Online mailbox. However, for a search folder to appear in Outlook, Outlook for the web, or Outlook Live, the folder must be created in the **WellKnownFolderName.SearchFolders** folder. -## Search folder lifecycle +### Search folder lifecycle -Search folders created by your application can be deleted by Exchange Online for one of the following reasons: +Exchange Online can delete search folders created by your application for one of the following reasons: 1. Search folders expire after 45 days of no usage. 2. There are limits on the number of search folders that can be created per source folder. When this limit is breached, older search folders are deleted to make way for new ones. When a search folder is deleted, your app should create a new search folder reso | Method | Return Type | Description | |:|:--|:-|-| [Create mail search folder](../api/mailsearchfolder-post.md) | [mailSearchFolder](mailsearchfolder.md) | Create a search folder in this user's mailbox. | +| [Create](../api/mailsearchfolder-post.md) | [mailSearchFolder](mailsearchfolder.md) | Create a search folder in this user's mailbox. | +| [Get](../api/mailfolder-get.md) | [mailSearchFolder](mailsearchfolder.md) | Get the specified search folder. | +| [Update](../api/mailsearchfolder-update.md) | [mailSearchFolder](mailsearchfolder.md) | Update the specified search folder. | +| [Delete](../api/mailfolder-delete.md) | None | Delete the specified search folder. | +| [Permanently delete](../api/mailsearchfolder-permanentdelete.md)|None|Permanently delete a mail search folder and remove its items from the user's mailbox.| | [List child folders](../api/mailfolder-list-childfolders.md) | [mailFolder](mailfolder.md) collection | List all the folders in this user's mailbox, including search folders. |-| [Get mail search folder](../api/mailfolder-get.md) | [mailSearchFolder](mailsearchfolder.md) | Get the specified search folder. | -| [Update mail search folder](../api/mailsearchfolder-update.md) | [mailSearchFolder](mailsearchfolder.md) | Update the specified search folder. | -| [Delete mail search folder](../api/mailfolder-delete.md) | None | Delete the specified search folder. | | [List messages in folder](../api/mailfolder-list-messages.md) | [message](message.md) collection | List all the messages in the specified search folder. | ## Properties |
v1.0 | Meetingregistrant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/meetingregistrant.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a meeting registrant who enrolled in an [online meeting](onlinemeeting.md). +Represents a meeting registrant who enrolled in an [online meeting](onlinemeeting.md). Inherits from [meetingRegistrantBase](meetingregistrantbase.md). > [!CAUTION]-> The 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 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/). ## Methods |
v1.0 | Meetingregistrantbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/meetingregistrantbase.md | Base type of [meetingRegistrant](meetingregistrant.md) and [externalMeetingRegis > This is an abstract type and cannot be used directly. Use the derived type [meetingRegistrant](meetingregistrant.md) or [externalMeetingRegistrant](externalmeetingregistrant.md) instead. > [!CAUTION]-> The 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 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/). ## Properties |
v1.0 | Message | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/message.md | The maximum total number of recipients included in the **toRecipients**, **ccRec This resource supports: -- Adding your own data as custom Internet message headers. Add custom headers only when creating a message, and name them starting with "x-". After the message is sent, you cannot modify the headers. To get the headers of a message, apply the `$select` query parameter in a [get message](../api/message-get.md) operation.+- Adding your own data as custom Internet message headers. Add custom headers only when creating a message, and name them starting with "x-". After the message is sent, you can't modify the headers. To get the headers of a message, apply the `$select` query parameter in a [get message](../api/message-get.md) operation. - Adding your own data as custom properties as [extensions](/graph/extensibility-overview). - Subscribing to [change notifications](/graph/webhooks). - Using [delta query](/graph/delta-query-overview) to track incremental additions, deletions, and updates, by providing a [delta](../api/message-delta.md) function. |[Forward message](../api/message-forward.md)|None|Forward a message, add a comment or modify any updateable properties all in one **forward** call. The message is then saved in the Sent Items folder.| |[Mark as junk](../api/message-markasjunk.md)|[message](../resources/message.md)|Mark a [message](../resources/message.md) as junk. This API adds the sender to the list of blocked senders and moves the message to the **Junk Email** folder, when **moveToJunk** is `true`.| |[Mark as not junk](../api/message-markasnotjunk.md)|[message](../resources/message.md)|Mark a [message](../resources/message.md) as not junk. This API removes the sender from the list of blocked senders and moves the message to the **Inbox** folder, when **moveToInbox** is `true`.|-|[Move message](../api/message-move.md)|[Message](message.md)|Move the message to a folder. This creates a new copy of the message in the destination folder.| +|[Move message](../api/message-move.md)|[Message](message.md)|Move the message to a folder. This API creates a new copy of the message in the destination folder.| |[Reply to message](../api/message-reply.md)|None|Reply to the sender of a message, add a comment or modify any updateable properties all in one **reply** call. The message is then saved in the Sent Items folder.| |[Reply-all to message](../api/message-replyall.md)|None|Reply to all the recipients of a message by specifying a comment and modifying any updateable properties for the reply, all by using the **replyAll** method. The message is then saved in the Sent Items folder.| |[Send draft message](../api/message-send.md)|None|Sends a previously created message draft. The message is then saved in the Sent Items folder.| |[Recall message](../api/message-recall.md)|[message](message.md)|Recall a message in the specified user's mailbox Sent Items folder.| |[Unsubscribe](../api/message-unsubscribe.md)|None|Send a message using the data and address specified in the first mailto command in the List-Unsubscribe header.|+|[Permanently delete](../api/message-permanentdelete.md)|None|Permanently delete a message and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.| |**Attachments**| | | |[List attachments](../api/message-list-attachments.md) |[Attachment](attachment.md) collection| Get all attachments on a message.| |[Add attachment](../api/message-post-attachments.md) |[Attachment](attachment.md)| Add a new attachment to a message by posting to the attachments collection.| |
v1.0 | Namepronunciationsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/namepronunciationsettings.md | + + Title: "namePronunciationSettings resource type" +description: "Represents a setting to control people-related admin settings in the tenant." ++ms.localizationpriority: medium ++++# namePronunciationSettings resource type ++Namespace: microsoft.graph +++Represents a setting to control people-related admin settings in the tenant. +++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get](../api/namepronunciationsettings-get.md)|[namePronunciationSettings](../resources/namepronunciationsettings.md)|Read the properties and relationships of a [namePronunciationSettings](../resources/namepronunciationsettings.md) object.| +|[Update](../api/namepronunciationsettings-update.md)|[namePronunciationSettings](../resources/namepronunciationsettings.md)|Update the properties of a [namePronunciationSettings](../resources/namepronunciationsettings.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier of the **namePronunciationSettings** object. Inherited from [entity](../resources/entity.md).| +|isEnabledInOrganization|Boolean| `true` to enable name pronunciation in the organization; otherwise, `false`. The default value is `false`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.namePronunciationSettings", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.namePronunciationSettings", + "id": "String (identifier)", + "isEnabledInOrganization": "Boolean" +} +``` + |
v1.0 | Nomfaonroleactivationalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/nomfaonroleactivationalertconfiguration.md | Represents an alert configuration that is triggered if roles don't require multi Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Nomfaonroleactivationalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/nomfaonroleactivationalertincident.md | Represents the details of an alert incident that is triggered if roles don't req Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Onlinemeeting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onlinemeeting.md | Contains information about a meeting, including the URL used to join a meeting, This resource supports subscribing to [change notifications](/graph/webhooks). For more information, see [subscribe to online meetings](/graph/changenotifications-for-onlinemeeting). -Inherits from [onlineMeetingBase](../resources/onlineMeetingBase.md). +Inherits from [onlineMeetingBase](../resources/onlinemeetingbase.md). ## Methods Inherits from [onlineMeetingBase](../resources/onlineMeetingBase.md). | Property | Type | Description | | :-- | :-- | : |-| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowMeetingChat | [meetingChatMode](#meetingchatmode-values) | Specifies the mode of meeting chat. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowBreakoutRooms | Boolean | Indicates whether breakout rooms are enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowedLobbyAdmitters | [allowedLobbyAdmitterRoles](../resources/onlinemeetingbase.md#allowedlobbyadmitterroles-values) | Specifies the users who can admit from the lobby. Possible values are: `organizerAndCoOrganizersAndPresenters`, `organizerAndCoOrganizers`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a meeting. Possible values are: `everyone`, `organization`, `roleIsPresenter`, `organizer`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowLiveShare | [meetingLiveShareOptions](#meetingliveshareoptions-values) | Indicates whether live share is enabled for the meeting. Possible values are: `enabled`, `disabled`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowMeetingChat | [meetingChatMode](#meetingchatmode-values) | Specifies the mode of meeting chat. Possible values are: `enabled`, `disabled`, `limited`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | allowParticipantsToChangeName | Boolean | Specifies if participants are allowed to rename themselves in an instance of the meeting. |+| allowPowerPointSharing | Boolean | Indicates whether PowerPoint live is enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowRecording | Boolean | Indicates whether recording is enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowTranscription | Boolean | Indicates whether transcription is enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowWhiteboard | Boolean | Indicates whether whiteboard is enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| anonymizeIdentityForRoles | onlineMeetingRole collection | Specifies whose identity is anonymized in the meeting. Possible values are: `attendee`. The `attendee` value can't be removed through a PATCH operation once added. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| audioConferencing | [audioConferencing](audioconferencing.md) | The phone access (dial-in) information for an online meeting. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md).| +| chatInfo | [chatInfo](chatinfo.md) | The chat information associated with this online meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | chatRestrictions | [chatrestrictions](../resources/chatrestrictions.md) | Specifies the configuration for meeting chat restrictions. |-| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowTranscription | Boolean | Indicates whether transcription is enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowRecording | Boolean | Indicates whether recording is enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a meeting. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| anonymizeIdentityForRoles | onlineMeetingRole collection | Specifies whose identity is anonymized in the meeting. Possible values are: `attendee`. The `attendee` value can't be removed through a PATCH operation once added. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| audioConferencing | [audioConferencing](audioconferencing.md) | The phone access (dial-in) information for an online meeting. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md).| -| chatInfo | [chatInfo](chatinfo.md) | The chat information associated with this online meeting. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | | creationDateTime | DateTime | The meeting creation time in UTC. Read-only. | | endDateTime | DateTime | The meeting end time in UTC. Required when you create an online meeting. | | externalId | String | The external ID. A custom ID. Optional. |-| id | String | The default ID associated with the online meeting. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| joinInformation | [itemBody](itembody.md) | The join information in the language and locale variant specified in 'Accept-Language' request HTTP header. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. Once an **onlineMeeting** is created, the **joinMeetingIdSettings** can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| id | String | The default ID associated with the online meeting. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| joinInformation | [itemBody](itembody.md) | The join information in the language and locale variant specified in 'Accept-Language' request HTTP header. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. Once an **onlineMeeting** is created, the **joinMeetingIdSettings** can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | joinWebUrl | String | The join URL of the online meeting. The format of the URL may change; therefore, users shouldn't rely on any information extracted from parsing the URL. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). |-| lobbyBypassSettings | [lobbyBypassSettings](lobbybypasssettings.md) | Specifies which participants can bypass the meeting lobby. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| lobbyBypassSettings | [lobbyBypassSettings](lobbybypasssettings.md) | Specifies which participants can bypass the meeting lobby. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | meetingTemplateId | String | The ID of the [meeting template](/microsoftteams/create-custom-meeting-template). | | participants | [meetingParticipants](meetingparticipants.md) | The participants associated with the online meeting, including the organizer and the attendees. |-| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| recordAutomatically | Boolean | Indicates whether to record the meeting automatically. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | startDateTime | DateTime | The meeting start time in UTC. Required when you create an online meeting. |-| shareMeetingChatHistoryDefault | [meetingChatHistoryDefaultMode](#meetingchathistorydefaultmode-values) | Specifies whether meeting chat history is shared with participants. Possible values are: `all`, `none`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| subject | String | The subject of the online meeting. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| watermarkProtection | [watermarkProtectionValues](watermarkprotectionvalues.md) | Specifies whether the client application should apply a watermark to a content type. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| shareMeetingChatHistoryDefault | [meetingChatHistoryDefaultMode](#meetingchathistorydefaultmode-values) | Specifies whether meeting chat history is shared with participants. Possible values are: `all`, `none`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| subject | String | The subject of the online meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| watermarkProtection | [watermarkProtectionValues](watermarkprotectionvalues.md) | Specifies whether the client application should apply a watermark to a content type. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | alternativeRecording (deprecated) | Stream | The content stream of the alternative recording of a [Microsoft Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events). Read-only. | | attendeeReport (deprecated) | Stream | The content stream of the attendee report of a [Teams live event](/microsoftteams/teams-live-events/what-are-teams-live-events). Read-only. | | autoAdmittedUsers (deprecated) | String | The setting that specifies the type of participants that are automatically allowed into the online meeting. Possible values are: `everyone`, `everyoneInSameAndFederatedCompany`, `everyoneInCompany`, `invitedUsersInCompany`, `organizer`. Read-only. | Inherits from [onlineMeetingBase](../resources/onlineMeetingBase.md). >- The **autoAdmittedUsers** property is deprecated. Use the **scope** property of [lobbyBypassSettings](lobbybypasssettings.md) instead. >- The **capabilities** property is deprecated. Use the **isQuestionAndAnswerEnabled** property of [broadcastMeetingSettings](broadcastMeetingSettings.md) instead. -### onlineMeetingPresenters values --| Value | Description | -| | - | -| everyone | Everyone is a presenter. Default. | -| organization | Everyone in organizerΓÇÖs organization is a presenter. | -| roleIsPresenter | Only the participants whose role is presenter are presenters. | -| organizer | Only the organizer is a presenter. | -| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +### meetingChatHistoryDefaultMode values -> [!TIP] -> -> When creating or updating an online meeting with **allowedPresenters** set to `roleIsPresenter`, include a full list of **attendees** with the specified attendees' **role** set to `presenter` in the request body. +| Value | Description | +| | - | +| all | All meeting chat history is shared. | +| none | No meeting chat history is shared. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ### meetingChatMode values Inherits from [onlineMeetingBase](../resources/onlineMeetingBase.md). | | - | | enabled | Meeting chat is enabled. | | disabled | Meeting chat is disabled. |-| limited | Meeting chat is enabled but only during the meeting call. | -| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| limited | Meeting chat is enabled but only during the meeting call. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | -### meetingChatHistoryDefaultMode values +### meetingLiveShareOptions values | Value | Description | | | - |-| all | All meeting chat history is shared. | -| none | No meeting chat history is shared. | -| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| enabled | Meeting live share is enabled. | +| disabled | Meeting live share is disabled. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++### onlineMeetingPresenters values ++| Value | Description | +| | - | +| everyone | Everyone is a presenter. Default. | +| organization | Everyone in organizerΓÇÖs organization is a presenter. | +| roleIsPresenter | Only the participants whose role is presenter are presenters. | +| organizer | Only the organizer is a presenter. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++> [!TIP] +> +> When creating or updating an online meeting with **allowedPresenters** set to `roleIsPresenter`, include a full list of **attendees** with the specified attendees' **role** set to `presenter` in the request body. ## Relationships | Relationship | Type | Description | | | - | -- |-| attendanceReports | [meetingAttendanceReport](meetingattendancereport.md) collection | The attendance reports of an online meeting. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| attendanceReports | [meetingAttendanceReport](meetingattendancereport.md) collection | The attendance reports of an online meeting. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | recordings | [callRecording](callrecording.md) collection | The recordings of an online meeting. Read-only. | | transcripts | [callTranscript](calltranscript.md) collection | The transcripts of an online meeting. Read-only. | | meetingAttendanceReport (deprecated) | [meetingAttendanceReport](meetingattendancereport.md) | The attendance report of the latest online meeting session. Read-only. | Inherits from [onlineMeetingBase](../resources/onlineMeetingBase.md). > [!TIP] > >- The **meetingAttendanceReport** property is deprecated. It will remain in beta for backward compatibility. Going forward, please use **attendanceReports** property to retrieve attendance reports of an online meeting.->- The **registration** property 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 **registration** property 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/). ## JSON representation The following JSON representation shows the resource type. { "allowAttendeeToEnableCamera": "Boolean", "allowAttendeeToEnableMic": "Boolean",- "allowMeetingChat": {"@odata.type": "microsoft.graph.meetingChatMode"}, - "allowTeamworkReactions": "Boolean", + "allowBreakoutRooms": "Boolean", + "allowedLobbyAdmitters": "String", "allowedPresenters": "String",+ "allowLiveShare": "String", + "allowMeetingChat": "String", + "allowParticipantsToChangeName": "Boolean", + "allowPowerPointSharing": "Boolean", + "allowRecording": "Boolean", + "allowTeamworkReactions": "Boolean", + "allowTranscription": "Boolean", + "allowWhiteboard": "Boolean", "anonymizeIdentityForRoles": ["String"], "audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"}, "chatInfo": {"@odata.type": "microsoft.graph.chatInfo"}, The following JSON representation shows the resource type. "meetingTemplateId": "String", "participants": {"@odata.type": "microsoft.graph.meetingParticipants"}, "recordAutomatically": "Boolean",- "shareMeetingChatHistoryDefault": "microsoft.graph.meetingChatHistoryDefaultMode", + "shareMeetingChatHistoryDefault": "String", "startDateTime": "String (timestamp)", "subject": "String", "videoTeleconferenceId": "String", |
v1.0 | Onlinemeetingbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onlinemeetingbase.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a base online meeting. The base type of [onlineMeeting](onlinemeeting.md) and [virtualEventSession](virtualEventSession.md). +Represents a base online meeting. The base type of [onlineMeeting](onlinemeeting.md) and [virtualEventSession](virtualeventsession.md). Inherits from [entity](../resources/entity.md). > [!TIP]-> This is an abstract type and can't be used directly. Use the derived types [onlineMeeting](onlinemeeting.md) and [virtualEventSession](virtualEventSession.md) instead. +> This is an abstract type and can't be used directly. Use the derived types [onlineMeeting](onlinemeeting.md) and [virtualEventSession](virtualeventsession.md) instead. ## Properties Inherits from [entity](../resources/entity.md). | :-- | :-- | : | | allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. | | allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. |-| allowMeetingChat | [meetingChatMode](#meetingchatmode-values) | Specifies the mode of meeting chat. | +| allowBreakoutRooms | Boolean | Indicates whether breakout rooms are enabled for the meeting. | +| allowedLobbyAdmitters | [allowedLobbyAdmitterRoles](#allowedlobbyadmitterroles-values) | Specifies the users who can admit from the lobby. Possible values are: `organizerAndCoOrganizersAndPresenters`, `organizerAndCoOrganizers`, `unknownFutureValue`. | +| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a meeting. Possible values are: `everyone`, `organization`, `roleIsPresenter`, `organizer`, `unknownFutureValue`. | +| allowLiveShare | [meetingLiveShareOptions](#meetingliveshareoptions-values) | Indicates whether live share is enabled for the meeting. Possible values are: `enabled`, `disabled`, `unknownFutureValue`. | +| allowMeetingChat | [meetingChatMode](#meetingchatmode-values) | Specifies the mode of meeting chat. Possible values are: `enabled`, `disabled`, `limited`, `unknownFutureValue`. | | allowParticipantsToChangeName | Boolean | Specifies if participants are allowed to rename themselves in an instance of the meeting. |+| allowPowerPointSharing | Boolean | Indicates whether PowerPoint live is enabled for the meeting. | +| allowRecording | Boolean | Indicates whether recording is enabled for the meeting. | | allowTeamworkReactions | Boolean | Indicates if Teams reactions are enabled for the meeting. | | allowTranscription | Boolean | Indicates whether transcription is enabled for the meeting. |-| allowRecording | Boolean | Indicates whether recording is enabled for the meeting. | -| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a meeting. | +| allowWhiteboard | Boolean | Indicates whether whiteboard is enabled for the meeting. | | anonymizeIdentityForRoles | onlineMeetingRole collection | Specifies whose identity is anonymized in the meeting. Possible values are: `attendee`. The `attendee` value can't be removed through a PATCH operation once added.| | audioConferencing | [audioConferencing](audioconferencing.md) | The phone access (dial-in) information for an online meeting. Read-only. | | chatInfo | [chatInfo](chatinfo.md) | The chat information associated with this online meeting. | Inherits from [entity](../resources/entity.md). | joinInformation | [itemBody](itembody.md) | The join information in the language and locale variant specified in 'Accept-Language' request HTTP header. Read-only. | | joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. Once an **onlineMeeting** is created, the **joinMeetingIdSettings** can't be modified. To make any changes to this property, the meeting needs to be canceled and a new one needs to be created. | | joinWebUrl | String | The join URL of the online meeting. Read-only. |-| lobbyBypassSettings | [lobbyBypassSettings](lobbyBypassSettings.md) | Specifies which participants can bypass the meeting lobby. | +| lobbyBypassSettings | [lobbyBypassSettings](lobbybypasssettings.md) | Specifies which participants can bypass the meeting lobby. | | recordAutomatically | Boolean | Indicates whether to record the meeting automatically. |-| shareMeetingChatHistoryDefault | meetingChatHistoryDefaultMode |Specifies whether meeting chat history is shared with participants. Possible values are: `all`, `none`, `unknownFutureValue`.| +| shareMeetingChatHistoryDefault | [meetingChatHistoryDefaultMode](#meetingchathistorydefaultmode-values) |Specifies whether meeting chat history is shared with participants. Possible values are: `all`, `none`, `unknownFutureValue`.| | subject | String | The subject of the online meeting. | | videoTeleconferenceId | String | The video teleconferencing ID. Read-only. | | watermarkProtection | [watermarkProtectionValues](watermarkprotectionvalues.md) | Specifies whether the client application should apply a watermark to a content type. | -### onlineMeetingPresenters values +### allowedLobbyAdmitterRoles values -| Value | Description | -| | - | -| everyone | Everyone is a presenter. Default. | -| organization | Everyone in organizerΓÇÖs organization is a presenter. | -| roleIsPresenter | Only the participants whose role is presenter are presenters. | -| organizer | Only the organizer is a presenter. | -| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| Value | Description | +||| +| organizerAndCoOrganizersAndPresenters | Meeting organizer, co-organizers, and presenters. | +| organizerAndCoOrganizers | Meeting organizer and co-organizers. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++### meetingChatHistoryDefaultMode values ++| Value | Description | +| | - | +| all | All meeting chat history is shared. | +| none | No meeting chat history is shared. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ### meetingChatMode values Inherits from [entity](../resources/entity.md). | limited | Meeting chat is enabled but only during the meeting call. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | -### meetingChatHistoryDefaultMode values +### meetingLiveShareOptions values | Value | Description | | | - |-| all | All meeting chat history is shared. | -| none | No meeting chat history is shared. | +| enabled | Meeting live share is enabled. | +| disabled | Meeting live share is disabled. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +### onlineMeetingPresenters values ++| Value | Description | +| | - | +| everyone | Everyone is a presenter. Default. | +| organization | Everyone in organizerΓÇÖs organization is a presenter. | +| roleIsPresenter | Only the participants whose role is presenter are presenters. | +| organizer | Only the organizer is a presenter. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | + ## Relationships | Relationship | Type | Description | The following JSON representation shows the resource type. { "allowAttendeeToEnableCamera": "Boolean", "allowAttendeeToEnableMic": "Boolean",- "allowMeetingChat": {"@odata.type": "microsoft.graph.meetingChatMode"}, - "allowTeamworkReactions": "Boolean", + "allowBreakoutRooms": "Boolean", + "allowedLobbyAdmitters": "String", "allowedPresenters": "String",+ "allowLiveShare": "String", + "allowMeetingChat": "String", + "allowParticipantsToChangeName": "Boolean", + "allowPowerPointSharing": "Boolean", + "allowRecording": "Boolean", + "allowTeamworkReactions": "Boolean", + "allowTranscription": "Boolean", + "allowWhiteboard": "Boolean", "anonymizeIdentityForRoles": ["String"], "audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"}, "chatInfo": {"@odata.type": "microsoft.graph.chatInfo"},- "id": "String (identifier)", + "id": "String (identifier)", "isEntryExitAnnounced": "Boolean", "joinInformation": {"@odata.type": "microsoft.graph.itemBody"}, "joinMeetingIdSettings": {"@odata.type": "microsoft.graph.joinMeetingIdSettings"}, "joinWebUrl": "String", "lobbyBypassSettings": {"@odata.type": "microsoft.graph.lobbyBypassSettings"}, "recordAutomatically": "Boolean",- "shareMeetingChatHistoryDefault": "microsoft.graph.meetingChatHistoryDefaultMode", + "shareMeetingChatHistoryDefault": "String", "subject": "String", "videoTeleconferenceId": "String", "watermarkProtection": {"@odata.type": "microsoft.graph.watermarkProtectionValues"} |
v1.0 | Onpremisesaccidentaldeletionprevention | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesaccidentaldeletionprevention.md | Title: "onPremisesAccidentalDeletionPrevention resource type" description: "Contains the accidental deletion prevention configuration for a tenant."-++ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Onpremisescurrentexportdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisescurrentexportdata.md | Title: "onPremisesCurrentExportData resource type" description: "Data for the current export run."-++ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Onpremisesdirectorysynchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesdirectorysynchronization.md | Title: "onPremisesDirectorySynchronization resource type" description: "A container for on-premises directory synchronization functionalities that are available for the organization."-++ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Onpremisesdirectorysynchronizationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesdirectorysynchronizationconfiguration.md | Title: "onPremisesDirectorySynchronizationConfiguration resource type" description: "Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant."-++ ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant. +Consists of configurations that can be fine-tuned and impact the [on-premises directory synchronization](../resources/onpremisesdirectorysynchronization.md) process for a tenant. ## Properties |
v1.0 | Onpremisesdirectorysynchronizationfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesdirectorysynchronizationfeature.md | Title: "onPremisesDirectorySynchronizationFeature resource type" description: "Consists of directory synchronization features that can be enabled or disabled."-++ ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Consists of directory synchronization features that can be enabled or disabled. The naming pattern used is `<featureName>Enabled`. `true` indicates that the feature is enabled and `false` indicates that the feature disabled. +Consists of [directory synchronization](../resources/onpremisesdirectorysynchronization.md) features that can be enabled or disabled. The naming pattern used is `<featureName>Enabled`. `true` indicates that the feature is enabled and `false` indicates that the feature disabled. ## Properties Consists of directory synchronization features that can be enabled or disabled. | fopeConflictResolutionEnabled | Boolean | Used to indicate that for a Microsoft Forefront Online Protection for Exchange (FOPE) migrated tenant, the conflicting proxy address should be migrated over. | | groupWriteBackEnabled | Boolean | Used to enable object-level group writeback feature for additional group types. | | passwordSyncEnabled | Boolean | Used to indicate on-premise password synchronization is enabled. |-| passwordWritebackEnabled | Boolean | Used to indicate that writeback of password resets from Microsoft Entra ID to on-premises AD is enabled. | +| passwordWritebackEnabled | Boolean | Used to indicate that writeback of password resets from Microsoft Entra ID to on-premises AD is enabled. **This property isn't in use and updating it isn't supported.** | | quarantineUponProxyAddressesConflictEnabled | Boolean | Used to indicate that we should quarantine objects with conflicting proxy address. | | quarantineUponUpnConflictEnabled | Boolean | Used to indicate that we should quarantine objects conflicting with duplicate userPrincipalName. | | softMatchOnUpnEnabled | Boolean | Used to indicate that we should soft match objects based on userPrincipalName. | |
v1.0 | Onpremisesextensionattributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremisesextensionattributes.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The return type of the **onPremisesExtensionAttributes** property of the [user](user.md) object and **extensionAttributes** property of the [device](device.md) object. Returns fifteen custom extension attribute properties. +The return type of the **onPremisesExtensionAttributes** property of the [user](user.md) object and **extensionAttributes** property of the [device](device.md) object. Returns fifteen custom extension attribute properties. Each attribute can store up to 1024 characters. On the [user](user.md) entity and for an **onPremisesSyncEnabled** user, the source of authority for this set of properties is the on-premises Active Directory that is synchronized to Microsoft Entra ID, and is read-only. For a cloud-only user (where **onPremisesSyncEnabled** is `false` or `null`), these properties can be set during [creation](../api/user-post-users.md) or [update](../api/user-update.md). If a cloud-only user was previously synced from on-premises Active Directory, these properties can't be managed via the Microsoft Graph API. Instead, they can be managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. |
v1.0 | Onpremiseswritebackconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/onpremiseswritebackconfiguration.md | Title: "onPremisesWritebackConfiguration resource type" description: "Configuration to control how cloud created or owned objects are synchronized back to the on-premises directory."-++ ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Configuration to control how cloud created or owned objects are synchronized back to the on-premises directory. +Configuration in the [onPremisesDirectorySynchronization resource](../resources/onpremisesdirectorysynchronization.md) to control how cloud created or owned objects are synchronized back to the on-premises directory. ## Properties |
v1.0 | Openidconnectsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/openidconnectsetting.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A complex type that contains the settings required to perform the OIDC request to the external authentication provider for an external authentication method. External authentication methods enable Microsoft Entra ID users to satisfy the second factor of multifactor authentication requirements using an external provider. +A complex type that contains the settings required to perform the OIDC request to the external authentication provider for an [external authentication method](../resources/externalauthenticationmethodconfiguration.md). External authentication methods enable Microsoft Entra ID users to satisfy the second factor of multifactor authentication requirements using an external provider. ## Properties |Property|Type|Description| |
v1.0 | Outgoingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outgoingcalloptions.md | Inherits from [callOptions](calloptions.md). |:|:--|:| | hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | | isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). |+| isDeltaRosterEnabled | Boolean | Indicates whether delta roster is enabled for the call. Inherited from [callOptions](calloptions.md). | ## JSON representation The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.outgoingCallOptions", "hideBotAfterEscalation": "Boolean",- "isContentSharingNotificationEnabled": "Boolean" + "isContentSharingNotificationEnabled": "Boolean", + "isDeltaRosterEnabled": "Boolean" } ``` |
v1.0 | Outlookcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlookcategory.md | ms.localizationpriority: medium doc_type: resourcePageType+toc. Title: Outlook category (deprecated) # outlookCategory resource type You can also [get this master list of categories](../api/outlookuser-list-master You can apply a category to an item by assigning the **displayName** property of the category to the **categories** collection of the item. Resources that can be assigned categories include [contact](contact.md), [event](event.md), [message](message.md), [outlookTask](outlooktask.md), [post](post.md), and [todoTask](todotask.md). -Each category is attributed by 2 properties: **displayName** and **color**. The **displayName** value must be unique in a user's master list. -The **color** however does not have to be unique; multiple categories in the master list can be mapped to the same color. You can map up to 25 different colors to categories in a user's master list. +Each category is attributed by two properties: **displayName** and **color**. The **displayName** value must be unique in a user's master list. +The **color** however doesn't have to be unique; multiple categories in the master list can be mapped to the same color. You can map up to 25 different colors to categories in a user's master list. ## Methods | Method | Return Type |Description| |:|:--|:-|-|[List categories](../api/outlookuser-list-mastercategories.md) | [outlookCategory](../resources/outlookcategory.md) collection |Get all the categories that have been defined for the user.| -|[Get category](../api/outlookcategory-get.md) | [outlookCategory](../resources/outlookcategory.md) |Get the properties and relationships of the specified **outlookCategory** object.| -|[Create category](../api/outlookuser-post-mastercategories.md) | [outlookCategory](../resources/outlookcategory.md) |Create an **outlookCategory** object in the user's master list of categories.| -|[Update category](../api/outlookcategory-update.md) | [outlookCategory](../resources/outlookcategory.md) |Update the writable property, **color**, of the specified **outlookCategory** object. | -|[Delete category](../api/outlookcategory-delete.md) | None |Delete the specified **outlookCategory** object. | +|[List](../api/outlookuser-list-mastercategories.md) | [outlookCategory](../resources/outlookcategory.md) collection |Get all the categories that have been defined for the user.| +|[Get](../api/outlookcategory-get.md) | [outlookCategory](../resources/outlookcategory.md) |Get the properties and relationships of the specified **outlookCategory** object.| +|[Create](../api/outlookuser-post-mastercategories.md) | [outlookCategory](../resources/outlookcategory.md) |Create an **outlookCategory** object in the user's master list of categories.| +|[Update](../api/outlookcategory-update.md) | [outlookCategory](../resources/outlookcategory.md) |Update the writable property, **color**, of the specified **outlookCategory** object. | +|[Delete](../api/outlookcategory-delete.md) | None |Delete the specified **outlookCategory** object. | ## Properties | Property | Type |Description| |:|:--|:-|-|color|String|A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. For more details, see the following note. | -|displayName|String|A unique name that identifies a category in the user's mailbox. After a category is created, the name cannot be changed. Read-only.| +|color|String|A preset color constant that characterizes a category, and that is mapped to one of 25 predefined colors. For more information, see the following note. | +|displayName|String|A unique name that identifies a category in the user's mailbox. After a category is created, the name can't be changed. Read-only.| -> **Note** The possible values for **color** are pre-set constants such as `None`, `preset0` and `preset1`. Each pre-set constant is further mapped to a color; the actual -color is dependent on the Outlook client that the categories are being displayed in. The following table shows the colors mapped to each pre-set constant for Outlook (desktop client). +> **Note** The possible values for **color** are preset constants such as `None`, `preset0` and `preset1`. Each preset constant is further mapped to a color; the actual +color is dependent on the Outlook client that the categories are being displayed in. The following table shows the colors mapped to each preset constant for Outlook (desktop client). -| Pre-set constant | Color mapped to in Outlook | +| Preset constant | Color mapped to in Outlook | |:|:--| | None | No color mapped | | Preset0 | Red | |
v1.0 | Outlooktask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlooktask.md | +toc. Title: Outlook task (deprecated) # outlookTask resource type (deprecated) Namespace: microsoft.graph An Outlook item that can track a work item. -You can use a task to track the start, due and actual completion dates and times, its progress or status, whether it's recurring, and requires reminding. +You can use a task to track: +- The start, due, and actual completion dates and times. +- The progress or status of the task. +- The recurrence and reminder statuses of the task. Date-related properties in the **outlookTask** resource include the following: Prefer: outlook.timezone="Eastern Standard Time" |[Get](../api/outlooktask-get.md) | [outlookTask](outlooktask.md) |Get the properties and relationships of an Outlook task in the user's mailbox.| |[Update](../api/outlooktask-update.md) | [outlookTask](outlooktask.md) |Change writeable properties of an Outlook task. | |[Delete](../api/outlooktask-delete.md) | None |Delete the specified task in the user's mailbox. |-|[Complete](../api/outlooktask-complete.md)|[outlookTask](outlooktask.md) collection|Complete an Outlook task which sets the **completedDateTime** property to the current date, and **status** property to `completed`.| +|[Permanently delete](../api/outlooktask-permanentdelete.md)|None|Permanently delete an Outlook task and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.| +|[Complete](../api/outlooktask-complete.md)|[outlookTask](outlooktask.md) collection|Complete an Outlook task that sets the **completedDateTime** property to the current date, and **status** property to `completed`.| |**Attachments**| | | |[List attachments](../api/outlooktask-list-attachments.md) |[attachment](attachment.md) collection| Get all attachments on an Outlook task.| |[Add attachment](../api/outlooktask-post-attachments.md) |[attachment](attachment.md)| Add a file, item (message, event or contact), or link to a file as an attachment to a task.| Prefer: outlook.timezone="Eastern Standard Time" | Property | Type |Description| |:|:--|:-| |assignedTo|String|The name of the person who has been assigned the task in Outlook. Read-only.|-|body|[itemBody](itembody.md)|The task body that typically contains information about the task. Note that only HTML type is supported.| +|body|[itemBody](itembody.md)|The task body that typically contains information about the task. Only the HTML type is supported.| |categories|String collection|The categories associated with the task. Each category corresponds to the **displayName** property of an [outlookCategory](outlookcategory.md) that the user has defined.| |changeKey|String|The version of the task.| |completedDateTime|[dateTimeTimeZone](datetimetimezone.md)|The date in the specified time zone that the task was finished.| Prefer: outlook.timezone="Eastern Standard Time" ## Relationships | Relationship | Type |Description| |:|:--|:-|-|attachments|[attachment](attachment.md) collection|The collection of [fileAttachment](fileattachment.md), [itemAttachment](itemattachment.md), and [referenceAttachment](referenceattachment.md) attachments for the task. Read-only. Nullable.| +|attachments|[attachment](attachment.md) collection|The collection of [fileAttachment](fileattachment.md), [itemAttachment](itemattachment.md), and [referenceAttachment](referenceattachment.md) attachments for the task. Read-only. Nullable.| |multiValueExtendedProperties|[multiValueLegacyExtendedProperty](multivaluelegacyextendedproperty.md) collection|The collection of multi-value extended properties defined for the task. Read-only. Nullable.| |singleValueExtendedProperties|[singleValueLegacyExtendedProperty](singlevaluelegacyextendedproperty.md) collection|The collection of single-value extended properties defined for the task. Read-only. Nullable.| |
v1.0 | Outlooktaskfolder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlooktaskfolder.md | +toc. Title: Outlook task folder (deprecated) # outlookTaskFolder resource type (deprecated) Namespace: microsoft.graph A folder that contains Outlook tasks (collection of [outlookTask](outlooktask.md) objects). In Outlook, the default task group, `My Tasks`, contains a default task folder, `Tasks`, for the user's mailbox. -You cannot rename or delete these default task group and folder, but you can create additional task groups and task folders. +You can't rename or delete these default task groups or folders, but you can create new task groups and folders. ## Methods You cannot rename or delete these default task group and folder, but you can cre |[List task folders in group](../api/outlooktaskfolder-list-tasks.md) |[outlookTask](outlooktask.md) collection| Get all the Outlook tasks in the specified folder.| |[Update](../api/outlooktaskfolder-update.md) | [outlookTaskFolder](outlooktaskfolder.md) |Update the writable properties of an Outlook task folder. | |[Delete](../api/outlooktaskfolder-delete.md) | None |Delete the specified Outlook task folder.|+|[Permanently delete](../api/outlooktask-permanentdelete.md)|None|Permanently delete an Outlook task and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.|](../api/outlooktaskfolder-permanentdelete.md)|None|Permanently delete an Outlook task folder and remove its items from the user's mailbox.| |**Extended properties**| | | |[Create single-value property](../api/singlevaluelegacyextendedproperty-post-singlevalueextendedproperties.md) |[outlookTaskFolder](outlooktaskfolder.md) |Create one or more single-value extended properties in a new or existing Outlook task folder. | |[Get single-value property](../api/singlevaluelegacyextendedproperty-get.md) | [outlookTaskFolder](outlooktaskfolder.md) | Get Outlook task folders that contain a single-value extended property by using `$expand` or `$filter`. | |
v1.0 | Outlooktaskgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/outlooktaskgroup.md | +toc. Title: Outlook task group (deprecated) # outlookTaskGroup resource type (deprecated) |
v1.0 | Pagetemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/pagetemplate.md | + + Title: "pageTemplate resource type" +description: "Represents a page template in the templates folder." ++ms.localizationpriority: medium ++++# pageTemplate resource type ++Namespace: microsoft.graph +++Represents a page template in the templates folder. ++In addition to other properties, a **pageTemplate** resource contains the title, layout, and a collection of [webPart](../resources/webpart.md) objects. ++Inherits from [baseSitePage](../resources/basesitepage.md). ++## Methods ++|Method|Return type|Description| +|:--|:-|:-| +|[List](../api/pagetemplate-list.md)|[pageTemplate](../resources/pagetemplate.md)|Get a list of the [pageTemplate](../resources/pagetemplate.md) objects and their properties.| +|[Create](../api/pagetemplate-create.md)|[pageTemplate](../resources/pagetemplate.md)|Create a new [pageTemplate](../resources/pagetemplate.md) object.| +|[Get](../api/pagetemplate-get.md)|[pageTemplate](../resources/pagetemplate.md)|Get a [pageTemplate](../resources/pagetemplate.md) object and properties.| +|[Update](../api/pagetemplate-update.md)|[pageTemplate](../resources/pagetemplate.md)|Update the properties of a [pageTemplate](../resources/pagetemplate.md) object.| +|[Delete](../api/pagetemplate-delete.md)|None|Delete a [pageTemplate](../resources/pagetemplate.md) object.| ++## Properties ++|Property|Type|Description| +|:--|:--|:-| +|contentType|[contentTypeInfo](../resources/contentTypeInfo.md)|The content type of the page template. Inherited from [baseSitePage](../resources/basesitepage.md).| +|createdBy|[identitySet](../resources/identityset.md)|The identity of the creator of the page template. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md).| +|createdDateTime|DateTimeOffset|The date and time the page template was created. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md).| +|description|String|The descriptive text for the page template. Inherited from [baseSitePage](../resources/basesitepage.md).| +|eTag|String|The eTag for the page template. Inherited from [baseSitePage](../resources/basesitepage.md).| +|id|String|The unique identifier of the page template. Inherited from [baseSitePage](../resources/basesitepage.md).| +|lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of the last modifier of the page template. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md).| +|lastModifiedDateTime|DateTimeOffset|The date and time the page template was last modified. Read-only. Inherited from [baseSitePage](../resources/basesitepage.md).| +|name|String|The name of the page template. Inherited from [baseSitePage](../resources/basesitepage.md).| +|pageLayout|[pageLayoutType](../resources/basesitepage.md#pagelayouttype-values)|The type of the page layout for the page. The possible values are: `microsoftReserved`, `article`, `home`, `unknownFutureValue`. Inherited from [baseSitePage](../resources/basesitepage.md).| +|parentReference|[itemReference](../resources/itemreference.md)|The parent information, if the page template has a parent. Inherited from [baseSitePage](../resources/baseSitePage.md).| +|publishingState|[publicationFacet](../resources/publicationfacet.md)|The publishing status and the MM.mm version of the page template. Inherited from [baseSitePage](../resources/basesitepage.md).| +|thumbnailWebUrl|String|The URL of the page template's thumbnail image| +|title|String|The title of the page template. Inherited from [baseSitePage](../resources/basesitepage.md).| +|titleArea|[titleArea](../resources/titlearea.md)|The title area on the SharePoint page template.| +|webUrl|String|The URL that displays the page template in the browser. Read-only. Inherited from [baseSitePage](../resources/baseSitePage.md).| ++## Relationships ++|Relationship|Type|Description| +|:--|:|:-| +|canvasLayout|[canvasLayout](../resources/canvaslayout.md)|The layout of the content in a given SharePoint page template, including horizontal sections and vertical sections.| +|createdByUser|[user](../resources/user.md)|The identity of the user who created this site page template. Read-only. Inherited from [baseSitePage](../resources/baseSitePage.md).| +|lastModifiedByUser|[user](../resources/user.md)|The identity of the last modifier of this item. Read-only. Inherited from [baseSitePage](../resources/baseSitePage.md).| +|webParts|[webPart](../resources/webpart.md) collection|The collection of web parts on the SharePoint page.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.pageTemplate", + "baseType": "microsoft.graph.baseSitePage", + "openType": true +} +--> ++```json +{ + "@odata.type": "#microsoft.graph.pageTemplate", + "id": "String (identifier)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "contentType": { + "@odata.type": "microsoft.graph.contentTypeInfo" + }, + "description": "String", + "eTag": "String", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "name": "String", + "parentReference": { + "@odata.type": "microsoft.graph.itemReference" + }, + "webUrl": "String", + "title": "String", + "pageLayout": "String", + "publishingState": { + "@odata.type": "microsoft.graph.publicationFacet" + }, + "thumbnailWebUrl": "String", + "titleArea": { + "@odata.type": "microsoft.graph.titleArea" + } +} +``` |
v1.0 | Partner Security Adminsmfaenforcedsecurityrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-adminsmfaenforcedsecurityrequirement.md | + + Title: "adminsMfaEnforcedSecurityRequirement resource type" +description: "Represents the partner admin MFA enforcement security requirement from the partner security score." ++ms.localizationpriority: medium ++++# adminsMfaEnforcedSecurityRequirement resource type ++Namespace: microsoft.graph.partner.security +++Represents the partner admin MFA enforcement security requirement. The requirement is calculated based on Entra tenant MFA usage data. Use this resource to determine whether admins are adequately protected with MFA. ++Inherits from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|actionUrl|String|The link to site where the admin can take action on the requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md).| +|adminsRequiredNotUsingMfaCount|Int64|The number of admins who are required to use MFA, but haven't completed registration.| +|complianceStatus|microsoft.graph.partner.security.complianceStatus|Indicates whether the partner is compliant with this requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `compliant`, `noncomplaint`, `unknownFutureValue`.| +|helpUrl|String|The link to documentation for the requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md).| +|id|String|The unique identifier for the requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md).| +|legacyPerUserMfaStatus|microsoft.graph.partner.security.policyStatus|The status of per-user MFA in the partner tenant. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|maxScore|Int64|The maximum score possible for the requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md).| +|mfaConditionalAccessPolicyStatus|microsoft.graph.partner.security.policyStatus|The status of conditional access policies in the partner tenant. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|mfaEnabledAdminsCount|Int64|The number of admins who are using MFA.| +|mfaEnabledUsersCount|Int64|The number of users who are using MFA.| +|requirementType|microsoft.graph.partner.security.securityRequirementType|The type of the requirement. The value is always `mfaEnforcedForAdminsOfCustomers` for this requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `mfaEnforcedForAdmins`, `mfaEnforcedForAdminsOfCustomers`, `securityAlertsPromptlyResolved`, `securityContactProvided`, `spendingBudgetSetForCustomerAzureSubscriptions`, `unknownFutureValue`.| +|score|Int64|The score received for this requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md).| +|securityDefaultsStatus|microsoft.graph.partner.security.policyStatus|The status of security defaults in the partner tenant. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|state|microsoft.graph.partner.security.securityRequirementState|Indicates whether the requirement is in preview or is fully released. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `active`, `preview`, `unknownFutureValue`.| +|totalAdminsCount|Int64|The total number of admins in the partner's tenant.| +|totalUsersCount|Int64|The total number of users in the partner's tenant.| +|updatedDateTime|DateTimeOffset|The date the requirement properties were last updated. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md).| +|usersRequiredNotUsingMfaCount|Int64|The number of users who are required to use MFA, but haven't completed registration.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.adminsMfaEnforcedSecurityRequirement", + "baseType": "microsoft.graph.partner.security.securityRequirement", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.adminsMfaEnforcedSecurityRequirement", + "id": "String (identifier)", + "requirementType": "String", + "complianceStatus": "String", + "actionUrl": "String", + "helpUrl": "String", + "score": "Integer", + "maxScore": "Integer", + "state": "String", + "updatedDateTime": "String (timestamp)", + "totalAdminsCount": "Integer", + "adminsRequiredNotUsingMfaCount": "Integer", + "mfaEnabledAdminsCount": "Integer", + "totalUsersCount": "Integer", + "usersRequiredNotUsingMfaCount": "Integer", + "mfaEnabledUsersCount": "Integer", + "securityDefaultsStatus": "String", + "mfaConditionalAccessPolicyStatus": "String", + "legacyPerUserMfaStatus": "String" +} +``` + |
v1.0 | Partner Security Customerinsight | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-customerinsight.md | + + Title: "customerInsight resource type" +description: "Represents insights into the security score for a partner's customer." ++ms.localizationpriority: medium ++++# customerInsight resource type ++Namespace: microsoft.graph.partner.security +++Represents insights into the security score for a partner's customer. ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/partner-security-partnersecurityscore-list-customerinsights.md)|[microsoft.graph.partner.security.customerInsight](../resources/partner-security-customerinsight.md) collection|Get a list of the [customerInsight](../resources/partner-security-customerinsight.md) objects and their properties.| ++## Properties +|Property|Type|Description| +|:|:|:| +|mfa|[microsoft.graph.partner.security.customerMfaInsight](../resources/partner-security-customermfainsight.md)|Details of the customer's Entra tenant MFA policy configuration and usage.| +|tenantId|String|The unique identifier for the customer.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "tenantId", + "@odata.type": "microsoft.graph.partner.security.customerInsight", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.customerInsight", + "tenantId": "String (identifier)", + "mfa": { + "@odata.type": "microsoft.graph.partner.security.customerMfaInsight" + } +} +``` + |
v1.0 | Partner Security Customermfainsight | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-customermfainsight.md | + + Title: "customerMfaInsight resource type" +description: "Represents a single partner customer's MFA policy configuration and usage" ++ms.localizationpriority: medium ++++# customerMfaInsight resource type ++Namespace: microsoft.graph.partner.security +++Contains aggregate data from the customer's Entra tenant MFA policy configuration and usage. ++## Properties +|Property|Type|Description| +|:|:|:| +|compliantAdminsCount|Int64|The number of admins that are compliant with the MFA requirements| +|compliantNonAdminsCount|Int64|The number of users that are compliant with the MFA requirements| +|legacyPerUserMfaStatus|microsoft.graph.partner.security.policyStatus|The status of per-user MFA configuration to require MFA in the tenant. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|mfaConditionalAccessPolicyStatus|microsoft.graph.partner.security.policyStatus|The status of conditional access policies to require MFA in the tenant. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|securityDefaultsStatus|microsoft.graph.partner.security.policyStatus|The status of security defaults in the tenant. The possible values are: `enabled`, `disabled`, `unknownFutureValue`.| +|totalUsersCount|Int64|The total number of users in the tenant| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.partner.security.customerMfaInsight" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.customerMfaInsight", + "compliantAdminsCount": "Integer", + "compliantNonAdminsCount": "Integer", + "totalUsersCount": "Integer", + "securityDefaultsStatus": "String", + "mfaConditionalAccessPolicyStatus": "String", + "legacyPerUserMfaStatus": "String" +} +``` + |
v1.0 | Partner Security Customersmfaenforcedsecurityrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-customersmfaenforcedsecurityrequirement.md | + + Title: "customersMfaEnforcedSecurityRequirement resource type" +description: "Represents the customer MFA-enforced security requirement in the partner security score." ++ms.localizationpriority: medium ++++# customersMfaEnforcedSecurityRequirement resource type ++Namespace: microsoft.graph.partner.security +++This resource represents the customer MFA-enforced security requirement in the partner security score based on aggregate data from the partner's customers and their mfa policy compliance. ++Inherits from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|actionUrl|String|The link to the site where the admin can take action on the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|complianceStatus|microsoft.graph.partner.security.complianceStatus|Indicates whether the partner is compliant with this requirement. Inherited from securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `compliant`, `noncomplaint`, `unknownFutureValue`.| +|compliantTenantCount|Int64|The number of customer tenants that are compliant.| +|helpUrl|String|The link to documentation for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|id|String|The unique identifier for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|maxScore|Int64|The maximum score possible for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|requirementType|microsoft.graph.partner.security.securityRequirementType|The value of this property is always `mfaEnforcedForAdminsOfCustomers` for this resource. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `mfaEnforcedForAdmins`, `mfaEnforcedForAdminsOfCustomers`, `securityAlertsPromptlyResolved`, `securityContactProvided`, `spendingBudgetSetForCustomerAzureSubscriptions`, `unknownFutureValue`.| +|score|Int64|The score received for this requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|state|microsoft.graph.partner.security.securityRequirementState|Indicates whether the requirement is in preview or is fully released. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `active`, `preview`, `unknownFutureValue`.| +|totalTenantCount|Int64|The total number of customer tenants associated with this partner| +|updatedDateTime|DateTimeOffset|The date the requirement properties were last updated. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.customersMfaEnforcedSecurityRequirement", + "baseType": "microsoft.graph.partner.security.securityRequirement", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.customersMfaEnforcedSecurityRequirement", + "id": "String (identifier)", + "requirementType": "String", + "complianceStatus": "String", + "actionUrl": "String", + "helpUrl": "String", + "score": "Integer", + "maxScore": "Integer", + "state": "String", + "updatedDateTime": "String (timestamp)", + "totalTenantCount": "Integer", + "compliantTenantCount": "Integer" +} +``` + |
v1.0 | Partner Security Customersspendingbudgetsecurityrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-customersspendingbudgetsecurityrequirement.md | + + Title: "customersSpendingBudgetSecurityRequirement resource type" +description: "Represents the security requirement to have a customer spending budget for all customers." ++ms.localizationpriority: medium ++++# customersSpendingBudgetSecurityRequirement resource type ++Namespace: microsoft.graph.partner.security +++Represents the security requirement to have a customer spending budget for all customers. All of a partner's customers are expected to have a spending budget set by the partner to track and control Azure spending. ++This requirement aggregates the partner's customers and tracks if they have an Azure spending budget. ++Inherits from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|actionUrl|String|The link to the site where the admin can take action on the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|complianceStatus|microsoft.graph.partner.security.complianceStatus|Indicates whether the partner is compliant with this requirement. Inherited from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `compliant`, `noncomplaint`, `unknownFutureValue`.| +|customersWithSpendBudgetCount|Int64|The number of customers with a spending budget set.| +|helpUrl|String|The link to documentation for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|id|String|The unique identifier for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|maxScore|Int64|The maximum score possible for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|requirementType|microsoft.graph.partner.security.securityRequirementType|The value of this property is always `spendingBudgetSetForCustomerAzureSubscriptions` for this resource. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `mfaEnforcedForAdmins`, `mfaEnforcedForAdminsOfCustomers`, `securityAlertsPromptlyResolved`, `securityContactProvided`, `spendingBudgetSetForCustomerAzureSubscriptions`, `unknownFutureValue`.| +|score|Int64|The score received for this requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|state|microsoft.graph.partner.security.securityRequirementState|Indicates whether the requirement is in preview or is fully released. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `active`, `preview`, `unknownFutureValue`.| +|totalCustomersCount|Int64|The total number of customers associated with the partner.| +|updatedDateTime|DateTimeOffset|The date the requirement properties were last updated. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.customersSpendingBudgetSecurityRequirement", + "baseType": "microsoft.graph.partner.security.securityRequirement", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.customersSpendingBudgetSecurityRequirement", + "id": "String (identifier)", + "requirementType": "String", + "complianceStatus": "String", + "actionUrl": "String", + "helpUrl": "String", + "score": "Integer", + "maxScore": "Integer", + "state": "String", + "updatedDateTime": "String (timestamp)", + "totalCustomersCount": "Integer", + "customersWithSpendBudgetCount": "Integer" +} +``` + |
v1.0 | Partner Security Partnersecurity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-partnersecurity.md | Title: "partnerSecurity resource type" -description: "Represents the root for various types of partner security entities." +description: "Represents the root for partner security entities." ms.localizationpriority: medium Namespace: microsoft.graph.partner.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the root for various types of partner security entities. +Represents the root for partner security entities. -Inherits from [entity](../resources/entity.md). ++Inherits from [microsoft.graph.entity](../resources/entity.md). ## Methods None. ## Relationships |Relationship|Type|Description| |:|:|:|-|securityAlerts|[microsoft.graph.partner.security.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) collection|The security alerts or a vulnerability of a CSP partner's customer that the partner must be made aware of for further action.| +|securityAlerts|[microsoft.graph.partner.security.partnerSecurityAlert](../resources/partner-security-partnersecurityalert.md) collection|The security alerts or a vulnerability of a Cloud Solution Provider (CSP) partner's customer that the partner must be made aware of for further action.| +|securityScore|[microsoft.graph.partner.security.securityScore](../resources/partner-security-partnerSecurityScore.md) singleton|The security score calculated for the CSP partner and their customers.| ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Partner Security Partnersecurityscore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-partnersecurityscore.md | + + Title: "partnerSecurityScore resource type" +description: "Represents the security score for a partner which helps them understand their security posture" ++ms.localizationpriority: medium ++++# partnerSecurityScore resource type ++Namespace: microsoft.graph.partner.security +++Represents the security score for the partner which helps Cloud Solution Provider (CSP) partners understand their security posture and their customer's security posture. The score includes an aggregate score along with history of score changes, detailed customer insights, and requirement score information. ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[Get](../api/partner-security-partnersecurityscore-get.md)|[microsoft.graph.partner.security.partnerSecurityScore](../resources/partner-security-partnersecurityscore.md)|Read the properties and relationships of a [partnerSecurityScore](../resources/partner-security-partnersecurityscore.md) object.| +|[List customer insights](../api/partner-security-partnersecurityscore-list-customerinsights.md)|[microsoft.graph.partner.security.customerInsight](../resources/partner-security-customerinsight.md) collection|Get a list of the **customerInsight** data to learn more about the partner's customer security posture.| +|[List history](../api/partner-security-partnersecurityscore-list-history.md)|[microsoft.graph.partner.security.securityScoreHistory](../resources/partner-security-securityscorehistory.md) collection|Lists the history of security score changes for the partner..| +|[List requirements](../api/partner-security-partnersecurityscore-list-requirements.md)|[microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md) collection|Get the security requirement resources from the **requirements** navigation property.| ++## Properties +|Property|Type|Description| +|:|:|:| +|currentScore|Single|The current security score for the partner.| +|lastRefreshDateTime|DateTimeOffset|The last time the data was checked.| +|maxScore|Single|The maximum score possible.| +|updatedDateTime|DateTimeOffset|The last time the security score or related properties changed.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|customerInsights|[microsoft.graph.partner.security.customerInsight](../resources/partner-security-customerinsight.md) collection|Contains customer-specific information for certain requirements.| +|history|[microsoft.graph.partner.security.securityScoreHistory](../resources/partner-security-securityscorehistory.md) collection|Contains a list of recent score changes.| +|requirements|[microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md) collection|Contains the list of security requirements that make up the score.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.partnerSecurityScore", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.partnerSecurityScore", + "updatedDateTime": "String (timestamp)", + "lastRefreshDateTime": "String (timestamp)", + "currentScore": "Single", + "maxScore": "Single" +} +``` + |
v1.0 | Partner Security Responsetimesecurityrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-responsetimesecurityrequirement.md | + + Title: "responseTimeSecurityRequirement resource type" +description: "Represents the response time security requirements for partner alerts in the partner security score." ++ms.localizationpriority: medium ++++# responseTimeSecurityRequirement resource type ++Namespace: microsoft.graph.partner.security +++Represents the response time security requirements for partner alerts in the partner security score. This requirement shows if the partner is responding quickly to address new [security alerts](../resources/security-alert.md). +++Inherits from [microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|actionUrl|String|The link to the site where the admin can take action on the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|averageResponseTimeInHours|Single|The average response time for alerts from the past 30 days.| +|complianceStatus|microsoft.graph.partner.security.complianceStatus|Indicates whether the partner is compliant with this requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `compliant`, `noncomplaint`, `unknownFutureValue`.| +|helpUrl|String|The link to documentation for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|id|String|The unique identifier for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|maxScore|Int64|The maximum score possible for the requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|requirementType|microsoft.graph.partner.security.securityRequirementType|The value of this property is always `securityAlertsPromptlyResolved` for this resource. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `mfaEnforcedForAdmins`, `mfaEnforcedForAdminsOfCustomers`, `securityAlertsPromptlyResolved`, `securityContactProvided`, `spendingBudgetSetForCustomerAzureSubscriptions`, `unknownFutureValue`.| +|score|Int64|The score received for this requirement. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| +|state|microsoft.graph.partner.security.securityRequirementState|Indicates whether the requirement is in preview or is fully released. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md). The possible values are: `active`, `preview`, `unknownFutureValue`.| +|updatedDateTime|DateTimeOffset|The date the requirement properties were last updated. Inherited from [securityRequirement](../resources/partner-security-securityrequirement.md).| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.responseTimeSecurityRequirement", + "baseType": "microsoft.graph.partner.security.securityRequirement", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.responseTimeSecurityRequirement", + "id": "String (identifier)", + "requirementType": "String", + "complianceStatus": "String", + "actionUrl": "String", + "helpUrl": "String", + "score": "Integer", + "maxScore": "Integer", + "state": "String", + "updatedDateTime": "String (timestamp)", + "averageResponseTimeInHours": "Single" +} +``` + |
v1.0 | Partner Security Score Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-score-api-overview.md | + + Title: "Use the partner security score API in Microsoft Graph (preview)" +description: "The partner security score API helps Cloud Solution Provider (CSP) partners understand their security posture and their customer's security posture." ++ms.localizationpriority: medium ++++# Use the partner security score API in Microsoft Graph (preview) ++Namespace: microsoft.graph.partner.security +++The Microsoft Partner Center ecosystem provides a security score to indirect providers or direct bill partners in the Cloud Solution Provider (CSP), Value Added Reseller, or Advisor programs. The goal of the score and requirements is to help partners understand the security posture of their tenant and their customer's tenants. The partner security score builds on the Identity and Microsoft 365 security scores to provide suggestions specific to their scenario. +The [partner security score API](../resources/partner-security-partnersecurityscore.md) is a pivotal tool designed to empower Microsoft partners by providing a quantifiable measure of their security performance. This API facilitates partners in enhancing their security posture by offering a comprehensive security score based on their adherence to Microsoft's security requirements. ++The partner security score API is defined in the OData subnamespace `microsoft.graph.partners.security`. ++## Objectives ++The primary objectives of the security score API include: + +* __Quantifying security performance:__ Offering partners a numerical score that reflects their current security status. +* __Guiding security enhancements with actionable insights:__ Providing actionable insights and recommendations to help partners bolster their security measures. +* __Monitoring security evolution:__ Enabling partners to track their security improvements over time, fostering a culture of continuous security enhancement. + +Use the Microsoft Graph [partner security score API](../resources/partner-security-partnersecurityscore.md) to retrieve the score and insights into your customer security posture. + +> **Note:** In order to take actions for the security requirements, choose the action URL provisioned in the API response to go to the relevant UI. ++## Common use cases ++The following table shows common requests for working with the partner security alert API in Microsoft Graph. ++| Use case | REST operation | Try it in Graph Explorer | +|:|:--|:-| +|Get partner security score| [Get](../api/partner-security-partnersecurityscore-get.md) | [https://graph.microsoft.com/beta/security/partner/securityScore](https://developer.microsoft.com/graph/graph-explorer?request=security/partner/securityScore&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | +|List customer security insights |[List](../api/partner-security-partnersecurityscore-list-customerinsights.md)| [https://graph.microsoft.com/beta/security/partner/securityScore/customerInsights](https://developer.microsoft.com/graph/graph-explorer?request=security/partner/securityScore/customerInsights&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | ++## Related content ++The partner security score API in Microsoft Graph provides a summary of your security posture and provides actions to improve. Follow these steps to get started: ++- Drill down on the requirements and properties of the [partnerSecurityScore](../resources/partner-security-partnersecurityscore.md) resource. +- Try the API in the [Microsoft Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). |
v1.0 | Partner Security Securityrequirement | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-securityrequirement.md | + + Title: "securityRequirement resource type" +description: "Represents the base type for security requirement objects." ++ms.localizationpriority: medium ++++# securityRequirement resource type ++Namespace: microsoft.graph.partner.security +++Represents the base type for security requirement objects. +++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/partner-security-partnersecurityscore-list-requirements.md)|[microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md) collection|Get a list of the [securityRequirement](../resources/partner-security-securityrequirement.md) objects and their properties.| +|[Get](../api/partner-security-securityrequirement-get.md)|[microsoft.graph.partner.security.securityRequirement](../resources/partner-security-securityrequirement.md)|Read the properties and relationships of a [securityRequirement](../resources/partner-security-securityrequirement.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|actionUrl|String|The link to the site where the admin can take action on the requirement.| +|complianceStatus|microsoft.graph.partner.security.complianceStatus|Indicates whether the partner is compliant with this requirement. The possible values are: `compliant`, `noncomplaint`, `unknownFutureValue`.| +|helpUrl|String|The link to documentation for the requirement.| +|id|String|The unique identifier for the requirement. Inherited from [microsoft.graph.entity](../resources/entity.md).| +|maxScore|Int64|The maximum score possible for the requirement. | +|requirementType|microsoft.graph.partner.security.securityRequirementType|The type of requirement. The possible values are: `mfaEnforcedForAdmins`, `mfaEnforcedForAdminsOfCustomers`, `securityAlertsPromptlyResolved`, `securityContactProvided`, `spendingBudgetSetForCustomerAzureSubscriptions`, `unknownFutureValue`.| +|score|Int64|The score received for this requirement. | +|state|microsoft.graph.partner.security.securityRequirementState|Indicates whether the requirement is in preview or is fully released. The possible values are: `active`, `preview`, `unknownFutureValue`.| +|updatedDateTime|DateTimeOffset|The date the requirement properties were last updated.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.securityRequirement", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.securityRequirement", + "id": "String (identifier)", + "requirementType": "String", + "complianceStatus": "String", + "actionUrl": "String", + "helpUrl": "String", + "score": "Integer", + "maxScore": "Integer", + "state": "String", + "updatedDateTime": "String (timestamp)" +} +``` + |
v1.0 | Partner Security Securityscorehistory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/partner-security-securityscorehistory.md | + + Title: "securityScoreHistory resource type" +description: "Represents a single history entry for the security score where the score or the requirements changed." ++ms.localizationpriority: medium ++++# securityScoreHistory resource type ++Namespace: microsoft.graph.partner.security +++Represents a single history entry for the security score where the score or the requirements changed. +++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/partner-security-partnersecurityscore-list-history.md)|[microsoft.graph.partner.security.securityScoreHistory](../resources/partner-security-securityscorehistory.md) collection|Get a list of [securityScoreHistory](../resources/partner-security-securityscorehistory.md) objects and their properties.| +|[Get](../api/partner-security-securityscorehistory-get.md)|[microsoft.graph.partner.security.securityScoreHistory](../resources/partner-security-securityscorehistory.md)|Read the properties and relationships of a [securityScoreHistory](../resources/partner-security-securityscorehistory.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|compliantRequirementsCount|Int64|The number of compliant security requirements at the time.| +|createdDateTime|DateTimeOffset|The date the history entry was created.| +|id|String|The unique identifier for the history entry.| +|score|Double|The score recorded at the time.| +|totalRequirementsCount|Int64|The total number of requirements at the time.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.partner.security.securityScoreHistory", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.partner.security.securityScoreHistory", + "id": "String (identifier)", + "createdDateTime": "String (timestamp)", + "score": "Double", + "compliantRequirementsCount": "Integer", + "totalRequirementsCount": "Integer" +} +``` + |
v1.0 | Passwordcredentialconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/passwordcredentialconfiguration.md | Password credential configuration object that contains properties to configure r | : | : | : | | maxLifetime | Duration | String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, `P4DT12H30M5S` represents four days, 12 hours, 30 minutes, and five seconds. This property is required when **restrictionType** is set to `passwordLifetime`.| | restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.|-| restrictionType | appCredentialRestrictionType | The type of restriction being applied. The possible values are: `passwordAddition`, `passwordLifetime`, `symmetricKeyAddition`, `symmetricKeyLifetime`,`customPasswordAddition`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.| -| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.| +| restrictionType | appCredentialRestrictionType | The type of restriction being applied. The possible values are: `passwordAddition`, `passwordLifetime`, `symmetricKeyAddition`, `symmetricKeyLifetime`, `customPasswordAddition`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.| +| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.| ## Relationships The following JSON representation shows the resource. "@odata.type": "microsoft.graph.appManagementRestrictionState" }, "restrictForAppsCreatedAfterDateTime": "String (DateTime)",- "maxLifetime": "String (ISO 8601 duration)" + "maxLifetime": "String (duration)" } ``` |
v1.0 | Passwordresetresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/passwordresetresponse.md | + + Title: "passwordResetResponse resource type" +description: "Represents the new system-generated password after a password reset operation." +++ms.localizationpriority: medium ++++# passwordResetResponse resource type ++Namespace: microsoft.graph +++Represents the new system-generated password after a [password reset operation](../api/authenticationmethod-resetpassword.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|newPassword|String|The Microsoft Entra ID-generated password.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.passwordResetResponse" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.passwordResetResponse", + "newPassword": "String" +} +``` |
v1.0 | Peopleadminsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/peopleadminsettings.md | Inherits from [entity](../resources/entity.md). | Property | Type | Description | |:|:-|:|-| id | String | The unique identifier for a **peopleAdminSettings** object. Inherited from [entity](entity.md). | +| id | String | The unique identifier for the **peopleAdminSettings** object. Inherited from [entity](entity.md). | ## Relationships |Relationship|Type|Description| |:|:|:|-|itemInsights|[insightsSettings](../resources/insightssettings.md)|Represents administrator settings that manage the support for item insights in an organization.| -|profileCardProperties|[profileCardProperty](profilecardproperty.md) collection| Contains a collection of the properties an administrator defined as visible on the Microsoft 365 profile card.| -|photoUpdateSettings|[photoUpdateSettings](../resources/photoupdatesettings.md)|Represents administrator settings that manage the support for item photo updates in an organization.| -|pronouns|[pronounsSettings](../resources/pronounssettings.md)|Represents administrator settings that manage the support of pronouns in an organization.| +|itemInsights|[insightsSettings](../resources/insightssettings.md)|Administrator settings that manage the support for item insights in an organization.| +|profileCardProperties|[profileCardProperty](profilecardproperty.md) collection|A collection of the properties an administrator defined as visible on the Microsoft 365 profile card.| +|photoUpdateSettings|[photoUpdateSettings](../resources/photoupdatesettings.md)|Administrator settings that manage the support for item photo updates in an organization.| +|pronouns|[pronounsSettings](../resources/pronounssettings.md)|Administrator settings that manage the support of pronouns in an organization.| +|namePronunciation|[namePronunciationSettings](../resources/namepronunciationsettings.md)|Administrator settings that manage the support of name pronunciation in an organization.| ## JSON representation |
v1.0 | Planner Order Hint Format | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/planner-order-hint-format.md | Title: "Using order hints in Planner" -description: "`)" +description: "Learn how to use order hints in Planner to manage the sort order of Planner objects." ms.localizationpriority: medium |
v1.0 | Plannerchecklistitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerchecklistitem.md | The **plannerChecklistItem** resource represents an item in the checklist of a t |:|:--|:-| |isChecked|Boolean|Value is `true` if the item is checked and `false` otherwise.| |lastModifiedBy|[identitySet](identityset.md)| Read-only. User ID by which this is last modified.|-|lastModifiedDateTime|DateTimeOffset|Read-only. Date and time at which this is last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| +|lastModifiedDateTime|DateTimeOffset|Read-only. Date and time at which this is last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |orderHint|String|Used to set the relative order of items in the checklist. The format is defined as outlined [here](planner-order-hint-format.md).|-|title|String|Title of the checklist item| +|title|String|Title of the checklist item.| ++## Relationships ++None. ## Relationships |
v1.0 | Plannerchecklistitems | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerchecklistitems.md | Title: "plannerChecklistItems resource type" -description: "The **plannerChecklistItemCollection** resource represents the collection of checklist items on a task. It's an Open Type. It's part of the task details object. The value in the property-value pair is the checklistItem object." +description: "Represents the collection of checklist items on a task. This complex type is an open type that's part of the task details object. The value in the property-value pair is the checklistItem object." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **plannerChecklistItemCollection** resource represents the collection of checklist items on a task. It's an Open Type. It's part of the [task details](plannertaskdetails.md) object. The value in the property-value pair is the [checklistItem](plannerchecklistitem.md) object. +Represents the collection of checklist items on a task. This complex type is an open type that's part of the [task details](plannertaskdetails.md) object. The value in the property-value pair is the [checklistItem](plannerchecklistitem.md) object. ## Properties-Properties of an Open Type can be defined by the client. In this case, the client should provide **GUIDs** as properties and their values must be [checklistItem](plannerchecklistitem.md) objects. Example is shown below. To remove an item in the checklist, set the value of the property to `null`. +Properties of an open type can be defined by the client. In this case, the client should provide **GUIDs** as properties and their values must be [checklistItem](plannerchecklistitem.md) objects. To remove an item in the checklist, set the value of the property to `null`. ## Relationships The following JSON representation shows the resource type. { "String-value": {+ "@odata.type": "microsoft.graph.plannerChecklistItem", "isChecked": true,- "lastModifiedBy": "String-value", + "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, "lastModifiedByDateTime": "String(timestamp)", "orderHint": "String-value", "title": "String-value" } }-``` -// Example --```json -{ - "3a73c9dd-fb47-4230-9c0f-b80788fb0f9b": // client-generated GUID - { - "@odata.type": "microsoft.graph.checklistItem", // required in PATCH requests to edit the checklist on a task - "isChecked": true, - "lastModifiedBy": { - "user": { - "id": "ebf3b108-5234-4e22-b93d-656d7dae5874" - } - }, - "lastModifiedByDateTime": "2015-09-21T17:45:12.039Z", - "orderHint": "0009005756397228702", - "title": "Get stamps" - }, - "5f36f5b2-1ec0-4c48-9c75-ed59429516c5": - { - "@odata.type": "microsoft.graph.checklistItem", - "isChecked": false, - "lastModifiedBy": { - "user": { - "id": "ebf3b108-5234-4e22-b93d-656d7dae5874" - } - }, - "lastModifiedByDateTime": "2015-09-21T17:45:12.039Z", - "orderHint": "0004105723397228784", - "title": "Mail card at UPS" - } -} - ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Plannerorderhintsbyassignee | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerorderhintsbyassignee.md | Title: "plannerOrderHintsByAssignee resource type" -description: "The **plannerOrderHintsByAssignee** is a resource that contains ordering hints for assignees in a plannerTask resource, to indicate the order of the task in Assigned To view of the Task Board." +description: "Contains ordering hints for assignees in a plannerTask resource, to indicate the order of the task in Assigned To view of the Task Board." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **plannerOrderHintsByAssignee** is a resource that contains [ordering hints](planner-order-hint-format.md) for assignees in a [plannerTask](plannertask.md) resource, to indicate the order of the task in Assigned To view of the Task Board. +Contains [ordering hints](planner-order-hint-format.md) for assignees in a [plannerTask](plannertask.md) resource, to indicate the order of the task in Assigned To view of the Task Board. This type is an open type. The properties are the IDs of users assigned to the task, and the values are order hints. ## Properties |
v1.0 | Plannerplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerplan.md | Represents a plan in Microsoft 365. Either a [group](group.md) or a [user](user. | Method | Return Type |Description| |:|:--|:-|-|[Get plan](../api/plannerplan-get.md) | [plannerPlan](plannerplan.md) |Read properties and relationships of **plannerPlan** object.| +|[Create](../api/planner-post-plans.md) | [plannerPlan](plannerplan.md) |Create a **plannerPlan** object.| +|[Get](../api/plannerplan-get.md) | [plannerPlan](plannerplan.md) |Read properties and relationships of **plannerPlan** object.| +|[Update](../api/plannerplan-update.md) | [plannerPlan](plannerplan.md) |Update **plannerPlan** object. | +|[Delete](../api/plannerplan-delete.md) | None | Delete **plannerPlan** object. | +|[Archive plan](../api/plannerplan-archive.md) | [plannerPlan](plannerplan.md) | Archive a **plannerPlan** object.| +|[Unarchive plan](../api/plannerplan-unarchive.md) | [plannerPlan](plannerplan.md) | Unarchive an archived **plannerPlan** object.| +|[Move to container](../api/plannerplan-movetocontainer.md) | [plannerPlan](../resources/plannerplan.md) | Move a **plannerPlan** object from one **plannerPlanContainer** to another. | |[List plan buckets](../api/plannerplan-list-buckets.md) |[plannerBucket](plannerbucket.md) collection| Get a **plannerBucket** object collection.| |[List plan tasks](../api/plannerplan-list-tasks.md) |[plannerTask](plannertask.md) collection| Get a **plannerTask** object collection.|-|[Update plan](../api/plannerplan-update.md) | [plannerPlan](plannerplan.md) |Update **plannerPlan** object. | -|[Delete plan](../api/plannerplan-delete.md) | None | Delete **plannerPlan** object. | |[Get delta](../api/plannerplan-delta.md) | [plannerPlan](../resources/plannerplan.md) collection | Get newly created, updated, or deleted **plannerPlan** objects in either a **group** or a [plannerRoster](plannerroster.md) type container without having to perform a full read of the entire resource collection. |-|[Move to container](../api/plannerplan-movetocontainer.md) | [plannerPlan](../resources/plannerplan.md) | Move a **plannerPlan** object from one **plannerPlanContainer** to another. | -|[Archive plan](../api/plannerplan-archive.md) | [plannerPlan](plannerplan.md) | Archive a **plannerPlan** object.| -|[Unarchive plan](../api/plannerplan-unarchive.md) | [plannerPlan](plannerplan.md) | Unarchive an archived **plannerPlan** object.| ## Properties | Property | Type |Description| |
v1.0 | Plannerplanconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerplanconfiguration.md | Inherits from [entity](../resources/entity.md). |:|:|:| |[Get](../api/plannerplanconfiguration-get.md)|[plannerPlanConfiguration](../resources/plannerplanconfiguration.md)|Read the properties and relationships of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object.| |[Update](../api/plannerplanconfiguration-update.md)|[plannerPlanConfiguration](../resources/plannerplanconfiguration.md)|Update the properties of a [plannerPlanConfiguration](../resources/plannerplanconfiguration.md) object for a [businessScenario](../resources/businessscenario.md). |-|[List](../api/plannerplanconfiguration-list-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) collection|Get the plannerPlanConfigurationLocalization resources from the localizations navigation property.| -|[Create](../api/plannerplanconfiguration-post-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Create a new plannerPlanConfigurationLocalization object.| ## Properties |
v1.0 | Plannerplanconfigurationlocalization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannerplanconfigurationlocalization.md | Inherits from [entity](../resources/entity.md). |Method|Return type|Description| |:|:|:| |[List](../api/plannerplanconfiguration-list-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) collection|Get a list of the [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) objects and their properties.|-|[Create](../api/plannerplanconfiguration-post-localizations.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Create a new [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| -|[Get](../api/plannerplanconfigurationlocalization-get.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Read the properties and relationships of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| -|[Update](../api/plannerplanconfigurationlocalization-update.md)|[plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md)|Update the properties of a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| -|[Delete](../api/plannerplanconfiguration-delete-localizations.md)|None|Delete a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) object.| +|[Update](../api/plannerplanconfiguration-update.md)|[plannerPlanConfiguration](../resources/plannerplanconfiguration.md)|Add, remove, or update a [plannerPlanConfigurationLocalization](../resources/plannerplanconfigurationlocalization.md) via the update of the plannerPlanConfiguration.| ## Properties |Property|Type|Description| |
v1.0 | Plannertask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/plannertask.md | Represents a planner task in Microsoft 365. A planner task is contained in a [pl | Method | Return Type |Description| |:|:--|:-|-|[Get task](../api/plannertask-get.md) | [plannerTask](plannertask.md) |Read the properties and relationships of **plannerTask** object.| -|[Update task](../api/plannertask-update.md) | [plannerTask](plannertask.md) |Update a **plannerTask** object. | -|[Delete task](../api/plannertask-delete.md) | None |Delete a **plannerTask** object. | +|[Create](../api/planner-post-tasks.md) | [plannerTask](plannertask.md) |Create a **plannerTask** object.| +|[Get](../api/plannertask-get.md) | [plannerTask](plannertask.md) |Read the properties and relationships of **plannerTask** object.| +|[Update](../api/plannertask-update.md) | [plannerTask](plannertask.md) |Update a **plannerTask** object. | +|[Delete](../api/plannertask-delete.md) | None |Delete a **plannerTask** object. | |[Get delta](../api/plannertask-delta.md)|[plannerTask](../resources/plannertask.md) collection| Get newly created, updated, or deleted **plannerTask** objects in either a **plannerPlan** or assigned to the signed-in user without having to perform a full read of the entire resource collection. | ## Properties |
v1.0 | Policyroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/policyroot.md | None | claimsMappingPolicies | [claimsMappingPolicy](claimsmappingpolicy.md) collection | The claim-mapping policies for WS-Fed, SAML, OAuth 2.0, and OpenID Connect protocols, for tokens issued to a specific application. | | conditionalAccessPolicies | [conditionalAccessPolicy](conditionalaccesspolicy.md) | The custom rules that define an access scenario. | | crossTenantAccessPolicy | [crossTenantAccessPolicy](crosstenantaccesspolicy.md) | The custom rules that define an access scenario when interacting with external Microsoft Entra tenants. |+| deviceRegistrationPolicy | [deviceRegistrationPolicy](deviceregistrationpolicy.md) | Represents the policy scope that controls quota restrictions, additional authentication, and authorization policies to register device identities to your organization. | | defaultAppManagementPolicy | [tenantAppManagementPolicy](tenantappmanagementpolicy.md) | The tenant-wide policy that enforces app management restrictions for all applications and service principals. | | externalIdentitiesPolicy | [externalIdentitiesPolicy](externalidentitiespolicy.md) | Represents the tenant-wide policy that controls whether guests can leave a Microsoft Entra tenant via self-service controls. | | featureRolloutPolicies | [featureRolloutPolicy](featurerolloutpolicy.md) collection | The feature rollout policy associated with a directory object. | |
v1.0 | Positiondetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/positiondetail.md | Represents information about positions related to entities within a user's [prof ## Properties -| Property | Type | Description | -|:|:|:-| -|company |[companyDetail](companydetail.md) | Detail about the company or employer. | -|description |String | Description of the position in question. | -|endMonthYear |Date | When the position ended. | -|jobTitle |String | The title held when in that position. | -|layer |Int32 | The place where the employee is within the organizational hierarchy. | -|level |String | The employeeΓÇÖs experience or management level. | -|role |String | The role the position entailed. | -|startMonthYear |Date | The start month and year of the position. | -|summary |String | summary of the position. | +|Property|Type|Description| +|:-|:|:-| +|company|[companyDetail](companydetail.md)|Information about the company or employer.| +|description|String|A description for the position in question.| +|endMonthYear|Date|The date when the position ended.| +|jobTitle|String|The title of the position.| +|layer|Int32|The place where the employee is within the organizational hierarchy.| +|level|String|The employeeΓÇÖs experience or management level.| +|role|String|The role the position entailed.| +|secondaryJobTitle|String|An optional job title for the position.| +|secondaryRole|String|An optional role for the position entailed.| +|startMonthYear|Date|The start date of the position.| +|summary|String|The summary of the position.| ## JSON representation The following JSON representation shows the resource type. "layer": "Integer", "level": "String", "role": "String",+ "secondaryJobTitle": "String", + "secondaryRole": "String", "startMonthYear": "String (timestamp)", "summary": "String" } |
v1.0 | Printercapabilities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printercapabilities.md | Title: printerCapabilities complex type + Title: "printerCapabilities resource type" description: Represents the capabilities reported by a printer. ms.localizationpriority: medium-# printerCapabilities complex type +# printerCapabilities resource type Namespace: microsoft.graph |
v1.0 | Printmargin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printmargin.md | Title: printMargin resource type + Title: "printMargin resource type" description: Specifies the margin widths to use when printing. ms.localizationpriority: medium-# printMargin complex type +# printMargin resource type Namespace: microsoft.graph |
v1.0 | Printoperationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/printoperationstatus.md | Title: printOperationStatus resource type + Title: "printOperationStatus resource type" description: Represents the current status of a long-running Universal Print operation. ms.localizationpriority: medium-# printOperationStatus complex type +# printOperationStatus resource type Namespace: microsoft.graph Represents the current status of a long-running Universal Print operation. ### printOperationProcessingState values -|Member|Value|Description| -|:|:|:| -|notStarted|0|The operation has not yet started.| -|running|1|The operation is running.| -|succeeded|2|The operation completed successfully.| -|failed|3|The operation failed.| -|unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +|Member|Description| +|:|:| +|notStarted|The operation has not yet started.| +|running|The operation is running.| +|succeeded|The operation completed successfully.| +|failed|The operation failed.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Privilegedidentitymanagement For Groups Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedidentitymanagement-for-groups-api-overview.md | Title: "Govern membership and ownership of groups using privileged identity management (PIM) for groups" -description: "Privileged Identity Management (PIM) is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources, such as groups, in your organization." + Title: "Govern membership and ownership of groups using PIM for groups" +description: "PIM, part of Microsoft Entra ID Governance, enables you to manage, control, and monitor access to important resources, such as groups, in your organization." ms.localizationpriority: medium doc_type: conceptualPageType - Previously updated : 10/12/2023+ Last updated : 09/25/2024+#Customer intent: As a security administrator, I want to understand how to use PIM for groups to govern membership and ownership of groups in my organization. # Govern membership and ownership of groups using PIM for groups -With [Privileged Identity Management for groups (PIM for groups)](/azure/active-directory/privileged-identity-management/concept-pim-for-groups), you can govern how principals are assigned membership or ownership of [groups](groups-overview.md). Security and Microsoft 365 groups are critical resources that you can use to provide access to Microsoft cloud resources like Microsoft Entra roles, Azure roles, Azure SQL, Azure Key Vault, Intune; and third-party applications. PIM for groups gives you more control over how and when principals are members or owners of groups, and therefore have privileges granted through their group membership or ownership. +With [Privileged Identity Management for groups (PIM for groups)](/entr). Security and Microsoft 365 Groups are critical resources that you can use to provide access to Microsoft cloud resources like Microsoft Entra roles, Azure roles, Azure SQL, Azure Key Vault, Intune; and third-party applications. PIM for groups gives you more control over how and when principals are members or owners of groups, and therefore have privileges granted through their group membership or ownership. -The PIM for groups APIs in Microsoft Graph provide you with more governance over security and Microsoft 365 groups such as the following capabilities: +The PIM for groups APIs in Microsoft Graph provide you with more governance over security and Microsoft 365 Groups such as the following capabilities: - Providing principals just-in-time membership or ownership of groups - Assigning principals temporary membership or ownership of groups The following table lists scenarios for using PIM for groups APIs to manage acti ## PIM for groups APIs for managing eligible assignments of group owners and members -Your principals may not require permanent membership or ownership of groups because they may not require the privileges granted through the membership or ownership all the time. In this case, PIM for groups allows you to make the principals eligible for the membership or ownership of the groups. +Your principals might not require permanent membership or ownership of groups because they don't require the privileges granted through the membership or ownership all the time. In this case, PIM for groups allows you to make the principals eligible for the membership or ownership of the groups. -When a principal has an eligible assignment, they activate their assignment when they need the privileges granted through the groups to perform privileged tasks. An eligible assignment can be permanent or temporary. The activation is always time-bound for up to a maximum of eight hours. +When a principal has an eligible assignment, they activate their assignment when they need the privileges granted through the groups to perform privileged tasks. An eligible assignment can be permanent or temporary. The activation is always time-bound for a maximum of 8 hours. The principal can also extend or renew their membership or ownership of the group. The following table lists scenarios for using PIM for groups APIs to manage eligible assignments for principals and the corresponding APIs to call. The following table lists scenarios for using PIM for groups APIs to manage elig ## Policy settings in PIM for groups -PIM for groups defines settings or rules that govern how principals can be assigned membership or ownership of security and Microsoft 365 groups. Such rules include whether multifactor authentication (MFA), justification, or approval is required to activate an eligible membership or ownership for a group, or whether you can create permanent assignments or eligibilities for principals to the groups. The rules are defined in policies and a policy can be applied to a group. +PIM for groups defines settings or rules that govern how principals can be assigned membership or ownership of security and Microsoft 365 Groups. Such rules include whether multifactor authentication (MFA), justification, or approval is required to activate an eligible membership or ownership for a group, or whether you can create permanent assignments or eligibilities for principals to the groups. The rules are defined in policies and a policy can be applied to a group. In Microsoft Graph, these rules are managed through the [unifiedRoleManagementPolicy](unifiedrolemanagementpolicy.md) and the [unifiedRoleManagementPolicyAssignment](unifiedrolemanagementpolicyassignment.md) resource types and their related methods. For more information about using Microsoft Graph to configure rules, see [Overvi You can't onboard a group to PIM for groups explicitly. When you make a request to add an assignment to a group by using [Create assignmentScheduleRequest](../api/privilegedaccessgroup-post-assignmentschedulerequests.md) or [Create eligibilityScheduleRequest](../api/privilegedaccessgroup-post-eligibilityschedulerequests.md), or you update PIM policy (role settings) for a group by using [Update unifiedRoleManagementPolicy](../api/unifiedrolemanagementpolicy-update.md) or [Update unifiedRoleManagementPolicyRule](../api/unifiedrolemanagementpolicyrule-update.md), the group is onboarded to PIM automatically if it wasn't onboarded before. -You can call [List assignmentScheduleRequests](../api/privilegedaccessgroup-list-assignmentschedulerequests.md), [List assignmentSchedules](../api/privilegedaccessgroup-list-assignmentschedules.md), [List assignmentScheduleInstances](../api/privilegedaccessgroup-list-assignmentscheduleinstances.md), [List eligibilityScheduleRequests](../api/privilegedaccessgroup-list-eligibilityschedulerequests.md), [List eligibilitySchedules](../api/privilegedaccessgroup-list-eligibilityschedules.md), and [List eligibilityScheduleInstances](../api/privilegedaccessgroup-list-eligibilityscheduleinstances.md) APIs for both groups that are onboarded to PIM and groups that aren't onboarded to PIM yet, but we recommend doing it only for groups that are onboarded to PIM to reduce the chances of getting throttled +You can call one of the following APIs for both groups that are onboarded to PIM and groups that aren't onboarded to PIM yet, but we recommend doing it only for groups that are onboarded to PIM to reduce the chances of getting throttled. +- [List assignmentScheduleRequests](../api/privilegedaccessgroup-list-assignmentschedulerequests.md) +- [List assignmentSchedules](../api/privilegedaccessgroup-list-assignmentschedules.md) +- [List assignmentScheduleInstances](../api/privilegedaccessgroup-list-assignmentscheduleinstances.md), +- [List eligibilityScheduleRequests](../api/privilegedaccessgroup-list-eligibilityschedulerequests.md) +- [List eligibilitySchedules](../api/privilegedaccessgroup-list-eligibilityschedules.md) +- [List eligibilityScheduleInstances](../api/privilegedaccessgroup-list-eligibilityscheduleinstances.md) After PIM onboards a group, IDs of the PIM policies and policy assignments of the specific group change. Call the [Get unifiedRoleManagementPolicy](../api/unifiedrolemanagementpolicy-get.md) or [Get unifiedRoleManagementPolicyAssignment](../api/unifiedrolemanagementpolicyassignment-get.md) API to get the updated IDs. When a principal's *temporary active* membership or ownership of a group expires <!-- End of: Link to ZT guidance --> -## Permissions and privileges --The following Microsoft Graph permissions are required to call the PIM for groups APIs. --| Endpoints | Supported operations | Permissions | -|||| -| assignmentSchedule <br/> assignmentScheduleInstance | LIST, GET | PrivilegedAssignmentSchedule.Read.AzureADGroup <br/> PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| assignmentScheduleRequest | CREATE, LIST, GET, UPDATE, DELELE | PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| eligibilitySchedule <br/> eligibilityScheduleInstance | LIST, GET | PrivilegedEligibilitySchedule.Read.AzureADGroup <br/> PrivilegedEligibilitySchedule.ReadWrite.AzureADGroup | -| eligibilityScheduleRequest | CREATE, LIST, GET, UPDATE, DELELE | PrivilegedEligibilitySchedule.ReadWrite.AzureADGroup | -| approval | GET | PrivilegedAssignmentSchedule.Read.AzureADGroup <br/> PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| approvalStep | LIST, GET | PrivilegedAssignmentSchedule.Read.AzureADGroup <br/> PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| approvalStep | UPDATE | PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| roleManagementPolicy <br/> roleManagementPolicyAssignment | LIST, GET | RoleManagementPolicy.Read.AzureADGroup <br/> RoleManagementPolicy.ReadWrite.AzureADGroup | -| roleManagementPolicy | UPDATE | RoleManagementPolicy.ReadWrite.AzureADGroup | --In addition, for delegated scenarios, the calling principal needs one of the following roles (not applicable to approval and approvalStep endpoints). --| Group | Role | Supported operations | -|||| -| Role-assignable | Privileged Role Administrator <br/> Group owner* <br/> Group member* | CREATE, UPDATE, DELELE | -| Role-assignable | Global Reader <br/> Privileged Role Administrator <br/> Group owner* <br/> Group member* | LIST, GET | -| Non-role-assignable | Directory Writer <br/> Groups Administrator <br/> Identity Governance Administrator <br/> User Administrator <br/> Group owner* <br/> Group member* | CREATE, UPDATE, DELELE | -| Non-role-assignable | Global Reader <br/> Directory Writer <br/> Groups Administrator <br/> Identity Governance Administrator <br/> User Administrator <br/> Group owner* <br/> Group member* | LIST, GET | --`*` Permissions for group members and group owners are limited to the read or write operations they need to perform. For example, a group member can [cancel their assignmentScheduleRequest](../api/privilegedaccessgroupassignmentschedulerequest-cancel.md) but not any other principal's request. --Only the approver of the request can call the `/approval` and `/approvalStep` endpoints. They don't have to be assigned any Microsoft Entra roles. +## Licensing +The tenant where Privileged Identity Management is being used must have enough purchased or trial licenses. For more information, see [Microsoft Entra ID Governance licensing fundamentals](/entra/id-governance/licensing-fundamentals). ## Related content |
v1.0 | Privilegedidentitymanagementv3 Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/privilegedidentitymanagementv3-overview.md | Title: "Manage Microsoft Entra role assignments using the privileged identity management (PIM) APIs" -description: "Privileged Identity Management (PIM) is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources in your organization." + Title: "Manage Microsoft Entra role assignments using the PIM APIs" +description: "PIM is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources in your organization." ms.localizationpriority: medium doc_type: conceptualPageType - Previously updated : 10/12/2023+ Last updated : 09/24/2024+# Customer intent: As a developer, I want to learn how to get started with PIM APIs for managing Microsoft Entra roles. # Manage Microsoft Entra role assignments using PIM APIs -[Privileged Identity Management (PIM)](/azure/active-directory/privileged-identity-management/pim-configure) is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources in your organization. One method through which principals such as users, groups, and service principals (applications) are granted access to important resources is through assignment of [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +[Privileged Identity Management (PIM)](/entra/id-governance/privileged-identity-management/pim-configure) is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources in your organization. One method through which principals such as users, groups, and service principals (applications) are granted access to important resources is through assignment of [Microsoft Entra administrator roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). The PIM for Microsoft Entra roles APIs allow you to govern privileged access and limit excessive access to Microsoft Entra roles. This article introduces the governance capabilities of PIM for Microsoft Entra roles APIs in Microsoft Graph. > [!NOTE] > To manage Azure resource roles use the [PIM APIs for Azure Resource Manager](/rest/api/authorization/privileged-role-eligibility-rest-sample). +## Methods of assigning roles ++PIM for Microsoft Entra roles provides two methods for assigning roles to principals: +- **Active role assignments**: A principal can have a permanent or temporary perpetually active role assignment. +- **Eligible role assignments**: A principal can be eligibile for a role either permanently or temporarily. With eligible assigments, the principal activates their role - thereby creating a temporarily active role assignment - when they need to perform privileged tasks. The activation is always time-bound for a maximum of 8 hours but the maximum duration can be lowered in the role settings. The activation can also be renewed or extended. + ## PIM APIs for managing active role assignments PIM allows you to manage active role assignments by creating permanent assignments or temporary assignments. Use the [unifiedRoleAssignmentScheduleRequest](unifiedroleassignmentschedulerequest.md) resource type and its related methods to manage role assignments. +> [!NOTE] +> We recommend using PIM to manage active role assignments over using the [unifiedRoleAssignment](../resources/unifiedroleassignment.md) or the [directoryRole](../resources/directoryrole.md) resource types to manage them directly. + The following table lists scenarios for using PIM to manage role assignments and the APIs to call. |Scenarios |API | The following table lists scenarios for using PIM to manage role assignments and ## PIM APIs for managing role eligibilities -Your principals may not require permanent role assignments because they may not require the privileges granted through the privileged role all the time. In this case, PIM also allows you to create role eligibilities and assign them to the principals. With role eligibilities, the principal activates the role when they need to perform privileged tasks. The activation is always time-bound for a maximum of 8 hours. The role eligibility can also be a permanent eligibility or a temporary eligibility. +Your principals may not require permanent role assignments because they don't require the privileges granted through the privileged role all the time. In this case, PIM also allows you to create role eligibilities and assign them to the principals. With role eligibilities, the principal activates the role when they need to perform privileged tasks. The activation is always time-bound for a maximum of 8 hours. The principal can also be permanently or temporarily eligible fot the role. Use the [unifiedRoleEligibilityScheduleRequest](unifiedroleeligibilityschedulerequest.md) resource type and its related methods to manage role eligibilities. The following table lists scenarios for using PIM to manage rules for Microsoft For more information about using Microsoft Graph to configure rules, see [Overview of rules for Microsoft Entra roles in PIM APIs in Microsoft Graph](/graph/identity-governance-pim-rules-overview). For examples of updating rules, see [Use PIM APIs in Microsoft Graph to update Microsoft Entra ID rules](/graph/how-to-pim-update-rules). -<a name='security-alerts-for-azure-ad-roles'></a> - ## Security alerts for Microsoft Entra roles PIM for Microsoft Entra roles generates alerts when it detects suspicious or unsafe settings for Microsoft Entra roles in your tenant. The following seven alert types are available: Use the following Microsoft Graph resources to manage PIM alerts. | [unifiedRoleManagementAlertConfiguration](unifiedrolemanagementalertconfiguration.md) | The tenant-specific configuration for the alert including whether the PIM service should scan the tenant for incidences relating to the alert, the thresholds that trigger the alert, and the related alert definition. This is an abstract type from which resources that represent the individual alert types are derived. | [List](../api/rolemanagementalert-list-alertconfigurations.md) <br/><br/> [Get](../api/unifiedrolemanagementalertconfiguration-get.md) <br/><br/> [Update](../api/unifiedrolemanagementalertconfiguration-update.md)| | [unifiedRoleManagementAlertIncident](unifiedrolemanagementalertincident.md) | The incidences in the tenant that match the alert type. | [List](../api/unifiedrolemanagementalert-list-alertincidents.md) <br/><br/> [Get](../api/unifiedrolemanagementalertincident-get.md) <br/><br/> [Remediate](../api/unifiedrolemanagementalertincident-remediate.md) | --For more information about working with security alerts for Microsoft Entra roles, see [Configure security alerts for Microsoft Entra roles in Privileged Identity Management](/azure/active-directory/privileged-identity-management/pim-how-to-configure-security-alerts). - For more information about working with security alerts for Microsoft Entra roles using PIM APIs, see [Manage security alerts for Microsoft Entra roles using PIM APIs in Microsoft Graph](/graph/how-to-pim-alerts). ## Audit logs All activities made through PIM for Microsoft Entra roles are logged in Microsof <!-- End of: Link to ZT guidance --> -<!-- -## Permissions and privileges --The following permissions are supported for PIM for Microsoft Entra roles API operations: --|Permissions |Supported operations | -||| -| RoleAssignmentSchedule.Read.Directory <br/> RoleAssignmentSchedule.ReadWrite.Directory <br/> RoleManagement.Read.Directory <br/> RoleManagement.ReadWrite.Directory | To manage role assignment operations. | -| RoleEligibilitySchedule.Read.Directory <br/> RoleEligibilitySchedule.ReadWrite.Directory <br/> RoleManagement.Read.Directory <br/> RoleManagement.ReadWrite.Directory | To manage role eligibility operations. | -| RoleManagementAlert.Read.Directory <br/> RoleManagementAlert.ReadWrite.Directory <br/> RoleManagement.Read.Directory <br/> RoleManagement.ReadWrite.Directory | To manage security alerts for Microsoft Entra roles. | --For delegated scenarios, the signed-in user must be assigned the *Privileged Role Administrator* or *Global Administrator* role in Microsoft Entra ID. > ## Licensing -The tenant where Privileged Identity Management is being used must have enough purchased or trial licenses. For more information, see [License requirements to use Privileged Identity Management](/azure/active-directory/privileged-identity-management/subscription-requirements). +The tenant where Privileged Identity Management is being used must have enough purchased or trial licenses. For more information, see [Microsoft Entra ID Governance licensing fundamentals](/entra/id-governance/licensing-fundamentals). ## Related content -- See the following articles to learn more about working with PIM APIs:- - [Working with rules for Microsoft Entra roles in PIM APIs](/graph/identity-governance-pim-rules-overview). - - [Use PIM APIs to update rules (settings) for Microsoft Entra roles](/graph/how-to-pim-update-rules). - - [Manage security alerts for Microsoft Entra roles using PIM APIs in Microsoft Graph](/graph/how-to-pim-alerts). - - [Tutorial: Use PIM APIs to assign Microsoft Entra roles](/graph/tutorial-assign-azureadroles). - To learn more about security operations, see [Microsoft Entra security operations for Privileged Identity Management](/azure/active-directory/architecture/security-operations-privileged-identity-management?source=docs#privileged-identity-management-alerts) in the Microsoft Entra architecture center. |
v1.0 | Profilesourceannotation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/profilesourceannotation.md | Represents the sources the user data comes from, such as Entra, UPA, Connector, The following table shows the mapping between the **id** value and the source system. -| ID | Source system | -|:--|:| -| 4ce763dd-9214-4eff-af7c-da491cc3782d, <br/> 0024a795-114d-4031-95c7-5fb543e00e80 | Microsoft Entra ID | -| 7986c642-b494-4140-8df4-f5ed125e2c67 | Organizational Data in Microsoft 365 | -| 6cdc4422-8c05-40c5-902e-8ade707725ab | SharePoint User Profile Application (UPA) | -| 9a3e0ce2-cf4b-477e-b3b3-df246318e251 | Microsoft account (MSA) | -| 46a57efc-33f8-4eec-a512-b90039ad6187 | User initiated edits | -| 107a83c9-714e-4d52-9d08-c303f081323b | Photo Etag | +| ID | Source system | +|:|:| +| 4ce763dd-9214-4eff-af7c-da491cc3782d, <br/> 0024a795-114d-4031-95c7-5fb543e00e80 | Microsoft Entra ID | +| 7986c642-b494-4140-8df4-f5ed125e2c67 | Organizational Data in Microsoft 365 | +| 6cdc4422-8c05-40c5-902e-8ade707725ab | SharePoint User Profile Application (UPA) | +| 9a3e0ce2-cf4b-477e-b3b3-df246318e251 | Microsoft account (MSA) | +| 46a57efc-33f8-4eec-a512-b90039ad6187 | User initiated edits | +| 107a83c9-714e-4d52-9d08-c303f081323b | Photo Etag | +| 75d4238e-b142-4d2d-aed9-232b830b8706 | Skills In Viva | >**Note:** > * The two Microsoft Entra IDs result from implementation differences and might be combined into one in the future. |
v1.0 | Program | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/program.md | Namespace: microsoft.graph [!INCLUDE [accessreviews-disclaimer](../../includes/accessreviews-disclaimer.md)] -In the Microsoft Entra [access reviews](accessreviews-root.md) feature, a program is a container, holding program controls. A tenant can have one or more programs. Each control links an access review to a program, to make it easier to locate related access reviews. +In the Microsoft Entra [access reviews](accessreviews-root.md) feature, a program is a container, holding program controls. A tenant can have one or more programs. Each control links an access review to a program, to make it easier to locate related access reviews. -Each tenant that has on-boarded Microsoft Entra access reviews has one program, `Default program`. A global administrator can create additional programs, for example to represent compliance initiatives. +A tenant that has onboarded Microsoft Entra access reviews has one program, the `Default program`. An authorized administrator can create more programs, for example, to represent compliance initiatives. ## Methods |
v1.0 | Programcontroltype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/programcontroltype.md | Namespace: microsoft.graph In the Microsoft Entra [access reviews](accessreviews-root.md) feature, the program control type is used when associating a control to a program, to indicate the type of access review the control is for. -The program control type objects are automatically generated when the global administrator onboards the tenant to use the access reviews feature. No additional program control types can be created. +The program control type objects are automatically generated when an authorized administrator onboards the tenant to use the access reviews feature. No additional program control types can be created. ## Methods |
v1.0 | Protectionrulebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/protectionrulebase.md | Title: "protectionRuleBase resource type" -description: "Describes Protection Rule and its properties " +description: "Represents a protection rule specified by the client as part of a protection plan applied to Microsoft 365 data in an organization. " ms.localizationpriority: medium Namespace: microsoft.graph Represents a protection rule specified by the client as part of a protection plan applied to Microsoft 365 data in an organization. Currently, only inclusion rules, which are rules that indicate that a protection policy should match the specified criteria, can be defined. -Protection rules can be static or dynamic, which means that the rules can run one time or at regular intervals. +Currently, protection rules are static in nature, meaning policy changes are applied only when the rule is executed, with no automatic/dynamic updates. This abstract type is the base type for [siteProtectionRule](../resources/siteprotectionrule.md), [mailboxProtectionRule](../resources/mailboxprotectionrule.md), and [driveProtectionRule](../resources/driveprotectionrule.md). +The following limitations apply to this resource: ++- The protection rule APIs for bulk addition of sites via site names or URL in the backup policy creation workflow can accommodate a maximum of 10 keywords at a time. Each keyword can have a minimum of three characters and a maximum of 255 characters. +- The protection rule APIs for bulk addition of user accounts via security groups or distribution lists can accommodate a maximum of three groups at a time. +- The rules are static and applied one time only. That is, the security groups or distribution lists are flattened at the time they're added to the backup configuration policy. For example, groups or lists aren't dynamically updated in the system if users are added or removed from the original security group. + ## Properties |Property|Type|Description| This abstract type is the base type for [siteProtectionRule](../resources/sitepr |createdBy|[identitySet](../resources/identityset.md)|The identity of person who created the rule.| |createdDateTime|DateTimeOffset|The time of creation of the rule.| |error|[publicError](../resources/publicerror.md)|Contains error details if an operation on a rule fails.|-|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of the person who last modified the rule.| |lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification made to the rule.|-|status|[protectionRuleStatus](../resources/protectionrulebase.md#protectionrulestatus-values )|The status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| +|status|[protectionRuleStatus](../resources/protectionrulebase.md#protectionrulestatus-values )|The status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. The `draft` member is currently unsupported. | ### protectionRuleStatus values |Member | Description | |:|:|-|draft | The initial status of the protection rule upon creation.| +|draft | The initial status of the protection rule upon creation. The `draft` member is currently unsupported. | |active | The status of the protection rule when it's running.| |completed | The status of the protection rule when it's successfully applied to the corresponding policy.| |completedWithErrors | The status of the protection rule when the rule ran but encountered errors.|-|unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## Relationships |
v1.0 | Protectionunitbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/protectionunitbase.md | Title: "protectionUnitBase resource type" -description: "Represents a site, drive, or mailbox that is protected by a protection policy." +description: "Represents a site, drive, or mailbox that's protected by a protection policy." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a site, drive, or mailbox that's protected by a [protection policy](protectionpolicybase.md). +Represents a site, drive, or mailbox that's protected by a [protection policy](protectionpolicybase.md). All the protection units in a protection policy have the same retention period by default. This resource is an abstract type. |
v1.0 | Protectionunitsbulkjobbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/protectionunitsbulkjobbase.md | + + Title: "protectionUnitsBulkJobBase resource type" +description: "Represents a bulk job associated with one of the protection policies, as specified by the client as part of a protection plan applied to Microsoft 365 data in an organization." ++ms.localizationpriority: medium ++toc. Title: Protection units bulk addition job +++# protectionUnitsBulkJobBase resource type ++Namespace: microsoft.graph +++Represents a bulk job associated with one of the protection policies, as specified by the client as part of a protection plan applied to Microsoft 365 data in an organization. ++This abstract type is the base type for [siteProtectionUnitsBulkAdditionJob](../resources/siteProtectionUnitsBulkAdditionJob.md), [mailboxProtectionUnitsBulkAdditionJob](../resources/mailboxprotectionunitsbulkadditionjob.md), and [driveProtectionUnitsBulkAdditionJob](../resources/driveprotectionunitsbulkadditionjob.md). ++> [!NOTE] +> The protection units bulk addition job APIs for bulk addition of protection units in the backup policy can accommodate a maximum of 50,000 protection resources in a single job. ++## Properties ++|Property|Type|Description| +|:|:|:| +|createdBy|[identitySet](../resources/identityset.md)|The identity of person who created the job.| +|createdDateTime|DateTimeOffset|The time of creation of the job.| +|displayName|String|The name of the protection units bulk addition job.| +|id|String|The unique identifier of the bulk job associated with the policy.| +|error|[publicError](../resources/publicerror.md)|Error details containing resource resolution failures, if any.| +|lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of the person who last modified the job.| +|lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification made to the job.| +|status|[protectionUnitsBulkJobStatus](../resources/protectionunitsbulkjobbase.md#protectionunitsbulkjobstatus-values )|The status of the job. The possible values are: `unknown`, `active`, `completed`, `completedWithErrors`, and `unknownFutureValue`.| ++### protectionUnitsBulkJobStatus values ++|Member | Description | +|:|:| +|unknown | The job is in an indeterminate state, possibly due to a temporary system issue or error. | +|active | The job is running.| +|completed | The job when was successfully applied to the corresponding policy.| +|completedWithErrors | The job finished running but encountered errors.| +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.protectionUnitsBulkJobBase", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.protectionUnitsBulkJobBase", + "id": "String (identifier)", + "displayName": "String", + "status": "String", + "createdDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "error": { + "@odata.type": "microsoft.graph.publicError" + } +} +``` |
v1.0 | Provisionedplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/provisionedplan.md | Used by the **provisionedPlans** property of the [user](user.md) entity and the ## Properties | Property | Type |Description| |:|:--|:-|-|capabilityStatus|String|For example, "Enabled".| -|provisioningStatus|String|For example, "Success".| +|capabilityStatus|String|Condition of the capability assignment. The possible values are `Enabled`, `Warning`, `Suspended`, `Deleted`, `LockedOut`. See [a detailed description of each value](../resources/assignedplan.md#capabilitystatus-values).| +|provisioningStatus|String|The possible values are:<br/>`Success` - Service is fully provisioned.<br/>`Disabled` - Service is disabled.<br/>`Error` - The service plan isn't provisioned and is in an error state.<br/>`PendingInput` - The service isn't provisioned and is awaiting service confirmation.<br/>`PendingActivation` - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)<br/>`PendingProvisioning` - Microsoft has added a new service to the product SKU and it isn't activated in the tenant.| |service|String|The name of the service; for example, "AccessControlS2S"| ## JSON representation |
v1.0 | Recyclebin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recyclebin.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a container for a collection of [recycleBinItem](recyclebinitem.md) resources in a SharePoint [site](site.md). +Represents a container for a collection of [recycleBinItem](recyclebinitem.md) resources in a SharePoint [site](site.md) or a SharePoint Embedded [fileStorageContainer](filestoragecontainer.md). Inherits from [baseItem](baseitem.md). Inherits from [baseItem](baseitem.md). | Property | Type | Description | |:|:-|:-| |id| String | The unique identifier for the **recycleBin** object. Returned only on `$select`. Inherited from [baseItem](baseitem.md). |+|settings|[recycleBinSettings](./recyclebinsettings.md)|Settings of the recycleBin.| ## Relationships The following JSON representation shows the resource type. ```json {- "id": "String (identifier)" + "id": "String (identifier)", + "settings": { "@odata.type": "microsoft.graph.recycleBinSettings" } } ``` |
v1.0 | Recyclebinsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/recyclebinsettings.md | + + Title: "recycleBinSettings resource type" +description: "Settings for the recycle bin resource type." ++ms.localizationpriority: medium ++++# recycleBinSettings resource type ++Namespace: microsoft.graph +++Represents settings for the [recycleBin](recyclebin.md) resource type. ++## Properties +|Property|Type|Description| +|:|:|:| +|retentionPeriodOverrideDays|Int32|Recycle bin retention period override in days for deleted content. The default value is `93`; the value range is `93` to `180`. The setting applies to newly deleted content only. Setting this property to `null` reverts to its default value. Read-write.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.recycleBinSettings" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.recycleBinSettings", + "retentionPeriodOverrideDays": "int32" +} +``` |
v1.0 | Redundantassignmentalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/redundantassignmentalertconfiguration.md | Represents an alert configuration that is triggered if a user goes over a specif Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Redundantassignmentalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/redundantassignmentalertincident.md | The threshold that triggers this incident when it's reached is defined in the [r Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Reflectcheckinresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/reflectcheckinresponse.md | Inherits from [entity](../resources/entity.md). |creatorId|String|ID of the user who created the Reflect check-in.| |isClosed|Boolean|Indicates whether the Reflect check-in is closed (`true`) or open (`false`).| |responderId|String|ID of the user who responded to the Reflect check-in.|-|responseEmotion|responseEmotionType|Represents the pleasantness level of the response that indicates how pleasant the responder felt. The possible values are: `none`, `confident`, `excited`, `happy`, `motivated`, `peaceful`, `ambitious`, `cheerful`, `comfortable`, `creative`, `determined`, `energized`, `focused`, `fulfilled`, `grateful`, `included`, `inspired`, `optimistic`, `proud`, `successful`, `valuable`, `annoyed`, `bored`, `calm`, `confused`, `glad`, `content`, `pensive`, `reserved`, `restless`, `shocked`, `tired`, `angry`, `depressed`, `exhausted`, `lonely`, `nervous`, `anxious`, `apathetic`, `concerned`, `disappointed`, `frightened`, `frustrated`, `hopeless`, `hurt`, `jealous`, `miserable`, `overwhelmed`, `skeptical`, `stressed`, `stuck`, `worthless`, `awed`, `ashamed`, `curious`, `sensitive`, `sad`, `unknownFutureValue`.| -|responseFeedback|responseFeedbackType|Represents the exact emotion name that the responder felt during the Reflect check-in response. The possible values are: `none`, `notDetected`, `veryUnpleasant`, `unpleasant`, `neutral`, `pleasant`, `veryPleasant`, `unknownFutureValue`.| +|responseEmotion|responseEmotionType|Represents the exact emotion name that the responder felt during the Reflect check-in response. The possible values are: `none`, `confident`, `excited`, `happy`, `motivated`, `peaceful`, `ambitious`, `cheerful`, `comfortable`, `creative`, `determined`, `energized`, `focused`, `fulfilled`, `grateful`, `included`, `inspired`, `optimistic`, `proud`, `successful`, `valuable`, `annoyed`, `bored`, `calm`, `confused`, `glad`, `content`, `pensive`, `reserved`, `restless`, `shocked`, `tired`, `angry`, `depressed`, `exhausted`, `lonely`, `nervous`, `anxious`, `apathetic`, `concerned`, `disappointed`, `frightened`, `frustrated`, `hopeless`, `hurt`, `jealous`, `miserable`, `overwhelmed`, `skeptical`, `stressed`, `stuck`, `worthless`, `awed`, `ashamed`, `curious`, `sensitive`, `sad`, `unknownFutureValue`.| +|responseFeedback|responseFeedbackType|Represents the pleasantness level of the response that indicates how pleasant the responder felt. The possible values are: `none`, `notDetected`, `veryUnpleasant`, `unpleasant`, `neutral`, `pleasant`, `veryPleasant`, `unknownFutureValue`.| |submitDateTime|DateTimeOffset|Date and time when the response to the Reflect check-in was submitted. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| ## Relationships |
v1.0 | Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/report.md | Title: "Working with Microsoft 365 usage reports in Microsoft Graph" -description: "With Microsoft Graph, you can access Microsoft 365 usage reports resources to get the information about how people in your business are using Microsoft 365 services. For example, you can identify who is using a service a lot and reaching quotas, or who may not need a Microsoft 365 license at all." +description: "With Microsoft Graph, you can access Microsoft 365 usage reports resources to get the information about how people in your business are using Microsoft 365 services. For example, you can identify who is using a service a lot and reaching quotas, or who might not need a Microsoft 365 license at all." ms.localizationpriority: high doc_type: conceptualPageType [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -With Microsoft Graph, you can access Microsoft 365 usage reports resources to get the information about how people in your business are using Microsoft 365 services. For example, you can identify who is using a service a lot and reaching quotas, or who might not need a Microsoft 365 license at all. +With Microsoft Graph, you can access Microsoft 365 usage reports resources to get the information about how people in your business are using Microsoft 365 services. For example, you can identify who is using a service a lot and reaching quotas, or who might not need a Microsoft 365 license at all. For details about the settings that govern identification/de-identification of information in the Microsoft 365 usage reports data, see [Microsoft 365 Reports in the admin center](/microsoft-365/admin/activity-reports/activity-reports) . Microsoft Graph controls access to resources via permissions. You must specify t ## Settings -In Microsoft 365 reports, user information such as usernames, groups, and sites is concealed; actual values are not displayed. You can use the [adminReportSettings](/graph/api/resources/adminreportsettings?view=graph-rest-beta&preserve-view=true) API to control the display of user information in the reports. +In Microsoft 365 reports, user information such as usernames, groups, and sites are concealed; actual values aren't displayed. You can use the [adminReportSettings](../resources/adminreportsettings.md) API to control the display of user information in the reports. ## Cloud deployments The following table shows the availability for each API across all cloud deployments. -| APIs | Microsoft Graph global service | **Microsoft Cloud for US Government** | **Microsoft Cloud China operated by 21Vianet** | **Microsoft Cloud for USNat and USSec** | -| | | - | - | | -| [Admin Report Settings](/graph/api/resources/adminreportsettings?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [Microsoft 365 activations](/graph/api/resources/office-365-activations-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | -| [Microsoft 365 active users](/graph/api/resources/office-365-active-users-reports?view=graph-rest-beta&preserve-view=true)| Γ£ö | Γ£ö | Γ£ö | Γ₧û | -| [Microsoft 365 Apps usage](/graph/api/resources/microsoft-365-apps-usage-report?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | -| [Microsoft 365 browser usage](/graph/api/resources/microsoft-365-browser-usage-report?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | -| [Microsoft 365 groups activity](/graph/api/resources/office-365-groups-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | -| [Microsoft Forms Usage](/graph/api/resources/microsoft-forms-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | -| [Microsoft Teams device usage](/graph/api/resources/microsoft-teams-device-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [Microsoft Teams team usage](/graph/api/resources/microsoft-teams-team-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [Microsoft Teams user activity](/graph/api/resources/microsoft-teams-user-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [Outlook activity](/graph/api/resources/email-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [Outlook app usage](/graph/api/resources/email-app-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [Outlook mailbox usage](/graph/api/resources/mailbox-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [OneDrive activity](/graph/api/resources/onedrive-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [OneDrive usage](/graph/api/resources/onedrive-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [SharePoint activity](/graph/api/resources/sharepoint-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [SharePoint site usage](/graph/api/resources/sharepoint-site-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | -| [Skype for Business activity](/graph/api/resources/skype-for-business-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | -| [Skype for Business device usage](/graph/api/resources/skype-for-business-device-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | -| [Skype for Business organizer activity](/graph/api/resources/skype-for-business-organizer-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | -| [Skype for Business participant activity](/graph/api/resources/skype-for-business-participant-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | -| [Skype for Business peer-to-peer activity](/graph/api/resources/skype-for-business-peer-to-peer-activity?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | -| [Yammer activity](/graph/api/resources/yammer-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | -| [Yammer device usage](/graph/api/resources/yammer-device-usage-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | -| [Yammer groups activity](/graph/api/resources/yammer-groups-activity-reports?view=graph-rest-beta&preserve-view=true) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | +| APIs | Microsoft Graph global service | **Microsoft Cloud for US Government** | **Microsoft Cloud China operated by 21Vianet** | **Microsoft Cloud for USNat and USSec** | +| | | - | - | | +| [Admin report settings](../resources/adminreportsettings.md) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [Microsoft 365 Copilot usage](../resources/reportroot.md#microsoft-365-copilot-usage) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | +| [Microsoft 365 activations](../resources/reportroot.md#microsoft-365-activations) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | +| [Microsoft 365 active users](../resources/reportroot.md#microsoft-365-active-users) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | +| [Microsoft 365 Apps usage](../resources/reportroot.md#microsoft-365-apps-usage) | Γ£ö | Γ£ö | Γ£ö | Γ₧û | +| [Microsoft 365 browser usage](../resources/reportroot.md#microsoft-365-browser-usage) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | +| [Microsoft 365 Groups activity](../resources/reportroot.md#microsoft-365-groups-activity) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | +| [Microsoft Forms Usage](../resources/reportroot.md#forms-activity) | Γ£ö | Γ₧û | +| [Microsoft Teams device usage](../resources/reportroot.md#microsoft-teams-device-usage) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [Microsoft Teams team activity](../resources/reportroot.md#microsoft-teams-team-activity) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [Microsoft Teams user activity](../resources/reportroot.md#microsoft-teams-user-activity) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [Outlook activity](../resources/reportroot.md#outlook-activity) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [Outlook app usage](../resources/reportroot.md#outlook-app-usage) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [Outlook mailbox usage](../resources/reportroot.md#outlook-mailbox-usage) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [OneDrive activity](../resources/reportroot.md#onedrive-activity) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [OneDrive usage](../resources/reportroot.md#onedrive-usage) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [SharePoint activity](../resources/reportroot.md#sharepoint-activity) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [SharePoint site usage](../resources/reportroot.md#sharepoint-site-usage) | Γ£ö | Γ£ö | Γ£ö | Γ£ö | +| [Skype for Business activity](../resources/reportroot.md#skype-for-business-activity) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | +| [Skype for Business device usage](../resources/reportroot.md#skype-for-business-device-usage) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | +| [Skype for Business organizer activity](../resources/reportroot.md#skype-for-business-organizer-activity) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | +| [Skype for Business participant activity](../resources/reportroot.md#skype-for-business-participant-activity) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | +| [Skype for Business peer-to-peer activity](../resources/reportroot.md#skype-for-business-peer-to-peer-activity) | Γ£ö | Γ₧û | Γ£ö | Γ₧û | +| [Viva Engage activity](../resources/reportroot.md#viva-engage-activity) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | +| [Viva Engage device usage](../resources/reportroot.md#viva-engage-device-usage) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | +| [Viva Engage groups activity](../resources/reportroot.md#viva-engage-groups-activity) | Γ£ö | Γ₧û | Γ₧û | Γ₧û | ## Next steps |
v1.0 | Reportroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/reportroot.md | Represents a container for Microsoft Entra ID and Microsoft 365 reporting resour ## Methods +### Microsoft 365 Copilot usage ++For details about report views and names, see [Microsoft 365 reports - Microsoft 365 Copilot usage](/microsoft-365/admin/activity-reports/microsoft-365-copilot-usage). ++| Method | Return type | Description | +| :- | :- | :- | +| [Get user detail](../api/reportroot-getmicrosoft365copilotusageuserdetail.md) | Stream | Get the most recent activity data for enabled users of Microsoft 365 Copilot apps. | +| [Get user counts summary](../api/reportroot-getmicrosoft365copilotusercountsummary.md) | Stream | Get the aggregated number of active and enabled users of Microsoft 365 Copilot for a specified time period. | +| [Get user counts trend](../api/reportroot-getmicrosoft365copilotusercounttrend.md) | Stream | Get the trend in the daily number of active and enabled users of Microsoft 365 Copilot for a specified time period. | + ### Forms activity For details about report views and names, see [Microsoft 365 reports - Forms activity](/microsoft-365/admin/activity-reports/forms-activity-ww). -| Method | Return type | Description | -|:|:|:--| -| [Get user detail](../api/reportroot-getformsuseractivityuserdetail.md ) | Stream | Get the detailed forms usage per user. | -| [Get user counts](../api/reportroot-getformsuseractivityusercounts.md ) | Stream | Get the trend in the number of active users for each user type. | -| [Get activity counts](../api/reportroot-getformsuseractivitycounts.md) | Stream | Get the number of activities count by activity type over a selected period. | +| Method | Return type | Description | +| : | :- | :-- | +| [Get user detail](../api/reportroot-getformsuseractivityuserdetail.md) | Stream | Get the detailed forms usage per user. | +| [Get user counts](../api/reportroot-getformsuseractivityusercounts.md) | Stream | Get the trend in the number of active users for each user type. | +| [Get activity counts](../api/reportroot-getformsuseractivitycounts.md) | Stream | Get the number of activities count by activity type for a specified time period. | ### Microsoft Teams device usage For details about report views and names, see [Microsoft 365 reports - Microsoft Teams device usage](/microsoft-365/admin/activity-reports/microsoft-teams-device-usage-preview). -| Method | Return type | Description | -|:-|:|:--| -| [Get user detail](../api/reportroot-getteamsdeviceusageuserdetail.md) | Stream | Get details about Microsoft Teams device usage by user. | -| [Get user counts](../api/reportroot-getteamsdeviceusageusercounts.md) | Stream | Get the number of daily unique users by device type. | -| [Get total user counts](../api/reportroot-getteamsdeviceusagetotalusercounts.md) | Stream | Get the number of daily unique Microsoft Teams licensed or non-licensed users by device type.| -| [Get distribution user counts](../api/reportroot-getteamsdeviceusagedistributionusercounts.md) | Stream | Get the number of unique users by device type over the selected time period. | -| [Get distribution total user counts](../api/reportroot-getteamsdeviceusagedistributiontotalusercounts.md) | Stream | Get the number of unique Microsoft Teams licensed or non-licensed users by device type over the selected time period. | +| Method | Return type | Description | +| :-- | :- | :-- | +| [Get user detail](../api/reportroot-getteamsdeviceusageuserdetail.md) | Stream | Get details about Microsoft Teams device usage by user. | +| [Get user counts](../api/reportroot-getteamsdeviceusageusercounts.md) | Stream | Get the number of daily unique users by device type. | +| [Get total user counts](../api/reportroot-getteamsdeviceusagetotalusercounts.md) | Stream | Get the number of daily unique Microsoft Teams licensed or nonlicensed users by device type. | +| [Get distribution user counts](../api/reportroot-getteamsdeviceusagedistributionusercounts.md) | Stream | Get the number of unique users by device type for the selected time period. | +| [Get distribution total user counts](../api/reportroot-getteamsdeviceusagedistributiontotalusercounts.md) | Stream | Get the number of unique Microsoft Teams licensed or nonlicensed users by device type for the selected time period. | ### Microsoft Teams user activity For details about report views and names, see [Microsoft 365 reports - Microsoft Teams user activity](/microsoft-365/admin/activity-reports/microsoft-teams-user-activity-preview). -| Method | Return type | Description | -|:--|:|:--| -| [Get user detail](../api/reportroot-getteamsuseractivityuserdetail.md) | Stream | Get details about Microsoft Teams user activity by user. | -| [Get activity counts](../api/reportroot-getteamsuseractivitycounts.md) | Stream | Get the number of Microsoft Teams activities by activity type. The activities are performed by Microsoft Teams licensed users. | -| [Get activity total counts](../api/reportroot-getteamsuseractivitytotalcounts.md) | Stream | Get the number of Microsoft Teams activities by activity type. The activities are performed by Microsoft Teams licensed or unlicensed users. | -| [Get user counts](../api/reportroot-getteamsuseractivityusercounts.md) | Stream | Get the number of users by activity type. The activity types are number of teams chat messages, private chat messages, calls, or meetings. | -| [Get total user counts](../api/reportroot-getteamsuseractivitytotalusercounts.md) | Stream | Get the number of Microsoft Teams licensed or unlicensed users by activity type. The activity types are number of teams chat messages, private chat messages, calls, or meetings. | -| [Get distribution user counts](../api/reportroot-getteamsuseractivitydistributionusercounts.md) | Stream | Get the number of Microsoft Teams licensed users by activity type over the selected period. The activity types are number of teams chat messages, private chat messages, calls, and meetings. | -| [Get distribution total user counts](../api/reportroot-getteamsuseractivitydistributiontotalusercounts.md) | Stream | Get the number of Microsoft Teams licensed or unlicensed users by activity type over the selected period. The activity types are number of teams chat messages, private chat messages, calls, and meetings. | +| Method | Return type | Description | +| : | :- | :- | +| [Get user detail](../api/reportroot-getteamsuseractivityuserdetail.md) | Stream | Get details about Microsoft Teams user activity by user. | +| [Get activity counts](../api/reportroot-getteamsuseractivitycounts.md) | Stream | Get the number of Microsoft Teams activities by activity type. The activities are performed by Microsoft Teams licensed users. | +| [Get activity total counts](../api/reportroot-getteamsuseractivitytotalcounts.md) | Stream | Get the number of Microsoft Teams activities by activity type. The activities are performed by Microsoft Teams licensed or unlicensed users. | +| [Get user counts](../api/reportroot-getteamsuseractivityusercounts.md) | Stream | Get the number of users by activity type. The activity types are number of teams chat messages, private chat messages, calls, or meetings. | +| [Get total user counts](../api/reportroot-getteamsuseractivitytotalusercounts.md) | Stream | Get the number of Microsoft Teams licensed or unlicensed users by activity type. The activity types are number of teams chat messages, private chat messages, calls, or meetings. | +| [Get distribution user counts](../api/reportroot-getteamsuseractivitydistributionusercounts.md) | Stream | Get the number of Microsoft Teams licensed users by activity type for the selected period. The activity types are number of teams chat messages, private chat messages, calls, and meetings. | +| [Get distribution total user counts](../api/reportroot-getteamsuseractivitydistributiontotalusercounts.md) | Stream | Get the number of Microsoft Teams licensed or unlicensed users by activity type for the selected period. The activity types are number of teams chat messages, private chat messages, calls, and meetings. | | [Get total distribution activity counts](../api/reportroot-getteamsuseractivitytotaldistributioncounts.md) | Stream | Get the number of Microsoft Teams user activities over the selected period. The activity types are team chat messages, private chat messages, calls, meetings, meetings organized, meetings attended, audio duration, video duration, screen share duration, post messages, and reply messages. | ### Microsoft Teams team activity For details about report views and names, see [Microsoft 365 reports - Microsoft Teams usage activity](/microsoft-365/admin/activity-reports/microsoft-teams-usage-activity). -| Method | Return type | Description | -|:--|:|:--| -| [Get team detail](../api/reportroot-getteamsteamactivitydetail.md) | Stream | Get details about Teams activity by team. The numbers include activities for both licensed and non-licensed users. | +| Method | Return type | Description | +| : | :- | :-- | +| [Get team detail](../api/reportroot-getteamsteamactivitydetail.md) | Stream | Get details about Teams activity by team. The numbers include activities for both licensed and nonlicensed users. | | [Get team activity counts](../api/reportroot-getteamsteamactivitycounts.md) | Stream | Get the number of team activities across Microsoft Teams. The activity types are related to meetings and messages. |-| [Get team activity distribution counts](../api/reportroot-getteamsteamactivitydistributioncounts.md) | Stream | Get the number of team activities across Microsoft Teams over a selected period. | -| [Get team counts](../api/reportroot-getteamsteamcounts.md) | Stream | Get the number of teams by type across Microsoft Teams. | +| [Get team activity distribution counts](../api/reportroot-getteamsteamactivitydistributioncounts.md) | Stream | Get the number of team activities across Microsoft Teams over a specified time period. | +| [Get team counts](../api/reportroot-getteamsteamcounts.md) | Stream | Get the number of teams by type across Microsoft Teams. | ### Outlook activity For details about report views and names, see [Microsoft 365 reports - Email Activity](/microsoft-365/admin/activity-reports/email-activity-ww). -| Method | Return type | Description | -|:-|:|:--| -| [Get user detail](../api/reportroot-getemailactivityuserdetail.md) | Stream | Get details about email activity users have performed. | -| [Get activity counts](../api/reportroot-getemailactivitycounts.md) | Stream | Enables you to understand the trends of email activity (like how many were sent, read, and received) in your organization. | +| Method | Return type | Description | +| :-- | :- | :- | +| [Get user detail](../api/reportroot-getemailactivityuserdetail.md) | Stream | Get details about email activity users have performed. | +| [Get activity counts](../api/reportroot-getemailactivitycounts.md) | Stream | Enables you to understand the trends of email activity (like how many were sent, read, and received) in your organization. | | [Get user counts](../api/reportroot-getemailactivityusercounts.md) | Stream | Enables you to understand trends on the number of unique users who are performing email activities like send, read, and receive. | ### Outlook app usage [Microsoft 365 reports - Email apps usage](/microsoft-365/admin/activity-reports/email-apps-usage-ww). -| Method | Return type | Description | -|:|:|:--| -| [Get user detail](../api/reportroot-getemailappusageuserdetail.md) | Stream | Get details about which activities users performed on the various email apps. | -| [Get apps user counts](../api/reportroot-getemailappusageappsusercounts.md) | Stream | Get the count of unique users per email app. | +| Method | Return type | Description | +| :- | :- | :-- | +| [Get user detail](../api/reportroot-getemailappusageuserdetail.md) | Stream | Get details about which activities users performed on the various email apps. | +| [Get apps user counts](../api/reportroot-getemailappusageappsusercounts.md) | Stream | Get the count of unique users per email app. | | [Get user counts](../api/reportroot-getemailappusageusercounts.md) | Stream | Get the count of unique users that connected to Exchange Online using any email app. |-| [Get versions user counts](../api/reportroot-getemailappusageversionsusercounts.md) | Stream | Get the count of unique users by Outlook desktop version. | +| [Get versions user counts](../api/reportroot-getemailappusageversionsusercounts.md) | Stream | Get the count of unique users by Outlook desktop version. | ### Outlook mailbox usage For details about report views and names, see [Microsoft 365 reports - Mailbox usage](/microsoft-365/admin/activity-reports/mailbox-usage). -| Method | Return type | Description | -|:|:|:--| -| [Get mailbox detail](../api/reportroot-getmailboxusagedetail.md) | Stream | Get details about mailbox usage. | +| Method | Return type | Description | +| :- | :- | : | +| [Get mailbox detail](../api/reportroot-getmailboxusagedetail.md) | Stream | Get details about mailbox usage. | | [Get mailbox counts](../api/reportroot-getmailboxusagemailboxcounts.md) | Stream | Get the total number of user mailboxes in your organization and how many are active each day of the reporting period. A mailbox is considered active if the user sent or read any email. |-| [Get quota status mailbox counts](../api/reportroot-getmailboxusagequotastatusmailboxcounts.md) | Stream | Get the count of user mailboxes in each quota category. | -| [Get storage](../api/reportroot-getmailboxusagestorage.md) | Stream | Get the amount of storage used in your organization. | +| [Get quota status mailbox counts](../api/reportroot-getmailboxusagequotastatusmailboxcounts.md) | Stream | Get the count of user mailboxes in each quota category. | +| [Get storage](../api/reportroot-getmailboxusagestorage.md) | Stream | Get the amount of storage used in your organization. | ### Microsoft 365 activations For details about report views and names, see [Microsoft 365 reports - Microsoft Office activations](/microsoft-365/admin/activity-reports/microsoft-office-activations-ww). -| Method | Return type | Description | -|:|:|:--| -| [Get user detail](../api/reportroot-getoffice365activationsuserdetail.md) | Stream | Get details about users who have activated Microsoft 365. | -| [Get activation counts](../api/reportroot-getoffice365activationcounts.md) | Stream | Get the count of Microsoft 365 activations on desktops and devices. | +| Method | Return type | Description | +| :- | :- | :- | +| [Get user detail](../api/reportroot-getoffice365activationsuserdetail.md) | Stream | Get details about users who have activated Microsoft 365. | +| [Get activation counts](../api/reportroot-getoffice365activationcounts.md) | Stream | Get the count of Microsoft 365 activations on desktops and devices. | | [Get user counts](../api/reportroot-getoffice365activationsusercounts.md) | Stream | Get the count of users that are enabled and those that have activated the Office subscription on desktop or devices. | ### Microsoft 365 active users For details about report views and names, see [Microsoft 365 reports - Active Users](/microsoft-365/admin/activity-reports/active-users-ww). -| Method | Return type | Description | -|:--|:|:--| -| [Get user detail](../api/reportroot-getoffice365activeuserdetail.md) | Stream | Get details about Microsoft 365 active users. | +| Method | Return type | Description | +| : | :- | :- | +| [Get user detail](../api/reportroot-getoffice365activeuserdetail.md) | Stream | Get details about Microsoft 365 active users. | | [Get user counts](../api/reportroot-getoffice365activeusercounts.md) | Stream | Get the count of daily active users in the reporting period by product. |-| [Get services user counts](../api/reportroot-getoffice365servicesusercounts.md) | Stream | Get the count of users by activity type and service. | +| [Get services user counts](../api/reportroot-getoffice365servicesusercounts.md) | Stream | Get the count of users by activity type and service. | ### Microsoft 365 apps usage For details about report views and names, see [Microsoft 365 reports - Microsoft 365 Apps usage](/microsoft-365/admin/activity-reports/microsoft365-apps-usage). -| Method | Return type | Description | -|:|:|:--| +| Method | Return type | Description | +| :- | :- | : | | [Get user detail](../api/reportroot-getm365appuserdetail.md) | Stream | Get details about the usage of Microsoft 365 Apps by user. |-| [Get user counts](../api/reportroot-getm365appusercounts.md) | Stream | Get the number of daily unique users by app. | -| [Get platform user counts](../api/reportroot-getm365appplatformusercounts.md) | Stream | Get the number of daily unique users by platform. | +| [Get user counts](../api/reportroot-getm365appusercounts.md) | Stream | Get the number of daily unique users by app. | +| [Get platform user counts](../api/reportroot-getm365appplatformusercounts.md) | Stream | Get the number of daily unique users by platform. | ### Microsoft 365 browser usage For details about report views and names, see [Microsoft 365 reports - Microsoft browser usage](/microsoft-365/admin/activity-reports/browser-usage-report). -| Method | Return type | Description | -|:--|:|:--| -| [Get user detail](../api/reportroot-getbrowseruserdetail.md ) | Stream | Get the detailed browser usage per user. | -| [Get user counts](../api/reportroot-getbrowserusercounts.md ) | Stream | Get the trend in the number of active users for each browser. | -| [Get distribution user counts](../api/reportroot-getbrowserdistributionusercounts.md) | Stream | Get the number of users by browser over a selected period. | +| Method | Return type | Description | +| : | :- | : | +| [Get user detail](../api/reportroot-getbrowseruserdetail.md) | Stream | Get the detailed browser usage per user. | +| [Get user counts](../api/reportroot-getbrowserusercounts.md) | Stream | Get the trend in the number of active users for each browser. | +| [Get distribution user counts](../api/reportroot-getbrowserdistributionusercounts.md) | Stream | Get the number of users by browser over a specified time period. | ### Microsoft 365 groups activity For details about report views and names, see [Microsoft 365 reports - Microsoft 365 groups](/microsoft-365/admin/activity-reports/office-365-groups-ww). -| Method | Return type | Description | -|:-|:|:--| -| [Get group detail](../api/reportroot-getoffice365groupsactivitydetail.md) | Stream | Get details about Microsoft 365 groups activity by group. | -| [Get activity counts](../api/reportroot-getoffice365groupsactivitycounts.md) | Stream | Get the number of group activities across group workloads. | +| Method | Return type | Description | +| :-- | :- | :-- | +| [Get group detail](../api/reportroot-getoffice365groupsactivitydetail.md) | Stream | Get details about Microsoft 365 groups activity by group. | +| [Get activity counts](../api/reportroot-getoffice365groupsactivitycounts.md) | Stream | Get the number of group activities across group workloads. | | [Get group counts](../api/reportroot-getoffice365groupsactivitygroupcounts.md) | Stream | Get the daily total number of groups and how many of them were active based on email conversations, Viva Engage posts, and SharePoint file activities. |-| [Get storage](../api/reportroot-getoffice365groupsactivitystorage.md) | Stream | Get the total storage used across all group mailboxes and group sites. | -| [Get file counts](../api/reportroot-getoffice365groupsactivityfilecounts.md) | Stream | Get the total number of files and how many of them were active across all group sites associated with a Microsoft 365 group. | +| [Get storage](../api/reportroot-getoffice365groupsactivitystorage.md) | Stream | Get the total storage used across all group mailboxes and group sites. | +| [Get file counts](../api/reportroot-getoffice365groupsactivityfilecounts.md) | Stream | Get the total number of files and how many of them were active across all group sites associated with a Microsoft 365 group. | ### OneDrive activity For details about report views and names, see [Microsoft 365 reports - OneDrive for Business activity](/microsoft-365/admin/activity-reports/onedrive-for-business-activity-ww). -| Method | Return type | Description | -|:-|:|:--| -| [Get user detail](../api/reportroot-getonedriveactivityuserdetail.md) | Stream | Get details about OneDrive activity by user. | -| [Get user counts](../api/reportroot-getonedriveactivityusercounts.md) | Stream | Get the trend in the number of active OneDrive users. | +| Method | Return type | Description | +| :-- | :- | : | +| [Get user detail](../api/reportroot-getonedriveactivityuserdetail.md) | Stream | Get details about OneDrive activity by user. | +| [Get user counts](../api/reportroot-getonedriveactivityusercounts.md) | Stream | Get the trend in the number of active OneDrive users. | | [Get file counts](../api/reportroot-getonedriveactivityfilecounts.md) | Stream | Get the number of unique, licensed users that performed file interactions against any OneDrive account. | ### OneDrive usage For details about report views and names, see [Microsoft 365 reports - OneDrive for Business usage](/microsoft-365/admin/activity-reports/onedrive-for-business-usage-ww). -| Method | Return type | Description | -|:-|:|:--| -| [Get account detail](../api/reportroot-getonedriveusageaccountdetail.md) | Stream | Get details about OneDrive usage by account. | -| [Get account counts](../api/reportroot-getonedriveusageaccountcounts.md) | Stream | Get the trend in the number of active OneDrive for Business sites. Any site on which users viewed, modified, uploaded, downloaded, shared, or synced files is considered an active site. | +| Method | Return type | Description | +| :-- | :- | :-- | +| [Get account detail](../api/reportroot-getonedriveusageaccountdetail.md) | Stream | Get details about OneDrive usage by account. | +| [Get account counts](../api/reportroot-getonedriveusageaccountcounts.md) | Stream | Get the trend in the number of active OneDrive for Business sites. Any site on which users viewed, modified, uploaded, downloaded, shared, or synced files is considered an active site. | | [Get file counts](../api/reportroot-getonedriveusagefilecounts.md) | Stream | Get the total number of files across all sites and how many are active files. A file is considered active if it has been saved, synced, modified, or shared within the specified time period. |-| [Get storage](../api/reportroot-getonedriveusagestorage.md) | Stream | Get the trend on the amount of storage you are using in OneDrive for Business. | +| [Get storage](../api/reportroot-getonedriveusagestorage.md) | Stream | Get the trend on the amount of storage you are using in OneDrive for Business. | ### SharePoint activity For details about report views and names, see [Microsoft 365 reports - SharePoint activity](/microsoft-365/admin/activity-reports/sharepoint-activity-ww). -| Method | Return type | Description | -|:|:|:--| -| [Get user detail](../api/reportroot-getsharepointactivityuserdetail.md) | Stream | Get details about SharePoint activity by user. | -| [Get file counts](../api/reportroot-getsharepointactivityfilecounts.md) | Stream | Get the number of unique, licensed users who interacted with files stored on SharePoint sites. | +| Method | Return type | Description | +| :- | :- | :- | +| [Get user detail](../api/reportroot-getsharepointactivityuserdetail.md) | Stream | Get details about SharePoint activity by user. | +| [Get file counts](../api/reportroot-getsharepointactivityfilecounts.md) | Stream | Get the number of unique, licensed users who interacted with files stored on SharePoint sites. | | [Get user counts](../api/reportroot-getsharepointactivityusercounts.md) | Stream | Get the trend in the number of active users. A user is considered active if he or she has executed a file activity (save, sync, modify, or share) or visited a page within the specified time period. |-| [Get pages](../api/reportroot-getsharepointactivitypages.md) | Stream | Get the number of unique pages visited by users. | +| [Get pages](../api/reportroot-getsharepointactivitypages.md) | Stream | Get the number of unique pages visited by users. | ### SharePoint site usage For details about report views and names, see [Microsoft 365 reports - SharePoint site usage](/microsoft-365/admin/activity-reports/sharepoint-site-usage-ww). -| Method | Return type | Description | -|:-|:|:--| -| [Get site detail](../api/reportroot-getsharepointsiteusagedetail.md) | Stream | Get details about SharePoint site usage. | +| Method | Return type | Description | +| :-- | :- | :-- | +| [Get site detail](../api/reportroot-getsharepointsiteusagedetail.md) | Stream | Get details about SharePoint site usage. | | [Get file counts](../api/reportroot-getsharepointsiteusagefilecounts.md) | Stream | Get the total number of files across all sites and the number of active files. A file (user or system) is considered active if it has been saved, synced, modified, or shared within the specified time period. |-| [Get site counts](../api/reportroot-getsharepointsiteusagesitecounts.md) | Stream | Get the trend of total and active site count during the reporting period. | -| [Get storage](../api/reportroot-getsharepointsiteusagestorage.md) | Stream | Get the trend of storage allocated and consumed during the reporting period. | -| [Get pages](../api/reportroot-getsharepointsiteusagepages.md) | Stream | Get the number of pages viewed across all sites. | +| [Get site counts](../api/reportroot-getsharepointsiteusagesitecounts.md) | Stream | Get the trend of total and active site count during the reporting period. | +| [Get storage](../api/reportroot-getsharepointsiteusagestorage.md) | Stream | Get the trend of storage allocated and consumed during the reporting period. | +| [Get pages](../api/reportroot-getsharepointsiteusagepages.md) | Stream | Get the number of pages viewed across all sites. | ### Skype for Business activity For details about report views and names, see [Skype for Business activity](/skypeforbusiness/skype-for-business-online-reporting/activity-report). -| Method | Return type | Description | -|:|:|:--| -| [Get user detail](../api/reportroot-getskypeforbusinessactivityuserdetail.md) | Stream | Get details about Skype for Business activity by user. | -| [Get activity counts](../api/reportroot-getskypeforbusinessactivitycounts.md) | Stream | Get the trends on how many users organized and participated in conference sessions held in your organization through Skype for Business. The report also includes the number of peer-to-peer sessions. | +| Method | Return type | Description | +| :- | :- | : | +| [Get user detail](../api/reportroot-getskypeforbusinessactivityuserdetail.md) | Stream | Get details about Skype for Business activity by user. | +| [Get activity counts](../api/reportroot-getskypeforbusinessactivitycounts.md) | Stream | Get the trends on how many users organized and participated in conference sessions held in your organization through Skype for Business. The report also includes the number of peer-to-peer sessions. | | [Get user counts](../api/reportroot-getskypeforbusinessactivityusercounts.md) | Stream | Get the trends on how many unique users organized and participated in conference sessions held in your organization through Skype for Business. The report also includes the number of peer-to-peer sessions. | ### Skype for Business device usage For details about report views and names, see [Skype for Business clients used](/skypeforbusiness/skype-for-business-online-reporting/device-usage-report). -| Method | Return type | Description | -|:-|:|:| -| [Get user detail](../api/reportroot-getskypeforbusinessdeviceusageuserdetail.md) | Stream | Get details about Skype for Business device usage by user. | -| [Get distribution user counts](../api/reportroot-getskypeforbusinessdeviceusagedistributionusercounts.md) | Stream | Get the number of users using unique devices in your organization. The report shows you the number of users per device including Windows, Windows phone, Android phone, iPhone, and iPad. | +| Method | Return type | Description | +| :-- | :- | :-- | +| [Get user detail](../api/reportroot-getskypeforbusinessdeviceusageuserdetail.md) | Stream | Get details about Skype for Business device usage by user. | +| [Get distribution user counts](../api/reportroot-getskypeforbusinessdeviceusagedistributionusercounts.md) | Stream | Get the number of users using unique devices in your organization. The report shows you the number of users per device including Windows, Windows phone, Android phone, iPhone, and iPad. | | [Get user counts](../api/reportroot-getskypeforbusinessdeviceusageusercounts.md) | Stream | Get the usage trends on how many users in your organization have connected using the Skype for Business app. You also get a breakdown by the type of device (Windows, Windows phone, Android phone, iPhone, or iPad) on which the Skype for Business client app is installed and used across your organization. | ### Skype for Business organizer activity For details about report views and names, see [Skype for Business conference organizer activity](/skypeforbusiness/skype-for-business-online-reporting/conference-organizer-activity-report). -| Method | Return type | Description | -|:-|:|:--| -| [Get activity counts](../api/reportroot-getskypeforbusinessorganizeractivitycounts.md) | Stream | Get usage trends on the number and type of conference sessions held and organized by users in your organization. Types of conference sessions include IM, audio/video, application sharing, web, dial-in/out - third party, and dial-in/out Microsoft. | +| Method | Return type | Description | +| :-- | :- | : | +| [Get activity counts](../api/reportroot-getskypeforbusinessorganizeractivitycounts.md) | Stream | Get usage trends on the number and type of conference sessions held and organized by users in your organization. Types of conference sessions include IM, audio/video, application sharing, web, dial-in/out - third party, and dial-in/out Microsoft. | | [Get user counts](../api/reportroot-getskypeforbusinessorganizeractivityusercounts.md) | Stream | Get usage trends on the number of unique users and type of conference sessions held and organized by users in your organization. Types of conference sessions include IM, audio/video, application sharing, web, dial-in/out - third party, and dial-in/out Microsoft. |-| [Get minute counts](../api/reportroot-getskypeforbusinessorganizeractivityminutecounts.md) | Stream | Get usage trends on the length in minutes and type of conference sessions held and organized by users in your organization. Types of conference sessions include audio/video, and dial-in and dial-out - Microsoft. | +| [Get minute counts](../api/reportroot-getskypeforbusinessorganizeractivityminutecounts.md) | Stream | Get usage trends on the length in minutes and type of conference sessions held and organized by users in your organization. Types of conference sessions include audio/video, and dial-in and dial-out - Microsoft. | ### Skype for Business participant activity For details about report views and names, see [Skype for Business conference participant activity](/skypeforbusiness/skype-for-business-online-reporting/conference-participant-activity-report). -| Method | Return type | Description | -|:|:|:--| -| [Get activity counts](../api/reportroot-getskypeforbusinessparticipantactivitycounts.md) | Stream | Get usage trends on the number and type of conference sessions that users from your organization participated in. Types of conference sessions include IM, audio/video, application sharing, web, and dial-in/out - third party. | +| Method | Return type | Description | +| :- | :- | :-- | +| [Get activity counts](../api/reportroot-getskypeforbusinessparticipantactivitycounts.md) | Stream | Get usage trends on the number and type of conference sessions that users from your organization participated in. Types of conference sessions include IM, audio/video, application sharing, web, and dial-in/out - third party. | | [Get user counts](../api/reportroot-getskypeforbusinessparticipantactivityusercounts.md) | Stream | Get usage trends on the number of unique users and type of conference sessions that users from your organization participated in. Types of conference sessions include IM, audio/video, application sharing, web, and dial-in/out - third party. |-| [Get minute counts](../api/reportroot-getskypeforbusinessparticipantactivityminutecounts.md) | Stream | Get usage trends on the length in minutes and type of conference sessions that users from your organization participated in. Types of conference sessions include audio/video. | +| [Get minute counts](../api/reportroot-getskypeforbusinessparticipantactivityminutecounts.md) | Stream | Get usage trends on the length in minutes and type of conference sessions that users from your organization participated in. Types of conference sessions include audio/video. | ### Skype for Business peer-to-peer activity For details about report views and names, see [Skype for Business peer-to-peer activity](/skypeforbusiness/skype-for-business-online-reporting/peer-to-peer-activity-report). -| Method | Return type | Description | -|:--|:|:--| -| [Get activity counts](../api/reportroot-getskypeforbusinesspeertopeeractivitycounts.md) | Stream | Get usage trends on the number and type of sessions held in your organization. Types of sessions include IM, audio, video, application sharing, and file transfer. | +| Method | Return type | Description | +| : | :- | : | +| [Get activity counts](../api/reportroot-getskypeforbusinesspeertopeeractivitycounts.md) | Stream | Get usage trends on the number and type of sessions held in your organization. Types of sessions include IM, audio, video, application sharing, and file transfer. | | [Get user counts](../api/reportroot-getskypeforbusinesspeertopeeractivityusercounts.md) | Stream | Get usage trends on the number of unique users and type of peer-to-peer sessions held in your organization. Types of sessions include IM, audio, video, application sharing, and file transfers in peer-to-peer sessions. |-| [Get minute counts](../api/reportroot-getskypeforbusinesspeertopeeractivityminutecounts.md) | Stream | Get usage trends on the length in minutes and type of peer-to-peer sessions held in your organization. Types of sessions include audio and video. | +| [Get minute counts](../api/reportroot-getskypeforbusinesspeertopeeractivityminutecounts.md) | Stream | Get usage trends on the length in minutes and type of peer-to-peer sessions held in your organization. Types of sessions include audio and video. | ### Viva Engage activity For details about report views and names, see [Microsoft 365 reports - Viva Engage Activity](/microsoft-365/admin/activity-reports/viva-engage-activity-report-ww). -| Method | Return type | Description | -|:--|:|:--| -| [Get user detail](../api/reportroot-getyammeractivityuserdetail.md) | Stream | Get details about Viva Engage activity by user. | +| Method | Return type | Description | +| : | :- | : | +| [Get user detail](../api/reportroot-getyammeractivityuserdetail.md) | Stream | Get details about Viva Engage activity by user. | | [Get activity counts](../api/reportroot-getyammeractivitycounts.md) | Stream | Get the trends on the amount of Viva Engage activity in your organization by how many messages were posted, read, and liked. |-| [Get user counts](../api/reportroot-getyammeractivityusercounts.md) | Stream | Get the trends on the number of unique users who posted, read, and liked Viva Engage messages. | +| [Get user counts](../api/reportroot-getyammeractivityusercounts.md) | Stream | Get the trends on the number of unique users who posted, read, and liked Viva Engage messages. | ### Viva Engage device usage For details about report views and names, see [Microsoft 365 reports - Viva Engage device usage](/microsoft-365/admin/activity-reports/viva-engage-device-usage-report-ww). -| Method | Return type | Description | -|:|:|:--| +| Method | Return type | Description | +| :- | :- | :-- | | [Get user detail](../api/reportroot-getyammerdeviceusageuserdetail.md) | Stream | Get details about Viva Engage device usage by user. |-| [Get distribution user counts](../api/reportroot-getyammerdeviceusagedistributionusercounts.md) | Stream | Get the number of users by device type. | -| [Get user counts](../api/reportroot-getyammerdeviceusageusercounts.md) | Stream | Get the number of daily users by device type. | +| [Get distribution user counts](../api/reportroot-getyammerdeviceusagedistributionusercounts.md) | Stream | Get the number of users by device type. | +| [Get user counts](../api/reportroot-getyammerdeviceusageusercounts.md) | Stream | Get the number of daily users by device type. | ### Viva Engage groups activity For details about report views and names, see [Microsoft 365 reports - Viva Engage groups activity](/microsoft-365/admin/activity-reports/viva-engage-groups-activity-report-ww). -| Method | Return type | Description | -|:-|:|:--| -| [Get group detail](../api/reportroot-getyammergroupsactivitydetail.md) | Stream | Get details about Viva Engage groups activity by group. | +| Method | Return type | Description | +| :-- | :- | : | +| [Get group detail](../api/reportroot-getyammergroupsactivitydetail.md) | Stream | Get details about Viva Engage groups activity by group. | | [Get group counts](../api/reportroot-getyammergroupsactivitygroupcounts.md) | Stream | Get the total number of groups that existed and how many included group conversation activity. |-| [Get activity counts](../api/reportroot-getyammergroupsactivitycounts.md) | Stream | Get the number of Viva Engage messages posted, read, and liked in groups. | +| [Get activity counts](../api/reportroot-getyammergroupsactivitycounts.md) | Stream | Get the number of Viva Engage messages posted, read, and liked in groups. | ## Properties None. ## Relationships -| Relationship | Type | Description | -|:-|:-|:| -| appCredentialSignInActivities | [appCredentialSignInActivity](appcredentialsigninactivity.md) collection | Represents a collection of sign-in activities of application credentials. | -| applicationSignInDetailedSummary | [applicationSignInDetailedSummary](applicationsignindetailedsummary.md) collection | Represents a detailed summary of an application sign-in. | -| authenticationMethods | [authenticationMethodsRoot](authenticationmethodsroot.md) | Container for navigation properties for Microsoft Entra authentication methods resources. | -| credentialUserRegistrationDetails | [credentialUserRegistrationDetails](credentialuserregistrationdetails.md) collection | Details of the usage of self-service password reset and multifactor authentication (MFA) for all registered users. | -| dailyPrintUsageByPrinter | [printUsageByPrinter](printusagebyprinter.md) collection | Retrieve a list of daily print usage summaries, grouped by printer. | -| dailyPrintUsageByUser | [printUsageByUser](printusagebyuser.md) collection | Retrieve a list of daily print usage summaries, grouped by user. | -| monthlyPrintUsageByPrinter | [printUsageByPrinter](printusagebyprinter.md) collection | Retrieve a list of monthly print usage summaries, grouped by printer. | -| monthlyPrintUsageByUser | [printUsageByUser](printusagebyuser.md) collection | Retrieve a list of monthly print usage summaries, grouped by user. | -| partners | [partners](partners.md) | Represents billing details for a Microsoft direct partner. | -| readingAssignmentSubmission | [readingAssignmentSubmission](../resources/readingassignmentsubmission.md) collection| Represents the submission details of the reading assignment associated with this data. | -| reflectCheckInResponse | [reflectCheckInResponse](../resources/reflectcheckinresponse.md) collection | Represents the response to the Microsoft Reflect check-in associated with this data. | -| security | [securityReportsRoot](securityreportsroot.md) | Provides the ability to launch a simulated phishing attack that organizations can learn from. | -| servicePrincipalSignInActivities | [servicePrincipalSignInActivity](serviceprincipalsigninactivity.md) collection | Represents a collection of sign-in activities of service principals. | -| serviceActivity | [serviceActivity](serviceactivity.md) | Reports that relate to tenant-level authentication activities in Microsoft Entra. | -| sla | [serviceLevelAgreementRoot](servicelevelagreementroot.md) | Reports that relate to tenant-level Microsoft Entra SLA attainment. | -| userCredentialUsageDetails | [userCredentialUsageDetails](usercredentialusagedetails.md) collection | Represents the self-service password reset (SSPR) usage for a given tenant. | -| userInsights | [userInsightsRoot](userinsightsroot.md) | Represents a collection of user activities on applications in a tenant that is configured for Microsoft Entra External ID for customers. | +| Relationship | Type | Description | +| :-- | : | : | +| appCredentialSignInActivities | [appCredentialSignInActivity](appcredentialsigninactivity.md) collection | Represents a collection of sign-in activities of application credentials. | +| applicationSignInDetailedSummary | [applicationSignInDetailedSummary](applicationsignindetailedsummary.md) collection | Represents a detailed summary of an application sign-in. | +| authenticationMethods | [authenticationMethodsRoot](authenticationmethodsroot.md) | Container for navigation properties for Microsoft Entra authentication methods resources. | +| credentialUserRegistrationDetails | [credentialUserRegistrationDetails](credentialuserregistrationdetails.md) collection | Details of the usage of self-service password reset and multifactor authentication (MFA) for all registered users. | +| dailyPrintUsageByPrinter | [printUsageByPrinter](printusagebyprinter.md) collection | Retrieve a list of daily print usage summaries, grouped by printer. | +| dailyPrintUsageByUser | [printUsageByUser](printusagebyuser.md) collection | Retrieve a list of daily print usage summaries, grouped by user. | +| healthMonitoring | [microsoft.graph.healthMonitoring.healthMonitoringRoot](healthmonitoring-healthmonitoringroot.md) collection | Reports for Microsoft Entra Health Monitoring. | +| monthlyPrintUsageByPrinter | [printUsageByPrinter](printusagebyprinter.md) collection | Retrieve a list of monthly print usage summaries, grouped by printer. | +| monthlyPrintUsageByUser | [printUsageByUser](printusagebyuser.md) collection | Retrieve a list of monthly print usage summaries, grouped by user. | +| partners | [partners](partners.md) | Represents billing details for a Microsoft direct partner. | +| readingAssignmentSubmission | [readingAssignmentSubmission](../resources/readingassignmentsubmission.md) collection | Represents the submission details of the reading assignment associated with this data. | +| reflectCheckInResponse | [reflectCheckInResponse](../resources/reflectcheckinresponse.md) collection | Represents the response to the Microsoft Reflect check-in associated with this data. | +| security | [securityReportsRoot](securityreportsroot.md) | Provides the ability to launch a simulated phishing attack that organizations can learn from. | +| servicePrincipalSignInActivities | [servicePrincipalSignInActivity](serviceprincipalsigninactivity.md) collection | Represents a collection of sign-in activities of service principals. | +| serviceActivity | [serviceActivity](serviceactivity.md) | Reports that relate to tenant-level authentication activities in Microsoft Entra. | +| sla | [serviceLevelAgreementRoot](servicelevelagreementroot.md) | Reports that relate to tenant-level Microsoft Entra Health SLA attainment. | +| userCredentialUsageDetails | [userCredentialUsageDetails](usercredentialusagedetails.md) collection | Represents the self-service password reset (SSPR) usage for a given tenant. | +| userInsights | [userInsightsRoot](userinsightsroot.md) | Represents a collection of user activities on applications in a tenant that is configured for Microsoft Entra External ID for customers. | ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "keyProperty": "id", The following JSON representation shows the resource type. "openType": false } -->-``` json ++```json { "@odata.type": "#microsoft.graph.reportRoot" } |
v1.0 | Requestormanager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/requestormanager.md | Title: "requestorManager complex type" -description: "Identifies a relationship to another user in the tenant who will be allowed as approver." + Title: "requestorManager resource type" +description: "Identifies a relationship to another user in the tenant who can approve." ms.localizationpriority: medium doc_type: "resourcePageType" -# requestorManager complex type +# requestorManager resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] Used in the approval settings of an [access package assignment policy](accesspackageassignmentpolicy.md). -It is a subtype of [userSet](userset.md), in which the `@odata.type` value `#microsoft.graph.requestorManager` indicates that a requesting user's manager is to be the approver. When creating an access package assignment policy approval stage with requestorManager, also include another approver, such as a single user or group member, in case the requesting user does not have a manager. +It's a subtype of [userSet](userset.md), in which the `@odata.type` value `#microsoft.graph.requestorManager` indicates that a requesting user's manager is to be the approver. Include another approver When creating an access package assignment policy approval stage with requestorManager, in case the requesting user doesn't have a manager. Including another approver, such as a single user or group member, covers the case where the requesting user doesn't have a manager. ## Properties |
v1.0 | Resourcespecificpermissiongrant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/resourcespecificpermissiongrant.md | For more information about granting apps consent to access a specific instance o |[List permission grants of a chat](../api/chat-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List resource-specific permissions that have been granted in a specific [chat](chat.md). | |[List permission grants of a group](../api/group-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List resource-specific permissions that have been granted in a specific [group](group.md). | |[List permission grants of a team](../api/team-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List resource-specific permissions that have been granted in a specific [team](team.md). |+|[List permission grants of a user](../api/user-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List resource-specific permissions that have been granted to a specific [user](user.md). | ## Properties |
v1.0 | Restorepoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/restorepoint.md | Namespace: microsoft.graph Represents the date and time when an [artifact](../resources/restoreartifactbase.md) is protected by a [protectionPolicy](../resources/protectionpolicybase.md) and can be restored. +The following limitations apply to this API: ++- When sites or mailboxes are added to a backup policy, it might take up to 15 minutes per 1,000 sites or mailboxes for restore points to become available. +- Although OneDrive account and mailbox backups of deleted users are maintained and restorable after the userΓÇÖs Microsoft Entra ID is deleted, the user is displayed as an empty user in results. + ## Methods |Method|Return type|Description| |
v1.0 | Restoresessionbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/restoresessionbase.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a restore session for a [protection unit](protectionunitbase.md) that's protected by a [protection policy](protectionpolicybase.md). APIs are used by Global Admin or SharePoint Online Admin for SharePoint Online/OneDrive & Exchange Online Admin for Exchange Online to perform restore related tasks on artifacts that are protected as part of Protection Policy. +Represents a restore session for a [protection unit](protectionunitbase.md) that's protected by a [protection policy](protectionpolicybase.md). Restore session APIs are used by global admins, SharePoint Online admins, and Exchange Online admins to perform restore-related tasks on artifacts that are protected as part of protection policy. ++Restoring to both a new location and the same URL in a single restore session is not supported. ## Methods |
v1.0 | Rolesassignedoutsideprivilegedidentitymanagementalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/rolesassignedoutsideprivilegedidentitymanagementalertconfiguration.md | Represents an alert configuration that is triggered if Microsoft Entra roles hav Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Rolesassignedoutsideprivilegedidentitymanagementalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/rolesassignedoutsideprivilegedidentitymanagementalertincident.md | Represents an alert incident that is triggered if roles have been assigned outsi Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Saveastemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/saveastemplate.md | + + Title: "saveAsTemplate resource type" +description: "Represents the required fields to save page as a template in SharePoint." ++ms.localizationpriority: medium ++++# saveAsTemplate resource type ++Namespace: microsoft.graph +++Represents the required fields to save page as a template in SharePoint. ++## Properties ++| Property | Type | Description | +| :| :| :| +| title | String | The title of the site page template to create. Optional. | +| name | String | The name of the site page template to create. Required. | +++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "optionalProperties": [ ++ ], + "@odata.type": "microsoft.graph.saveastemplate", + "baseType": null +}--> ++```json +{ + "title": "String", + "name": "String" +} +``` ++<!-- { + "type": "#page.annotation", + "description": "Save as template request body", + "keywords": "", + "section": "documentation", + "tocPath": "" +}--> |
v1.0 | Scheduleinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/scheduleinformation.md | Represents the availability of a user, distribution list, or resource (room or e ## Properties | Property | Type |Description| |:|:--|:-|-|availabilityView |String |Represents a merged view of availability of all the items in `scheduleItems`. The view consists of time slots. Availability during each time slot is indicated with: `0`= free or working elswhere, `1`= tentative, `2`= busy, `3`= out of office.<br><br>**Note:** Working elsewhere is set to `0` instead of `4` for backward compatibility. For details, see the [Q&A](/answers/questions/309571/working-elsewhere-in-getschedules-availabilityview).| +|availabilityView |String |Represents a merged view of availability of all the items in `scheduleItems`. The view consists of time slots. Availability during each time slot is indicated with: `0`= free or working elswhere, `1`= tentative, `2`= busy, `3`= out of office.<br><br>**Note:** Working elsewhere is set to `0` instead of `4` for backward compatibility. For details, see the [Q&A](/answers/questions/309571/working-elsewhere-in-getschedules-availabilityview) and [Exchange 2007 and Exchange 2010 do not use the WorkingElsewhere value](/openspecs/exchange_server_protocols/ms-oxwscdata/e5ec9563-0491-486d-9bec-50585fa2a2c6#Appendix_A_117).| |error |[freeBusyError](freebusyerror.md) |Error information from attempting to get the availability of the user, distribution list, or resource. | |scheduleId |String |An SMTP address of the user, distribution list, or resource, identifying an instance of **scheduleInformation**. | |scheduleItems |[scheduleItem](scheduleitem.md) collection |Contains the items that describe the availability of the user or resource. | |
v1.0 | Scopedrolemembership | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/scopedrolemembership.md | Title: "scopedRoleMembership resource type" -description: "A scoped-role membership describes a user's membership of a directory role that is further scoped to an Administrative Unit. This provides a mechanism to allow a tenant-wide company administrator to delegate administrative privileges to a user to manage users and groups in a subset of the organization (the administrative unit defines the subset)." +description: "A scoped-role membership describes a user's membership of a directory role that is further scoped to an Administrative Unit." ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Search Api Answers Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/search-api-answers-overview.md | doc_type: conceptualPageType You can use Microsoft Graph to [manage administrative search answer results](/graph/search-concept-answers) in the [Microsoft Search](/microsoftsearch/overview-microsoft-search) experience. -Requests to manage administrative search answers are performed by global administrators, search administrators, search editors, or are performed on behalf of an application without the presence of a signed-in user, identified using an [access token with application permission](/graph/auth-v2-service). +Requests to manage administrative search answers are performed by users with administrator roles, such as Search Administrators and Search Editors, or are performed on behalf of an application without the presence of a signed-in user, identified using an [access token with application permission](/graph/auth-v2-service). ## Common use cases |
v1.0 | Searchquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/searchquery.md | Title: "searchQuery resource type" -description: "searchQuery" +description: "Represents a search query that contains search terms and optional filters." ms.localizationpriority: medium |
v1.0 | Security Alert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-alert.md | Security providers create an alert in the system when they detect a threat. Micr |detectionSource|[microsoft.graph.security.detectionSource](#detectionsource-values)| Detection technology or sensor that identified the notable component or activity. Possible values are: `unknown`, `microsoftDefenderForEndpoint`, `antivirus`, `smartScreen`, `customTi`, `microsoftDefenderForOffice365`, `automatedInvestigation`, `microsoftThreatExperts`, `customDetection`, `microsoftDefenderForIdentity`, `cloudAppSecurity`, `microsoft365Defender`, `azureAdIdentityProtection`, `manual`, `microsoftDataLossPrevention`, `appGovernancePolicy`, `appGovernanceDetection`, `unknownFutureValue`, `microsoftDefenderForCloud`, `microsoftDefenderForIoT`, `microsoftDefenderForServers`, `microsoftDefenderForStorage`, `microsoftDefenderForDNS`, `microsoftDefenderForDatabases`, `microsoftDefenderForContainers`, `microsoftDefenderForNetwork`, `microsoftDefenderForAppService`, `microsoftDefenderForKeyVault`, `microsoftDefenderForResourceManager`, `microsoftDefenderForApiManagement`, `microsoftSentinel`, `nrtAlerts`, `scheduledAlerts`, `microsoftDefenderThreatIntelligenceAnalytics`, `builtInMl`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `microsoftDefenderForCloud`, `microsoftDefenderForIoT`, `microsoftDefenderForServers`, `microsoftDefenderForStorage`, `microsoftDefenderForDNS`, `microsoftDefenderForDatabases`, `microsoftDefenderForContainers`, `microsoftDefenderForNetwork`, `microsoftDefenderForAppService`, `microsoftDefenderForKeyVault`, `microsoftDefenderForResourceManager`, `microsoftDefenderForApiManagement`, `microsoftSentinel`, `nrtAlerts`, `scheduledAlerts`, `microsoftDefenderThreatIntelligenceAnalytics`, `builtInMl`.| |detectorId|String| The ID of the detector that triggered the alert.| |productName|String| The name of the product which published this alert.|-|determination|[microsoft.graph.security.alertDetermination](#alertdetermination-values)| Specifies the result of the investigation, whether the alert represents a true attack, and if so, the nature of the attack. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedUser`, `phishing`, `maliciousUserActivity`, `clean`, `insufficientData`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| +|determination|[microsoft.graph.security.alertDetermination](#alertdetermination-values)| Specifies the result of the investigation, whether the alert represents a true attack, and if so, the nature of the attack. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedAccount`, `phishing`, `maliciousUserActivity`, `notMalicious`, `notEnoughDataToValidate`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| |evidence|[microsoft.graph.security.alertEvidence](security-alertEvidence.md) collection| Collection of evidence related to the alert.| |firstActivityDateTime|DateTimeOffset| The earliest activity associated with the alert.| |id|String| Unique identifier to represent the **alert** resource.| Security providers create an alert in the system when they detect a threat. Micr | securityPersonnel | A true positive alert that detected valid suspicious activity performed by someone on the customer's security team. | | securityTesting | The alert detected valid suspicious activity that was performed as part of a known security testing. | | unwantedSoftware | The alert detected unwanted software. |+| other | Other determination. | | multiStagedAttack | A true positive alert that detected multiple kill-chain attack stages. | | compromisedAccount | A true positive alert that detected that the intended user's credentials were compromised or stolen. | | phishing | A true positive alert that detected a phishing email. | Security providers create an alert in the system when they detect a threat. Micr | notEnoughDataToValidate | A false alert, without enough information to prove otherwise. | | confirmedActivity | The alert caught a true suspicious activity that is considered OK because it's a known user activity. | | lineOfBusinessApplication | The alert caught a true suspicious activity that is considered OK because it's a known and confirmed internal application. |-| other | Other determination. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ### alertSeverity values |
v1.0 | Security Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-api-overview.md | You can create advanced hunting [Custom detection rules](/microsoft-365/security Alerts are detailed warnings about suspicious activities in a customer's tenant that Microsoft or partner security providers have identified and flagged for action. Attacks typically employ various techniques against different types of entities, such as devices, users, and mailboxes. The result is alerts from multiple security providers for multiple entities in the tenant. Piecing the individual alerts together to gain insight into an attack can be challenging and time-consuming. The beta version of the security API offers two types of alerts that aggregate other alerts from security providers and make analyzing attacks and determining responses easier:-- [Alerts and incidents](#alerts-and-incidents) - the latest generation of alerts in the Microsoft Graph security API. They are represented by the [alert](security-alert.md) resource and its collection, [incident](security-incident.md) resource, defined in the `microsoft.graph.security` namespace.-- [Legacy alerts](#legacy-alerts) - the first generation of alerts in the Microsoft Graph security API. They are represented by the [alert](alert.md) resource defined in the `microsoft.graph` namespace.+- [Alerts and incidents](#alerts-and-incidents) - the latest generation of alerts in the Microsoft Graph security API. They're represented by the [alert](security-alert.md) resource and its collection, [incident](security-incident.md) resource, defined in the `microsoft.graph.security` namespace. +- [Legacy alerts](#legacy-alerts) - the first generation of alerts in the Microsoft Graph security API. They're represented by the [alert](alert.md) resource defined in the `microsoft.graph` namespace. ### Alerts and incidents Alerts from the following security providers are available via the legacy **aler \* File issue: Alert status gets updated across Microsoft Graph security API integrated applications but not reflected in the provider’s management experience. -\*\* Microsoft Defender for Endpoint requires additional [user roles](/windows/security/threat-protection/microsoft-defender-atp/user-roles) to those required by the Microsoft Graph security API. Only the users in both Microsoft Defender for Endpoint and Microsoft Graph security API roles can have access to the Microsoft Defender for Endpoint data. Because application-only authentication is not limited by this, we recommend that you use an application-only authentication token. +\*\* Microsoft Defender for Endpoint requires additional [user roles](/windows/security/threat-protection/microsoft-defender-atp/user-roles) to those required by the Microsoft Graph security API. Only the users in both Microsoft Defender for Endpoint and Microsoft Graph security API roles can have access to the Microsoft Defender for Endpoint data. Because application-only authentication isn't limited by this, we recommend that you use an application-only authentication token. \*\*\* Microsoft Defender for Identity alerts are available via the Microsoft Defender for Cloud Apps integration. This means you get Microsoft Defender for Identity alerts only if you have joined Unified SecOps and connected Microsoft Defender for Identity into Microsoft Defender for Cloud Apps. Learn more about [how to integrate Microsoft Defender for Identity and Microsoft Defender for Cloud Apps](/azure-advanced-threat-protection/atp-mcas-integration). Alerts from the following security providers are available via the legacy **aler [Attack simulation and training](/microsoft-365/security/office-365-security/attack-simulation-training) is part of [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/defender-for-office-365?view=o365-worldwide&preserve-view=true). This service lets users in a tenant experience a realistic benign phishing attack and learn from it. Social engineering simulation and training experiences for end users help reduce the risk of users being breached via those attack techniques. The attack simulation and training API enables tenant administrators to view launched [simulation](simulation.md) exercises and trainings, and get [reports](report-m365defender-reports-overview.md) on derived insights into online behaviors of users in the phishing simulations. -## eDiscovery (preview) +## eDiscovery [Microsoft Purview eDiscovery (Premium)](/microsoft-365/compliance/overview-ediscovery-20) provides an end-to-end workflow to preserve, collect, analyze, review, and export content that's responsive to your organization's internal and external investigations. -## Audit logs query (preview) +## Audit log query (preview) [Microsoft Purview Audit](/microsoft-365/compliance/audit-solutions-overview) provides an integrated solution to help organizations effectively respond to security events, forensic investigations, internal investigations, and compliance obligations. Thousands of user and admin operations performed in dozens of Microsoft 365 services and solutions are captured, recorded, and retained in your organization's unified audit log. Audit records for these events are searchable by security ops, IT admins, insider risk teams, and compliance and legal investigators in your organization. This capability provides visibility into the activities performed across your Microsoft 365 organization. +## Identities ++### Health issues ++The Microsoft Defender for Identity health issues API allows you to monitor the health status of your sensors and agents across your hybrid identity infrastructure. You can use the health issues API to retrieve information about the current health issues of your sensors, such as the issue type, status, configuration, and severity. You can also use the API to identify and resolve any issues that might affect the functionality or security of your sensors and agents. ++> **Note:** The Microsoft Defender for Identity health issues API is only available on the Defender for Identity plan or Microsoft 365 E5/A5/G5/F5 Security service plans. ++### Sensors ++The Defender for Identity sensors management API allows you to create detailed reports of the sensors in your workspace, including information about the server name, sensor version, type, state, and health status. It also enables you to manage sensor settings, such as adding descriptions, enabling or disabling delayed updates, and specifying the domain controller that the sensor connects to for querying Entra ID. + ## Incidents An [incident](security-incident.md) is a collection of correlated  [alerts](security-alert.md) and associated data that make up the story of an attack. Incident management is part of Microsoft 365 Defender and is available in the Microsoft 365 Defender portal (https://security.microsoft.com/). The  [incident](security-incident.md) resource and its APIs allow you to sort ## Records management -Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let their employees effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. +Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let their employees effectively and agilely share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. ## Secure Score The Microsoft Graph threat submission API helps organizations to submit a threat > **Note:** We recommend that you use the threat submission API instead of the deprecated Information Protection threat assessment API. The threat submission API provides unified security threat submission functionality and adds unified result support, user submission query support, tenant allow block list support, admin review support and app-only mode support. -## Email and collaboration protection (preview) +## Email and collaboration protection [Microsoft Defender for Office 365](/microsoft-365/security/office-365-security/defender-for-office-365?view=o365-worldwide&preserve-view=true) is a cloud-based email filtering service that helps protect your organization against advanced threats to email and collaboration tools, like phishing, business email compromise, and malware attacks. You can use the Microsoft Graph **analyzedemails** and **remediate** APIs to retrieve email metadata and perform response actions (soft delete, hard delete, move to junk, move to Inbox) on analyzed messages. > **Note:** These APIs are only available for Defender for Office 365 Plan 2 or Microsoft 365 A5/E5/F5/G5 Security service plans. For the most up-to-date list of service plans, see [Microsoft Defender for Office 365 service description](/office365/servicedescriptions/office-365-advanced-threat-protection-service-description). -## Identities -### Health Issues -The Defender for Identity health issues API allows you to monitor the health status of your sensors and agents across your hybrid identity infrastructure. You can use the health issues API to retrieve information about the current health issues of your sensors, such as the issue type, status, configuration, and severity. You can also use the API to identify and resolve any issues that may affect the functionality or security of your sensors and agents. +### Sensors +The Defender for Identity sensors management API allows you to create detailed reports of the sensors in your workspace, including information about the server's name, sensor version, type, state, and health status. It also enables you to manage sensor settings, such as adding descriptions, enabling or disabling delayed updates, and specifying the domain controller that the sensor connects to to query Entra ID. ## Common use cases The following are some of the most popular requests for working with the Microso |Get details of a single message instance|[GET analyzedemails/Id](../api/security-analyzedemail-get.md)|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails/{Id}](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails/Id&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)| |Remediate analyzed email|[analyzedEmail: remediate](../api/security-analyzedemail-remediate.md )|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails/remediate](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails/remediate&method=POST&version=beta&GraphUrl=https://graph.microsoft.com)| | **Identities**|||-| List health issues | [List health issues](../api/security-identityContainer-list-healthIssues.md) | [https://graph.microsoft.com/beta/security/identities/healthIssues](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/healthIssues&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | +| List health issues | [List health issues](../api/security-identitycontainer-list-healthissues.md) | [https://graph.microsoft.com/beta/security/identities/healthIssues](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/healthIssues&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | +| List sensors | [List sensors](../api/security-identitycontainer-list-sensors.md) | [https://graph.microsoft.com/beta/security/identities/sensors](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/sensors&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) | You can use Microsoft Graph [webhooks](/graph/webhooks) to subscribe to and receive notifications about updates to Microsoft Graph security API entities. |
v1.0 | Security Auditlogquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-auditlogquery.md | Inherits from [microsoft.graph.entity](../resources/entity.md). |objectIdFilters|String collection|For SharePoint and OneDrive for Business activity, the full path name of the file or folder accessed by the user. For Exchange admin audit logging, the name of the object that was modified by the cmdlet.| |operationFilters|String collection|The name of the user or admin activity. For a description of the most common operations/activities, see [Search the audit log in the Office 365 Protection Center](https://go.microsoft.com/fwlink/p/?LinkId=708432).| |recordTypeFilters|microsoft.graph.security.auditLogRecordType collection|The type of operation indicated by the record. The possible values are: `exchangeAdmin`, `exchangeItem`, `exchangeItemGroup`, `sharePoint`, `syntheticProbe`, `sharePointFileOperation`, `oneDrive`, `azureActiveDirectory`, `azureActiveDirectoryAccountLogon`, `dataCenterSecurityCmdlet`, `complianceDLPSharePoint`, `sway`, `complianceDLPExchange`, `sharePointSharingOperation`, `azureActiveDirectoryStsLogon`, `skypeForBusinessPSTNUsage`, `skypeForBusinessUsersBlocked`, `securityComplianceCenterEOPCmdlet`, `exchangeAggregatedOperation`, `powerBIAudit`, `crm`, `yammer`, `skypeForBusinessCmdlets`, `discovery`, `microsoftTeams`, `threatIntelligence`, `mailSubmission`, `microsoftFlow`, `aeD`, `microsoftStream`, `complianceDLPSharePointClassification`, `threatFinder`, `project`, `sharePointListOperation`, `sharePointCommentOperation`, `dataGovernance`, `kaizala`, `securityComplianceAlerts`, `threatIntelligenceUrl`, `securityComplianceInsights`, `mipLabel`, `workplaceAnalytics`, `powerAppsApp`, `powerAppsPlan`, `threatIntelligenceAtpContent`, `labelContentExplorer`, `teamsHealthcare`, `exchangeItemAggregated`, `hygieneEvent`, `dataInsightsRestApiAudit`, `informationBarrierPolicyApplication`, `sharePointListItemOperation`, `sharePointContentTypeOperation`, `sharePointFieldOperation`, `microsoftTeamsAdmin`, `hrSignal`, `microsoftTeamsDevice`, `microsoftTeamsAnalytics`, `informationWorkerProtection`, `campaign`, `dlpEndpoint`, `airInvestigation`, `quarantine`, `microsoftForms`, `applicationAudit`, `complianceSupervisionExchange`, `customerKeyServiceEncryption`, `officeNative`, `mipAutoLabelSharePointItem`, `mipAutoLabelSharePointPolicyLocation`, `microsoftTeamsShifts`, `secureScore`, `mipAutoLabelExchangeItem`, `cortanaBriefing`, `search`, `wdatpAlerts`, `powerPlatformAdminDlp`, `powerPlatformAdminEnvironment`, `mdatpAudit`, `sensitivityLabelPolicyMatch`, `sensitivityLabelAction`, `sensitivityLabeledFileAction`, `attackSim`, `airManualInvestigation`, `securityComplianceRBAC`, `userTraining`, `airAdminActionInvestigation`, `mstic`, `physicalBadgingSignal`, `teamsEasyApprovals`, `aipDiscover`, `aipSensitivityLabelAction`, `aipProtectionAction`, `aipFileDeleted`, `aipHeartBeat`, `mcasAlerts`, `onPremisesFileShareScannerDlp`, `onPremisesSharePointScannerDlp`, `exchangeSearch`, `sharePointSearch`, `privacyDataMinimization`, `labelAnalyticsAggregate`, `myAnalyticsSettings`, `securityComplianceUserChange`, `complianceDLPExchangeClassification`, `complianceDLPEndpoint`, `mipExactDataMatch`, `msdeResponseActions`, `msdeGeneralSettings`, `msdeIndicatorsSettings`, `ms365DCustomDetection`, `msdeRolesSettings`, `mapgAlerts`, `mapgPolicy`, `mapgRemediation`, `privacyRemediationAction`, `privacyDigestEmail`, `mipAutoLabelSimulationProgress`, `mipAutoLabelSimulationCompletion`, `mipAutoLabelProgressFeedback`, `dlpSensitiveInformationType`, `mipAutoLabelSimulationStatistics`, `largeContentMetadata`, `microsoft365Group`, `cdpMlInferencingResult`, `filteringMailMetadata`, `cdpClassificationMailItem`, `cdpClassificationDocument`, `officeScriptsRunAction`, `filteringPostMailDeliveryAction`, `cdpUnifiedFeedback`, `tenantAllowBlockList`, `consumptionResource`, `healthcareSignal`, `dlpImportResult`, `cdpCompliancePolicyExecution`, `multiStageDisposition`, `privacyDataMatch`, `filteringDocMetadata`, `filteringEmailFeatures`, `powerBIDlp`, `filteringUrlInfo`, `filteringAttachmentInfo`, `coreReportingSettings`, `complianceConnector`, `powerPlatformLockboxResourceAccessRequest`, `powerPlatformLockboxResourceCommand`, `cdpPredictiveCodingLabel`, `cdpCompliancePolicyUserFeedback`, `webpageActivityEndpoint`, `omePortal`, `cmImprovementActionChange`, `filteringUrlClick`, `mipLabelAnalyticsAuditRecord`, `filteringEntityEvent`, `filteringRuleHits`, `filteringMailSubmission`, `labelExplorer`, `microsoftManagedServicePlatform`, `powerPlatformServiceActivity`, `scorePlatformGenericAuditRecord`, `filteringTimeTravelDocMetadata`, `alert`, `alertStatus`, `alertIncident`, `incidentStatus`, `case`, `caseInvestigation`, `recordsManagement`, `privacyRemediation`, `dataShareOperation`, `cdpDlpSensitive`, `ehrConnector`, `filteringMailGradingResult`, `publicFolder`, `privacyTenantAuditHistoryRecord`, `aipScannerDiscoverEvent`, `eduDataLakeDownloadOperation`, `m365ComplianceConnector`, `microsoftGraphDataConnectOperation`, `microsoftPurview`, `filteringEmailContentFeatures`, `powerPagesSite`, `powerAppsResource`, `plannerPlan`, `plannerCopyPlan`, `plannerTask`, `plannerRoster`, `plannerPlanList`, `plannerTaskList`, `plannerTenantSettings`, `projectForTheWebProject`, `projectForTheWebTask`, `projectForTheWebRoadmap`, `projectForTheWebRoadmapItem`, `projectForTheWebProjectSettings`, `projectForTheWebRoadmapSettings`, `quarantineMetadata`, `microsoftTodoAudit`, `timeTravelFilteringDocMetadata`, `teamsQuarantineMetadata`, `sharePointAppPermissionOperation`, `microsoftTeamsSensitivityLabelAction`, `filteringTeamsMetadata`, `filteringTeamsUrlInfo`, `filteringTeamsPostDeliveryAction`, `mdcAssessments`, `mdcRegulatoryComplianceStandards`, `mdcRegulatoryComplianceControls`, `mdcRegulatoryComplianceAssessments`, `mdcSecurityConnectors`, `mdaDataSecuritySignal`, `vivaGoals`, `filteringRuntimeInfo`, `attackSimAdmin`, `microsoftGraphDataConnectConsent`, `filteringAtpDetonationInfo`, `privacyPortal`, `managedTenants`, `unifiedSimulationMatchedItem`, `unifiedSimulationSummary`, `updateQuarantineMetadata`, `ms365DSuppressionRule`, `purviewDataMapOperation`, `filteringUrlPostClickAction`, `irmUserDefinedDetectionSignal`, `teamsUpdates`, `plannerRosterSensitivityLabel`, `ms365DIncident`, `filteringDelistingMetadata`, `complianceDLPSharePointClassificationExtended`, `microsoftDefenderForIdentityAudit`, `supervisoryReviewDayXInsight`, `defenderExpertsforXDRAdmin`, `cdpEdgeBlockedMessage`, `hostedRpa`, `cdpContentExplorerAggregateRecord`, `cdpHygieneAttachmentInfo`, `cdpHygieneSummary`, `cdpPostMailDeliveryAction`, `cdpEmailFeatures`, `cdpHygieneUrlInfo`, `cdpUrlClick`, `cdpPackageManagerHygieneEvent`, `filteringDocScan`, `timeTravelFilteringDocScan`, `mapgOnboard`, `unknownFutureValue`.|-|serviceFilter|String|The Office 365 service where the activity occurred.| +|serviceFilter|String|Refers to the workload property in the audit record. This is the Microsoft service where the activity occurred. Optional.| |status|microsoft.graph.security.auditLogQueryStatus|Describes the current status of the query. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `cancelled`, `unknownFutureValue`.| |userPrincipalNameFilters|String collection|The UPN (user principal name) of the user who performed the action (specified in the operation property) that resulted in the record being logged; for example, _my_name@my_domain_name_.| |
v1.0 | Security Caseoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-caseoperation.md | Inherits from [entity](../resources/entity.md). ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`.| |completedDateTime|DateTimeOffset| The date and time the operation was completed. | |createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | |createdDateTime|DateTimeOffset| The date and time the operation was created. | |
v1.0 | Security Deploymentaccesskeytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-deploymentaccesskeytype.md | + + Title: "deploymentAccessKeyType resource type" +description: "Sensor deployment access key" ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# deploymentAccessKeyType resource type ++Namespace: microsoft.graph.security +++Represents the deployment access key for a Microsoft Defender for Identity sensor. ++## Properties +|Property|Type|Description| +|:|:|:| +|deploymentAccessKey|String|The deployment access key.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.deploymentAccessKeyType" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.deploymentAccessKeyType", + "deploymentAccessKey": "String" +} +``` |
v1.0 | Security Deviceevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-deviceevidence.md | Title: "deviceEvidence resource type" description: "A device that is reported in the alert." Previously updated : 09/09/2021 ms.localizationpriority: medium Inherits from [alertEvidence](../resources/security-alertevidence.md). |azureAdDeviceId|String|A unique identifier assigned to a device by Microsoft Entra ID when device is Microsoft Entra joined.| |defenderAvStatus|[microsoft.graph.security.defenderAvStatus](#defenderavstatus-values)|State of the Defender AntiMalware engine. The possible values are: `notReporting`, `disabled`, `notUpdated`, `updated`, `unknown`, `notSupported`, `unknownFutureValue`.| |deviceDnsName|String|The fully qualified domain name (FQDN) for the device.|+| dnsDomain | String | The DNS domain that this computer belongs to. A sequence of labels separated by dots. | |firstSeenDateTime|DateTimeOffset|The date and time when the device was first seen.| |healthStatus|[microsoft.graph.security.deviceHealthStatus](#devicehealthstatus-values)|The health state of the device. The possible values are: `active`, `inactive`, `impairedCommunication`, `noSensorData`, `noSensorDataImpairedCommunication`, `unknown`, `unknownFutureValue`.|+| hostName | String | The hostname without the domain suffix. | |ipInterfaces|String collection|Ip interfaces of the device during the time of the alert.| |loggedOnUsers|[microsoft.graph.security.loggedOnUser](../resources/security-loggedonuser.md) collection|Users that were logged on the machine during the time of the alert.| |mdeDeviceId|String|A unique identifier assigned to a device by Microsoft Defender for Endpoint.|+| ntDomain | String | A logical grouping of computers within a Microsoft Windows network. | |onboardingStatus|[microsoft.graph.security.onboardingStatus](#onboardingstatus-values)|The status of the machine onboarding to Microsoft Defender for Endpoint. The possible values are: `insufficientInfo`, `onboarded`, `canBeOnboarded`, `unsupported`, `unknownFutureValue`.| |osBuild|Int64|The build version for the operating system the device is running.| |osPlatform|String|The operating system platform the device is running.| The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.security.deviceEvidence",+ "azureAdDeviceId": "String", "createdDateTime": "String (timestamp)",- "verdict": "String", - "remediationStatus": "String", - "remediationStatusDetails": "String", - "roles": [ - "String" - ], - "detailedRoles": [ - "String" - ], - "tags": [ - "String" - ], + "defenderAvStatus": "String", + "detailedRoles": ["String"], + "deviceDnsName": "String", + "dnsDomain": "String", "firstSeenDateTime": "String (timestamp)",+ "healthStatus": "String", + "hostName": "String", + "ipInterfaces": ["String"], + "loggedOnUsers": [{"@odata.type": "microsoft.graph.security.loggedOnUser"}], "mdeDeviceId": "String",- "azureAdDeviceId": "String", - "deviceDnsName": "String", - "osPlatform": "String", + "ntDomain": "String", + "onboardingStatus": "String", "osBuild": "Integer",- "version": "String", + "osPlatform": "String", "rbacGroupId": "Integer", "rbacGroupName": "String",- "healthStatus": "String", + "remediationStatus": "String", + "remediationStatusDetails": "String", "riskScore": "String",- "onboardingStatus": "String", - "defenderAvStatus": "String", - "vmMetadata": { - "@odata.type": "microsoft.graph.security.vmMetadata" - }, - "ipInterfaces": [ - "String" - ], - "loggedOnUsers": [ - { - "@odata.type": "microsoft.graph.security.loggedOnUser" - } - ] + "roles": ["String"], + "tags": ["String"], + "verdict": "String", + "version": "String", + "vmMetadata": {"@odata.type": "microsoft.graph.security.vmMetadata"} } ``` |
v1.0 | Security Ediscoveryaddtoreviewsetoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryaddtoreviewsetoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|microsoft.graph.security.caseAction| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ## Relationships |Relationship|Type|Description| |
v1.0 | Security Ediscoverycustodian | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoverycustodian.md | In the context of eDiscovery, represents a user and all of their digital assets, |[Get last index operation](../api/security-ediscoverycustodian-list-lastindexoperation.md)|[microsoft.graph.security.ediscoveryIndexOperation](../resources/security-ediscoveryindexoperation.md) collection|Get a list of the [ediscoveryIndexOperation](../resources/security-ediscoveryindexoperation.md) associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md).| |[List site sources](../api/security-ediscoverycustodian-list-sitesources.md)|[microsoft.graph.security.siteSource](../resources/security-sitesource.md) collection|Get the siteSource resources from the siteSources navigation property.| |[Create site source](../api/security-ediscoverycustodian-post-sitesources.md)|[microsoft.graph.security.siteSource](../resources/security-sitesource.md)|Create a new [siteSource](../resources/security-sitesource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).|-|[List unitifed group sources](../api/security-ediscoverycustodian-list-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md) collection|Get the unifiedGroupSource resources from the unifiedGroupSources navigation property.| -|[Create unifed group source](../api/security-ediscoverycustodian-post-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md)|Create a new [unifiedGroupSource](../resources/security-unifiedgroupsource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).| +|[List unified group sources](../api/security-ediscoverycustodian-list-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md) collection|Get the unifiedGroupSource resources from the unifiedGroupSources navigation property.| +|[Create unified group source](../api/security-ediscoverycustodian-post-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md)|Create a new [unifiedGroupSource](../resources/security-unifiedgroupsource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).| |[List user sources](../api/security-ediscoverycustodian-list-usersources.md)|[microsoft.graph.security.userSource](../resources/security-usersource.md) collection|Get the userSource resources from the userSources navigation property.| |[Create user source](../api/security-ediscoverycustodian-post-usersources.md)|[microsoft.graph.security.userSource](../resources/security-usersource.md)|Create a new [userSource](../resources/security-usersource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).| |
v1.0 | Security Ediscoveryestimateoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryestimateoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|microsoft.graph.security.caseAction| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset|The date and time the operation was completed. Read-only. | -|createdBy|[identitySet](../resources/identityset.md)|The user who created the operation. Read-only. | -|createdDateTime|DateTimeOffset|The date and time the operation was started. Read-only.| -|id|String| The ID for the operation. Read-only.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset|The date and time the operation was completed. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)|The user who created the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset|The date and time the operation was started. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| |indexedItemCount|Int64|The estimated count of items for the **search** that matched the content query.| |indexedItemsSize|Int64|The estimated size of items for the **search** that matched the content query.| |mailboxCount|Int32|The number of mailboxes that had search hits.|-|percentProgress|Int32|The progress of the operation. Read-only. | -|resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. | +|percentProgress|Int32|The progress of the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| |siteCount|Int32|The number of mailboxes that had search hits.|-|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| |unindexedItemCount|Int64|The estimated count of unindexed items for the collection.| |unindexedItemsSize|Int64|The estimated size of unindexed items for the collection.| |
v1.0 | Security Ediscoveryexportoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryexportoperation.md | Inherits from [caseOperation](../resources/security-caseoperation.md). ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the export was completed.| -|createdBy|[identitySet](../resources/identityset.md)| The user who initiated the export operation.| -|createdDateTime|DateTimeOffset| The date and time the export was created.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the export was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user who initiated the export operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the export was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| |description|String| The description provided for the export.| |exportFileMetadata | [microsoft.graph.security.ediscoveryExportFileMetadata](../resources/security-ediscoveryexportfilemetadata.md)| Contains the properties for an export file metadata, including **downloadUrl**, **fileName**, and **size**. If you export to an Azure storage location, this property returns empty. | |exportOptions|microsoft.graph.security.exportOptions| The options provided for the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `originalFiles`, `text`, `pdfReplacement`, `fileInfo`, `tags`. The `fileInfo` member is deprecated and will stop returning data on April 30, 2023. Going forward, the summary and load file are always included. | |exportStructure|microsoft.graph.security.exportFileStructure|The options provided that specify the structure of the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `none`, `directory`, `pst`.|-|id|String| The ID for the operation. Read-only. | +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| |outputName|String| The name provided for the export.|-|percentProgress|Int32| The progress of the operation.| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| |resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/ediscovery-caseoperation.md).|-|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| |azureBlobContainer (deprecated)|String| The name of the Azure storage location where the export is stored. This only applies to exports stored in your own Azure storage location. The **azureBlobContainer** property is deprecated and will stop returning data on April 30th, 2023. | |azureBlobToken (deprecated)|String| The SAS token for the Azure storage location. This only applies to exports stored in your own Azure storage location. The **azureBlobToken** property is deprecated and will stop returning data on April 30, 2023. | |outputFolderId (deprecated) | String | The output folder ID. The **outputFolderId** property is deprecated and will stop returning data on April 30, 2023. |
v1.0 | Security Ediscoveryholdoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryholdoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ## Relationships None. |
v1.0 | Security Ediscoveryholdpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryholdpolicy.md | Represents a legal hold policy. Legal holds are holds that are tied to an eDisco |createdDateTime|DateTimeOffset|The date and time the legal hold was created. | |description|String| The legal hold description. | |displayName|String| The display name of the legal hold. |+|contentQuery|String| KQL query that specifies content to be held in the specified locations. | |errors|String collection|Lists any errors that happened while placing the hold. | |id|String|The ID for the eDiscovery case. Read-only. Inherited from [entity](../resources/entity.md). | |isEnabled|Boolean|Indicates whether the hold is enabled and actively holding content. | |
v1.0 | Security Ediscoveryindexoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoveryindexoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ## Relationships None. |
v1.0 | Security Ediscoverypurgedataoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoverypurgedataoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ### purgeType values |Name|Description| |:-|--| |recoverable|Purged data is recoverable.|-|permanentlyDeleted|Purged data is permanently deleted.| -|unknownFutureValue|Reserved for future options.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| +|permanentlyDelete|Purged data is permanently deleted.| + ### purgeAreas values |Name|Description| |:-|--| |mailboxes|Purges data from Exchange mailboxes.| |teamsMessages|Purges Teams messages.|-|unknownFutureValue|Reserved for future options.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| ## Relationships None. |
v1.0 | Security Ediscoverysearch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoverysearch.md | Represents an eDiscovery search. For details, see [Collect data for a case in eD |[Update](../api/security-ediscoverysearch-update.md)|[microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md)|Update the properties of an [ediscoverySearch](../resources/security-ediscoverysearch.md) object.| |[Delete](../api/security-ediscoverycase-delete-searches.md)|None|Delete an [microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md) object.| |[Estimate statistics](../api/security-ediscoverysearch-estimatestatistics.md)|None|Run an estimate statistics operation on the data contained in the eDiscovery search.|-|[Purge data](../api/security-ediscoverysearch-purgedata.md)|None|Run a purge data operation on the Teams data contained in the eDiscovery search.| +|[Purge data](../api/security-ediscoverysearch-purgedata.md)|None|Delete Exchange mailbox items or Microsoft Teams messages contained in an eDiscovery search.| |[Export report](../api/security-ediscoverysearch-exportreport.md)|None|Export an item report from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md).| |[Export result](../api/security-ediscoverysearch-exportresult.md)|None|Export results from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md).| |[List additional sources](../api/security-ediscoverysearch-list-additionalsources.md)|[microsoft.graph.security.dataSource](../resources/security-datasource.md) collection|Get the list of [additional sources](../resources/security-datasource.md) associated with an [eDiscovery search](../resources/security-ediscoverysearch.md).| |
v1.0 | Security Ediscoverysearchexportoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoverysearchexportoperation.md | Inherits from [caseOperation](../resources/security-caseoperation.md). |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| -|additionalOptions|[microsoft.graph.security.additionalOptions](../resources/security-ediscoverysearchexportoperation.md#additionaloptions-values)| The additional items to include in the export. The possible values are: `none`, `teamsAndYammerConversations`, `cloudAttachments`, `allDocumentVersions`, `subfolderContents`, `listAttachments`, `unknownFutureValue`.| -|completedDateTime|DateTimeOffset|The date and time when the operation was completed. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| -|createdBy|[microsoft.graph.identitySet](../resources/identityset.md)|The user who created the operation. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| -|createdDateTime|DateTimeOffset|The date and time when the operation was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| -|description|String|The name of export provided by the user.| -|displayName|String|The description of the export by the user.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|additionalOptions|[microsoft.graph.security.additionalOptions](../resources/security-ediscoverysearchexportoperation.md#additionaloptions-values)| The additional items to include in the export. The possible values are: `none`, `teamsAndYammerConversations`, `cloudAttachments`, `allDocumentVersions`, `subfolderContents`, `listAttachments`, `unknownFutureValue`. | +|completedDateTime|DateTimeOffset|The date and time when the operation was completed. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[microsoft.graph.identitySet](../resources/identityset.md)|The user who created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset|The date and time when the operation was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|description|String|The description of the export by the user.| +|displayName|String|The name of export provided by the user.| |exportCriteria|[microsoft.graph.security.exportCriteria](../resources/security-ediscoverysearchexportoperation.md#exportcriteria-values)|Items to be included in the export. The possible values are: `searchHits`, `partiallyIndexed`, `unknownFutureValue`.| |exportFileMetadata|[microsoft.graph.security.ediscoveryExportFileMetadata](../resources/security-ediscoveryexportfilemetadata.md) collection|Contains the properties for an export file metadata, including **downloadUrl**, **fileName**, and **size**.| |exportFormat|[microsoft.graph.security.exportFormat](../resources/security-ediscoverysearchexportoperation.md#exportformat-values)|Format of the emails of the export. The possible values are: `pst`, `msg`, `eml`, `unknownFutureValue`.| |exportLocation|[microsoft.graph.security.exportLocation](../resources/security-ediscoverysearchexportoperation.md#exportlocation-values)| Location scope for partially indexed items. You can choose to include partially indexed items only in responsive locations with search hits or in all targeted locations. The possible values are: `responsiveLocations`, `nonresponsiveLocations`, `unknownFutureValue`.| |exportSingleItems|Boolean|Indicates whether to export single items.|-|id|String| The ID for the operation. Read-only. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| -|percentProgress|Int32|The progress of the operation. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| -|resultInfo|[microsoft.graph.resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. The possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`, `unknownFutureValue`. Inherited from [microsoft.graph.security.caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32|The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[microsoft.graph.resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. The possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`, `unknownFutureValue`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ### additionalOptions values |
v1.0 | Security Ediscoverytagoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-ediscoverytagoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`.| |completedDateTime|DateTimeOffset| The date and time the operation was completed. | |createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | |createdDateTime|DateTimeOffset| The date and time the operation was created. | |
v1.0 | Security Healthissue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-healthissue.md | Title: "healthIssue resource type" -description: "Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified." +description: "Represents potential issues identified by Microsoft Defender for Identity within a customer's Microsoft Defender for Identity configuration." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified. +Represents potential issues identified by Microsoft Defender for Identity within a customer's Microsoft Defender for Identity configuration. -Inherits from [microsoft.graph.entity](../resources/entity.md). +Inherits from [entity](../resources/entity.md). ## Methods |Method|Return type|Description| Inherits from [microsoft.graph.entity](../resources/entity.md). |Property|Type|Description| |:|:|:| |additionalInformation|String collection|Contains additional information about the issue, such as a list of items to fix.|-|createdDateTime|DateTimeOffset|The date and time of when the health issue was generated.| +|createdDateTime|DateTimeOffset|The date and time when the health issue was generated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |description|String|Contains more detailed information about the health issue.| |displayName|String|The display name of the health issue.| |domainNames|String collection|A list of the fully qualified domain names of the domains or the sensors the health issue is related to.| |healthIssueType|[microsoft.graph.security.healthIssueType](#healthissuetype-values)|The type of the health issue. The possible values are: `sensor`, `global`, `unknownFutureValue`. For a list of all health issues and their identifiers, see [Microsoft Defender for Identity health issues](/defender-for-identity/health-alerts). |-|ID|String|A unique identifier that represents the health issue.| +|id|String|A unique identifier that represents the health issue. Inherited from [entity](../resources/entity.md).| |issueTypeId|String|The type identifier of the health issue. For a list of all health issues and their identifiers, see [Microsoft Defender for Identity health issues](/defender-for-identity/health-alerts).|-|lastModifiedDateTime|DateTimeOffset|The date and time of when the health issue was last updated.| -|recommendations|String collection|This field contains a list of recommended actions that can be taken to resolve the issue effectively and efficiently. These actions might include how to investigate the issue further. Not limited to prewritten responses.| -|recommendedActionCommands|String collection|Contains a list of commands from the product's PowerShell module that can be used to resolve the issue, if available. If there aren't any commands that can be used to solve the issue, this field is empty. The commands, if present, provide a quick and efficient way to address the issue. The commands run in order for the single recommended fix.| -|sensorDNSNames|String collection|A list of the dns names of the sensors the health issue is related to.| +|lastModifiedDateTime|DateTimeOffset|The date and time when the health issue was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|recommendations|String collection|A list of recommended actions that can be taken to resolve the issue effectively and efficiently. These actions might include instructions for further investigation and aren't limited to prewritten responses.| +|recommendedActionCommands|String collection|A list of commands from the PowerShell module for the product that can be used to resolve the issue, if available. If no commands can be used to solve the issue, this property is empty. The commands, if present, provide a quick and efficient way to address the issue. These commands run in sequence for the single recommended fix.| +|sensorDNSNames|String collection|A list of the DNS names of the sensors the health issue is related to.| |severity|[microsoft.graph.security.healthIssueSeverity](#healthissueseverity-values)|The severity of the health issue. The possible values are: `low`, `medium`, `high`, `unknownFutureValue`.| |status|[microsoft.graph.security.healthIssueStatus](#healthissuestatus-values)|The status of the health issue. The possible values are: `open`, `closed`, `suppressed`, `unknownFutureValue`.| -#### healthIssueSeverity values +### healthIssueSeverity values | Member | Description | | :--| : | Inherits from [microsoft.graph.entity](../resources/entity.md). | high | High severity health issues indicate critical issues that could have a severe impact on your environment. These issues require immediate attention and action. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| -#### healthIssueStatus values +### healthIssueStatus values | Member | Description | | :--| : | Inherits from [microsoft.graph.entity](../resources/entity.md). | suppressed | The operator suppressed the issue manually. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| -#### healthIssueType values +### healthIssueType values | Member | Description | | :--| : |-| Sensor | The issue is on specific sensor. | -| Global | The issue is in the Defender for identity system configuration. | +| sensor | The issue is on specific sensor. | +| global | The issue is in the Defender for identity system configuration. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ## Relationships None. The following JSON representation shows the resource type. <!-- { "blockType": "resource",- "keyProperty": "ID", + "keyProperty": "id", "@odata.type": "microsoft.graph.security.healthIssue", "baseType": "microsoft.graph.entity", "openType": false The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.security.healthIssue",- "ID": "String (identifier)", + "additionalInformation": ["String"], + "createdDateTime": "String (timestamp)", + "description": "String", "displayName": "String",+ "domainNames": ["String"], "healthIssueType": "String",+ "id": "String (identifier)", "issueTypeId": "String",- "severity": "String", - "status": "String", - "createdDateTime": "String (timestamp)", "lastModifiedDateTime": "String (timestamp)",- "domainNames": [ - "String" - ], - "sensorDNSNames": [ - "String" - ], - "description": "String", - "recommendations": [ - "String" - ], - "recommendedActionCommands": [ - "String" - ], - "additionalInformation": [ - "String" - ] + "recommendations": ["String"], + "recommendedActionCommands": ["String"], + "sensorDNSNames": ["String"], + "severity": "String", + "status": "String" } ``` |
v1.0 | Security Identitycontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-identitycontainer.md | Title: "identityContainer resource type" -description: "A container for security identities APIs." +description: "Represents a container for security identities APIs that currently exposes the [healthIssues](security-healthissue.md) relationship." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph.security [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A container for security identities APIs. Currently exposes the [healthIssues](security-healthissue.md) relationship. +Represents a container for security identities APIs that currently exposes the [healthIssues](security-healthissue.md) relationship. ## Methods None. |Relationship|Type|Description| |:|:|:| |healthIssues|[microsoft.graph.security.healthIssue](security-healthissue.md) collection| Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified.|+|sensors|[microsoft.graph.security.sensor](security-sensor.md) collection| Represents a customer's Microsoft Defender for Identity sensors.| ## JSON representation |
v1.0 | Security Networkadapter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-networkadapter.md | + + Title: "networkAdapter resource type" +description: "Network adapters that are used for communication" ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# networkAdapter resource type ++Namespace: microsoft.graph.security +++Represents the network adapter from which the Microsoft Defender for Identity sensor analyzes network traffic. ++Inherits from [entity](../resources/entity.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|A unique identifier that represents the network adapter. Inherited from [entity](../resources/entity.md).| +|isEnabled|Boolean|Indicates whether the network adapter is selected for capturing and analyzing network traffic.| +|name|String|The name of the network adapter.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.networkAdapter", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.networkAdapter", + "id": "String (identifier)", + "isEnabled": "Boolean", + "name": "String" +} +``` |
v1.0 | Security Sensor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-sensor.md | + + Title: "sensor resource type" +description: "Represents a Microsoft Defender for Identity sensor." ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# sensor resource type ++Namespace: microsoft.graph.security +++Represents a Microsoft Defender for Identity sensor. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/security-identitycontainer-list-sensors.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md) collection|Get a list of [sensor](../resources/security-sensor.md) objects and their properties.| +|[Get](../api/security-sensor-get.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Read the properties and relationships of a [sensor](../resources/security-sensor.md) object.| +|[Update](../api/security-sensor-update.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Update the properties of a [sensor](../resources/security-sensor.md) object.| +|[Delete](../api/security-sensor-delete.md)|None|Delete a [sensor](../resources/security-sensor.md) object.| +|[Get deployment access key](../api/security-sensor-getdeploymentaccesskey.md)|[microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md)|Get the deployment access key associated with the Microsoft Defender for Identity workspace, needed to install sensors associated with the workspace.| +|[Get deployment package URI](../api/security-sensor-getdeploymentpackageuri.md)|[microsoft.graph.security.sensorDeploymentPackage](../resources/security-sensordeploymentpackage.md)|Get the sensor deployment package URL and version.| +|[Regenerate deployment access key](../api/security-sensor-regeneratedeploymentaccesskey.md)|[microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md)|Generate a new deployment access key that can be used to install sensors associated with the workspace.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdDateTime|DateTimeOffset|The date and time when the sensor was generated. The Timestamp represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|deploymentStatus|[microsoft.graph.security.deploymentStatus](#deploymentstatus-values)|The deployment status of the sensor. The possible values are: `upToDate`, `outdated`, `updating`, `updateFailed`, `notConfigured`, `unreachable`, `disconnected`, `startFailure`, `syncing`, `unknownFutureValue`.| +|displayName|String|The display name of the sensor.| +|domainName|String|The fully qualified domain name of the sensor.| +|healthStatus|[microsoft.graph.security.sensorHealthStatus](#sensorhealthstatus-values)|The health status of the sensor. The possible values are: `healthy`, `notHealthyLow`, `notHealthyMedium`, `notHealthyHigh`, `unknownFutureValue`.| +|id|String|Unique identifier to represent the sensor. Inherited from [entity](../resources/entity.md).| +|openHealthIssuesCount|Int64|This field displays the count of health issues related to this sensor.| +|sensorType|[microsoft.graph.security.sensorType](#sensortype-values)|The type of the sensor. The possible values are: `adConnectIntegrated`, `adcsIntegrated`, `adfsIntegrated`, `domainControllerIntegrated`, `domainControllerStandalone`, `unknownFutureValue`.| +|settings|[microsoft.graph.security.sensorSettings](../resources/security-sensorsettings.md)|Sensor settings information.| +|version|String|The version of the sensor.| ++### deploymentStatus values ++| Member | Description | +| :--| :-- | +| upToDate |Sensor is running a current version of the sensor.| +| outdated |Sensor is running a version of the software that is at least three versions behind the current version.| +| updating |Sensor software is being updated.| +| updateFailed |Sensor failed to update to a new version.| +| notConfigured |Sensor requires more configuration before it's fully operational. This applies to sensors installed on ADFS and ADCS servers or standalone sensors.| +| unreachable |The domain controller was deleted from Active Directory. However, the sensor installation wasn't uninstalled and removed from the domain controller before it was decommissioned. You can safely delete this entry.| +| disconnected |The Defender for Identity service hasn't seen any communication from this sensor in 10 minutes.| +| startFailure |Sensor didn't pull configuration for more than 30 minutes.| +| syncing |Sensor has configuration updates pending, but it didn't yet pull the new configuration.| +| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.| ++### sensorHealthStatus values ++| Member | Description | +| :--| :-- | +| healthy |No opened health issues.| +| notHealthyLow |The highest severity opened health issue is low.| +| notHealthyMedium |The highest severity opened health issue is medium.| +| notHealthyHigh |The highest severity opened health issue is high.| +| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.| ++### sensorType values ++| Member | Description | +| :--| :-- | +| adConnectIntegrated |Entra Connect sensor.| +| adcsIntegrated |Active Directory Certificate Services (ADCS) sensor.| +| adfsIntegrated |Active Directory Federation Services (ADFS) sensor.| +| domainControllerIntegrated |Domain controller sensor.| +| domainControllerStandalone |Standalone sensor.| +| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|healthIssues|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md) collection|Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified related to the sensor.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.sensor", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.sensor", + "createdDateTime": "String (timestamp)", + "deploymentStatus": "String", + "displayName": "String", + "domainName": "String", + "healthStatus": "String", + "id": "String (identifier)", + "openHealthIssuesCount": "Int64", + "sensorType": "String", + "settings": {"@odata.type": "microsoft.graph.security.sensorSettings"}, + "version": "String" +} +``` |
v1.0 | Security Sensordeploymentpackage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-sensordeploymentpackage.md | + + Title: "sensorDeploymentPackage resource type" +description: "Sensor deployment package" ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# sensorDeploymentPackage resource type ++Namespace: microsoft.graph.security +++Represents a sensor deployment package. ++## Properties +|Property|Type|Description| +|:|:|:| +|downloadUrl|String|URL to download the sensor deployment package.| +|version|String|Version of the sensor.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.sensorDeploymentPackage" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.sensorDeploymentPackage", + "downloadUrl": "String", + "version": "String" +} +``` |
v1.0 | Security Sensorsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/security-sensorsettings.md | + + Title: "sensorSettings resource type" +description: "Sensor settings information" ++ms.localizationpriority: medium + Last updated : 09/10/2024+++# sensorSettings resource type ++Namespace: microsoft.graph.security +++Provides settings information for a sensor. ++## Properties +|Property|Type|Description| +|:|:|:| +|description|String|Description of the sensor.| +|domainControllerDnsNames|String collection|DNS names for the domain controller| +|isDelayedDeploymentEnabled|Boolean|Indicates whether to delay updates for the sensor.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|networkAdapters|[microsoft.graph.security.networkAdapter](../resources/security-networkadapter.md) collection|Sensor network adapters.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.sensorSettings" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.sensorSettings", + "description": "String", + "domainControllerDnsNames": [ + "String" + ], + "isDelayedDeploymentEnabled": "Boolean" +} +``` |
v1.0 | Sequentialactivationrenewalsalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sequentialactivationrenewalsalertconfiguration.md | Represents an alert configuration that is triggered if a user activates the same Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Sequentialactivationrenewalsalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sequentialactivationrenewalsalertincident.md | Represents an alert incident that is triggered if a user activates the same priv Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Servicelevelagreementroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/servicelevelagreementroot.md | Title: "serviceLevelAgreementRoot resource type" -description: "A placeholder to allow for the desired URL path for Microsoft Entra SLA attainment." +description: "A placeholder to allow for the desired URL path for Microsoft Entra Health SLA attainment." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -A placeholder to allow for the desired URL path for Microsoft Entra SLA attainment. +A placeholder to allow for the desired URL path for Microsoft Entra Health SLA attainment. Inherits from [entity](../resources/entity.md). None. ## Relationships |Relationship|Type|Description| |:|:|:|-|azureADAuthentication|[azureADAuthentication](../resources/azureadauthentication.md)|Collects the Microsoft Entra SLA attainment for each month for a Microsoft Entra tenant.| +|azureADAuthentication|[azureADAuthentication](../resources/azureadauthentication.md)|Collects the monthly Microsoft Entra Health SLA attainment metrics for a Microsoft Entra tenant.| ## JSON representation This entity can not be viewed as it is only a placeholder. |
v1.0 | Serviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/serviceprincipal.md | This resource supports using [delta query](/graph/delta-query-overview) to track |appOwnerOrganizationId|Guid|Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports `$filter` (`eq`, `ne`, `NOT`, `ge`, `le`).| |appRoleAssignmentRequired|Boolean|Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is `false`. Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `NOT`). | |appRoles|[appRole](approle.md) collection|The roles exposed by the application, which this service principal represents. For more information, see the **appRoles** property definition on the [application](application.md) entity. Not nullable. |-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). Filter value is case sensitive.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). Filter value is case sensitive.<br><li>To read this property, the calling app must be assigned the *CustomSecAttributeAssignment.Read.All* permission. To write this property, the calling app must be assigned the *CustomSecAttributeAssignment.ReadWrite.All* permissions. <li>To read or write this property in delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role.| | deletedDateTime | DateTimeOffset | The date and time the service principal was deleted. Read-only. | | description | String | Free text field to provide an internal end-user facing description of the service principal. End-user portals such [MyApps](/azure/active-directory/user-help/my-apps-portal-end-user-access) displays the application description in this field. The maximum allowed size is 1,024 characters. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`) and `$search`.| | disabledByMicrosoftStatus | String | Specifies whether Microsoft has disabled the registered application. Possible values are: `null` (default value), `NotDisabled`, and `DisabledDueToViolationOfServicesAgreement` (reasons may include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). <br><br> Supports `$filter` (`eq`, `ne`, `not`). | This resource supports using [delta query](/graph/delta-query-overview) to track |notificationEmailAddresses|String collection|Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.| |passwordCredentials|[passwordCredential](passwordcredential.md) collection|The collection of password credentials associated with the service principal. Not nullable. | |passwordSingleSignOnSettings|[passwordSingleSignOnSettings](passwordsinglesignonsettings.md)|The collection for settings related to password single sign-on. Use `$select=passwordSingleSignOnSettings` to read the property. Read-only for [applicationTemplates](applicationTemplate.md) except for custom applicationTemplates. |-|preferredSingleSignOnMode|string|Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Microsoft Entra My Apps. The supported values are `password`, `saml`, `notSupported`, and `oidc`.| +|preferredSingleSignOnMode|string|Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Microsoft Entra My Apps. The supported values are `password`, `saml`, `notSupported`, and `oidc`. **Note:** This field might be `null` for older SAML apps and for OIDC applications where it isn't set automatically.| |permissionGrantPreApprovalPolicies|[permissionGrantPreApprovalPolicy](../resources/permissiongrantpreapprovalpolicy.md) collection|The list of preapproval policies that has been assigned to the service principal.| |preferredTokenSigningKeyEndDateTime|DateTimeOffset|Specifies the expiration date of the keyCredential used for token signing, marked by **preferredTokenSigningKeyThumbprint**. Updating this attribute isn't currently supported. For details, see [ServicePrincipal property differences](/graph/migrate-azure-ad-graph-property-differences#serviceprincipal-property-differences).| |preferredTokenSigningKeyThumbprint|String|This property can be used on SAML applications (apps that have **preferredSingleSignOnMode** set to `saml`) to control which certificate is used to sign the SAML responses. For applications that aren't SAML, don't write or otherwise rely on this property. | |
v1.0 | Serviceprincipalriskdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/serviceprincipalriskdetection.md | For more information about risk events, see [Microsoft Entra ID Protection](/azu ## Properties |Property|Type|Description| |:|:|:|-|activity|activityType|Indicates the activity type the detected risk is linked to. The possible values are: `signin`, `servicePrincipal`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `servicePrincipal`. | +|activity|activityType|Indicates the activity type the detected risk is linked to. The possible values are: `signin`, `servicePrincipal`. 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): `servicePrincipal`. | |activityDateTime|DateTimeOffset|Date and time when the risky activity occurred. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |additionalInfo|String|Additional information associated with the risk detection. This string value is represented as a JSON object with the quotations escaped. | |appId|String|The unique identifier for the associated application.|-|correlationId|String|Correlation ID of the sign-in activity associated with the risk detection. This property is `null` if the risk detection is not associated with a sign-in activity.| +|correlationId|String|Correlation ID of the sign-in activity associated with the risk detection. This property is `null` if the risk detection isn't associated with a sign-in activity.| |detectedDateTime|DateTimeOffset|Date and time when the risk was detected. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|-|detectionTimingType|riskDetectionTimingType|Timing of the detected risk , whether real-time or offline). The possible values are: `notDefined`, `realtime`, `nearRealtime`, `offline`, `unknownFutureValue`.| +|detectionTimingType|riskDetectionTimingType|Timing of the detected risk, whether real-time or offline). The possible values are: `notDefined`, `realtime`, `nearRealtime`, `offline`, `unknownFutureValue`.| |id|String|Unique identifier of the risk detection. Inherited from [entity](../resources/entity.md).| |ipAddress|String|Provides the IP address of the client from where the risk occurred.| |keyIds|String collection|The unique identifier (GUID) for the key credential associated with the risk detection.| |lastUpdatedDateTime|DateTimeOffset|Date and time when the risk detection was last updated.| |location|[signInLocation](signinlocation.md)|Location from where the sign-in was initiated. |-|requestId|String|Request identifier of the sign-in activity associated with the risk detection. This property is `null` if the risk detection is not associated with a sign-in activity. Supports `$filter` (`eq`).| -|riskDetail|riskDetail|Details of the detected risk. <br>**Note:** Details for this property are only available for Workload Identities Premium customers. Events in tenants without this license will be returned `hidden`. <br/>The possible values are: `none`, `hidden`, `adminConfirmedServicePrincipalCompromised`, `adminDismissedAllRiskForServicePrincipal`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `adminConfirmedServicePrincipalCompromised` , `adminDismissedAllRiskForServicePrincipal`.| -|riskEventType|String|The type of risk event detected. The possible values are: `investigationsThreatIntelligence`, `generic`, `adminConfirmedServicePrincipalCompromised`, `suspiciousSignins`, `leakedCredentials`, `anomalousServicePrincipalActivity`, `maliciousApplication`, `suspiciousApplication`.| -|riskLevel|riskLevel|Level of the detected risk. <br>**Note:** Details for this property are only available for Workload Identities Premium customers. Events in tenants without this license will be returned `hidden`. The possible values are: `low`, `medium`, `high`, `hidden`, `none`.| +|requestId|String|Request identifier of the sign-in activity associated with the risk detection. This property is `null` if the risk detection isn't associated with a sign-in activity. Supports `$filter` (`eq`).| +|riskDetail|riskDetail|Details of the detected risk. <br>**Note:** Details for this property are only available for Workload Identities Premium customers. Events in tenants without this license are returned `hidden`. <br/>The possible values are: `none`, `hidden`, `adminConfirmedServicePrincipalCompromised`, `adminDismissedAllRiskForServicePrincipal`. 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): `adminConfirmedServicePrincipalCompromised` , `adminDismissedAllRiskForServicePrincipal`.| +|riskEventType|String|The type of risk event detected. The possible values are: `investigationsThreatIntelligence`, `generic`, `adminConfirmedServicePrincipalCompromised`, `suspiciousSignins`, `leakedCredentials`, `anomalousServicePrincipalActivity`, `maliciousApplication`, `suspiciousApplication`, `suspiciousAPITraffic`.| +|riskLevel|riskLevel|Level of the detected risk. <br>**Note:** Details for this property are only available for Workload Identities Premium customers. Events in tenants without this license are returned `hidden`. The possible values are: `low`, `medium`, `high`, `hidden`, `none`.| |riskState|riskState|The state of a detected risky service principal or sign-in activity. The possible values are: `none`, `dismissed`, `atRisk`, `confirmedCompromised`.| |servicePrincipalDisplayName|String| The display name for the service principal.| |servicePrincipalId|String|The unique identifier for the service principal. Supports `$filter` (`eq`).| |
v1.0 | Shareddriveitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/shareddriveitem.md | + Title: sharedDriveItem resource type description: The sharedDriveItem resource is returned when using the Shares API to access a shared driveItem. Previously updated : 09/10/2017 Title: SharedDriveItem ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -The **sharedDriveItem** resource is returned when using the [Shares](../api/shares-get.md) API to access a shared [driveItem](driveitem.md). +The **sharedDriveItem** resource is returned when using the [shares](../api/shares-get.md) API to access a shared [driveItem](driveitem.md). -## JSON representation --Here is a JSON representation of the **sharedDriveItem** resource. +The **sharedDriveItem** resource is derived from [baseItem](baseitem.md) and inherits properties from that resource. -The **sharedDriveItem** resource is derived from [**baseItem**](baseitem.md) and inherits properties from that resource. +For more information about the facets on a DriveItem, see [driveItem](driveitem.md). -<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.baseItem", - "optionalProperties": [ ], - "@odata.type": "microsoft.graph.sharedDriveItem" -}--> --```json -{ - "id": "string", - "name": "string", - "owner": { "@odata.type": "microsoft.graph.identitySet" }, +## Methods - "driveItem": { "@odata.type": "microsoft.graph.driveItem" }, - "items": [ { "@odata.type": "microsoft.graph.driveItem" }], - "list": { "@odata.type": "microsoft.graph.list" }, - "listItem": { "@odata.type": "microsoft.graph.listItem" }, - "permission": { "@odata.type": "microsoft.graph.permission" }, - "site": { "@odata.type": "microsoft.graph.site" } -} -``` +| Method | Return Type | Description | +|:|:--|:| +| [Use sharing links](../api/shares-get.md) | [sharedDriveItem](shareddriveitem.md) | Access a shared item or a collection of shared items by using a **shareId** or sharing URL. | ## Properties The **sharedDriveItem** resource is derived from [**baseItem**](baseitem.md) and | :- | :- | : | | id | String | The unique identifier for the share being accessed. | | name | String | The display name of the shared item. |-| owner | [IdentitySet](identityset.md) | Information about the owner of the shared item being referenced. | +| owner | [identitySet](identityset.md) | Information about the owner of the shared item being referenced. | ## Relationships -| Relationship | Type | Description | -| -- | : | :- | -| **driveItem** | [**driveItem**][driveItem] | Used to access the underlying **driveItem** | -| **list** | [**list**][list] | Used to access the underlying **list** | -| **listItem** | [**listItem**][listItem] | Used to access the underlying **listItem** | -| **permission** | [**permission**][permission] | Used to access the **permission** representing the underlying sharing link | -| **site** | [**site**][site] | Used to access the underlying **site** | +| Relationship name | Type | Description | +| |:-|:| +| driveItem | [driveItem][driveItem] | Used to access the underlying driveItem | +| list | [list][list] | Used to access the underlying list | +| listItem | [listItem][listItem] | Used to access the underlying listItem | +| permission | [permission][permission] | Used to access the permission representing the underlying sharing link | +| site | [site][site] | Used to access the underlying site | Alternatively, for **driveItems** shared from personal OneDrive accounts, the following relationships may also be used. -| Relationship name | Type | Description | -| -- | : | :- | -| **items** | [**driveItem**][driveItem] collection | All driveItems contained in the sharing root. This collection cannot be enumerated. | -| **driveItem** | [**driveItem**][driveItem] | Used to access the underlying **driveItem** | +| Relationship name | Type | Description | +| |:-|:| +| items | [driveItem][driveItem] collection | All driveItems contained in the sharing root. This collection cannot be enumerated. | [driveItem]: driveitem.md [list]: list.md Alternatively, for **driveItems** shared from personal OneDrive accounts, the fo [permission]: permission.md [site]: site.md -## Methods +## JSON representation -| Method | REST Path | -| :-- | :-- | -| [Use sharing links](../api/shares-get.md) | `GET /shares/{share-id}` | +The following JSON representation shows the resource. -## Remarks +<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.baseItem", + "optionalProperties": [ ], + "@odata.type": "microsoft.graph.sharedDriveItem" +}--> -For more information about the facets on a DriveItem, see [DriveItem](driveitem.md). +```json +{ + "id": "string", + "name": "string", + "owner": { "@odata.type": "microsoft.graph.identitySet" }, ++ "driveItem": { "@odata.type": "microsoft.graph.driveItem" }, + "items": [ { "@odata.type": "microsoft.graph.driveItem" }], + "list": { "@odata.type": "microsoft.graph.list" }, + "listItem": { "@odata.type": "microsoft.graph.listItem" }, + "root": { "@odata.type": "microsoft.graph.driveItem" }, + "site": { "@odata.type": "microsoft.graph.site" } +} +``` <!-- { |
v1.0 | Sharepointonedriveoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepointonedriveoptions.md | ms.localizationpriority: medium doc_type: "resourcePageType"+toc. Title: "SharePoint OneDrive options" # sharePointOneDriveOptions resource type |
v1.0 | Sharepointprotectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sharepointprotectionpolicy.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a plan defined by the SharePoint Online Admin to protect SharePoint Online, including what data to protect, when to protect it, and for what time period to retain the protected data. +Represents a plan defined by the SharePoint Online admin to protect SharePoint Online, including what data to protect, when to protect it, and for what time period to retain the protected data. Currently, policies are supported only for SharePoint Online sites in the main geolocation only; multi-geo tenants aren't supported. Inherits from [protectionPolicyBase](../resources/protectionpolicybase.md). |
v1.0 | Signin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/signin.md | The [Microsoft Entra data retention policies](/azure/active-directory/reports-mo |:|:--|:-| |appDisplayName|String|The application name displayed in the Microsoft Entra admin center. <br/><br/> Supports `$filter` (`eq`, `startsWith`).| |appId|String|The application identifier in Microsoft Entra ID. <br/><br/> Supports `$filter` (`eq`).|-|appliedConditionalAccessPolicies|[appliedConditionalAccessPolicy](appliedconditionalaccesspolicy.md) collection|A list of conditional access policies that the corresponding sign-in activity triggers. Apps need more Conditional Access-related privileges to read the details of this property. For more information, see [Viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#viewing-applied-conditional-access-ca-policies-in-sign-ins).| +|appliedConditionalAccessPolicies|[appliedConditionalAccessPolicy](appliedconditionalaccesspolicy.md) collection|A list of conditional access policies that the corresponding sign-in activity triggers. Apps need more Conditional Access-related privileges to read the details of this property. For more information, see [Permissions for viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#permissions).| |appliedEventListeners|[appliedAuthenticationEventListener](../resources/appliedauthenticationeventlistener.md) collection|Detailed information about the listeners, such as Azure Logic Apps and Azure Functions, which the corresponding events in the sign-in event triggered.| |appTokenProtectionStatus|tokenProtectionStatus|Token protection creates a cryptographically secure tie between the token and the device it's issued to. This field indicates whether the app token was bound to the device.| |authenticationAppDeviceDetails|[authenticationAppDeviceDetails](../resources/authenticationappdevicedetails.md)|Provides details about the app and device used during a Microsoft Entra authentication step.| The [Microsoft Entra data retention policies](/azure/active-directory/reports-mo |homeTenantId|String|The tenant identifier of the user initiating the sign-in. Not applicable in Managed Identity or service principal sign ins.| |homeTenantName|String|For user sign ins, the identifier of the tenant that the user is a member of. Only populated in cases where the home tenant provides affirmative consent to Microsoft Entra ID to show the tenant content.| |id|String|The identifier representing the sign-in activity. Inherited from [entity](entity.md). <br/><br/> Supports `$filter` (`eq`).|-|incomingTokenType|incomingTokenType|Indicates the token types that were presented to Microsoft Entra ID to authenticate the actor in the sign in. The possible values are: `none`, `primaryRefreshToken`, `saml11`, `saml20`, `unknownFutureValue`, `remoteDesktopToken`. <br><br> **NOTE** Microsoft Entra ID might have also used token types not listed in this enum type to authenticate the actor. Don't infer the lack of a token if it isn't one of the types listed. Also, you must use the `Prefer: include-unknown-enum-members` request header to get the following value or values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `remoteDesktopToken`.| +|incomingTokenType|incomingTokenType|Indicates the token types that were presented to Microsoft Entra ID to authenticate the actor in the sign in. The possible values are: `none`, `primaryRefreshToken`, `saml11`, `saml20`, `unknownFutureValue`, `remoteDesktopToken`, `refreshToken`. <br><br> **NOTE** Microsoft Entra ID might have also used token types not listed in this enum type to authenticate the actor. Don't infer the lack of a token if it isn't one of the types listed. Also, you must use the `Prefer: include-unknown-enum-members` request header to get the following value or values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `remoteDesktopToken`, `refreshToken`.| |ipAddress|String|The IP address of the client from where the sign-in occurred. <br/><br/> Supports `$filter` (`eq`, `startsWith`).| |ipAddressFromResourceProvider|String|The IP address a user used to reach a resource provider, used to determine Conditional Access compliance for some policies. For example, when a user interacts with Exchange Online, the IP address that Microsoft Exchange receives from the user can be recorded here. This value is often `null`.| |isInteractive|Boolean|Indicates whether a user sign in is interactive. In interactive sign in, the user provides an authentication factor to Microsoft Entra ID. These factors include passwords, responses to MFA challenges, biometric factors, or QR codes that a user provides to Microsoft Entra ID or an associated app. In non-interactive sign in, the user doesn't provide an authentication factor. Instead, the client app uses a token or code to authenticate or access a resource on behalf of a user. Non-interactive sign ins are commonly used for a client to sign in on a user's behalf in a process transparent to the user.| |
v1.0 | Singleuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/singleuser.md | Title: "singleUser complex type" + Title: "singleUser resource type" description: "Identifies a user in the tenant who will be allowed as requestor, approver, or reviewer." ms.localizationpriority: medium -# singleUser complex type +# singleUser resource type Namespace: microsoft.graph |
v1.0 | Site | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/site.md | The **site** resource provides metadata and relationships for a SharePoint site. | [Get analytics][] | GET /sites/{site-id}/analytics | | [Get activities by interval][] | GET /sites/{site-id}/getActivitiesByInterval | | [List pages][] | GET /sites/{site-id}/pages |+| [List page templates][] | GET /sites/{site-id}/pageTemplates/microsoft.graph.pageTemplate | | [List root sites][] | GET /sites?filter=root ne null&select=siteCollection,webUrl | | [List sites across geographies][] | GET /site/getAllSites | | [List subsites for a site][] | GET /sites/{site-id}/sites | The **site** resource provides metadata and relationships for a SharePoint site. [Get analytics]: ../api/itemanalytics-get.md [Get activities by interval]: ../api/itemactivity-getbyinterval.md [List pages]: ../api/basesitepage-list.md+[List page templates]: ../api/pagetemplate-list.md [List root sites]: ../api/site-list.md [List sites across geographies]: ../api/site-getallsites.md [List subsites for a site]: ../api/site-list-subsites.md The `root` identifier always references the root site for a given target, as fol | lists | [list][] collection | The collection of lists under this site. | | operations | [richLongRunningOperation](../resources/richlongrunningoperation.md) collection | The collection of long running operations for the site. | | pages | [baseSitePage][] collection | The collection of pages in the baseSitePages list on this site. |+| pageTemplates | [pageTemplate][] collection | The collection of page templates on this site. | | permissions | [permission][] collection | The permissions associated with the site. Nullable. | | recycleBin | [recycleBin][] | A container for a collection of [recycleBinItem](../resources/recyclebinitem.md) resources in this site. | | sites | [site][] collection | The collection of the sub-sites under this site. | The `root` identifier always references the root site for a given target, as fol [list]: list.md [permission]: permission.md [baseSitePage]: baseSitePage.md+[pageTemplate]: pagetemplate.md [root]: root.md [site]: site.md [siteSettings]: sitesettings.md |
v1.0 | Sitepage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/sitepage.md | Inherits from [baseSitePage](../resources/basesitepage.md). | [Delete](../api/basesitepage-delete.md) | None | Deletes a [sitePage](../resources/sitepage.md) object. | | [Publish](../api/sitepage-publish.md) | None | Publish a [sitePage](../resources/sitepage.md) object. | | [Get by position](../api/sitepage-getwebpartsbyposition.md) | [webPart](../resources/webpart.md) collection | Get a collection of [WebPart](../resources/webpart.md) by providing [webPartPosition](../resources/webpartposition.md) information. |+| [Save as template](../api/sitepage-saveastemplate.md) | [pageTemplate](../resources/pagetemplate.md) | Save a [sitePage](../resources/sitepage.md) as a [pageTemplate](../resources/pagetemplate.md) in a [site](../resources/site.md). | +| [Create from template](../api/sitepage-createfromtemplate.md) | [sitePage](../resources/sitepage.md) | Create a new [sitePage](../resources/sitepage.md) from a [pageTemplate](../resources/pagetemplate.md) in a [site](../resources/site.md). | ## Properties |
v1.0 | Siteprotectionrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/siteprotectionrule.md | Inherits from [protectionRuleBase](../resources/protectionrulebase.md). |createdBy|[identitySet](../resources/identityset.md)|The identity of the person who created the rule.| |createdDateTime|DateTimeOffset|The date and time that the rule was created.| |error|[publicError](../resources/publicerror.md)|Contains error details if any operation on a rule expression fails.|-|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic. Static rules run one time and dynamic rules listen to all changes in the system and update the protection unit list.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Static rules run one time while dynamic rules listen to all changes in the system and update the protection unit list. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified the rule.| |lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification to the rule.| |siteExpression|String|Contains a site expression. For examples, see [siteExpression example](../resources/siteprotectionrule.md#siteexpression-examples).|-|status|[protectionRuleStatus](../resources/siteprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| +|status|[protectionRuleStatus](../resources/siteprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. The `draft` member is currently unsupported.| ### siteExpression examples The following table shows the possible formats for the site expression. |Member | Description | |:|:|-|draft | The initial status of the protection rule upon creation.| +|draft | The initial status of the protection rule upon creation. The `draft` member is currently unsupported. | |active | The status of the protection rule upon using the `/run` API.|-|completed |The status of the protection rule after it is successfully applied to the corresponding policy.| -|completedWithErrors | The status of the protection rule after it is applied to the corresponding policy and any failures occurred.| -|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.| +|completed |The status of the protection rule after it's successfully applied to the corresponding policy.| +|completedWithErrors | The status of the protection rule after it's applied to the corresponding policy and any failures occurred.| +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Siteprotectionunitsbulkadditionjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/siteprotectionunitsbulkadditionjob.md | + + Title: "siteProtectionUnitsBulkAdditionJob resource type" +description: "Represents the list of site URLs or site IDs of SharePoint sites to be added into the corresponding Sharepoint protection policy." ++ms.localizationpriority: medium ++++# siteProtectionUnitsBulkAdditionJob resource type ++Namespace: microsoft.graph +++Represents the properties of a siteProtectionUnitsBulkAdditionJob associated with a [SharePoint protection policy](../resources/sharepointprotectionpolicy.md). It contains a list of SharePoint site URLs, and a list of site IDs to be added to the SharePoint protection policy for backup. ++Inherits from [protectionUnitsBulkJobBase](../resources/protectionunitsbulkjobbase.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List](../api/sharepointprotectionpolicy-list-siteprotectionunitsbulkadditionjobs.md)|[siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) collection|Get a list of [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md) objects and their properties.| +|[Create](../api/siteprotectionunitsbulkadditionjobs-post.md)|[siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md)|Create a new [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md).| +|[Get](../api/siteprotectionunitsbulkadditionjobs-get.md)|[siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md)|Read the properties and relationships of a [siteProtectionUnitsBulkAdditionJob](../resources/siteprotectionunitsbulkadditionjob.md).| ++## Properties ++|Property|Type|Description| +|:|:|:| +|createdBy|[identitySet](../resources/identityset.md)|The identity of the person who created the job.| +|createdDateTime|DateTimeOffset|The date and time that the job was created.| +|displayName|String|The name of the job.| +|error|[publicError](../resources/publicerror.md)|Contains error details if any site-url resolution fails.| +|id|String|The unique identifier of the job associated with the SharePoint protection policy.| +|lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified the job.| +|lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification to the job.| +|status|[protectionUnitsBulkJobStatus](../resources/protectionunitsbulkjobbase.md#protectionunitsbulkjobstatus-values )|Status of the job. The possible values are: `unknown`, `active`, `completed`, `completedWithErrors`, and `unknownFutureValue`.| +|siteWebUrls|Collection(String)|The list of SharePoint site URLs to add to the SharePoint protection policy.| +|siteIds|Collection(String)|The list of SharePoint site IDs to add to the SharePoint protection policy.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.siteProtectionUnitsBulkAdditionJob", + "baseType": "microsoft.graph.protectionUnitsBulkJobBase", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.siteProtectionUnitsBulkAdditionJob", + "id": "String (identifier)", + "displayName": "String", + "status": "String", + "createdDateTime": "String (timestamp)", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "error": { + "@odata.type": "microsoft.graph.publicError" + }, + "siteWebUrls": [ + "String" + ], + "siteIds": [ + "String" + ] +} +``` |
v1.0 | Stalesigninalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/stalesigninalertconfiguration.md | Represents an alert configuration that is triggered if there are accounts in a p Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Stalesigninalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/stalesigninalertincident.md | The threshold that triggers this alert when it's reached is defined in the [stal Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Strongauthenticationrequirements | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/strongauthenticationrequirements.md | Captures settings relating to per-user Microsoft Entra multifactor authenticatio ## Properties |Property|Type|Description| |:|:|:|-|perUserMfaState|perUserMfaState|Sets the per-user MFA state for the user. The possible values are: `disabled`, `enforced`, `enabled`, `unknownFutureValue`.| +|perUserMfaState|perUserMfaState|Sets the per-user MFA state for the user. The possible values are: `disabled`, `enforced`, `enabled`, `unknownFutureValue`. When you update a user's MFA state to `enabled` and the user has already registered an MFA method, their state changes automatically to `enforced`.| ## Relationships None. |
v1.0 | Targetusersponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/targetusersponsors.md | Title: "targetUserSponsors complex type" + Title: "targetUserSponsors resource type" description: "Identifies a relationship to another user in the tenant who will be allowed as approver." ms.localizationpriority: medium-# targetUserSponsors complex type +# targetUserSponsors resource type Namespace: microsoft.graph |
v1.0 | Tasks Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tasks-overview.md | +toc. Title: To-do tasks API overview (deprecated) # Use the To Do API built on base tasks in Microsoft Graph (deprecated) |
v1.0 | Team | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/team.md | Every team is associated with a [Microsoft 365 group](../resources/group.md). Th |[Get primary channel](../api/team-get-primarychannel.md)|[channel](channel.md)| The general channel for the team. | |[Update member](../api/team-update-members.md)|[conversationMember](../resources/conversationmember.md)|Change a member to an owner or back to a regular member.| |[Remove member](../api/team-delete-members.md)|None|Remove an existing member from the team.|+|[Remove members in bulk](../api/conversationmember-remove.md)|[actionResultPart](../resources/actionresultpart.md) collection|Remove multiple members from a [team](../resources/team.md) in a single request.| |[Archive team](../api/team-archive.md) | [teamsAsyncOperation](../resources/teamsasyncoperation.md) |Put the team in a read-only state. | |[Unarchive team](../api/team-unarchive.md) | [teamsAsyncOperation](../resources/teamsasyncoperation.md) |Restore the team to a read-write state. | |[Clone team](../api/team-clone.md) | [teamsAsyncOperation](../resources/teamsasyncoperation.md) |Copy the team and its associated group. | Every team is associated with a [Microsoft 365 group](../resources/group.md). Th | Property | Type | Description | |:|:--|:-|-| id | string | The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type. | |classSettings|[teamClassSettings](teamclasssettings.md) |Configure settings of a class. Available only when the team represents a class.| |classification|string| An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory. | |createdDateTime|dateTimeOffset|Timestamp at which the team was created.|-|description|string| An optional description for the team. Maximum length: 1024 characters. | +|description|string| An optional description for the team. Maximum length: 1,024 characters. | |discoverySettings|[teamDiscoverySettings](teamdiscoverysettings.md) |Settings to configure team discoverability by others.| |displayName|string| The name of the team. | |funSettings|[teamFunSettings](teamfunsettings.md) |Settings to configure the use of Giphy, memes, and stickers in the team.| |guestSettings|[teamGuestSettings](teamguestsettings.md) |Settings to configure whether guests can create, update, or delete channels in the team.|+|id| string | The unique identifier of the team. The group has the same ID as the team. This property is read-only, and is inherited from the base entity type. | |internalId | string | A unique ID for the team used in a few places such as the audit log/[Office 365 Management Activity API](/office/office-365-management-api/office-365-management-activity-api-reference). | |isArchived|Boolean|Whether this team is in read-only mode. | |isMembershipLimitedToOwners|Boolean|If set to `true`, the team is currently in the owner-only team membership state and inaccessible by other team members, such as students.| Every team is associated with a [Microsoft 365 group](../resources/group.md). Th |summary|[teamSummary](teamsummary.md)| Contains summary information about the team, including the number of owners, members, and guests. | |tenantId |string | The ID of the Microsoft Entra tenant. | |visibility|[teamVisibilityType](teamvisibilitytype.md)| The visibility of the group and team. Defaults to Public. |-|webUrl|string (readonly) | A hyperlink that goes to the team in the Microsoft Teams client. It is the URL you get when you right-click a team in the Microsoft Teams client and select **Get link to team**. This URL should be treated as an opaque blob, and not parsed. | +|webUrl|string (readonly) | A hyperlink that goes to the team in the Microsoft Teams client. It's the URL you get when you right-click a team in the Microsoft Teams client and select **Get link to team**. This URL should be treated as an opaque blob, and not parsed. | ### Instance attributes For a POST request example, see [Request (create team in migration state)](/micr ## JSON representation -The JSON representation shows the resource type. +The following JSON representation shows the resource type. >**Note:** If the team is of type class, a **classSettings** property is applied on the team. The JSON representation shows the resource type. "displayName": "String", "funSettings": {"@odata.type": "microsoft.graph.teamFunSettings"}, "guestSettings": {"@odata.type": "microsoft.graph.teamGuestSettings"},+ "id": "String (identifier)", "internalId": "String", "isArchived": "Boolean", "isMembershipLimitedToOwners": "Boolean", |
v1.0 | Teamdiscoverysettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamdiscoverysettings.md | Title: "teamDiscoverySettings resource type" description: "Settings to configure team discoverability by others." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Teamfunsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamfunsettings.md | Title: "teamFunSettings resource type" description: "Settings to configure use of Giphy, memes, and stickers in the team." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Teamguestsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamguestsettings.md | Title: "teamGuestSettings resource type" description: "Settings to configure whether guests can create, update, or delete channels in the team." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Teammessagingsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teammessagingsettings.md | Title: "teamMessagingSettings resource type" description: "Settings to configure messaging and mentions in the team."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teams Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teams-api-overview.md | Title: "Use the Microsoft Graph API to work with Microsoft Teams" description: "Microsoft Teams is a chat-based workspace in Microsoft 365 that provides built-in access to team-specific calendars, files, OneNote notes, Planner plans, and more." ms.localizationpriority: high-+ doc_type: conceptualPageType The following table lists common use cases for Microsoft Teams APIs in Microsoft | Use cases | REST resources | See also | |:--|:--|:--|-| Create and manage teams, groups and channels | [team](../resources/team.md), [channel](../resources/channel.md), [group](../resources/group.md) | [create team](../api/team-put-teams.md), [list teams](../api/user-list-joinedteams.md), [create a channel](../api/channel-post.md) | -| Add tabs, manage or install apps in the Microsoft Teams app catalog | [teamsTab](../resources/teamstab.md), [teamsAppInstallation](../resources/teamsappinstallation.md) | [create teamsTab](../api/channel-post-tabs.md), [list teamsTab](../api/channel-list-tabs.md), [list installedApps](../api/appcatalogs-list-teamsapps.md) | +| Create and manage teams, groups, and channels | [team](../resources/team.md), [channel](../resources/channel.md), [group](../resources/group.md) | [create team](../api/team-put-teams.md), [list teams](../api/user-list-joinedteams.md), [create a channel](../api/channel-post.md) | +| Add tabs, manage, or install apps in the Microsoft Teams app catalog | [teamsTab](../resources/teamstab.md), [teamsAppInstallation](../resources/teamsappinstallation.md) | [create teamsTab](../api/channel-post-tabs.md), [list teamsTab](../api/channel-list-tabs.md), [list installedApps](../api/appcatalogs-list-teamsapps.md) | | Create channels and chats to send and receive chat messages | [channel](../resources/channel.md), [chat](../resources/chat.md), [chatMessage](../resources/chatmessage.md) | [create channel](../api/channel-post.md), [list channel](../api/channel-list.md), [send chatMessage in a channel](../api/chatmessage-post.md) | | Use tags to classify users or groups based on common attributes within a team | [teamworkTag](../resources/teamworktag.md), [teamworkTagMember](../resources/teamworktagmember.md) | [list teamworkTag](../api/teamworktag-list.md), [create teamworkTag](../api/teamworktag-post.md) | | Create and receive calls, call records or retrieve meeting coordinates | [call](../resources/call.md), [callRecords](../resources/callrecords-api-overview.md) | [answer](../api/call-answer.md), [invite participants](../api/participant-invite.md) | | Connect bots to calls and implement interactive voice response (IVR) | [call](../resources/call.md) | [IVR scenarios](#ivr-scenarios) | | Create and retrieve online meetings or check users presence and activity | [onlineMeeting](../resources/onlinemeeting.md), [presence](../resources/presence.md) | [create onlineMeeting](../api/application-post-onlinemeetings.md), [meetingAttendanceReport](../resources/meetingattendancereport.md) | -| Create and manage workforce integration with shifts, schedules, time cards or time off in your organization | [workforceIntegration](../resources/workforceintegration.md), [schedule](../resources/schedule.md), [shift](../resources/shift.md), [timeOff](../resources/timeoff.md), [timeOffReason](../resources/timeoffreason.md) | [create workforceIntegration](../api/workforceintegration-post.md), [create schedule](../api/schedule-post-schedulinggroups.md), [create shift](../api/schedule-post-shifts.md), [create timeOff](../api/schedule-post-timesoff.md) | +| Create and manage workforce integration with shifts, schedules, time cards, or time off in your organization | [workforceIntegration](../resources/workforceintegration.md), [schedule](../resources/schedule.md), [shift](../resources/shift.md), [timeOff](../resources/timeoff.md), [timeOffReason](../resources/timeoffreason.md) | [create workforceIntegration](../api/workforceintegration-post.md), [create schedule](../api/schedule-post-schedulinggroups.md), [create shift](../api/schedule-post-shifts.md), [create timeOff](../api/schedule-post-timesoff.md) | | Use the employee learning API to integrate with Viva Learning | [employee learning](../resources/viva-learning-api-overview.md), [learningProvider](../resources/learningprovider.md), [learningContent](../resources/learningcontent.md) | [list learningProviders](../api/employeeexperience-list-learningproviders.md), [list learningContents](../api/learningprovider-list-learningcontents.md) | ### IVR scenarios If your app polls to see whether a resource has changed, you can only do that on If you need to hear about changes more frequently than that, you should [create a subscription](../api/subscription-post-subscriptions.md) to that resource and receive change notifications (webhooks). If you don't find support for the type of subscription you need, we encourage you to provide feedback via the [Microsoft 365 Developer Platform ideas forum](https://techcommunity.microsoft.com/t5/microsoft-365-developer-platform/idb-p/Microsoft365DeveloperPlatform/label-name/Microsoft%20Graph). -When polling for new messages, you must specify a date range where supported. For details, see [get channel messages delta](../api/chatmessage-delta.md). +When polling for new messages, you must specify a date range where supported. For more information, see [get delta chat messages for a user](../api/chatmessage-delta.md). Polling is doing a GET operation on a resource over and over again to see if that resource has changed. You're allowed to GET the same resource multiple times a day, as long as it's not polling.-For example, it is okay to GET /me/joinedTeams every time the user visits/refreshes your web page, -but it is not okay to GET /me/joinedTeams in a loop every 30 seconds to refresh that web page. +For example, it's okay to GET /me/joinedTeams every time the user visits/refreshes your web page, +but it isn't okay to GET /me/joinedTeams in a loop every 30 seconds to refresh that web page. Apps that don't follow these polling requirements will be considered in violation of the [Microsoft APIs Terms of Use](/legal/microsoft-apis/terms-of-use). This may result in additional [throttling](/graph/throttling) |
v1.0 | Teamsapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsapp.md | Title: "teamsApp resource type" description: "Represents an app in the Microsoft Teams app catalog."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamsappauthorization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsappauthorization.md | The authorization details of a [teamsApp](teamsapp.md). ## Properties |Property|Type|Description| |:|:|:|+|clientAppId|String|The registration ID of the Microsoft Entra app ID associated with the [teamsApp](teamsapp.md). | |requiredPermissionSet|[teamsAppPermissionSet](../resources/teamsapppermissionset.md)|Set of permissions required by the [teamsApp](teamsapp.md).| ## Relationships The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.teamsAppAuthorization",+ "clientAppId": "String", "requiredPermissionSet": { "@odata.type": "microsoft.graph.teamsAppPermissionSet" } } ```- |
v1.0 | Teamsappdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsappdefinition.md | Title: "teamsAppDefinition resource type" description: "The details of one version of a teamsApp."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamsappinstalledstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsappinstalledstate.md | Title: "Members" description: "Describes the current installation status of a teamsApp."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamsasyncoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsasyncoperation.md | Title: "teamsAsyncOperation resource type" description: "A Microsoft Teams async operation is an operation that transcends the lifetime of a single API request. "-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamsasyncoperationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsasyncoperationstatus.md | Title: "teamsAsyncOperationStatus enum type" description: "Describes the current status of a teamsAsyncOperation."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamsasyncoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamsasyncoperationtype.md | Title: "teamsAsyncOperationType enum type" description: "Types of teamsAsyncOperation. Members are added here as more async operations are supported."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamscatalogapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamscatalogapp.md | Title: "teamsCatalogApp resource type" description: "see teamsApp."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamspecialization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamspecialization.md | Title: "teamSpecialization enum type" description: "Describes the special use case for a team."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamstabconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamstabconfiguration.md | Title: "teamsTabConfiguration resource type (Open Type)" description: "The settings that determine the content of a tab."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamstemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamstemplate.md | Title: "teamsTemplate resource type" description: "Describes the teamsTemplate entity."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamtemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamtemplate.md | Title: "teamTemplate resource type" description: "Represents a logical container for all the definitions and versions of the same team template."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamvisibilitytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamvisibilitytype.md | Title: "Members" description: "Describes the visibility of a team. "-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamwork | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/teamwork.md | Inherits from [entity](../resources/entity.md). |:|:|:| |id|string|The default teamwork identifier.| |isTeamsEnabled|Boolean|Indicates whether Microsoft Teams is enabled for the organization.| -|region|string|Represents the region of the organization or the tenant. The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israe`l, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| +|region|string|Represents the region of the organization or the tenant. The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israel`, `Spain`, `Mexico`, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| ## Relationships | Relationship | Type | Description | |
v1.0 | Tenantappmanagementpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/tenantappmanagementpolicy.md | Inherits from [policyBase](policybase.md). | Method | Return type | Description | | :- | :- | :- |-| [Get](../api/tenantappmanagementpolicy-get.md) | tenantAppManagementPolicy | Read the properties of the default app management policy set for applications and service principals. | +| [Get](../api/tenantappmanagementpolicy-get.md) | [tenantAppManagementPolicy](../resources/tenantappmanagementpolicy.md) | Read the properties of the default app management policy set for applications and service principals. | | [Update](../api/tenantappmanagementpolicy-update.md) | None | Updates the default app management policy for applications and service principals. | ## Properties Inherits from [policyBase](policybase.md). | displayName | String | The display name of the default policy. Inherited from [policyBase](policybase.md). | | description | String | The description of the default policy. Inherited from [policyBase](policybase.md). | | isEnabled | Boolean | Denotes whether the policy is enabled. Default value is `false`. |-| applicationRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all application objects in the tenant. | -| servicePrincipalRestrictions | [appManagementConfiguration](../resources/appManagementConfiguration.md) | Restrictions that apply as default to all service principal objects in the tenant. | +| applicationRestrictions | [appManagementApplicationConfiguration](../resources/appmanagementapplicationconfiguration.md) | Restrictions that apply as default to all application objects in the tenant. | +| servicePrincipalRestrictions | [appManagementServicePrincipalConfiguration](../resources/appmanagementserviceprincipalconfiguration.md) | Restrictions that apply as default to all service principal objects in the tenant. | ## Relationships The following JSON representation shows the resource type. "displayName": "string", "isEnabled": false, "applicationRestrictions": {- "@odata.type":"microsoft.graph.appManagementConfiguration" + "@odata.type":"microsoft.graph.appManagementApplicationConfiguration" }, "servicePrincipalRestrictions": {- "@odata.type":"microsoft.graph.appManagementConfiguration" + "@odata.type":"microsoft.graph.appManagementServicePrincipalConfiguration" } } ``` |
v1.0 | Timeslot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/timeslot.md | Title: "timeSlot resource type" -description: "A time period." +description: "Represents a time slot for a meeting." ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Toomanyglobaladminsassignedtotenantalertconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/toomanyglobaladminsassignedtotenantalertconfiguration.md | Triggered if two different criteria are met, and you can configure both of them. Inherits from [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertConfiguration](../resources/unifiedrolemanagementalertconfiguration.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Toomanyglobaladminsassignedtotenantalertincident | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/toomanyglobaladminsassignedtotenantalertincident.md | The threshold that triggers this incident when its reached is defined in the [to Inherits from [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [unifiedRoleManagementAlertIncident](../resources/unifiedrolemanagementalertincident.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Trustframeworkpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/trustframeworkpolicy.md | Title: "trustFrameworkPolicy" description: "In the Azure AD B2C trust framework policy is referred to as custom policies. This describes the operations available on a trustFrameworkPolicy object for the tenant." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/user.md | This resource supports: | [Get free/busy schedule](../api/calendar-getschedule.md) | [scheduleInformation](scheduleinformation.md) | Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified period. | | [List calendar view](../api/user-list-calendarview.md) | [event](event.md) collection | Get an event object collection. | | [Reminder view](../api/user-reminderview.md) | [Reminder](reminder.md) collection | Return a list of calendar reminders within the start and end times specified.|+| **Cloud licensing**||| +|[List usage rights](../api/cloudlicensing-usercloudlicensing-list-usagerights.md)|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md) collection|Get a list of the [usageRight](../resources/cloudlicensing-usageright.md) objects granted to a user.| +|[Get usage right](../api/cloudlicensing-usageright-get.md)|[microsoft.graph.cloudLicensing.usageRight](../resources/cloudlicensing-usageright.md)|Get the properties and relationships of a [usageRight](../resources/cloudlicensing-usageright.md) object granted to a user.| | **Cloud PC**||| |[List cloud PCs](../api/user-list-cloudpcs.md)|[cloudPC](../resources/cloudpc.md) collection|List the [cloudPC](../resources/cloudpc.md) devices that are attributed to the signed-in user.| |[Get launch info](../api/cloudpc-getcloudpclaunchinfo.md)|[cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md)|Get the [cloudPCLaunchInfo](../resources/cloudpclaunchinfo.md) for the signed-in user.| This resource supports: | birthday | DateTimeOffset | The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z` <br><br>Returned only on `$select`. | | businessPhones | String collection | The telephone numbers for the user. Only one number can be set for this property. <br><br>Read-only for users synced from on-premises directory. Supports `$filter` (`eq`, `not`, `ge`, `le`, `startsWith`).| | city | String | The city where the user is located. Maximum length is 128 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). |+| cloudLicensing | [microsoft.graph.cloudLicensing.userCloudLicensing](../resources/cloudlicensing-usercloudlicensing.md) | The relationships of a user to cloud licensing resources. | | cloudRealtimeCommunicationInfo | [cloudRealtimeCommunicationInfo](cloudrealtimecommunicationinfo.md) | Microsoft realtime communication information related to the user. <br> Supports `$filter` (`eq`, `ne`,`not`).| | companyName | String | The name of the company the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.<br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| | consentProvidedForMinor | [consentProvidedForMinor](#consentprovidedforminor-values) | Sets whether consent has been obtained for minors. Allowed values: `null`, `Granted`, `Denied` and `NotRequired`. Refer to the [legal age group property definitions](#legal-age-group-property-definitions) for further information. <br><br>Supports `$filter` (`eq`, `ne`, `not`, and `in`).| | country | String | The country or region where the user is located; for example, `US` or `UK`. Maximum length is 128 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). | | createdDateTime | DateTimeOffset | The date and time the user was created in ISO 8601 format and UTC. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is `null` for some users created before June 2018 and on-premises users synced to Microsoft Entra ID before June 2018. Read-only. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). | | creationType | String | Indicates whether the user account was created through one of the following methods: <br/> <ul><li>As a regular school or work account (`null`). <li>As an external account (`Invitation`). <li>As a local account for an Azure Active Directory B2C tenant (`LocalAccount`). <li>Through self-service sign-up by an internal user using email verification (`EmailVerified`). <li>Through self-service sign-up by an external user signing up through a link that is part of a user flow (`SelfServiceSignUp`). </ul> <br>Read-only.<br>Supports `$filter` (`eq`, `ne`, `not`, and `in`). |-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). The filter value is case-sensitive.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). The filter value is case-sensitive. <br><li>To read this property, the calling app must be assigned the *CustomSecAttributeAssignment.Read.All* permission. To write this property, the calling app must be assigned the *CustomSecAttributeAssignment.ReadWrite.All* permissions. <li>To read or write this property in delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). | | deletedDateTime | DateTimeOffset | The date and time the user was deleted. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, and `in`). | | department | String | The name of the department where the user works. Maximum length is 64 characters.<br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, and `eq` on `null` values). | | displayName | String | The name displayed in the address book for the user. This value is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created, and it cannot be cleared during updates. Maximum length is 256 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$orderby`, and `$search`.| | employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work if there is a future hire. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).|-| employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. <br><br>To read this property, the calling app must be assigned the *User-LifeCycleInfo.Read.All* permission. To write this property, the calling app must be assigned the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator*, *Global Reader*. To write this property in delegated scenarios, the admin needs the *Global Administrator* role. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). <br><br>For more information, see [Configure the employeeLeaveDateTime property for a user](/graph/tutorial-lifecycle-workflows-set-employeeleavedatetime).| +| employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. <br><li>To read this property, the calling app must be assigned the *User-LifeCycleInfo.Read.All* permission. To write this property, the calling app must be assigned the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* permissions. <li>To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator* (least privilege), *Global Reader*. To write this property in delegated scenarios, the admin needs the *Global Administrator* role. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). <br><br>For more information, see [Configure the employeeLeaveDateTime property for a user](/graph/tutorial-lifecycle-workflows-set-employeeleavedatetime).| | employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters.<br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |employeeOrgData|[employeeOrgData](employeeorgdata.md) |Represents organization data (for example, division and costCenter) associated with a user. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).| | employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`).| This resource supports: | mobilePhone | String | The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values) and `$search`.| | mySite | String | The URL for the user's site. <br><br>Returned only on `$select`. | | officeLocation | String | The office location in the user's place of business. Maximum length is 128 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values). |-| onPremisesDistinguishedName | String | Contains the on-premises Active Directory `distinguished name` or `DN`. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. | -| onPremisesDomainName | String | Contains the on-premises `domainFQDN`, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. | -|onPremisesExtensionAttributes|[onPremisesExtensionAttributes](onpremisesextensionattributes.md)|Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. <br><li>For an **onPremisesSyncEnabled** user, the source of authority for this set of properties is the on-premises and is read-only. </li><li>For a cloud-only user (where **onPremisesSyncEnabled** is `false`), these properties can be set during the creation or update of a user object. </li><li>For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.</li><br> Supports `$filter` (`eq`, `ne`, `not`, `in`). | +| onPremisesDistinguishedName | String | Contains the on-premises Active Directory `distinguished name` or `DN`. | +| onPremisesDomainName | String | Contains the on-premises `domainFQDN`, also called dnsDomainName synchronized from the on-premises directory. | +|onPremisesExtensionAttributes|[onPremisesExtensionAttributes](onpremisesextensionattributes.md)|Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. <br><li>For an **onPremisesSyncEnabled** user, the source of authority for this set of properties is the on-premises and is read-only. </li><li>For a cloud-only user (where **onPremisesSyncEnabled** is `false`), these properties can be set during the creation or update of a user object. </li><li>For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.</li><br> Supports `$filter` (`eq`, `ne`, `not`, `in`). | | onPremisesImmutableId | String | This property associates an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's `userPrincipalName` (UPN) property. **Note:** The **$** and **\_** characters can't be used when specifying this property. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`). | | onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the object was synced with the on-premises directory; for example: "2013-02-16T03:04:54Z". The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`). | | onPremisesProvisioningErrors | [onPremisesProvisioningError](onpremisesprovisioningerror.md) collection | Errors when using Microsoft synchronization product during provisioning. <br> Supports `$filter` (`eq`, `not`, `ge`, `le`).|-| onPremisesSamAccountName | String | Contains the on-premises `sAMAccountName` synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.<br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`).| -| onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user synchronized from on-premises to the cloud. Read-only. Supports `$filter` (`eq` including on `null` values). | +| onPremisesSamAccountName | String | Contains the on-premises `sAMAccountName` synchronized from the on-premises directory. <br><br> Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`).| +| onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user synchronized from on-premises to the cloud. Must be in the format of SID, such as "S-1-5-21-1180699209-877415012-3182824384-1006". Supports `$filter` (`eq` including on `null` values). | |onPremisesSipInfo|[onPremisesSipInfo](../resources/onpremisessipinfo.md)|Contains all on-premises Session Initiation Protocol (SIP) information related to the user. Read-only.| | onPremisesSyncEnabled | Boolean | `true` if this user object is currently being synced from an on-premises Active Directory (AD); otherwise, the user isn't being synced and can be managed in Microsoft Entra ID. Read-only. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). |-| onPremisesUserPrincipalName | String | Contains the on-premises `userPrincipalName` synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`). | +| onPremisesUserPrincipalName | String | Contains the on-premises `userPrincipalName` synchronized from the on-premises directory. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`). | | otherMails | String collection | A list of additional email addresses for the user; for example: `["bob@contoso.com", "Robert@fabrikam.com"]`.<br>NOTE: This property can't contain accent characters.<br><br>Supports `$filter` (`eq`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, `/$count eq 0`, `/$count ne 0`). | | passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two may be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`. For more information on the default password policies, see [Microsoft Entra password policies](/azure/active-directory/authentication/concept-sspr-policy#password-policies-that-only-apply-to-cloud-user-accounts). <br><br>Supports `$filter` (`ne`, `not`, and `eq` on `null` values).|-| passwordProfile | [passwordProfile](passwordprofile.md) | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values).| +| passwordProfile | [passwordProfile](passwordprofile.md) | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). <br><br>To update this property: <br><li> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. <li> In application-only access, the calling app must be assigned the *User.ReadWrite.All* (least privilege) or *Directory.ReadWrite.All* (higher privilege) application permission *and* at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).| | pastProjects | String collection | A list for users to enumerate their past projects. <br><br>Returned only on `$select`. | | postalCode | String | The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. <br><br>Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| | preferredDataLocation | String | The preferred data location for the user. For more information, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction).| For example, Cameron is an administrator of a directory for an elementary school |scopedRoleMemberOf|[scopedRoleMembership](scopedrolemembership.md) collection| The scoped-role administrative unit memberships for this user. Read-only. Nullable.| |security|[security](security.md) |Nullable.| |settings|[userSettings](usersettings.md) | Read-only. Nullable.|+|solutions|[userSolutionRoot](../resources/usersolutionroot.md)| Represents a user's custom solution entity. Read-Only. Nullable.| |sponsors|[directoryObject](../resources/directoryobject.md) collection|The users and groups responsible for this guest user's privileges in the tenant and keep the guest user's information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports `$expand`.| |teamwork|[userTeamwork](userteamwork.md)| A container for Microsoft Teams features available for the user. Read-only. Nullable.| |todo|[todo](todo.md)|Represents the To Do services available to a user. | The following JSON representation shows the resource type. "birthday": "String (timestamp)", "businessPhones": ["String"], "city": "String",+ "cloudLicensing": { "@odata.type": "microsoft.graph.cloudLicensing.userCloudLicensing" }, "cloudRealtimeCommunicationInfo": { "@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo" }, |
v1.0 | Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/users.md | The user ID or userPrincipalName is always the signed-in user's. | Reset password | `POST /users/{id or userPrincipalName}/authentication/methods/{id}/resetPassword` where the authentication method ID is always `28c10230-6103-485e-b985-444c60001490`. | UserAuthenticationMethod.ReadWrite | --> -### Who can reset passwords +## Sensitive actions -In the following table, the columns list the roles that can reset passwords and invalidate refresh tokens. The rows list the roles for which their password can be reset. For example, a Password Administrator can reset the password for Directory Readers, Guest Inviter, Password Administrator, and users with no administrator role. If a user is assigned any other role, the Password Administrator cannot reset their password. --The following table is for roles assigned at the scope of a tenant. For roles assigned at the scope of an administrative unit, [further restrictions apply](/entra/identity/role-based-access-control/admin-units-assign-roles#roles-that-can-be-assigned-with-administrative-unit-scope). --| Role that password can be reset | Password Admin | Helpdesk Admin | Auth Admin | User Admin | Privileged Auth Admin | Global Admin | -| | | | | | | | -| Auth Admin | | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | -| Directory Readers | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Global Admin | | | | | :white_check_mark: | :white_check_mark:\* | -| Groups Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Guest Inviter | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Helpdesk Admin | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Message Center Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Password Admin | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Privileged Auth Admin | | | | | :white_check_mark: | :white_check_mark: | -| Privileged Role Admin | | | | | :white_check_mark: | :white_check_mark: | -| Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| User<br/>(no admin role) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| User<br/>(no admin role, but member or owner of a role-assignable group) | | | | | :white_check_mark: | :white_check_mark: | -| User with a role scoped to a restricted management administrative unit | | | | | :white_check_mark: | :white_check_mark: | -| User Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Usage Summary Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| All custom roles | | | | | :white_check_mark: | :white_check_mark: | --The ability to reset a password includes the ability to update the following sensitive properties required for [self-service password reset](/entra/identity/authentication/concept-sspr-howitworks): -> - businessPhones -> - mobilePhone -> - otherMails --### Who can perform sensitive actions --Some administrators can perform the following sensitive actions for some users. All users can read the sensitive properties. +The following actions against the user object are considered sensitive and might be locked down to only specific administrators. All users can read the sensitive properties. | Sensitive action | Sensitive property name | ||-| Some administrators can perform the following sensitive actions for some users. | Update user principal name | userPrincipalName | | Delete or restore users | Not applicable | +### Who can perform sensitive actions ++Some administrators can perform the preceding sensitive actions for some users. + In the following table, the columns list the roles that can perform sensitive actions. The rows list the roles for which the sensitive action can be performed upon. The following table is for roles assigned at the scope of a tenant. For roles assigned at the scope of an administrative unit, [further restrictions apply](/entra/identity/role-based-access-control/admin-units-assign-roles#roles-that-can-be-assigned-with-administrative-unit-scope). The following table is for roles assigned at the scope of a tenant. For roles as | Usage Summary Reports Reader | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | All custom roles | | | :white_check_mark: | :white_check_mark: | +### Who can reset passwords ++In the following table, the columns list the roles that can reset passwords and invalidate refresh tokens. The rows list the roles for which their password can be reset. For example, a Password Administrator can reset the password for Directory Readers, Guest Inviter, Password Administrator, and users with no administrator role. If a user is assigned any other role, the Password Administrator cannot reset their password. ++The following table is for roles assigned at the scope of a tenant. For roles assigned at the scope of an administrative unit, [further restrictions apply](/entra/identity/role-based-access-control/admin-units-assign-roles#roles-that-can-be-assigned-with-administrative-unit-scope). ++| Role that password can be reset | Password Admin | Helpdesk Admin | Auth Admin | User Admin | Privileged Auth Admin | Global Admin | +| | | | | | | | +| Auth Admin | | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | +| Directory Readers | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Global Admin | | | | | :white_check_mark: | :white_check_mark:\* | +| Groups Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Guest Inviter | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Helpdesk Admin | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Message Center Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Password Admin | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Privileged Auth Admin | | | | | :white_check_mark: | :white_check_mark: | +| Privileged Role Admin | | | | | :white_check_mark: | :white_check_mark: | +| Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| User<br/>(no admin role) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| User<br/>(no admin role, but member or owner of a role-assignable group) | | | | | :white_check_mark: | :white_check_mark: | +| User with a role scoped to a restricted management administrative unit | | | | | :white_check_mark: | :white_check_mark: | +| User Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Usage Summary Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| All custom roles | | | | | :white_check_mark: | :white_check_mark: | ++The ability to reset a password includes the ability to update the following sensitive properties required for [self-service password reset](/entra/identity/authentication/concept-sspr-howitworks): +> - businessPhones +> - mobilePhone +> - otherMails + ## User and group search limitations for guest users in organizations User and group search capabilities allow the app to search for any user or group in an organization's directory by performing queries against the `/users` or `/groups` resource set (for example, `https://graph.microsoft.com/v1.0/users`). Both administrators and users who are members have this capability; however, guest users don't. |
v1.0 | Userset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userset.md | Title: "userSet complex type" + Title: "userSet resource type" description: "The abstract base type for types used in the request, approval, and assignment review settings of an access package assignment policy." ms.localizationpriority: medium -# userSet complex type +# userSet resource type Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Used in the request, approval, and assignment review settings of an [access package assignment policy](accesspackageassignmentpolicy.md). It is an abstract base type inherited by the following resource types: +Used in the request, approval, and assignment review settings of an [access package assignment policy](accesspackageassignmentpolicy.md). It's an abstract base type inherited by the following resource types: + [singleUser](singleuser.md) + [groupMembers](groupmembers.md) + [connectedOrganizationMembers](connectedorganizationmembers.md) None. ## JSON representation -The following is a JSON representation of userSet. A [userSet](userset.md) is an abstract base class and so would not be sent or received. Instead, one of the following `@odata.type` values representing the inherited types would be used: +The following JSON representation shows the resource type. A [userSet](userset.md) is an abstract base class and so wouldn't be sent or received. Instead, one of the following `@odata.type` values representing the inherited types would be used: + `#microsoft.graph.singleUser` + `#microsoft.graph.groupMembers` + `#microsoft.graph.connectedOrganizationMembers` |
v1.0 | Usersolutionroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/usersolutionroot.md | + + Title: "userSolutionRoot resource type" +description: "Represents a user's custom userSolutionRoot entity." ++ms.localizationpriority: medium ++++# userSolutionRoot resource type ++Namespace: microsoft.graph +++Represents a user's custom solution entity. ++## Properties ++|Property|Type|Description| +|:|:|:| +|id|String|A unique programmatic identifier for the entity. Read-only.| ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|workingTimeSchedule|[workingTimeSchedule](../resources/workingtimeschedule.md)|The working time schedule entity associated with the solution.| ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.userSolutionRoot", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userSolutionRoot", + "id": "String (identifier)" +} +``` |
v1.0 | Userteamwork | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/userteamwork.md | Represents a container for the range of Microsoft Teams functionalities that are |:|:--|:-| |id| String|The unique identifier for the **userTeamwork** object.| |locale|String |Represents the location that a user selected in Microsoft Teams and doesn't follow the Office's locale setting. A userΓÇÖs locale is represented by their preferred language and country or region. For example, `en-us`. The language component follows two-letter codes as defined in [ISO 639-1](https://www.iso.org/iso/home/standards/language_codes.htm), and the country component follows two-letter codes as defined in [ISO 3166-1 alpha-2](https://www.iso.org/iso/country_codes.htm).| -|region|string|Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region.<br><br>The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israe`l, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| +|region|string|Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region.<br><br>The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israel`, `Spain`, `Mexico`, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| ## Relationships |
v1.0 | Uxsetting | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/uxsetting.md | + + Title: "uxSetting resource type" +description: "Represents settings related to access to the Microsoft Entra admin center." ++ms.localizationpriority: medium ++toc. Title: Microsoft Entra admin center settings +++# uxSetting resource type ++Namespace: microsoft.graph +++Represents settings related to access to the Microsoft Entra admin center. ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get](../api/uxsetting-get.md)|[uxSetting](../resources/uxsetting.md)|Get the properties and relationships of a [uxSetting](../resources/uxsetting.md) object.| +|[Update](../api/uxsetting-update.md)|None|Update the properties of a [uxSetting](../resources/uxsetting.md) object.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|id| String | The unique identifier for the tenant.| +|restrictNonAdminAccess|nonAdminSetting|If set to `true`, nonadministrators can't browse the Microsoft Entra admin center. Nonadministrators who are owners of groups or applications are unable to use the Azure portal to manage their owned resources. If set to `false`, nonadministrators can browse the Microsoft Entra admin center. The possible values are: `false`, `true`, `unknownFutureValue`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.uxSetting", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.uxSetting", + "id": "String (identifier)", + "restrictNonAdminAccess": "String" +} +``` |
v1.0 | Virtualendpoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualendpoint.md | Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -> [!CAUTION] -> The **cloudPcSharedUseServicePlan** resource is deprecated and stopped returning data on October 8, 2023. Existing apps that use this feature with the **cloudPcSharedUseServicePlan** should be updated. - Represents a container for APIs to manage Cloud PCs. Use the Cloud PC API to provision and manage virtual desktops for employees in an organization, or along with the [Intune API](../resources/intune-graph-overview.md) to manage physical and virtual endpoints. Inherits from [entity](../resources/entity.md). |[List external partner settings](../api/virtualendpoint-list-externalpartnersettings.md)|[cloudPcExternalPartnerSetting](../resources/cloudpcexternalpartnersetting.md) collection|Get a list of the [cloudPcExternalPartnerSetting](../resources/cloudpcexternalpartnersetting.md) objects and their properties.| |[Create external partner setting](../api/virtualendpoint-post-externalpartnersettings.md)|[cloudPcExternalPartnerSetting](../resources/cloudpcexternalpartnersetting.md)|Create a new [cloudPcExternalPartnerSetting](../resources/cloudpcexternalpartnersetting.md) object.| |[List front line service plans](../api/virtualendpoint-list-frontlineserviceplans.md) |[cloudPcFrontLineServicePlan](../resources/cloudpcfrontlineserviceplan.md) collection|Get a list of the [cloudPcFrontLineServicePlan](../resources/cloudpcfrontlineserviceplan.md) objects and their properties.|-|[List shared use service plans](../api/virtualendpoint-list-shareduseserviceplans.md) (deprecated)|[cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) collection|List properties and relationships of the [cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) objects.| |[List bulk actions](../api/virtualendpoint-list-bulkactions.md)|[cloudPcBulkAction](../resources/cloudpcbulkaction.md) collection|Get a list of the [cloudPcBulkAction](../resources/cloudpcbulkaction.md) objects and their properties.| |[Create bulk action](../api/virtualendpoint-post-bulkactions.md)|[cloudPcBulkAction](../resources/cloudpcbulkaction.md)|Create a new [cloudPcBulkAction](../resources/cloudpcbulkaction.md) object.| |[Retrieve tenant encryption setting](../api/virtualendpoint-retrievetenantencryptionsetting.md)|[cloudPcTenantEncryptionSetting](../resources/cloudPcTenantEncryptionSetting.md)|Retrieve the [cloudPcTenantEncryptionSetting](../resources/cloudPcTenantEncryptionSetting.md) associated with the current authenticated user.| Inherits from [entity](../resources/entity.md). |snapshots|[cloudPcSnapshot](../resources/cloudpcsnapshot.md) collection|Cloud PC snapshots.| |supportedRegions|[cloudPcSupportedRegion](../resources/cloudpcsupportedregion.md) collection|Cloud PC supported regions.| |userSettings|[cloudPcUserSetting](../resources/cloudpcusersetting.md) collection|Cloud PC user settings. |-|sharedUseServicePlans (deprecated)|[cloudPcSharedUseServicePlan](../resources/cloudpcshareduseserviceplan.md) collection|Cloud PC shared-use service plans. The **sharedUseServicePlans** relationship is deprecated and stopped returning data on October 8, 2023. Going forward, use the **frontLineServicePlans** relationship.| |tenantEncryptionSetting|[cloudPcTenantEncryptionSetting](../resources/cloudPcTenantEncryptionSetting.md) collection|Cloud PC encryption setting for a tenant. | ## JSON representation |
v1.0 | Virtualeventexternalregistrationinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventexternalregistrationinformation.md | + + Title: "virtualEventExternalRegistrationInformation resource type" +description: "Represents the external information for a virtual event registration." ++ms.localizationpriority: medium ++++# virtualEventExternalRegistrationInformation resource type ++Namespace: microsoft.graph +++Represents the external information for a [virtual event registration](../resources/virtualeventregistration.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|referrer|String| A URL or string that represents the location from which the registrant registered. Optional. | +|registrationId|String| The identifier for a **virtualEventExternalRegistrationInformation** object. Optional. If set, the maximum supported length is 256 characters.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.virtualEventExternalRegistrationInformation" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.virtualEventExternalRegistrationInformation", + "referrer": "String", + "registrationId": "String" +} +``` |
v1.0 | Virtualeventregistration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventregistration.md | Inherits from [entity](../resources/entity.md). |:|:|:| |cancelationDateTime|DateTimeOffset|Date and time when the registrant cancels their registration for the virtual event. Only appears when applicable. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |email|String|Email address of the registrant.|+|externalRegistrationInformation|[virtualEventExternalRegistrationInformation](../resources/virtualeventexternalregistrationinformation.md)| The external information for a virtual event registration. | |firstName|String|First name of the registrant.| |id|String|Unique identifier of the registrant. Read-only. Inherited from [entity](../resources/entity.md).| |lastName|String|Last name of the registrant.| Inherits from [entity](../resources/entity.md). | waitlisted | Waitlist is enabled and the virtual event is at full capacity. The attendee is on the waitlist. | | pendingApproval | Manual approval is enabled and the attendee is pending approval from the organizer. | | rejectedByOrganizer | Manual approval is enabled and the organizer rejected the attendee. |-| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## JSON representation The following JSON representation shows the resource type "@odata.type": "#microsoft.graph.virtualEventRegistration", "cancelationDateTime": "String (timestamp)", "email": "String",+ "externalRegistrationInformation": {"@odata.type": "microsoft.graph.virtualEventExternalRegistrationInformation"}, "firstName": "String", "id": "String (identifier)", "lastName": "String", |
v1.0 | Virtualeventsession | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventsession.md | Namespace: microsoft.graph Represents a session in a [virtualEvent](../resources/virtualevent.md). -Inherits from [onlineMeetingBase](../resources/onlinemeetingBase.md). +Inherits from [onlineMeetingBase](../resources/onlinemeetingbase.md). ## Methods Inherits from [onlineMeetingBase](../resources/onlinemeetingBase.md). | Property | Type | Description | | :-- | :-- | : |-| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowMeetingChat | [meetingChatMode](#meetingchatmode-values) | Specifies the mode of meeting chat. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowParticipantsToChangeName | Boolean | Specifies whether participants are allowed to rename themselves in an instance of the meeting. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowTranscription | Boolean | Indicates whether transcription is enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowRecording | Boolean | Indicates whether recording is enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a virtual event session. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| anonymizeIdentityForRoles | onlineMeetingRole collection | Specifies whose identity is anonymized in the virtual event session. Possible values are: `attendee`. The `attendee` value can't be removed through a PATCH operation once added. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md).| -| audioConferencing | [audioConferencing](audioconferencing.md) | The phone access (dial-in) information for the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| chatInfo | [chatInfo](chatinfo.md) | The chat information associated with the virtual event session. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| allowAttendeeToEnableCamera | Boolean | Indicates whether attendees can turn on their camera. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowAttendeeToEnableMic | Boolean | Indicates whether attendees can turn on their microphone. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowBreakoutRooms | Boolean | Indicates whether breakout rooms are enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowedLobbyAdmitters | [allowedLobbyAdmitterRoles](../resources/onlinemeetingbase.md#allowedlobbyadmitterroles-values) | Specifies the users who can admit from the lobby. Possible values are: `organizerAndCoOrganizersAndPresenters`, `organizerAndCoOrganizers`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowedPresenters | [onlineMeetingPresenters](#onlinemeetingpresenters-values)| Specifies who can be a presenter in a virtual event session. Possible values are: `everyone`, `organization`, `roleIsPresenter`, `organizer`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowLiveShare | [meetingLiveShareOptions](#meetingliveshareoptions-values) | Indicates whether live share is enabled for the virtual event session. Possible values are: `enabled`, `disabled`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowMeetingChat | [meetingChatMode](#meetingchatmode-values) | Specifies the mode of meeting chat. Possible values are: `enabled`, `disabled`, `limited`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowParticipantsToChangeName | Boolean | Specifies whether participants are allowed to rename themselves in an instance of the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowPowerPointSharing | Boolean | Indicates whether PowerPoint live is enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowRecording | Boolean | Indicates whether recording is enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowTranscription | Boolean | Indicates whether transcription is enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| allowWhiteboard | Boolean | Indicates whether whiteboard is enabled for the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| anonymizeIdentityForRoles | onlineMeetingRole collection | Specifies whose identity is anonymized in the virtual event session. Possible values are: `attendee`. The `attendee` value can't be removed through a PATCH operation once added. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md).| +| audioConferencing | [audioConferencing](audioconferencing.md) | The phone access (dial-in) information for the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| chatInfo | [chatInfo](chatinfo.md) | The chat information associated with the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | endDateTime | [DateTimeTimeZone](../resources/datetimetimezone.md) | The virtual event session end time. |-| id | String | The unique identifier of the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| joinInformation | [itemBody](itembody.md) | The join information of the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| joinWebUrl | String | The join URL of the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| lobbyBypassSettings | [lobbyBypassSettings](lobbyBypassSettings.md) | Specifies which participants can bypass the meeting lobby. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| recordAutomatically | Boolean | Indicates whether to record the virtual event session automatically. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| id | String | The unique identifier of the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| isEntryExitAnnounced | Boolean | Indicates whether to announce when callers join or leave. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| joinInformation | [itemBody](itembody.md) | The join information of the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| joinMeetingIdSettings | [joinMeetingIdSettings](joinmeetingidsettings.md) | Specifies the **joinMeetingId**, the meeting passcode, and the requirement for the passcode. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| joinWebUrl | String | The join URL of the virtual event session. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| lobbyBypassSettings | [lobbyBypassSettings](lobbyBypassSettings.md) | Specifies which participants can bypass the meeting lobby. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| recordAutomatically | Boolean | Indicates whether to record the virtual event session automatically. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| shareMeetingChatHistoryDefault | [meetingChatHistoryDefaultMode](#meetingchathistorydefaultmode-values) | Specifies whether meeting chat history is shared with participants. Possible values are: `all`, `none`, `unknownFutureValue`. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | | startDateTime | [DateTimeTimeZone](../resources/datetimetimezone.md) | The virtual event session start time. |-| subject | String | The subject of the virtual event session. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | -| watermarkProtection | [watermarkProtectionValues](watermarkprotectionvalues.md) | Specifies whether the client application should apply a watermark to a content type. Inherited from [onlineMeetingBase](../resources/onlineMeetingBase.md). | +| subject | String | The subject of the virtual event session. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| videoTeleconferenceId | String | The video teleconferencing ID. Read-only. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | +| watermarkProtection | [watermarkProtectionValues](watermarkprotectionvalues.md) | Specifies whether the client application should apply a watermark to a content type. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). | -### onlineMeetingPresenters values +### meetingChatHistoryDefaultMode values -| Value | Description | -| | - | -| everyone | Everyone is a presenter. Default. | -| organization | Everyone in organizerΓÇÖs organization is a presenter. | -| roleIsPresenter | Only the participants whose role is presenter are presenters. | -| organizer | Only the organizer is a presenter. | -| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +| Value | Description | +| | - | +| all | All meeting chat history is shared. | +| none | No meeting chat history is shared. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ### meetingChatMode values Inherits from [onlineMeetingBase](../resources/onlinemeetingBase.md). | | - | | enabled | Meeting chat is enabled. | | disabled | Meeting chat is disabled. |-| limited | Meeting chat is enabled but only during the meeting call. | +| limited | Meeting chat is enabled but only during the meeting call. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | -### meetingChatHistoryDefaultMode values +### meetingLiveShareOptions values | Value | Description | | | - |-| all | All meeting chat history is shared. | -| none | No meeting chat history is shared. | +| enabled | Meeting live share is enabled. | +| disabled | Meeting live share is disabled. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | +### onlineMeetingPresenters values ++| Value | Description | +| | - | +| everyone | Everyone is a presenter. Default. | +| organization | Everyone in organizerΓÇÖs organization is a presenter. | +| roleIsPresenter | Only the participants whose role is presenter are presenters. | +| organizer | Only the organizer is a presenter. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | + ## Relationships |Relationship|Type|Description| The following JSON representation shows the resource type. "@odata.type": "#microsoft.graph.virtualEventSession", "allowAttendeeToEnableCamera": "Boolean", "allowAttendeeToEnableMic": "Boolean",+ "allowBreakoutRooms": "Boolean", + "allowedLobbyAdmitters": "String", + "allowedPresenters": "String", + "allowLiveShare": "String", "allowMeetingChat": "String", "allowParticipantsToChangeName": "Boolean",+ "allowPowerPointSharing": "Boolean", + "allowRecording": "Boolean", "allowTeamworkReactions": "Boolean",- "allowedPresenters": "String", + "allowTranscription": "Boolean", + "allowWhiteboard": "Boolean", "anonymizeIdentityForRoles": ["String"], "audioConferencing": {"@odata.type": "microsoft.graph.audioConferencing"}, "chatInfo": {"@odata.type": "microsoft.graph.chatInfo"}, |
v1.0 | Virtualeventsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventsroot.md | The container for [virtual event](virtualevent.md) APIs. ## Methods -None. +|Method|Return type|Description| +|:|:|:| +| [List townhalls](../api/virtualeventsroot-list-townhalls.md) | [virtualEventTownhall](../resources/virtualeventtownhall.md) collection | Get the list of all [virtualEventTownhall](../resources/virtualeventtownhall.md) objects created in a tenant. | +| [List webinars](../api/virtualeventsroot-list-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in a tenant. | ## Properties |
v1.0 | Virtualeventtownhall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventtownhall.md | Inherits from [virtualEvent](../resources/virtualevent.md). |Method|Return type|Description| |:|:|:|+| [List](../api/virtualeventsroot-list-townhalls.md) | [virtualEventTownhall](../resources/virtualeventtownhall.md) collection | Get the list of all [virtualEventTownhall](../resources/virtualeventtownhall.md) objects created in a tenant. | | [Create](../api/virtualeventsroot-post-townhalls.md) | [virtualEventTownhall](../resources/virtualeventtownhall.md) | Create a new [virtualEventTownhall](../resources/virtualeventtownhall.md) object. | | [Get](../api/virtualeventtownhall-get.md) | [virtualEventTownhall](../resources/virtualeventtownhall.md) | Read the properties and relationships of a [virtualEventTownhall](../resources/virtualeventtownhall.md) object. | | [Update](../api/virtualeventtownhall-update.md) | [virtualEventTownhall](../resources/virtualeventtownhall.md) | Update the properties of a [virtualEventTownhall](../resources/virtualeventtownhall.md) object. | | [Publish](../api/virtualeventtownhall-publish.md) | None | Publish a [virtualEventTownhall](../resources/virtualeventtownhall.md).| | [Cancel](../api/virtualeventtownhall-cancel.md) | None | Cancel a [virtualEventTownhall](../resources/virtualeventtownhall.md).|+| [List by user role](../api/virtualeventtownhall-getbyuserrole.md) | [virtualEventTownhall](../resources/virtualeventtownhall.md) collection | Get a list of **virtualEventTownhall** objects where the signed-in user is either the organizer or a coorganizer. | +| [List by user ID and role](../api/virtualeventtownhall-getbyuseridandrole.md) | [virtualEventTownhall](../resources/virtualeventtownhall.md) collection | Get a list of **virtualEventTownhall** objects where the specified user is either the organizer or a coorganizer. | ## Properties |
v1.0 | Virtualeventwebinar | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/virtualeventwebinar.md | Inherits from [virtualEvent](../resources/virtualevent.md). | Method | Return Type |Description | | | -- | - |+| [List](../api/virtualeventsroot-list-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in a tenant. | | [Create](../api/virtualeventsroot-post-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) | Create a [virtualEventWebinar](../resources/virtualeventwebinar.md) object. | | [Get](../api/virtualeventwebinar-get.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) | Read the properties and relationships of a [virtualEventWebinar](../resources/virtualeventwebinar.md) object. | | [Update](../api/virtualeventwebinar-update.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) | Update the properties of a [virtualEventWebinar](../resources/virtualeventwebinar.md) object. | | [Publish](../api/virtualeventwebinar-publish.md) | None | Publish a [virtualEventWebinar](../resources/virtualeventwebinar.md). | | [Cancel](../api/virtualeventwebinar-cancel.md) | None | Cancel a [virtualEventWebinar](../resources/virtualeventwebinar.md). |-| [List in organization](../api/virtualeventsroot-list-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in the tenant. | -| [List by user role](../api/virtualeventwebinar-getbyuserrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the signed-in user is either the organizer or a co-organizer. | -| [List by user ID and role](../api/virtualeventwebinar-getbyuseridandrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the specified user is either the organizer or a co-organizer. | +| [List by user role](../api/virtualeventwebinar-getbyuserrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the signed-in user is either the organizer or a coorganizer. | +| [List by user ID and role](../api/virtualeventwebinar-getbyuseridandrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the specified user is either the organizer or a coorganizer. | ## Properties |
v1.0 | Webauthnpublickeycredentialcreationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/webauthnpublickeycredentialcreationoptions.md | Defines public key options for the creation of a new public key credential. For |:|:|:| |attestation|String|Attestation preference for the Microsoft Entra ID relying party.| |authenticatorSelection|[webauthnAuthenticatorSelectionCriteria](../resources/webauthnauthenticatorselectioncriteria.md)|Properties of WebAuthn authenticators allowed to be used for authentication in Microsoft Entra ID.| -|challenge|String|A challenge generated by Microsoft Entra ID and sent back with the registration request to prevent replay attacks.| +|challenge|String|A Base64-encoded challenge generated by Microsoft Entra ID and sent back with the registration request to prevent replay attacks.| |excludeCredentials|[webauthnPublicKeyCredentialDescriptor](../resources/webauthnpublickeycredentialdescriptor.md) collection|List of credentials blocked for creations in Microsoft Entra ID.| |extensions|[webauthnAuthenticationExtensionsClientInputs](../resources/webauthnauthenticationextensionsclientinputs.md)|Additional processing required by Microsoft Entra ID for the client and WebAuthn authenticator. For example, Microsoft Entra ID might require that particular information be returned in the attestation object.| |pubKeyCredParams|[webauthnPublicKeyCredentialParameters](../resources/webauthnpublickeycredentialparameters.md) collection|A set of preferred credential properties for the creation of a new public key credential in Microsoft Entra ID.| |
v1.0 | Windowsupdates Applicablecontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-applicablecontent.md | Title: "applicableContent resource type" description: "Represents content applicable for offering to the related collection of devices." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Applicablecontentdevicematch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-applicablecontentdevicematch.md | Title: "applicableContentDeviceMatch resource type" description: "Represents a collection of devices and recommendations for the applicable catalog content." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Azureaddevice | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-azureaddevice.md | Title: "azureADDevice resource type" -description: "Represents a device in Microsoft Entra ID that is registered with the deployment service." +description: "Represents a device in Microsoft Entra ID that is registered with Windows Autopatch." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a device in Microsoft Entra ID that is registered with the deployment service. +Represents a device in Microsoft Entra ID that is registered with Windows Autopatch. A Microsoft Entra device is automatically created through one of the following methods: * [updatableAsset: enrollAssets](../api/windowsupdates-updatableasset-enrollassets.md) Inherits from [updatableAsset](../resources/windowsupdates-updatableasset.md). |[List Microsoft Entra devices](../api/adminwindowsupdates-list-updatableassets-azureaddevice.md)|[microsoft.graph.windowsUpdates.azureADDevice](../resources/windowsupdates-azureaddevice.md) collection|Get a list of the [azureADDevice](../resources/windowsupdates-azureaddevice.md) objects and their properties.| |[Get Microsoft Entra device](../api/windowsupdates-azureaddevice-get.md)|[microsoft.graph.windowsUpdates.azureADDevice](../resources/windowsupdates-azureaddevice.md)|Read the properties and relationships of an [azureADDevice](../resources/windowsupdates-azureaddevice.md) object.| |[Delete Microsoft Entra device](../api/windowsupdates-azureaddevice-delete.md)|None|Delete an [azureADDevice](../resources/windowsupdates-azureaddevice.md) object.|-|[Enroll in update management](../api/windowsupdates-updatableasset-enrollassets.md)|None|Enroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources in update management by the deployment service.| -|[Enroll by ID](../api/windowsupdates-updatableasset-enrollassetsbyid.md)|None|Enroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources in update management by the deployment service.| -|[Unenroll from update management](../api/windowsupdates-updatableasset-unenrollassets.md)|None|Unenroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources from update management by the deployment service.| -|[Unenroll by ID](../api/windowsupdates-updatableasset-unenrollassetsbyid.md)|None|Unenroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources from update management by the deployment service.| +|[Enroll in update management](../api/windowsupdates-updatableasset-enrollassets.md)|None|Enroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources in update management by Windows Autopatch.| +|[Enroll by ID](../api/windowsupdates-updatableasset-enrollassetsbyid.md)|None|Enroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources of the same type in update management by Windows Autopatch.| +|[Unenroll from update management](../api/windowsupdates-updatableasset-unenrollassets.md)|None|Unenroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources from update management by Windows Autopatch.| +|[Unenroll by ID](../api/windowsupdates-updatableasset-unenrollassetsbyid.md)|None|Unenroll [azureADDevice](../resources/windowsupdates-azureaddevice.md) resources of the same type from update management by Windows Autopatch.| ## Properties |Property|Type|Description| |:|:|:|-|enrollments|[microsoft.graph.windowsUpdates.updatableAssetEnrollment](../resources/windowsupdates-updatableassetenrollment.md) collection|Specifies areas of the service in which the device is enrolled. Read-only. Returned by default.| +|enrollments|[microsoft.graph.windowsUpdates.updatableAssetEnrollment](../resources/windowsupdates-updatableassetenrollment.md) collection|Specifies areas in which the device is enrolled. Read-only. Returned by default.| |errors|[microsoft.graph.windowsUpdates.updatableAssetError](../resources/windowsupdates-updatableasseterror.md) collection|Specifies any errors that prevent the device from being enrolled in update management or receving deployed content. Read-only. Returned by default.| |id|String|An identifier for the device. Key. Not nullable. Read-only. Returned by default. Inherited from [updatableAsset](../resources/windowsupdates-updatableasset.md)| |
v1.0 | Windowsupdates Azureaddeviceregistrationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-azureaddeviceregistrationerror.md | Title: "azureADDeviceRegistrationError resource type" -description: "An error in the registration process of a Microsoft Entra device that prevents the service from enrolling the device in update management or deploying content to the device." +description: "An error in the registration process of a Microsoft Entra device that prevents Windows Autopatch from enrolling the device in update management or deploying content to the device." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An error in the registration process of an [Microsoft Entra device](../resources/windowsupdates-azureaddevice.md) that prevents the service from enrolling the device in update management or deploying content to the device. +An error in the registration process of an [Microsoft Entra device](../resources/windowsupdates-azureaddevice.md) that prevents Windows Autopatch from enrolling the device in update management or deploying content to the device. Inherits from [updatableAssetError](../resources/windowsupdates-updatableasseterror.md). |
v1.0 | Windowsupdates Buildversiondetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-buildversiondetails.md | Title: "buildVersionDetails resource type" description: "Represents the build version details of a product revision that is associated with a quality update." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Catalogcontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-catalogcontent.md | Title: "catalogContent resource type" description: "Represents content that can be deployed from the catalog." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Catalogentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-catalogentry.md | Title: "catalogEntry resource type" description: "An abstract type that represents metadata for a piece of content that you can approve for deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType Base type for [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareu ## Properties |Property|Type|Description| |:|:|:|-|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available to deploy using the service. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| +|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available to deploy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| |displayName|String|The display name of the content. Read-only.| |id|String|The unique identifier for the catalog entry. Read-only.| |releaseDateTime|DateTimeOffset|The release date for the content. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| |
v1.0 | Windowsupdates Compliancechange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-compliancechange.md | Title: "complianceChange resource type" description: "An abstract type that represents a change to enforce policy such as approving content." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Compliancechangerule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-compliancechangerule.md | Title: "complianceChangeRule resource type" description: "An abstract type that represents a rule for governing the automatic creation of compliance changes." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Contentapplicabilitysettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-contentapplicabilitysettings.md | Title: "contentApplicabilitySettings resource type" description: "Represents settings for governing whether content is applicable to a device." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Contentapproval | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-contentapproval.md | Title: "contentApproval resource type" description: "Represents content approval to be deployed according to a policy." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Contentapprovalrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-contentapprovalrule.md | Title: "contentApprovalRule resource type" description: "Represents a rule for governing the automatic creation of content approvals." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Contentfilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-contentfilter.md | Title: "contentFilter resource type" description: "An abstract type that represents a filter to determine which content matches the rule on an ongoing basis." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Cveinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-cveinformation.md | Title: "cveInformation resource type" description: "Represents the number and URL for a Common Vulnerability and Exposure (CVE)." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Datedrivenrolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-datedrivenrolloutsettings.md | Title: "dateDrivenRolloutSettings resource type" description: "Represents settings for controlling how to roll out by a specific end date." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Deployablecontent | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-deployablecontent.md | Title: "deployableContent resource type" -description: "Represents content that is deployable by the service." +description: "An abstract type that represents content that is deployable by Windows Autopatch." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents content that is deployable by the service. --This is an abstract type. +An abstract type that represents content that is deployable by Windows Autopatch. Base type for [catalogContent](../resources/windowsupdates-catalogcontent.md). |
v1.0 | Windowsupdates Deployment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-deployment.md | Title: "deployment resource type" description: "Represents the deployment of content to a set of devices." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Deploymentaudience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-deploymentaudience.md | Title: "deploymentAudience resource type" description: "The set of updatableAsset resources to which a deployment can apply." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Deploymentsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-deploymentsettings.md | Title: "deploymentSettings resource type" -description: "Represents settings that determine when and how the service deploys an update." +description: "Represents settings that determine when and how Windows Autopatch deploys an update." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents settings that determine when and how the service deploys an update. +Represents settings that determine when and how Windows Autopatch deploys an update. ## Properties |Property|Type|Description| |
v1.0 | Windowsupdates Deploymentstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-deploymentstate.md | Title: "deploymentState resource type" description: "Describes and controls the current state of a deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Deploymentstatereason | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-deploymentstatereason.md | Title: "deploymentStateReason resource type" description: "A reason for a particular deployment state." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Driverupdatecatalogentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-driverupdatecatalogentry.md | Title: "driverUpdateCatalogEntry resource type" description: "Represents the metadata for driver update content that you can approve for deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType Inherits from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareu ## Properties |Property|Type|Description| |:|:|:|-|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment using the service. Read-only. Inherited from [microsoft.graph.windowsUpdates.catalogEntry](../resources/windowsupdates-catalogentry.md).| +|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment. Read-only. Inherited from [microsoft.graph.windowsUpdates.catalogEntry](../resources/windowsupdates-catalogentry.md).| |description|String|The description of the content.| |displayName|String|The display name of the content. Read-only. Inherited from [microsoft.graph.windowsUpdates.catalogEntry](../resources/windowsupdates-catalogentry.md).| |driverClass|String|The classification of the driver.| |
v1.0 | Windowsupdates Driverupdatefilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-driverupdatefilter.md | Title: "driverUpdateFilter resource type" description: "Represents a filter to determine which driver update content matches the rule on an ongoing basis." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Durationdrivenrolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-durationdrivenrolloutsettings.md | Title: "durationDrivenRolloutSettings resource type" description: "Represents settings for controlling how to roll out over a specific duration." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Edition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-edition.md | Title: "edition resource type" description: "Represents a specific edition of a Windows product, such as Enterprise, Core, or Education." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Expeditesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-expeditesettings.md | Title: "expediteSettings resource type" description: "Represents settings for expediting the deployment of content." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates Represents settings for expediting the deployment of content. -The [catalog content](../resources/windowsupdates-qualityupdatecatalogentry.md) has the property **isExpeditable** set to `true` if it can be expedited. If an attempt is made to create a deployment tagged with **isExpedited** set to `true` but the content has **isExpeditable** set to `false`, then the operation might return a `400 Bad Request` response code. For more information, see [Deploy an expedited security update using the Windows Update for Business deployment service](/graph/docs/concepts/windowsupdates-deploy-expedited-update.md). +The [catalog content](../resources/windowsupdates-qualityupdatecatalogentry.md) has the property **isExpeditable** set to `true` if it can be expedited. If an attempt is made to create a deployment tagged with **isExpedited** set to `true` but the content has **isExpeditable** set to `false`, then the operation might return a `400 Bad Request` response code. For more information, see [Deploy an expedited quality update using Windows Autopatch](/graph/docs/concepts/windowsupdates-deploy-expedited-update.md). An expedite readiness test is an expedited deployment that delivers no content to the device. The purpose of designating an expedited deployment as a readiness test is to ensure that the device meets the prerequisites for a successful expedited quality update deployment. An attempt that is made to create a deployment with **isExpedited** set to `false` and **isReadinessTest** set to `true` returns a `400 Bad Request` response code. |
v1.0 | Windowsupdates Featureupdatecatalogentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-featureupdatecatalogentry.md | Title: "featureUpdateCatalogEntry resource type" description: "Represents metadata for a Windows 10 feature update that you can approve for deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType Inherits from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareu |Property|Type|Description| |:|:|:| |buildNumber|String|The build number of the feature update. Read-only.|-|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment using the service. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| +|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| |displayName|String|The display name of the content. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| |id|String|The unique identifier for the catalog entry. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| |releaseDateTime|DateTimeOffset|The release date for the content. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| |
v1.0 | Windowsupdates Gradualrolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-gradualrolloutsettings.md | Title: "gradualRolloutSettings resource type" description: "Represents settings for governing how to rollout content to devices." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Itembody | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-itembody.md | Title: "itemBody resource type" description: "Represents a container for holding content and its type." ms.localizationpriority: medium -+ doc_type: resourcePageType |
v1.0 | Windowsupdates Knowledgebasearticle | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-knowledgebasearticle.md | Title: "knowledgeBaseArticle resource type" description: "Represents a knowledge base article." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Knownissue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-knownissue.md | Title: "knownIssue resource type" description: "Represents a known issue related to a Windows product." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Knownissuehistoryitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-knownissuehistoryitem.md | Title: "knownIssueHistoryItem resource type" description: "Represents the description text for the known issue, used to maintain historical records." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Monitoringrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-monitoringrule.md | Title: "monitoringRule resource type" description: "Rule defining a signal and threshold to monitor, and the action to perform when met." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Monitoringsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-monitoringsettings.md | Title: "monitoringSettings resource type" description: "Settings controlling automated monitoring and response in a deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Operationalinsightsconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-operationalinsightsconnection.md | Title: "operationalInsightsConnection resource type" -description: "Represents a specialized resourceConnection that links a Log Analytics workspace to the Windows Update for Business deployment service." +description: "Represents a specialized resourceConnection that links a Log Analytics workspace to Windows Autopatch." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents a specialized [resourceConnection](../resources/windowsupdates-resourceconnection.md) that links a Log Analytics workspace to the Windows Update for Business deployment service. +Represents a specialized [resourceConnection](../resources/windowsupdates-resourceconnection.md) that links a Log Analytics workspace to Windows Autopatch. Inherits from [resourceConnection](../resources/windowsupdates-resourceconnection.md). |
v1.0 | Windowsupdates Product | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-product.md | Title: "product resource type" description: "Represents a Windows product." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Productrevision | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-productrevision.md | Title: "productRevision resource type" description: "Represents a product revision that is associated with a quality update." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Qualityupdatecatalogentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-qualityupdatecatalogentry.md | Title: "qualityUpdateCatalogEntry resource type" description: "Represents metadata for a Windows 10 quality update that you can approve for deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType Inherits from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareu |:|:|:| |catalogName|String|The catalog name of the content. Read-only.| |cveSeverityInformation|[microsoft.graph.windowsUpdates.qualityUpdateCveSeverityInformation](../resources/windowsupdates-qualityupdatecveseverityinformation.md)|Severity information of the Common Vulnerabilities and Exposures associated with the content.|-|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment using the service. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| +|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| |displayName|String|The display name of the content. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| |id|String|The unique identifier for the catalog entry. Read-only. Inherited from [softwareUpdateCatalogEntry](../resources/windowsupdates-softwareupdatecatalogentry.md).| |isExpeditable|Boolean|Indicates whether the content can be deployed as an expedited quality update. Read-only.| |
v1.0 | Windowsupdates Qualityupdatecveseverityinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-qualityupdatecveseverityinformation.md | Title: "qualityUpdateCveSeverityInformation resource type" description: "Represents the summary of severity information regarding the Common Vulnerabilities and Exposures (CVEs) addressed by a quality update." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Ratedrivenrolloutsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-ratedrivenrolloutsettings.md | Title: "rateDrivenRolloutSettings resource type" description: "Represents settings for governing rate driven rollouts." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Resourceconnection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-resourceconnection.md | Title: "resourceConnection resource type" description: "Represents connections to external resources from which more specialized connections are derived." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Safeguardprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-safeguardprofile.md | Title: "safeguardProfile resource type" -description: "Describes the issue(s) against which the service safeguards devices." +description: "Describes one or more issues against which Windows Autopatch safeguards devices." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Describes the issue(s) against which the service safeguards devices. +Describes one or more issues against which Windows Autopatch safeguards devices. ## Properties |Property|Type|Description| |
v1.0 | Windowsupdates Safeguardsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-safeguardsettings.md | Title: "safeguardSettings resource type" -description: "Manages the safeguards that the service applies to devices in a deployment." +description: "Manages the safeguards that Windows Autopatch applies to devices in a deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Manages the safeguards that the service applies to devices in a deployment. +Manages the safeguards that Windows Autopatch applies to devices in a deployment. ## Properties |Property|Type|Description| |
v1.0 | Windowsupdates Schedulesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-schedulesettings.md | Title: "scheduleSettings resource type" -description: "Represents settings for controlling how and when the service deploys an update over time." +description: "Represents settings for controlling how and when Windows Autopatch deploys an update over time." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents settings for controlling how and when the service deploys an update over time. +Represents settings for controlling how and when Windows Autopatch deploys an update over time. ## Properties |Property|Type|Description| |
v1.0 | Windowsupdates Servicingperiod | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-servicingperiod.md | Title: "servicingPeriod resource type" description: "Represents information about a servicing period related to a product edition." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Softwareupdatecatalogentry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-softwareupdatecatalogentry.md | Title: "softwareUpdateCatalogEntry resource type" description: "Metadata for a software update that you can approve for deployment." ms.localizationpriority: medium-+ doc_type: resourcePageType This is an abstract type. ## Properties |Property|Type|Description| |:|:|:|-|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment using the service. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Inherited from [catalogEntry](../resources/windowsupdates-catalogentry.md).| +|deployableUntilDateTime|DateTimeOffset|The date on which the content is no longer available for deployment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Inherited from [catalogEntry](../resources/windowsupdates-catalogentry.md).| |displayName|String|The display name of the content. Read-only. Inherited from [catalogEntry](../resources/windowsupdates-catalogentry.md).| |id|String|The unique identifier for the catalog entry. Read-only. Inherited from [catalogEntry](../resources/windowsupdates-catalogentry.md).| |releaseDateTime|DateTimeOffset|The release date for the content. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Inherited from [catalogEntry](../resources/windowsupdates-catalogentry.md).| |
v1.0 | Windowsupdates Softwareupdatefilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-softwareupdatefilter.md | Title: "softwareUpdateFilter resource type" description: "An abstract type that represents a filter to determine which software update content matches the rule on an ongoing basis." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Updatableasset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-updatableasset.md | Title: "updatableAsset resource type" description: "Represents an asset that can receive updates." ms.localizationpriority: medium-+ doc_type: resourcePageType This is an abstract type. |[Create updatable asset group](../api/adminwindowsupdates-post-updatableassets-updatableassetgroup.md)|[microsoft.graph.windowsUpdates.updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md)|Create a new [updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md) object.| |[Get updatable asset](../api/windowsupdates-updatableasset-get.md)|[microsoft.graph.windowsUpdates.updatableAsset](../resources/windowsupdates-updatableasset.md)|Read the properties and relationships of an [updatableAsset](../resources/windowsupdates-updatableasset.md) object.| |[Delete updatable asset](../api/windowsupdates-updatableasset-delete.md)|None|Delete an [updatableAsset](../resources/windowsupdates-updatableasset.md) object.|-|[Enroll in update management](../api/windowsupdates-updatableasset-enrollassets.md)|None|Enroll [updatableAssets](../resources/windowsupdates-updatableasset.md) in update management by the deployment service.| -|[Enroll by ID](../api/windowsupdates-updatableasset-enrollassetsbyid.md)|None|Enroll [updatableAssets](../resources/windowsupdates-updatableasset.md) of the same type in update management by the deployment service.| -|[Unenroll from update management](../api/windowsupdates-updatableasset-unenrollassets.md)|None|Unenroll [updatableAssets](../resources/windowsupdates-updatableasset.md) from update management by the deployment service.| -|[Unenroll by ID](../api/windowsupdates-updatableasset-unenrollassetsbyid.md)|None|Unenroll [updatableAssets](../resources/windowsupdates-updatableasset.md) of the same type from update management by the deployment service.| +|[Enroll in update management](../api/windowsupdates-updatableasset-enrollassets.md)|None|Enroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources in update management by Windows Autopatch.| +|[Enroll by ID](../api/windowsupdates-updatableasset-enrollassetsbyid.md)|None|Enroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources of the same type in update management by Windows Autopatch.| +|[Unenroll from update management](../api/windowsupdates-updatableasset-unenrollassets.md)|None|Unenroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources from update management by Windows Autopatch.| +|[Unenroll by ID](../api/windowsupdates-updatableasset-unenrollassetsbyid.md)|None|Unenroll [updatableAsset](../resources/windowsupdates-updatableasset.md) resources of the same type from update management by Windows Autopatch.| |[Add members](../api/windowsupdates-updatableassetgroup-addmembers.md)|None|Add members to an [updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md).| |[Add members by ID](../api/windowsupdates-updatableassetgroup-addmembersbyid.md)|None|Add members of the same type to an [updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md).| |[Remove members](../api/windowsupdates-updatableassetgroup-removemembers.md)|None|Remove members from an [updatableAssetGroup](../resources/windowsupdates-updatableassetgroup.md).| |
v1.0 | Windowsupdates Updatableassetenrollment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-updatableassetenrollment.md | Title: "updatableAssetEnrollment resource type" -description: "Represents an enrollment into an area of the service." +description: "An abstract type that represents an enrollment into an area of Windows Autopatch." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents an enrollment into an area of the service. +An abstract type that represents an enrollment into an area of Windows Autopatch. Base type of [updateManagementEnrollment](../resources/windowsupdates-updatemanagementenrollment.md). -This is an abstract type. - ## Properties None. |
v1.0 | Windowsupdates Updatableasseterror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-updatableasseterror.md | Title: "updatableAssetError resource type" -description: "An abstract type that represents an error which prevents the deployment service from enrolling an azureADDevice in update management, or deploying content to the device" +description: "An abstract type that represents an error which prevents Windows Autopatch from enrolling an azureADDevice in update management, or deploying content to the device." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -An abstract type that represents an error which prevents the deployment service from enrolling an [azureADDevice](../resources/windowsupdates-azureaddevice.md) in update management, or deploying content to the device. +An abstract type that represents an error which prevents Windows Autopatch from enrolling an [azureADDevice](../resources/windowsupdates-azureaddevice.md) in update management, or deploying content to the device. All updatable asset errors are of the derived type, [azureADDeviceRegistrationError](../resources/windowsupdates-azureaddeviceregistrationerror.md). |
v1.0 | Windowsupdates Updatableassetgroup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-updatableassetgroup.md | Title: "updatableAssetGroup resource type" description: "A group of azureADDevice resources that can receive updates." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Updatemanagementenrollment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-updatemanagementenrollment.md | Title: "updateManagementEnrollment resource type" -description: "Represents enrollment into management by the service of a certain update category." +description: "Represents enrollment into management by Windows Autopatch of a certain update category." ms.localizationpriority: medium-+ doc_type: resourcePageType Namespace: microsoft.graph.windowsUpdates [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents enrollment into management by the service of a certain update category. +Represents enrollment into management by Windows Autopatch of a certain update category. Inherits from [updatableAssetEnrollment](../resources/windowsupdates-updatableassetenrollment.md). ## Properties |Property|Type|Description| |:|:|:|-|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates that the service manages. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| +|updateCategory|microsoft.graph.windowsUpdates.updateCategory|The category of updates that Windows Autopatch manages. Supports a subset of the values for **updateCategory**. Possible values are: `driver`, `feature`, `quality`, `unknownFutureValue`.| ## Relationships None. |
v1.0 | Windowsupdates Updatepolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-updatepolicy.md | Title: "updatePolicy resource type" description: "Represents an entity that governs the deployment of content to an associated deploymentAudience." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Userexperiencesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-userexperiencesettings.md | Title: "userExperienceSettings resource type" description: "Settings controlling the user's update experience on a device." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Windowsupdates Windowsupdatefilter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/windowsupdates-windowsupdatefilter.md | Title: "windowsUpdateFilter resource type" description: "An abstract type that represents a filter to determine which Windows Update content matches the rule on an ongoing basis." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Workforceintegrationencryption | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workforceintegrationencryption.md | An encryption entity defining the protocol and secret for a [workforceintegratio |protocol|String| Possible values are: `sharedSecret`, `unknownFutureValue`.| |secret|String|Encryption shared secret.| +## Relationships ++None. + ## JSON representation -HEre's a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Workinghours | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workinghours.md | to the destination time zone so that Outlook time values are displayed in local When other people request work meetings with you in your usual place of work, they can still respect your working hours in the appropriate time zone. +> **Note:** The [working hours experience](https://support.microsoft.com/office/set-your-work-hours-and-location-in-outlook-af2fddf9-249e-4710-9c95-5911edfd76f6#articleFooterSupportBridge=communityBridge) in new Outlook and Outlook on the web isn't currently supported. ## Properties | Property | Type |Description| |
v1.0 | Workingtimeschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workingtimeschedule.md | + + Title: "workingTimeSchedule resource type" +description: "Contains methods that trigger policies for the start and end of working hours for a user." ++ms.localizationpriority: medium ++++# workingTimeSchedule resource type ++Namespace: microsoft.graph +++Contains methods that trigger policies for the start and end of working hours for a user. ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get](../api/workingtimeschedule-get.md)|[workingTimeSchedule](../resources/workingtimeschedule.md)|Read the properties and relationships of a [workingTimeSchedule](../resources/workingtimeschedule.md) object.| +|[Start working time](../api/workingtimeschedule-startworkingtime.md)|None|Trigger the policies associated with the start of working hours for a specific user.| +|[End working time](../api/workingtimeschedule-endworkingtime.md)|None|Trigger the policies associated with the end of working hours for a specific user.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|id|String|A unique programmatic identifier for the resource. Read-only.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.workingTimeSchedule", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.workingTimeSchedule", + "id": "String (identifier)" +} +``` |
v1.0 | Workplacesensor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workplacesensor.md | Represents a sensor on hardware that collects and reports data on physical or en |displayName|String|The display name of the sensor. Optional.| |placeId|String| The unique identifier of the place that the sensor detects. If the device is installed in a room equipped with a mailbox, this property should match the **ExternalDirectoryObjectId** or Microsoft Entra object ID of the room mailbox. If the sensor detects the same place as the location of the device, the property can be omitted. The default value is the place identifier of the device. Optional. | |sensorId|String| The user-defined unique identifier of the sensor on the device. If the device has multiple sensors of the same type, the property must be provided to identify each sensor. If the device has only one sensor of a type, the property can be omitted. The default value is the sensor type. Optional. |-|sensorType|[workplaceSensorType](../resources/workplacesensor.md#workplacesensortype-values)|The type of sensor. The possible values are: `occupancy`, `peopleCount`, `inferredOccupancy`, `heartbeat`, `bagde`, `wifi`, `unknownFutureValue`. Required. | +|sensorType|[workplaceSensorType](../resources/workplacesensor.md#workplacesensortype-values)|The type of sensor. The possible values are: `occupancy`, `peopleCount`, `inferredOccupancy`, `heartbeat`, `badge`, `unknownFutureValue`. Required. | ### workplaceSensorType values Represents a sensor on hardware that collects and reports data on physical or en | inferredOccupancy | The sensor estimates the occupancy status of the place based on other clues, such as the presence of a laptop or a backpack. Use it for sensors that don't directly detect motion or people count. | | heartbeat | The sensor reports the heartbeat of the device. It indicates if the device is online or not. Use it for sensors that monitor the status of the device. | | badge | The sensor reports badge-swiping events of the people. Use it for sensors that accept active user interactions. |-| wifi | The sensor reports the device's Wi-Fi connection and disconnects events from people. Use it for sensors that connect to other devices with Wi-Fi. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## Relationships |
v1.0 | Workplacesensordevicetelemetry | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workplacesensordevicetelemetry.md | Represents the data collected and reported by a sensor on a device, such as occu |deviceId|String|The user-defined unique identifier of the device provided at the time of creation. Don't use the system generated identifier of the device.| |intValue|Int32|The value of the sensor as an integer. Use it for sensors that report numerical values, such as people count. | |sensorId|String|The user-defined unique identifier of the sensor on the device. Optional. If the device has multiple sensors of the same type, the property must be provided to identify each sensor. If the device has unique sensor types, the property can be omitted. The default value is the sensor type.|-|sensorType|[workplaceSensorType](../resources/workplacesensor.md#workplacesensortype-values)| The type of sensor. The possible values are: `occupancy`, `peopleCount`, `inferredOccupancy`, `heartbeat`, `badge`, `wifi`, `unknownFutureValue`.| +|sensorType|[workplaceSensorType](../resources/workplacesensor.md#workplacesensortype-values)| The type of sensor. The possible values are: `occupancy`, `peopleCount`, `inferredOccupancy`, `heartbeat`, `badge`, `unknownFutureValue`.| |timestamp|DateTimeOffset|The date and time when the sensor measured and reported its value. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. |-|eventValue| [workplaceSensorEventValue](../resources/workplacesensoreventvalue.md)| The extra values associated with badge and Wi-Fi signals. | +|eventValue| [workplaceSensorEventValue](../resources/workplacesensoreventvalue.md)| The extra values associated with badge signals. | |locationHint|String|The additional information to indicate the location of the device. | ## Relationships |
v1.0 | Workplacesensoreventvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/beta/resources/workplacesensoreventvalue.md | Title: "workplaceSensorEventValue resource type" -description: "Represents the data collected and reported by a Wi-Fi or badge-swiping device." +description: "Represents the data collected and reported by a badge-swiping device." ms.localizationpriority: medium Namespace: microsoft.graph [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] -Represents the data collected and reported by a Wi-Fi or badge-swiping device. +Represents the data collected and reported by a badge-swiping device. ## Properties | Property | Type | Description | |:|:--|:|-| eventType | [workplaceSensorEventType](../resources/workplacesensoreventvalue.md#workplacesensoreventtype-values) | The type of possible sensor event value. The possible values are: `badgeIn`, `badgeOut`, `wifiConnect`, `wifiDisconnect`, `unknownFutureValue`. | +| eventType | [workplaceSensorEventType](../resources/workplacesensoreventvalue.md#workplacesensoreventtype-values) | The type of possible sensor event value. The possible values are: `badgeIn`, `badgeOut`, `unknownFutureValue`. | | user | [emailIdentity](../resources/emailidentity.md) | The unique identifier of a user. It could be an email or a Microsoft Entra ID. | ### workplaceSensorEventType values Represents the data collected and reported by a Wi-Fi or badge-swiping device. |:-|:| | badgeIn | An event in which a user enters a place by swiping the badge. | | badgeOut | An event in which a user exits a place by swiping the badge. |-| wifiConnect | An event in which a user connects to the Wi-Fi device. | -| wifiDisconnect | An event in which a user disconnects from the Wi-Fi device. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Accesspackage Delete Resourcerolescopes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/accesspackage-delete-resourcerolescopes.md | Title: "Remove resourceRoleScope from an access package" -description: "Remove a resourceRoleScope from an access package." +description: "Remove an accessPackageResourceRoleScope from an accessPackage list of resource role scopes." ms.localizationpriority: medium doc_type: "apiPageType" Namespace: microsoft.graph -Remove a [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) from an [accessPackage](../resources/accesspackage.md) list of resource role scopes. +Remove an [accessPackageResourceRoleScope](../resources/accesspackageresourcerolescope.md) from an [accessPackage](../resources/accesspackage.md) list of resource role scopes. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Accesspackage Filterbycurrentuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/accesspackage-filterbycurrentuser.md | doc_type: apiPageType # accessPackage: filterByCurrentUser Namespace: microsoft.graph +> [!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. |
v1.0 | Accesspackageassignmentpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/accesspackageassignmentpolicy-get.md | The following example shows how to retrieve the collection of custom extension s The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_accesspackageassignmentpolicy_expand_customextensionstagesettings" }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197?$expand=customExtensionStageSettings($expand=customExtension) +GET https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197?$expand=customExtensionStageSettings($expand=customExtension) ``` +# [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 | Accesspackageassignmentpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/accesspackageassignmentpolicy-update.md | If successful, this method returns a `200 OK` response code and an updated [acce The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_accesspackageassignmentpolicy" } --> ``` http-PUT https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/accessPackageassignmentPolicies/87e1c7f7-c7f7-87e1-f7c7-e187f7c7e187 +PUT https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentPolicies/87e1c7f7-c7f7-87e1-f7c7-e187f7c7e187 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) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ #### Response The following example shows the response. To remove the collection of **customExtensionStageSettings** and their associate The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_accesspackageassignmentpolicy_delete_customExtensionStageSettings" The following example shows a request. --> ```http-PUT https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197 +PUT https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentPolicies/4540a08f-8ab5-43f6-a923-015275799197 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) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ #### Response The following example shows the response. The following example shows how to update a policy to include a custom extension The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_accesspackageassignmentpolicy_updating_customExtensionStageSettings" The following example shows a request. --> ```http-PUT https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/accessPackageAssignmentPolicies/f9afd2e3-7486-40df-9c35-aa2ae108c495 +PUT https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentPolicies/f9afd2e3-7486-40df-9c35-aa2ae108c495 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) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ #### Response The following example shows the response. |
v1.0 | Accesspackageassignmentrequest Resume | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 doc_type: "apiPageType" Namespace: microsoft.graph -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-only.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 <!-- { If successful, this action returns a `204 No Content` response code. #### Request -The following is an example of a call to resume an access package assignment request that's waiting for a callback. +The following example shows a request of a call to resume an access package assignment request that's waiting for a callback. # [HTTP](#tab/http) <!-- { HTTP/1.1 204 No Content #### Request -The following is an example to resume the processing of an access package assignment request by denying the request that's waiting for a callback. A request cannot be denied at the `assignmentRequestCreated` stage of the callout. +The following example shows a request to resume the processing of an access package assignment request by denying the request that's waiting for a callback. A request cannot be denied at the `assignmentRequestCreated` stage of the callout. <!-- { "blockType": "request" } |
v1.0 | Adminconsentrequestpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/adminconsentrequestpolicy-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "adminconsentrequestpolicy_get" } --> [!INCLUDE [permissions-table](../includes/permissions/adminconsentrequestpolicy-get-permissions.md)] -When calling on behalf of a user, the user 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): --+ Global Reader -+ Cloud Application Administrator -+ Application Administrator ## HTTP request |
v1.0 | Adminconsentrequestpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/adminconsentrequestpolicy-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "adminconsentrequestpolicy_update" } --> [!INCLUDE [permissions-table](../includes/permissions/adminconsentrequestpolicy-update-permissions.md)] -For delegated scenarios, the calling user needs to belong to at least the *Application Administrator* or *Cloud Application Administrator* [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request |
v1.0 | Administrativeunit Delete Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/administrativeunit-delete-members.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_delete_members" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-delete-members-permissions.md)] -To remove a member from an administrative unit, the calling principal must be assigned at least the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Administrativeunit Delete Scopedrolemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/administrativeunit-delete-scopedrolemembers.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_delete_scopedrolemembers" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-delete-scopedrolemembers-permissions.md)] -To remove a role assignment from an administrative unit, the calling principal must be assigned at least the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Administrativeunit Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/administrativeunit-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-delete-permissions.md)] -To delete an administrative unit, the calling principal must be assigned at least the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Administrativeunit Get Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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 Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/administrativeunit-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_get" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http Content-type: application/json "deletedDateTime": null, "displayName": "Seattle District Technical Schools", "description": "Seattle district technical schools administration",- "membershipRule": null, - "membershipType": null, - "membershipRuleProcessingState": null, + "membershipRule": "(user.country -eq \"United States\")", + "membershipType": "Dynamic", + "membershipRuleProcessingState": "On", "visibility": "HiddenMembership" } ``` |
v1.0 | Administrativeunit List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/administrativeunit-list-members.md | Choose the permission or permissions marked as least privileged for this API. Us > **Note:** To list the members of a hidden membership in an administrative unit, the *Member.Read.Hidden* permission is also required. + ## HTTP request ```http |
v1.0 | Administrativeunit List Scopedrolemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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 principal must be assigned at least 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 principal |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 Post Scopedrolemembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/administrativeunit-post-scopedrolemembers.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "administrativeunit_post_scopedrolemembers" } --> [!INCLUDE [permissions-table](../includes/permissions/administrativeunit-post-scopedrolemembers-permissions.md)] -To assign Microsoft Entra roles with an administrative unit scope, the calling principal must be assigned at least the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Administrativeunit Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/administrativeunit-update.md | Title: "Update administrativeunit" + Title: "Update administrativeUnit" description: "Update the properties of an administrativeUnit object." ms.localizationpriority: medium 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.| +| description | String | Description for the administrative unit.| +| displayName | String | Display name for the administrative unit. | +| 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. ### 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) <!-- { PATCH https://graph.microsoft.com/v1.0/directory/administrativeUnits/4d7ea995-bc Content-type: application/json {- "displayName": "Greater Seattle District Technical Schools" + "displayName": "Executive Division", + "membershipType": "Dynamic", + "membershipRule": "(user.country -eq \"United States\")", + "membershipRuleProcessingState": "On" } ``` 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/v1.0/api/adminreportsettings-get.md | + + Title: "Get adminReportSettings" +description: "Get the tenant-level settings for Microsoft 365 reports." +ms.localizationpriority: medium +++++# Get adminReportSettings ++Namespace: microsoft.graph ++Get the tenant-level settings for Microsoft 365 reports. ++> **Note:** For details about different report views and names, see [Microsoft 365 Reports in the admin center - Microsoft 365 Apps usage](/microsoft-365/admin/activity-reports/microsoft365-apps-usage). +++## 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": "adminreportsettings_get" } --> ++> **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 ++<!-- { "blockType": "ignored" } --> ++```http +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 | +| : | : | +|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 an [adminReportSettings](../resources/adminreportsettings.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_adminreportsettings" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/admin/reportSettings +``` ++# [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": "microsoft.graph.adminReportSettings" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.graph.adminReportSettings", + "displayConcealedNames": true + } +} +``` |
v1.0 | Adminreportsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/adminreportsettings-update.md | + + Title: "Update adminReportSettings" +description: "Update tenant-level settings for Microsoft 365 reports." +ms.localizationpriority: medium +++++# Update adminReportSettings ++Namespace: microsoft.graph ++Update tenant-level settings for Microsoft 365 reports. +++## 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": "adminreportsettings_update" } --> ++> **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" } --> +```http +PATCH /admin/reportSettings +``` ++## 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 | +| -- | -- | - | +| 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 ++If successful, this method returns a `204 No Content` response code. ++## Examples ++The following example shows a request that updates a tenant-level setting for Microsoft 365 reports. ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_adminreportsettings" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/admin/reportSettings +Content-Type: application/json +Content-length: 37 ++{ + "displayConcealedNames": 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 204 No Content +``` |
v1.0 | Appcatalogs List Teamsapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/appcatalogs-list-teamsapps.md | Title: "List teamsApp" description: "List apps from the Microsoft Teams app catalog."-+ ms.localizationpriority: medium doc_type: apiPageType The following example shows the response. <!-- { "blockType": "response", "name": "list_teamsapp_with_bots",- "@odata.type": "microsoft.graph.teamsApp", - "truncated": true, - "isCollection": true + "@odata.type": "Collection(microsoft.graph.teamsApp)", + "truncated": true } --> ```http HTTP/1.1 200 OK Content-Type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#appCatalogs/teamsApps(appDefinitions(bot()))", - "value": [ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#appCatalogs/teamsApps(appDefinitions(bot()))", + "value": [ + { + "id": "8a1ed7a3-5c78-46b2-8504-f9da00a1d1a6", + "externalId": "3CAB7543-216D-47C6-986C-6247670F4663", + "displayName": "Ducks-3", + "distributionMethod": "organization", + "appDefinitions": [ {- "id": "8a1ed7a3-5c78-46b2-8504-f9da00a1d1a6", - "externalId": "3CAB7543-216D-47C6-986C-6247670F4663", - "displayName": "Ducks-3", - "distributionMethod": "organization", - "appDefinitions": [ - { - "@odata.etag": "ImNOTW1CR2V1VzgwczlEblVidU00UHc9PSI=", - "id": "OGExZWQ3YTMtNWM3OC00NmIyLTg1MDQtZjlkYTAwYTFkMWE2IyMxLjAuOSMjUmVqZWN0ZWQ=", - "teamsAppId": "8a1ed7a3-5c78-46b2-8504-f9da00a1d1a6", - "displayName": "Ducks-3", - "version": "1.0.9", - "publishingState": "rejected", - "shortDescription": "quaerat quasi magnam. slight change. 5", - "description": "Aliquid placeat animi debitis accusamus. Non perferendis ullam. Quis est consequuntur vitae provident. Sunt laudantium id aut. slight change 5", - "lastModifiedDateTime": "2020-11-23T21:36:00.9437445Z", - "createdBy": { - "application": null, - "device": null, - "conversation": null, - "user": { - "id": "70292a90-d2a7-432c-857e-55db6d8f5cd0", - "displayName": null, - "userIdentityType": "aadUser" - } - }, - "authorization": - { - "requiredPermissionSet": - { - "resourceSpecificPermissions": [] - } - }, - "bot": { - "id": "bb9f67a4-893b-48d7-ab17-40ed466c0f16" - } - } - ] - }, + "@odata.etag": "ImNOTW1CR2V1VzgwczlEblVidU00UHc9PSI=", + "id": "OGExZWQ3YTMtNWM3OC00NmIyLTg1MDQtZjlkYTAwYTFkMWE2IyMxLjAuOSMjUmVqZWN0ZWQ=", + "teamsAppId": "8a1ed7a3-5c78-46b2-8504-f9da00a1d1a6", + "displayName": "Ducks-3", + "version": "1.0.9", + "publishingState": "rejected", + "shortDescription": "quaerat quasi magnam. slight change. 5", + "description": "Aliquid placeat animi debitis accusamus. Non perferendis ullam. Quis est consequuntur vitae provident. Sunt laudantium id aut. slight change 5", + "lastModifiedDateTime": "2020-11-23T21:36:00.9437445Z", + "createdBy": { + "application": null, + "device": null, + "conversation": null, + "user": { + "id": "70292a90-d2a7-432c-857e-55db6d8f5cd0", + "displayName": null, + "userIdentityType": "aadUser" + } + }, + "authorization": { + "clientAppId": null, + "requiredPermissionSet": { + "resourceSpecificPermissions": [] + } + }, + "bot": { + "id": "bb9f67a4-893b-48d7-ab17-40ed466c0f16" + } + } + ] + }, + { + "id": "30909dee-f7dd-4f89-8b3b-55de2e32489c", + "externalId": "0ebd3f4d-ca91-495b-a227-a17d298e22cc", + "displayName": "Self-Install-App-E2E-Tests", + "distributionMethod": "organization", + "appDefinitions": [ {- "id": "30909dee-f7dd-4f89-8b3b-55de2e32489c", - "externalId": "0ebd3f4d-ca91-495b-a227-a17d298e22cc", - "displayName": "Self-Install-App-E2E-Tests", - "distributionMethod": "organization", - "appDefinitions": [ - { - "@odata.etag": "IkwzVDlMOTBSSEdTMFducHUyYkpjVmc9PSI=", - "id": "MzA5MDlkZWUtZjdkZC00Zjg5LThiM2ItNTVkZTJlMzI0ODljIyM2LjAuMCMjU3VibWl0dGVk", - "teamsAppId": "30909dee-f7dd-4f89-8b3b-55de2e32489c", - "displayName": "Self-Install-App-E2E-Tests", - "version": "6.0.0", - "publishingState": "submitted", - "shortDescription": "A conversational smart assistant from MSX that surfaces real-time insights.", - "description": "For MSX Users: A conversational role-based smart assistant that will enable Enterprise sellers (AE, ATS, SSP, TSP) to be more productive by surfacing real-time insights, recommendations, actions and notifications, and by automating repetitive tasks.", - "lastModifiedDateTime": "2020-08-25T18:40:13.035341Z", - "createdBy": { - "application": null, - "device": null, - "conversation": null, - "user": { - "id": "c071a180-a220-43a1-adaf-e8db95c4a7d6", - "displayName": null, - "userIdentityType": "aadUser" - } - }, - "authorization": - { - "requiredPermissionSet": - { - "resourceSpecificPermissions": [] - } - }, - "bot": { - "id": "da7d471b-de7d-4152-8556-1cdf7a564f6c" - } - } - ] + "@odata.etag": "IkwzVDlMOTBSSEdTMFducHUyYkpjVmc9PSI=", + "id": "MzA5MDlkZWUtZjdkZC00Zjg5LThiM2ItNTVkZTJlMzI0ODljIyM2LjAuMCMjU3VibWl0dGVk", + "teamsAppId": "30909dee-f7dd-4f89-8b3b-55de2e32489c", + "displayName": "Self-Install-App-E2E-Tests", + "version": "6.0.0", + "publishingState": "submitted", + "shortDescription": "A conversational smart assistant from MSX that surfaces real-time insights.", + "description": "For MSX Users: A conversational role-based smart assistant that will enable Enterprise sellers (AE, ATS, SSP, TSP) to be more productive by surfacing real-time insights, recommendations, actions and notifications, and by automating repetitive tasks.", + "lastModifiedDateTime": "2020-08-25T18:40:13.035341Z", + "createdBy": { + "application": null, + "device": null, + "conversation": null, + "user": { + "id": "c071a180-a220-43a1-adaf-e8db95c4a7d6", + "displayName": null, + "userIdentityType": "aadUser" + } + }, + "authorization": { + "clientAppId": null, + "requiredPermissionSet": { + "resourceSpecificPermissions": [] + } + }, + "bot": { + "id": "da7d471b-de7d-4152-8556-1cdf7a564f6c" + } }- ] + ] + } + ] } ``` -### Example 7: List applications with a given ID and return only the resource specific permissions required by the app +### Example 6: List applications with a given ID and return only the resource specific permissions required by the app The following example lists the apps with a given ID and returns the resource-specific permissions that are associated with it. The following example shows the response. <!-- { "blockType": "response", "name": "list_teamsapp_with_rsc_permissions",- "@odata.type": "microsoft.graph.teamsApp", - "truncated": true, - "isCollection": true + "@odata.type": "Collection(microsoft.graph.teamsApp)", + "truncated": true } --> ```http HTTP/1.1 200 OK Content-Type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#appCatalogs/teamsApps(appDefinitions(id,authorization))", - "value": [ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#appCatalogs/teamsApps(appDefinitions(id,authorization))", + "value": [ + { + "id": "a5228c26-a9ae-4702-90e0-79a5246d2f7d", + "externalId": "a55ec032-36e9-4b60-b604-34b2fe55abf1", + "displayName": "teamsDelegatedRscTests", + "distributionMethod": "organization", + "appDefinitions@odata.context": "https://graph.microsoft.com/v1.0/$metadata#appCatalogs/teamsApps('a5228c26-a9ae-4702-90e0-79a5246d2f7d')/appDefinitions(id,authorization)", + "appDefinitions": [ {- "id": "a5228c26-a9ae-4702-90e0-79a5246d2f7d", - "externalId": "a55ec032-36e9-4b60-b604-34b2fe55abf1", - "displayName": "teamsDelegatedRscTests", - "distributionMethod": "organization", - "appDefinitions@odata.context": "https://graph.microsoft.com/v1.0/$metadata#appCatalogs/teamsApps('a5228c26-a9ae-4702-90e0-79a5246d2f7d')/appDefinitions(id,authorization)", - "appDefinitions": [ + "id": "YTUyMjhjMjYtYTlhZS00NzAyLTkwZTAtNzlhNTI0NmQyZjdkIyMxLjAuMCMjUHVibGlzaGVk", + "authorization": { + "clientAppId": "6ed63604-0ba7-4a28-bb3a-dda03ea18d54", + "requiredPermissionSet": { + "resourceSpecificPermissions": [ + { + "permissionValue": "Channel.Create.Group", + "permissionType": "application" + }, + { + "permissionValue": "Channel.Delete.Group", + "permissionType": "application" + }, {- "id": "YTUyMjhjMjYtYTlhZS00NzAyLTkwZTAtNzlhNTI0NmQyZjdkIyMxLjAuMCMjUHVibGlzaGVk", - "authorization": { - "requiredPermissionSet": { - "resourceSpecificPermissions": [ - { - "permissionValue": "Channel.Create.Group", - "permissionType": "application" - }, - { - "permissionValue": "Channel.Delete.Group", - "permissionType": "application" - }, - { - "permissionValue": "ChannelMeeting.ReadBasic.Group", - "permissionType": "delegated" - } - ] - } - } + "permissionValue": "ChannelMeeting.ReadBasic.Group", + "permissionType": "delegated" }- ] + ] + } + } }- ] + ] + } + ] } ``` |
v1.0 | Application Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/application-delta.md | doc_type: apiPageType Namespace: microsoft.graph -Get newly created, updated, or deleted applications without performing a full read of the entire resource collection. For details, see [Using delta query](/graph/delta-query-overview). +Get newly created, updated, or deleted applications 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)] |
v1.0 | Application List Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 -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 <!-- { "blockType": "permissions", "name": "application_list_owners" } --> [!INCLUDE [permissions-table](../includes/permissions/application-list-owners-permissions.md)] - ## HTTP request 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 a 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/v1.0/applications/acc848e9-e8ec-4feb-a521-8d58b5482e09/owners +GET https://graph.microsoft.com/v1.0/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. +### 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. <!-- { HTTP/1.1 200 OK Content-type: application/json {- "value": [ - { - "id": "id-value" - } - ] + "@odata.context": "https://graph.microsoft.com/v1.0/$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/v1.0/api/application-post-calls.md | doc_type: apiPageType 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 will need to [register the calling bot](/microsoftteams/platform/concepts/calls-and-meetings/registering-calling-bot) and go through the list of permissions needed as mentioned below. +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-us.md)] If successful, this method returns a `201 Created` response code and a [call](.. ## Examples -### Example 1: Create peer-to-peer VoIP call with service hosted media +### Example 1: Create a peer-to-peer VoIP call with service-hosted media > **Note:** This call needs the Calls.Initiate.All permission. #### Request-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. -+The following example shows a request that makes a peer-to-peer call between the bot and the specified user. In this example, the service hosts the media. 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) <!-- { 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 + }, "toneInfo": null } ``` |
v1.0 | Application Post Federatedidentitycredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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|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. 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/v1.0/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 | Applicationtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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 |
v1.0 | Applicationtemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 | Approleassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 | Approvalstage Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/approvalstage-update.md | PATCH /identityGovernance/entitlementManagement/accessPackageAssignmentApprovals To update an approval decision in PIM for groups: <!-- { "blockType": "ignored" } --> ```http-PATCH /identityGovernance/privilegedAccess/group/assignmentApprovals/{privilegedaccessgroupassignmentschedulerequestId}/steps/{approvalStageId} +PATCH /identityGovernance/privilegedAccess/group/assignmentApprovals/{privilegedaccessgroupassignmentschedulerequestId}/stages/{approvalStageId} ``` ## Request headers |
v1.0 | Authentication List Methods | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authentication-list-methods.md | Namespace: microsoft.graph Retrieve a list of authentication methods registered to a user. The authentication methods are defined by the types derived from the [authenticationMethod](../resources/authenticationmethod.md) resource type, and only the methods supported on this API version. See [Microsoft Entra authentication methods API overview](../resources/authenticationmethods-overview.md) for a list of currently supported methods. -We don't recommend using the authentication methods APIs for scenarios where you need to iterate over your entire user population for auditing or security check purposes. For these types of scenarios, we recommend using the [authentication method registration and usage reporting APIs](/graph/api/resources/authenticationmethods-usage-insights-overview) (available on the `beta` endpoint only). +We don't recommend using the authentication methods APIs for scenarios where you need to iterate over your entire user population for auditing or security check purposes. For these types of scenarios, we recommend using the [authentication method registration and usage reporting APIs](/graph/api/resources/authenticationmethods-usage-insights-overview). [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Authenticationconditionapplication Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationconditionapplication-delete.md | DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313c [!INCLUDE [sample-code](../includes/snippets/php/delete-includeapplications-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/delete-includeapplications-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Authenticationconditionsapplications List Includeapplications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationconditionsapplications-list-includeapplications.md | GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37 [!INCLUDE [sample-code](../includes/snippets/php/get-includeapplications-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-includeapplications-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Authenticationconditionsapplications Post Includeapplications | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationconditionsapplications-post-includeapplications.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/post-includeapplications-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/post-includeapplications-python-snippets.md)] [!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/v1.0/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 <!-- { "blockType": "ignored" } --> |
v1.0 | Authenticationcontextclassreference Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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 may require consent to multiple permissions. |
v1.0 | Authenticationeventlistener Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventlistener-delete.md | doc_type: apiPageType # Delete authenticationEventListener Namespace: microsoft.graph -Delete 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 [!INCLUDE [national-cloud-support](../../includes/global-us.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/v1.0/api/authenticationeventlistener-get.md | doc_type: apiPageType # Get authenticationEventListener Namespace: microsoft.graph -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 [!INCLUDE [national-cloud-support](../../includes/global-us.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/v1.0/api/authenticationeventlistener-update.md | doc_type: apiPageType # Update authenticationEventListener Namespace: microsoft.graph -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 [!INCLUDE [national-cloud-support](../../includes/global-us.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: +### Example 1: Update an authentication event listener's trigger conditions ++#### Request +The following example shows a request to update an authentication event listener's trigger conditions. # [HTTP](#tab/http) <!-- { Content-Type: application/json -### Response +#### Response The following example shows the response. <!-- { "blockType": "response", The following example shows the response. 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/v1.0/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/v1.0/$metadata#identity/authenticationEventListeners('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications/$entity", + "appId": "63856651-13d9-4784-9abf-20758d509e19" +} +``` |
v1.0 | Authenticationeventsflow Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventsflow-delete.md | DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313c [!INCLUDE [sample-code](../includes/snippets/php/delete-authenticationeventsflow-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/delete-authenticationeventsflow-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Authenticationeventsflow Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventsflow-get.md | GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37 [!INCLUDE [sample-code](../includes/snippets/php/get-authenticationeventsflow-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-authenticationeventsflow-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Authenticationeventsflow Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/authenticationeventsflow-update.md | You must include the **@odata.type** property with a value of the specific user |conditions|[authenticationConditions](../resources/authenticationconditions.md)|The conditions representing the context of the authentication request that is used to decide whether the events policy is invoked. | |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 Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/authenticationeventsflow-update-beta-e1-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/authenticationeventsflow-update-beta-e1-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 ``` -### Example 2: Update the onAttributeCollection event of an external identities 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're 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" + } + ] } ] } Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-authenticationeventsflow-onattributecollection-beta-e2-php-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] -# [Python](#tab/python) ----#### Response --The following example shows the response. -<!-- { - "blockType": "response", - "truncated": true -} >-``` http -HTTP/1.1 204 No Content -``` --### Example 3: Remove an attribute collected during an external identities 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/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e -Content-Type: application/json --{ - "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow", - "onAttributeCollection": { - "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp", - "attributeCollectionPage": { - "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) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] # [Python](#tab/python) [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] The following example shows the response. ``` http HTTP/1.1 204 No Content ```- |
v1.0 | Authenticationmethod Resetpassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 [passwordResetResponse](../resources/passwordresetresponse.md) in the response body. The response body might also include a **Location** header with a URL to check the status of the [reset operation](longrunningoperation-get.md). +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 didn't 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/v1.0/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. You can use the ID in the **Location** <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.entity" + "@odata.type": "microsoft.graph.passwordResetResponse" } --> ```http-HTTP/1.1 202 ACCEPTED +HTTP/1.1 202 Accepted Location: https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/operations/77bafe36-3ac0-4f89-96e4-a4a5a48da851?aadgdc=DUB02P&aadgsu=ssprprod-a Content-type: application/json |
v1.0 | B2xidentityuserflow List Userattributeassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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 Delete Serviceapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-delete-serviceapps.md | If successful, this method returns a `204 No Content` response code. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_serviceapp" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/solutions/backupRestore/serviceApps/{71633878-8321-4950-bfaf-ed285bdd1461} ``` +# [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 Enable | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-enable.md | In the request body, supply a JSON representation of the following parameter. |Parameter|Type|Description| |:|:|:|-|appOwnerTenantId|String|The ID of the tenant in which this application is registered. Required.| +|appOwnerTenantId|String|The ID of the owning tenant in which the billing profile is created.| ## Response If successful, this action returns a `200 OK` response code and a [serviceStatus The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "backuprestoreroot_enable" POST https://graph.microsoft.com/v1.0/solutions/backupRestore/enable } ``` +# [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 Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-get.md | If successful, this method returns a `200 OK` response code and a [backupRestore The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "backuprestoreroot_get" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore ``` +# [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 List Driveprotectionunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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* The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_all_driveprotectionunit" } --> ``` http-GET /solutions/backupRestore/driveProtectionUnits +GET /solutions/backupRestore/protectionUnits/microsoft.graph.driveProtectionUnit ``` +# [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 following example shows the response. HTTP/1.1 200 OK {- "@odata.nextLink": "https://graph.microsoft.com/v1.0/solutions/backupRestore/driveProtectionUnits?$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionUnits/microsoft.graph.driveProtectionUnit?$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%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**. The following example shows how to list all the **driveProtectionUnits** associa The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_driveprotectionunit" The following example shows a request. GET /solutions/backupRestore/oneDriveForBusinessProtectionPolicies/845457dc-4bb2-4815-bef3-8628ebd1952e/driveProtectionUnits ``` +# [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 List Mailboxprotectionunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_all_mailboxprotectionunit" } --> ``` http-GET https://graph.microsoft.com/v1.0/solutions/backupRestore/mailboxProtectionUnits +GET https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionUnits/microsoft.graph.mailboxProtectionUnit ``` +# [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 following example shows the response. HTTP/1.1 200 OK {- "@odata.nextLink": "https://graph.microsoft.com/v1.0/solutions/backupRestore/mailboxProtectionUnits?$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionUnits/microsoft.graph.mailboxProtectionUnit?$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", "value": [ { "@odata.type": "#microsoft.graph.mailboxProtectionUnit", |
v1.0 | Backuprestoreroot List Protectionpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-list-protectionpolicies.md | If successful, this method returns a `200 OK` response code and a [protectionPol The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "protectionpolicybase_list" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/ProtectionPolicies ``` +# [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 List Restorepoints | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-list-restorepoints.md | doc_type: resourcePageType Namespace: microsoft.graph -Get a list of the [restorePoint](../resources/restorepoint.md) objects and their properties. +Get a list of the [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)] 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 The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/restorePoints?$expand=protectionUnit($filter=id eq 'd234cf54-e0fb-49b7-9c8a-5bcd1439e853')&$filter=protectionDateTime lt 2024-05-12T10:01:00Z ``` +# [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 List Restoresessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-list-restoresessions.md | 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": "restoresession_list" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/restoreSessions ``` +# [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 List Serviceapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-list-serviceapps.md | 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": "serviceapps_list" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/serviceApps ``` +# [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 List Siteprotectionunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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** The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_all_siteprotectionunit" } --> ``` http-GET https://graph.microsoft.com/v1.0/solutions/backupRestore/siteProtectionUnits +GET https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionUnits/microsoft.graph.siteProtectionUnit ``` +# [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 following example shows the response. HTTP/1.1 200 OK {- "@odata.nextLink": "https://graph.microsoft.com/v1.0/solutions/backupRestore/siteProtectionUnits?$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionUnits/microsoft.graph.siteProtectionUnit?$skiptoken=M2UyZDAwMDAwMDMxMzkzYTMyNjQ2MTM0NjMzMjM5NjYzNjY0MzczMDM0MzE2NTYzNjEzNzMwNjIzNjMzMzg2MjM0MzM2NDM0MzUzNDMzMzc0MDc0Njg3MjY1NjE2NDJlNzYzMjAxZThmYjY4M2Y3ODAxMDAwMDg4NjA5ODdhNzgwMTAwMDB8MTYxNjk2NDUwOTgzMg%3d%3d", "value": [ { "@odata.type": "#microsoft.graph.siteProtectionUnit", The following example shows how to list all the **siteProtectionUnits** associat The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_siteprotectionunit" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtectionPolicies/845457dc-4bb2-4815-bef3-8628ebd1952e/siteProtectionUnits ``` +# [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 Exchangeprotectionpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangeprotectionpolicy_create" POST https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtection } ``` +# [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 Exchangerestoresessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 If successful, this method returns a `201 Created` response code and an [exchang The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangerestoresession_create_mailboxrestoreartifacts" 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. 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/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "onedriveforbusinessprotectionpolicy_create" POST https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusines } ``` +# [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 Onedriveforbusinessrestoresessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 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 Serviceapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/backuprestoreroot-post-serviceapps.md | If successful, this method returns a `201 Created` response code and a [serviceA The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_serviceapp" 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 Sharepointprotectionpolicies | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "sharepointprotectionpolicy_create" POST https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtecti } ``` +# [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 Sharepointrestoresessions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "sharepointrestoresession_create" 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 | Basesitepage Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/basesitepage-delete.md | DELETE /sites/{site-id}/pages/{page-id} | Name | Value | Description |:--|:|:---|Authorization|Bearer {token}.| Required| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| Required| | _if-match_ | etag | If this request header is included and the eTag provided doesn't match the current tag on the item, a `412 Precondition Failed` response is returned and the item won't be deleted. ## Request body |
v1.0 | Bitlocker List Recoverykeys | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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, 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 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 |
v1.0 | Bitlockerrecoverykey Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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)] -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 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 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/v1.0/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/v1.0/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/v1.0/api/bookingappointment-get.md | This method supports the `$count` and `$expand` [OData query parameters](/graph/ | 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/v1.0/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/v1.0/api/bookingbusiness-get.md | This method supports the `$count` [OData query parameter](/graph/query-parameter | 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/v1.0/api/bookingbusiness-list-calendarview.md | This method also supports some of the `$count` and `$expand` [OData query parame | 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 Customers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingbusiness-list-customers.md | This method supports the $count and $expand [OData query parameters](/graph/quer ## 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/v1.0/api/bookingbusiness-list.md | This method also supports the `query` parameter which accepts a string value. Th | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingbusiness Post Bookingbusinesses | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 a [bookingBusiness](../resources/bookingbusiness.md) object. |
v1.0 | Bookingbusiness Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/api/bookingbusiness-update.md | PATCH /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 [!INCLUDE [table-intro](../../includes/update-property-table-intro.md)] |
v1.0 | Bookingcurrency Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/bookingcurrency-get.md | This method supports the $count and $expand [OData query parameters](/graph/quer ## 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/v1.0/api/bookingcurrency-list.md | This method supports the $count and $expand [OData query parameters](/graph/quer ## 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/v1.0/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/v1.0/api/bookingcustomer-get.md | This method supports the $count and $expand [OData query parameters](/graph/quer | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Bookingcustomer Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 |
v1.0 | Bookingservice Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/api/bookingstaffmember-get.md | This method supports the $count and $expand [OData query parameters](/graph/quer | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Call Answer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/call-answer.md | doc_type: apiPageType Namespace: microsoft.graph -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 will contain 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 for regular scenarios, and 5 seconds for policy-based recording scenarios. +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 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-us.md)] In the request body, provide a JSON object with the following parameters. | Parameter | Type |Description | |:--|:--|:-|-| callbackUri |String |Allows bots to provide a specific callback URI for the concurrent call to receive later notifications. If this property has not been set, the bot's global callback URI will be used instead. This must be `https`. | -|acceptedModalities|String collection |The list of accept modalities. Possible values are: `audio`, `video`, `videoBasedScreenSharing`. Required for answering a call. | +| callbackUri |String |Allows bots to provide a specific callback URI for the concurrent call to receive later notifications. If this property isn't set, the bot's global callback URI is used instead. I must be `https`. | +|acceptedModalities|String collection |The list of accepted modalities. Possible values are: `audio`, `video`, `videoBasedScreenSharing`. Required for answering a call. | | callOptions | [incomingCallOptions](../resources/incomingcalloptions.md) | The call options. | | mediaConfig | [appHostedMediaConfig](../resources/apphostedmediaconfig.md) or [serviceHostedMediaConfig](../resources/servicehostedmediaconfig.md) |The media configuration. (Required) |-| participantCapacity | Int32 | The number of participant that the application can handle for the call, for [Teams policy-based recording](/microsoftteams/teams-recording-policy) scenario. | +| participantCapacity | Int32 | The number of participants that the application can handle for the call, for [Teams policy-based recording](/microsoftteams/teams-recording-policy) scenario. | ## Response This method returns a `202 Accepted` response code. The following example shows how to call this API. #### Request The following example shows the request. - # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Length: 211 ], "callOptions": { "@odata.type": "#microsoft.graph.incomingCallOptions",- "isContentSharingNotificationEnabled": true + "isContentSharingNotificationEnabled": true, + "isDeltaRosterEnabled": true }, "participantCapacity": 200 } Content-Type: application/json #### Request - # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json #### Request - # [HTTP](#tab/http) <!-- { "blockType": "request", Content-Type: application/json ### Example 3: Answer a policy-based recording call -Under the [Policy-based recording scenario](/microsoftteams/teams-recording-policy), before a participant under policy joins a call, an incoming call notification will be sent to the bot associated with the policy. +Under the [Policy-based recording scenario](/microsoftteams/teams-recording-policy), before a participant under policy joins a call, an incoming call notification is sent to the bot associated with the policy. The join information can be found under the **botData** property. The bot can then choose to answer the call and [update the recording status](call-updaterecordingstatus.md) accordingly. -When `participantCapacity` is specified in the `Answer` request for a policy-based recording notification, subsequent participant joining event belonging to the same policy group will be sent out as [participantJoiningNotification](../resources/participantJoiningNotification.md) instead of -new incoming call notification, until number of participants that current call instance is handling has reached the number specified in `participantCapacity`. +When `participantCapacity` is specified in the `Answer` request for a policy-based recording notification, subsequent participant joining events belonging to the same policy group is sent out as [participantJoiningNotification](../resources/participantJoiningNotification.md) instead of +new incoming call notification, until a number of participants that the current call instance is handling has reached the number specified in `participantCapacity`. The following is an example of the incoming call notification that a bot would receive in this case. |
v1.0 | Callrecording Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/callrecording-delta.md | + + Title: "callRecording: delta" +description: "Get a set of callRecording resources added for onlineMeeting instances organized by the specified user." +ms.localizationpriority: medium +++++# callRecording: delta ++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 do an initial full synchronization, and then get incremental changes to that recording view periodically. ++A GET request with the delta function returns one of the following: ++- 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. 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. ++### Known issues ++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). +- [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). ++## 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": "callrecording_delta" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +``` http +GET /users/{usersId}/onlineMeetings/getAllRecordings(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta +``` +>**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. ++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 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 ++| Header | Value | +||| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## 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. ++## Examples ++### Example 1: Initial round of synchronization ++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 3: [third request](#third-request) and [final response](#third-and-final-response-for-the-round). ++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 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/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta +``` ++#### Initial response ++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": "Collection(microsoft.graph.callRecording)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken1}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callRecording", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/recordings/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++#### 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. ++<!-- { "blockType": "ignored" } --> +```http +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta +$skiptoken={skipToken1} +``` ++#### Second response ++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": "Collection(microsoft.graph.callRecording)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callRecording", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/recordings/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++#### Third 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/v1.0/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 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": "Collection(microsoft.graph.callRecording)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callRecording)", + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callRecording", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/recordings/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++### 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. ++#### Request +The following example shows a request. ++<!-- { "blockType": "ignored" } --> +```http +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1} +``` ++#### 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.callRecording)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callRecording)", + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken2}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callRecording", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/recordings/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` |
v1.0 | Callrecording Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/callrecording-get.md | GET https://graph.microsoft.com/v1.0/me/onlineMeetings/MSoxMjczYTAxNi0yMDFkLTRmO [!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) |
v1.0 | Callrecords Callrecord Getpstncalls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/callrecords-callrecord-getpstncalls.md | doc_type: "apiPageType" Namespace: microsoft.graph.callRecords -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 getting 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 getting 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 ## Related content * [Microsoft Teams PSTN usage report](/microsoftteams/teams-analytics-and-reports/pstn-usage-report).-* [Direct routing report in Microsoft Graph](callrecords-callrecord-getdirectroutingcalls.md). +* [Direct Routing report in Microsoft Graph](callrecords-callrecord-getdirectroutingcalls.md). |
v1.0 | Callrecords Callrecord List Participants_V2 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/callrecords-callrecord-list-participants_v2.md | This method supports the following OData query parameter to help customize the r | Name |Description| |:-|:-|-| Authorization | Bearer {token} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | Prefer: odata.maxpagesize={x} | Specifies a preferred integer {x} page size for paginated results. This value must be equal to or less than the maximum allowable page size. Optional. | | Prefer: include-unknown-enum-members | Enables evolvable enum values beyond the sentinel value. For more information, see [Best practices for working with Microsoft Graph](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). Optional. | | Prefer: omit-values=nulls | Removes null or empty values from the response. Optional. | |
v1.0 | Callrecords Cloudcommunications List Callrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/callrecords-cloudcommunications-list-callrecords.md | This method supports the following OData query parameters to help customize the | Name |Description| |:-|:-|-| Authorization | Bearer {token} | +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| | Prefer: odata.maxpagesize={x} | Specifies a preferred integer {x} page size for paginated results. This value must be equal to or less than the maximum allowable page size. Optional. | | Prefer: include-unknown-enum-members | Enables evolvable enum values beyond the sentinel value. For more information, see [Best practices for working with Microsoft Graph](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). Optional. | | Prefer: omit-values=nulls | Removes null or empty values from the response. Optional. | |
v1.0 | Calltranscript Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/calltranscript-delta.md | + + Title: "callTranscript: delta" +description: "Get a set of callTranscript resources added for onlineMeeting instances organized by the specified user." +ms.localizationpriority: medium +++++# callTranscript: delta ++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. ++A GET request with the delta function returns one of the following: ++- 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. 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. ++### Known issues ++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). +- [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. 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": "calltranscript_delta" } --> ++## HTTP request +<!-- { "blockType": "ignored" } --> +``` http +GET /users/{usersId}/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='{userId}',startDateTime={startDateTime})/delta +``` +>**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. ++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 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 ++| Header | Value | +||| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## 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. ++## Examples ++### Example 1: Initial round of synchronization ++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 3: [third request](#third-request) and [final response](#third-and-final-response-for-the-round). ++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 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/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta +``` ++#### Initial response ++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": "Collection(microsoft.graph.callTranscript)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken1}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callTranscript", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/transcripts/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++#### 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. ++<!-- { "blockType": "ignored" } --> +```http +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta +$skiptoken={skipToken1} +``` ++#### Second response ++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": "Collection(microsoft.graph.callTranscript)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={skipToken2}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callTranscript", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/transcripts/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++#### Third 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/v1.0/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 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": "Collection(microsoft.graph.callTranscript)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callTranscript)", + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callTranscript", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/transcripts/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++### 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. ++#### Request +The following example shows a request. ++<!-- { "blockType": "ignored" } --> +```http +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken1} +``` ++#### 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.callTranscript)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callTranscript)", + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')/delta?skipToken={deltaToken2}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callTranscript", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/transcripts/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` |
v1.0 | Calltranscript Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/me/onlineMeetings/MSoxMjczYTAxNi0yMDFkLTRmOTUtODA4My0xYjdmOTliM2VkZWIqMCoqMTk6bWVldGluZ19OV1EwWm1GbFpEY3RORFJqTmkwMFlXRm1MV0U1WXpBdE9UZzJNMk0yTm1Nd1pERTNAdGhyZWFkLnYy/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 | Certificatebasedauthconfiguration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Certificatebasedauthconfiguration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_get" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Certificatebasedauthconfiguration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_list" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Certificatebasedauthconfiguration Post Certificatebasedauthconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "certificatebasedauthconfiguration_post_certificatebasedauthconfiguration" } --> [!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthconfiguration-post-certificatebasedauthconfiguration-permissions.md)] -For delegated scenarios, the calling user must have the *Global Administrator* [Microsoft Entra role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). ## HTTP request |
v1.0 | Channel Archive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-archive.md | POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721 [!INCLUDE [sample-code](../includes/snippets/php/archive-channel-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/archive-channel-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721 [!INCLUDE [sample-code](../includes/snippets/php/archive-channel-on-archived-team-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/archive-channel-on-archived-team-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Channel Completemigration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-completemigration.md | Complete the message migration process by removing `migration mode` from a [chan After a **completeMigration** request is made, you can't import additional messages into the team. You can add members to the team after the request returns a successful response. +> [!NOTE] +> Completing the migration of the channel `General` before completing the migration of other channels leads to a situation in +> which the team is marked as migrated, prohibiting you from creating further channels to be migrated. + [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions |
v1.0 | Channel Delete Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/api/channel-delete.md | Title: "Delete channel" description: "Delete the channel."-+ ms.localizationpriority: medium doc_type: apiPageType Delete the [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_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/v1.0/api/channel-get-filesfolder.md | Title: "Get filesFolder" description: "Retrieve the filesFolder 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/v1.0/api/channel-get-tabs.md | Title: "Get tab in channel" description: "Retrieve the properties and relationships of the specified tab. "-+ 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/v1.0/api/channel-get.md | Title: "Get channel" description: "Retrieve the properties and relationships of a channel."-+ doc_type: apiPageType ms.localizationpriority: medium This method supports federation. Only a user who is a member of the shared chann 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" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-get-permissions.md)] |
v1.0 | Channel Getallretainedmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-getallretainedmessages.md | + + Title: "channel: getAllRetainedMessages" +description: "Get all retained messages across all channels in a team." ++ms.localizationpriority: medium ++++# channel: getAllRetainedMessages ++Namespace: microsoft.graph ++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). +++> [!NOTE] +> This API requires [Teams retention policies](/purview/create-retention-policies?tabs=teams-retention) to be configured. For more information, see [Manage retention policies for Microsoft Teams](/microsoftteams/retention-policies). +++## 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": "channel_getallretainedmessages" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /teams/{teamsId}/channels/getAllRetainedMessages +``` ++## Optional query parameters ++The following example shows how to use the `model` query parameter with values `A` or `B` to select the preferred [licensing and payment model](/graph/teams-licenses). If you don't specify a `model`, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) is used by default. ++```http +GET /teams/{team-id}/channels/getAllRetainedMessages?model=A +GET /teams/{team-id}/channels/getAllRetainedMessages?model=B +``` ++This method supports the following OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++| Name |Description| +|:--|:-| +| $filter | The [$filter](/graph/query-parameters#filter-parameter) query parameter supports date and time range queries on the **lastModifiedDateTime** property.| +| $top | Use the [$top](/graph/query-parameters#top-parameter) query parameter to control the number of items per 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 function returns a `200 OK` response code and a collection of [chatMessage](../resources/chatmessage.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "channelthis.getallretainedmessages" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/teams/8b081ef6-4792-4def-b2c9-c363a1bf41d5/channels/getAllRetainedMessages +``` ++# [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.chatMessage)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(chatMessage)", + "@odata.count": 2, + "@odata.nextLink": "https://graph.microsoft.com/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/getAllRetainedMessages?$skip=2", + "value": [ + { + "@odata.type": "#microsoft.graph.chatMessage", + "id": "1616990417393", + "replyToId": null, + "etag": "1616990417393", + "messageType": "message", + "createdDateTime": "2021-03-29T04:00:17.393Z", + "lastModifiedDateTime": "2021-03-29T04:00:17.393Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": null, + "importance": "normal", + "locale": "en-us", + "webUrl": "https://teams.microsoft.com/l/message/19%3Ad5d2708d408c41d98424c1c354c19db3%40thread.tacv2/1616990417393?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1616990417393&parentMessageId=1616990417393", + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "conversation": null, + "user": { + "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", + "displayName": "Robin Kline", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "text", + "content": "Test message" + }, + "channelIdentity": { + "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", + "channelId": "19:d5d2708d408c41d98424c1c354c19db3@thread.tacv2" + }, + "attachments": [], + "mentions": [], + "reactions": [] + }, + { + "@odata.type": "#microsoft.graph.chatMessage", + "id": "1616990171266", + "replyToId": "1616990032035", + "etag": "1616990171266", + "messageType": "message", + "createdDateTime": "2021-03-29T03:56:11.266Z", + "lastModifiedDateTime": "2021-03-29T03:56:11.266Z", + "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/1616990171266?groupId=fbe2bf47-16c8-47cf-b4a5-4b9b187c508b&tenantId=2432b57b-0abd-43db-aa7b-16eadd115d34&createdTime=1616990171266&parentMessageId=1616990032035", + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "conversation": null, + "user": { + "id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", + "displayName": "Robin Kline", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "text", + "content": "Hello World" + }, + "channelIdentity": { + "teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", + "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + ] +} +``` ++## Related content ++[Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) |
v1.0 | Channel List Messages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 `ChannelMessage.Read.Group` permission uses [resource-specific consent](/microsoftteams/platform/graph-api/rsc/resource-specific-consent). ## HTTP request This method supports the following [OData query parameters](/graph/query-paramet | Name | Description | |:-|:| | [$top](/graph/query-parameters#top-parameter)| Apply `$top` to specify the number of channel messages returned per page in the response. The default page size is 20 messages. You can extend up to 50 channel messages per page. |-| [$expand](/graph/query-parameters#expand) | Apply `$expand` to get the properties of channel messages that are replies. By default, a response can include up to 1000 replies. For an operation that expands channel messages with more than 1000 replies, use the request URL returned in `replies@odata.nextLink` to get the next page of replies. | +| [$expand](/graph/query-parameters#expand) | Apply `$expand` to get the properties of channel messages that are replies. By default, a response can include up to 1,000 replies. For an operation that expands channel messages with more than 1,000 replies, use the request URL returned in `replies@odata.nextLink` to get the next page of replies. | -The other [OData query parameters](/graph/query-parameters) are not 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 . +The other [OData query parameters](/graph/query-parameters) aren't currently supported. ## Request headers 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 If successful, this method returns a `200 OK` response code and a collection of #### Request -The following example shows a request with the $top query option and without the optional prefer header. +The following example shows a request with the `$top` query option and without the optional prefer header. # [HTTP](#tab/http) GET https://graph.microsoft.com/v1.0/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 1000 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 1000 replies in that channel message, but for readability, the following response shows only 3 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/v1.0/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 List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-list.md | Title: "List channels" description: "Retrieve the list of channels in this team."-+ doc_type: "apiPageType" ms.localizationpriority: high Retrieve the list of [channels](../resources/channel.md) in this [team](../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). -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" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-list-permissions.md)] |
v1.0 | Channel Patch Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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" } --> |
v1.0 | Channel Patch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 Messagereply | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post-messagereply.md | Title: "Reply to a message in a channel" description: "Reply to an existing message in a channel."-+ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Channel Post Tabs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-post-tabs.md | Title: "Add tab to channel" description: "Add (pin) a tab to the specified channel within a team. "-+ ms.localizationpriority: high 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/v1.0/api/channel-post.md | Title: "Create channel" description: "Create new channel in a team, as specified in the request body." ms.localizationpriority: medium-+ doc_type: apiPageType If you're creating a private channel, you can add a maximum of 200 members. 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 are not a member of. +This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. <!-- { "blockType": "permissions", "name": "channel_post" } --> [!INCLUDE [permissions-table](../includes/permissions/channel-post-permissions.md)] |
v1.0 | Channel Unarchive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/channel-unarchive.md | POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721 [!INCLUDE [sample-code](../includes/snippets/php/unarchive-channel-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/unarchive-channel-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] POST https://graph.microsoft.com/v1.0/teams/16dc05c0-2259-4540-a970-3580ff459721 [!INCLUDE [sample-code](../includes/snippets/php/unarchive-channel-on-archived-team-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/unarchive-channel-on-archived-team-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Chat Delete Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-delete-installedapps.md | Title: "Uninstall app in a chat" description: "Uninstall (remove) an app installed in a chat."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | Chat Getallretainedmessages | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-getallretainedmessages.md | + + Title: "chat: getAllRetainedMessages" +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 ++++# chat: getAllRetainedMessages ++Namespace: microsoft.graph ++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). +++> [!NOTE] +> This API requires [Teams retention policies](/purview/create-retention-policies?tabs=teams-retention) to be configured. For more information, see [Manage retention policies for Microsoft Teams](/microsoftteams/retention-policies). +++## 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": "chat_getallretainedmessages" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /users/{id}/chats/getAllRetainedMessages +``` ++## Optional query parameters ++The following example shows how to use the `model` query parameter with values `A` or `B` to select the preferred [licensing and payment model](/graph/teams-licenses). If you don't specify a payment model, [evaluation mode](/graph/teams-licenses#evaluation-mode-default-requirements) is used by default. ++```http +GET /users/{id}/chats/getAllRetainedMessages?model=A +GET /users/{id}/chats/getAllRetainedMessages?model=B +``` ++This method supports the following OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++| Name |Description| +|:--|:-| +| $filter | The [$filter](/graph/query-parameters#filter-parameter) query parameter supports date and time range queries on the **lastModifiedDateTime** property using [date range parameters](/graph/query-parameters).| +| $top | Use the [$top](/graph/query-parameters#top-parameter) query parameter to control the number of items per response.| ++The following example shows a request that uses the `$top` and `$filter` query parameters to get a list of retained chat messages. ++```http +GET /users/{id}/chats/getAllRetainedMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z +``` ++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 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' || ++## 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 [chatMessage](../resources/chatmessage.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "chatthis.getallretainedmessages" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages +``` ++# [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.chatMessage)" +} +--> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(chatMessage)", + "@odata.count": 10, + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/chats/getAllRetainedMessages?$skip=10", + "value": [ + { + "@odata.type": "#microsoft.graph.chatMessage", + "id": "1600457965467", + "replyToId": null, + "etag": "1600457965467", + "messageType": "message", + "createdDateTime": "2020-09-18T19:39:25.467Z", + "lastModifiedDateTime": "2020-09-18T19:39:25.467Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:0de69e5e-2da8-4cf2-821f-5e6585b2c65b_5c64e248-3269-4268-a36e-0f80314e9c39@unq.gbl.spaces", + "importance": "normal", + "locale": "en-us", + "webUrl": null, + "channelIdentity": null, + "policyViolation": null, + "eventDetail": null, + "from": { + "application": null, + "device": null, + "conversation": null, + "user": { + "id": "0de69e5e-2da8-4cf2-821f-5e6585b2c65b", + "displayName": "Richard Wilson", + "userIdentityType": "aadUser" + } + }, + "body": { + "contentType": "html", + "content": "<div>\n<blockquote itemscope=\"\" itemtype=\"http://schema.skype.com/Reply\" itemid=\"1600457867820\">\n<strong itemprop=\"mri\" itemid=\"8:orgid:0de69e5e-2da8-4cf2-821f-5e6585b2c65b\">Richard Wilson</strong><span itemprop=\"time\" itemid=\"1600457867820\"></span>\n<p itemprop=\"preview\">1237</p>\n</blockquote>\n<p>this is a reply</p>\n</div>" + }, + "attachments": [], + "mentions": [], + "reactions": [] + } + ] +} +``` ++## Related content ++[Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) |
v1.0 | Chat Post Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-post-installedapps.md | The following table lists other parameters that can be used with the request bod |consentedPermissionSet|[teamsAppPermissionSet](../resources/teamsapppermissionset.md)|Set of resource-specific permissions that are being consented to.| > **Note:**-> The permissions consented to during the installation must match the resource-specific permissions defined in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app).If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. +> The permissions consented to during the installation must match the resource-specific permissions defined in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app).If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. ## Response HTTP/1.1 201 Created ### Example 2: Install app in a chat and consent to the resource-specific permissions required by the app -To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). +To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). #### Request |
v1.0 | Chat Teamsappinstallation Upgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/chat-teamsappinstallation-upgrade.md | The following table lists other parameters that can be used with the upgrade act |consentedPermissionSet|[teamsAppPermissionSet](../resources/teamsapppermissionset.md)|The set of resource-specific permissions that are being consented to.| > **Note**:-> The permissions consented to during the installation must match the resource-specific permissions defined in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. +> The permissions consented to during the installation must match the resource-specific permissions defined in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. ## Response HTTP/1.1 204 No Content ### Example 2: Upgrade app installed in a chat and consent to the resource specific permissions -To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). +To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). #### Request |
v1.0 | Chatmessage Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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." + Title: "chats-getAllMessages: delta" +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-+ -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 get 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 to retrieve more 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). - ## 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 the 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 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 does not include any state token. This round returns all the events in that calendar view. --The request specifies the optional request header, odata.top, returning 2 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/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$top=2 +GET https://graph.microsoft.com/v1.0/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/v1.0/$metadata#Collection(chatMessage)", - "@odata.nextLink": "https://graph.microsoft.com/v1.0/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" - }, - "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" - }, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.chatMessage)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/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", "-FG3FPHv7HuyuazNLuy3eXlzQGbEjYLUsW9-pYkmXgn5KGsaOwrCoor2W23dGNNM1KtAX4AyvpFQNVsBgsEwUOX9lw8x9zDumgJy-C-UbjZLlZDQACyC9FyrVelZus9n.--rshdLwy_WBFJd8anPXJPbSUtUD7r3V4neB5tcrG58"] + "name": "get_chatmessagedeltachats_2" }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/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/v1.0/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 2 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/v1.0/$metadata#Collection(chatMessage)", - "@odata.nextLink": "https://graph.microsoft.com/v1.0/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" - }, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] - }, - { - "@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" - }, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.chatMessage)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/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", "8UusBixEHS9UUau6uGcryrA6FpnWwMJbuTYILM1PArHxnZzDVcsHQrijNzCyIVeEauMQsKUfMhNjLWFs1o4sBS_LofJ7xMftZUfec_pijuT6cAk5ugcWCca9RCjK7iVj.DKZ9w4bX9vCR7Sj9P0_qxjLAAPiEZgxlOxxmCLMzHJ4"] + "name": "get_chatmessagedeltachats_3" }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$skiptoken=8UusBixEHS9UUau6uGcryrA6FpnWwMJbuTYILM1PArHxnZzDVcsHQrijNzCyIVeEauMQsKUfMhNjLWFs1o4sBS_LofJ7xMftZUfec_pijuT6cAk5ugcWCca9RCjK7iVj.DKZ9w4bX9vCR7Sj9P0_qxjLAAPiEZgxlOxxmCLMzHJ4 +GET https://graph.microsoft.com/v1.0/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/v1.0/$metadata#Collection(chatMessage)", - "@odata.deltaLink": "https://graph.microsoft.com/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$deltatoken=aQdvS1VwGCSRxVmZJqykmDik_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" - }, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] - }, - { - "@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" - }, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.chatMessage)", + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/users/5ed12dd6-24f8-4777-be3d-0d234e06cefik_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 -Using the `@odata.deltaLink` from the last request in the last round, you can get only those messages that changed (by being added, or updated) in that channel since then. Your request should look like the following, assuming you prefer to keep the same maximum page size in the response: +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", "aQdvS1VwGCSRxVmZJqykmDik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4"] + "name": "get_chatmessagedeltachats_4" }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$deltatoken=aQdvS1VwGCSRxVmZJqykmDik_JIC44iCZpv-GLiA2VnFuE5yG-kCEBROb2iaPT_y_eMWVQtBO_ejzzyIxl00ji-tQ3HzAbW4liZAVG88lO3nG_6-MBFoHY1n8y21YUzjocG-Cn1tCNeeLPLTzIe5Dw.EP9gLiCoF2CE_e6l_m1bTk2aokD9KcgfgfcLGqd1r_4 +GET https://graph.microsoft.com/v1.0/users/5ed12dd6-24f8-4777-be3d-0d234e06cefik_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/v1.0/$metadata#Collection(chatMessage)", - "@odata.deltaLink": "https://graph.microsoft.com/v1.0/teams/fbe2bf47-16c8-47cf-b4a5-4b9b187c508b/channels/19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2/messages/delta?$deltatoken=aQdvS1VwGCSRxVmZJqykmDik_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" - }, - "attachments": [], - "mentions": [], - "reactions": [], - "messageHistory": [] + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(chatMessage)", + "@odata.deltaLink": "https://graph.microsoft.com/v1.0/users/5ed12dd6-24f8-4777-be3d-0d234e06cefik_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/v1.0/api/chatmessage-get.md | Content-type: application/json } ``` +### Example 4: Get a chat message with custom emojis and reactions ++The following example shows a request to get a chat message that contains custom emojis in the message body and includes custom reactions. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_chatmessage_4", + "sampleKeys": ["19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2", "1706763669648"] +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706763669648 +``` ++# [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 `<customemoji></customemoji>` tag, and the message includes a custom reaction indicated by `"reactionType": "custom"`. You can access both custom emojis and reactions as content hosted within a chat message. ++<!-- { + "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/v1.0/$metadata#chats('19%3Abcf84b15c2994a909770f7d05bc4fe16%40thread.v2')/messages/$entity", + "id": "1706763669648", + "replyToId": null, + "etag": "1707948456260", + "messageType": "message", + "createdDateTime": "2024-02-01T05:01:09.648Z", + "lastModifiedDateTime": "2024-02-14T22:07:36.26Z", + "lastEditedDateTime": null, + "deletedDateTime": null, + "subject": null, + "summary": null, + "chatId": "19:bcf84b15c2994a909770f7d05bc4fe16@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": "670374fa-3b0e-4a3b-9d33-0e1bc5ff1956", + "displayName": "Adele Vance", + "userIdentityType": "aadUser", + "tenantId": "2432b57b-0abd-43db-aa7b-16eadd115d34" + } + }, + "body": { + "contentType": "html", + "content": "<p>I am looking <emoji id=\"1f440_eyes\" alt=\"👀\" title=\"Eyes\"></emoji><customemoji id=\"dGVzdHNjOzAtd3VzLWQyLTdiNWRkZGQ2ZGVjMDNkYzIwNTgxY2NkYTE1MmEyZTM4\" alt=\"microsoft_teams\" source=\"https://graph.microsoft.com/v1.0/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": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "670374fa-3b0e-4a3b-9d33-0e1bc5ff1956", + "displayName": null, + "userIdentityType": "aadUser" + } + } + }, + { + "reactionType": "custom", + "displayName": "microsoft_teams", + "reactionContentUrl": "https://graph.microsoft.com/v1.0/chats/19:bcf84b15c2994a909770f7d05bc4fe16@thread.v2/messages/1706763669648/hostedContents/aWQ9MC13dXMtZDExLTc3ZmI2NmY4MTMwMGI2OGEzYzRkOWUyNmU1YTc5ZmMyLHR5cGU9MSx1cmw9/$value", + "createdDateTime": "2024-02-14T22:07:02.288Z", + "user": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "28c10244-4bad-4fda-993c-f332faef94f0", + "displayName": null, + "userIdentityType": "aadUser" + } + } + } + ] +} +``` + ## 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/v1.0/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/v1.0/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 | Community Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/community-delete.md | + + Title: "Delete community" +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 ++++# Delete community ++Namespace: microsoft.graph ++Delete a Viva Engage [community](../resources/community.md) along with all associated Microsoft 365 content, including the connected Microsoft 365 group, OneNote notebook, and Planner plans. For more information, see [What happens if I delete a Viva Engage community connected to Microsoft 365 groups](/viva/engage/engage-microsoft-365-groups#q-what-happens-if-i-delete-a-viva-engage-community-connected-to-microsoft-365-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": "community_delete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /employeeExperience/communities/{communityId} +``` ++## 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 `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_community", + "sampleKeys": ["eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0"] +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/employeeExperience/communities/eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0 +``` ++# [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 +} +--> +``` http +HTTP/1.1 204 No Content +``` + |
v1.0 | Community Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/community-get.md | + + Title: "Get community" +description: "Read the properties and relationships of a community object." ++ms.localizationpriority: medium ++++# Get community ++Namespace: microsoft.graph ++Read the properties and relationships of a [community](../resources/community.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": "community_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /employeeExperience/communities/{communityId} +``` ++## Optional query parameters ++This method supports the `$select` and `$expand` [OData query parameters](/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 [community](../resources/community.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_community", + "sampleKeys": ["eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0"] +} +--> +``` http +GET https://graph.microsoft.com/v1.0/employeeExperience/communities/eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0 +``` ++# [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.community" +} +--> +```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#employeeExperience/communities/$entity", + "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0", + "displayName": "Financial Advice for Software Engineers", + "description": "A community where financial advisors who represent customers from software engineering profession can discuss advice and suggestions for there clients.", + "privacy": "public", + "groupId": "963da73d-a587-4ef3-aab0-d783e937e9e7" +} +``` |
v1.0 | Community Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/community-update.md | + + Title: "Update community" +description: "Update the properties of an existing Viva Engage community." ++ms.localizationpriority: medium ++++# Update community ++Namespace: microsoft.graph ++Update the properties of an existing Viva Engage [community](../resources/community.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": "community_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /employeeExperience/communities/{communityId} +``` ++## 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| +|:|:|:| +| description | String | The description of the community. Maximum length is 1,024 characters. | +| displayName | String | The name of the community. Maximum length is 255 characters. | +| privacy | [communityPrivacy](../resources/community.md#communityprivacy-values) | Defines the privacy level of the community. The possible values are: `public`, `private`, `unknownFutureValue`. | +++## Response ++If successful, this method returns a `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_community", + "sampleKeys": ["eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0"] +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/employeeExperience/communities/eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0 +Content-Type: application/json ++{ + "displayName": "Financial Advice for Software Engineers", + "description": "A community where financial advisors who represent customers from software engineering profession can discuss advice and suggestions for their clients.", + "privacy": "public" +} +``` ++# [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 +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Companysubscription Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/companysubscription-get.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/companysubscription-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Conditionalaccesspolicy Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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 Namedlocations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/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 | Contract Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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 | Countrynamedlocation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/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/v1.0/api/customauthenticationextension-delete.md | doc_type: apiPageType # Delete customAuthenticationExtension Namespace: microsoft.graph -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. [!INCLUDE [national-cloud-support](../../includes/global-us.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/v1.0/api/customauthenticationextension-get.md | doc_type: apiPageType # Get customAuthenticationExtension Namespace: microsoft.graph -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. [!INCLUDE [national-cloud-support](../../includes/global-us.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/v1.0/api/customauthenticationextension-update.md | doc_type: apiPageType # Update customAuthenticationExtension Namespace: microsoft.graph -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. [!INCLUDE [national-cloud-support](../../includes/global-us.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/v1.0/api/customauthenticationextension-validateauthenticationconfiguration.md | doc_type: apiPageType # customAuthenticationExtension: validateAuthenticationConfiguration Namespace: microsoft.graph -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.resource type. [!INCLUDE [national-cloud-support](../../includes/global-us.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 | Device Delete Registeredowners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Device Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 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/v1.0/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/v1.0/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)] + ## HTTP request You can address the device using either its **id** or **deviceId**. |
v1.0 | Device List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/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)] +> [!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 Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 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/v1.0/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)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Device Post Devices | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 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/v1.0/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/v1.0/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)] + ## HTTP request You can address the device using either its **id** or **deviceId**. |
v1.0 | Device Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/api/devicelocalcredentialinfo-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "devicelocalcredentialinfo_get" } --> [!INCLUDE [permissions-table](../includes/permissions/devicelocalcredentialinfo-get-permissions.md)] -To access the actual passwords on the device by using the `$select=credentials` query parameter, the app must be assigned the DeviceLocalCredential.Read.All permission. DeviceLocalCredential.ReadBasic.All is insufficient. -+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: |
v1.0 | Directory Deleteditems Restore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directory-deleteditems-restore.md | doc_type: apiPageType Namespace: microsoft.graph -Restore a recently deleted [application](../resources/application.md), [group](../resources/group.md), [servicePrincipal](../resources/serviceprincipal.md), [administrative unit](../resources/administrativeunit.md), or [user](../resources/user.md) object from [deleted items](../resources/directory.md). If an item was accidentally deleted, you can fully restore the item. However, security groups cannot be restored. Also, restoring an application doesn't restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. +Restore a recently deleted [application](../resources/application.md), [group](../resources/group.md), [servicePrincipal](../resources/serviceprincipal.md), [administrative unit](../resources/administrativeunit.md), or [user](../resources/user.md) object from [deleted items](../resources/directory.md). If an item was accidentally deleted, you can fully restore the item. However, security groups can't be restored. Also, restoring an application doesn't restore the associated service principal automatically. You must call this API to explicitly restore the deleted service principal. A recently deleted item remains available for up to 30 days. After 30 days, the item is permanently deleted. POST /directory/deletedItems/{id}/restore | Content-type | application/json | ## Request body-Don't supply a request body for this method. +In the request body, supply a JSON representation of the parameters. ++The following table lists the parameters that are required when you call this action. ++|Parameter|Type|Description| +|:|:|:| +|autoReconcileProxyConflict|Boolean|Optional parameter. Indicates whether Microsoft Entra ID should remove any conflicting proxy addresses while restoring a soft-deleted user whose one or more proxy addresses are currently used for an active user. Used only for restoring soft-deleted [user](../resources/user.md) objects. The default value for this parameter is `false`.| ## Response If successful, this method returns a `200 OK` response code and a [directoryObject](../resources/directoryobject.md) object in the response body. -## Example -### Request +## Examples ++### Example 1: Restore a deleted item ++#### Request # [HTTP](#tab/http) If successful, this method returns a `200 OK` response code and a [directoryObje "name": "restore_directory_deleteditem" }--> ```http-POST https://graph.microsoft.com/v1.0/directory/deletedItems/{object-id}/restore +POST https://graph.microsoft.com/v1.0/directory/deletedItems/78bf875b-9343-4edc-9130-0d3958113563/restore ``` # [C#](#tab/csharp) POST https://graph.microsoft.com/v1.0/directory/deletedItems/{object-id}/restore -### Response -Note: The response object shown here might be shortened for readability. +#### Response +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, Content-type: application/json ] }--> +### Example 2: Restore a deleted item and remove any conflicting proxy addresses ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "restore_directory_deleteditem_autoreconcileproxyconflict" +}--> +```http +POST https://graph.microsoft.com/v1.0/directory/deleteditems/78bf875b-9343-4edc-9130-0d3958113563/restore +Content-Type: application/json ++{ + "autoReconcileProxyConflict": 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 +> **Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.directoryObject" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity", + "id": "78bf875b-9343-4edc-9130-0d3958113563", + "businessPhones": [], + "displayName": "SampleUser", + "givenName": "Sample", + "jobTitle": "Product Marketing Manager", + "mail": "sampleuser@contoso.com", + "mobilePhone": "+1 425 555 0109", + "officeLocation": "18/2111", + "preferredLanguage": "en-US", + "surname": "Vance", + "userPrincipalName": "sampleuser@contoso.com" +} +``` + |
v1.0 | Directory List Administrativeunits | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directory-list-administrativeunits.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directory_list_administrativeunits" } --> [!INCLUDE [permissions-table](../includes/permissions/directory-list-administrativeunits-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http Content-type: application/json "deletedDateTime": null, "displayName": "Seattle District Technical Schools", "description": "Seattle district technical schools administration",- "membershipRule": null, - "membershipType": null, - "membershipRuleProcessingState": null, + "membershipRule": "(user.country -eq \"United States\")", + "membershipType": "Dynamic", + "membershipRuleProcessingState": "On", "visibility": "HiddenMembership" } ] |
v1.0 | Directory List Devicelocalcredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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** objects within the tenant: |
v1.0 | Directory List Subscriptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directory-list-subscriptions.md | Choose the permission or permissions marked as least privileged for this API. Us [!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/v1.0/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 doc_type: apiPageType Namespace: microsoft.graph -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" } --> ```http 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. -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. +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. | +| 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. | ++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 ### Request -Here's an example of the request. -+The following example shows a request that creates a new administrative unit with a dynamic membership rule to include all users whose country is the United States. # [HTTP](#tab/http) <!-- { Content-type: application/json { "displayName": "Seattle District Technical Schools", "description": "Seattle district technical schools administration",+ "membershipType": "Dynamic", + "membershipRule": "(user.country -eq \"United States\")", + "membershipRuleProcessingState": "On", "visibility": "HiddenMembership" } ``` Content-type: application/json -In the request body, supply a JSON representation of an [administrativeUnit](../resources/administrativeunit.md) object. - ### Response -Here's an example of the response. +The following example shows the response. >**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", Content-type: application/json "deletedDateTime": null, "displayName": "Seattle District Technical Schools", "description": "Seattle district technical schools administration",+ "membershipRule": "(user.country -eq \"United States\")", + "membershipType": "Dynamic", + "membershipRuleProcessingState": "On", "visibility": "HiddenMembership" } ``` |
v1.0 | Directoryaudit Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryaudit-get.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/directoryaudit-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> 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/v1.0/api/directoryaudit-list.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/directoryaudit-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> 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/v1.0/api/directoryobject-checkmembergroups.md | You can check up to a maximum of 20 groups per request. This function supports a |Delegated (personal Microsoft account) | Not supported. | |Application | User.Read.All and GroupMember.Read.All, User.Read.All and Group.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 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 | 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) | You can check up to a maximum of 20 groups per request. This function supports a ### Group memberships for a device -<!-- { "blockType": "permissions", "name": "directoryobject_checkmembergroups_6" } --> --<!-- --Use the follow scenario guidance to help determine which permission types to use: --| Scenario | Permissions to use | -|:-|:-| -| 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 directory object | Use the **Directory.Read.All** permission. | --<!-- These tables will replace the data in lines 22-36 to help with the tooling that parses permissions tables. -+ Current data is copy-pasted from incorrect files/file names -+ To validate these permissions against lines 32-36 >+<!-- { "blockType": "permissions", "name": "directoryobject_checkmembergroups_7" } --> ## 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/v1.0/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) | |:--|:| 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+``` ++Memberships for other users. +<!-- { "blockType": "ignored" } --> +```http POST /users/{id | userPrincipalName}/checkMemberObjects ``` |
v1.0 | Directoryobject Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/api/directoryrole-delete-member.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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](../resources/directoryrole.md). 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). Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_delete_member" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-delete-member-permissions.md)] + ## HTTP request You can address the directory role using either its **id** or **roleTemplateId**. |
v1.0 | Directoryrole Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryrole-delta.md | doc_type: apiPageType Namespace: microsoft.graph -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)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_delta" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-delta-permissions.md)] + ## HTTP request To begin tracking changes, you make a request including the **delta** function on the [directoryRole](../resources/directoryrole.md) resource. You only need to specify any desired query parameters once upfront. In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response, as that URL already includes the encoded, desired 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 | Directoryrole Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryrole-get.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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](../resources/directoryrole.md) object. The role must be activated in tenant for a successful response. 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). Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_get" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-get-permissions.md)] + ## HTTP request You can address the directory role using either its **id** or **roleTemplateId**. |
v1.0 | Directoryrole List Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryrole-list-members.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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 the list of principals that are assigned to the 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). 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 directory role using either its **id** or **roleTemplateId**. |
v1.0 | Directoryrole List Scopedmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryrole-list-scopedmembers.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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/global-only.md)] Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_list_scopedmembers" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-list-scopedmembers-permissions.md)] + ## HTTP request You can address the directory role using either its **id** or **roleTemplateId**. |
v1.0 | Directoryrole List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryrole-list.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_list" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Directoryrole Post Directoryroles | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryrole-post-directoryroles.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_post_directoryroles" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-post-directoryroles-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Directoryrole Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryrole-post-members.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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). Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "directoryrole_post_members" } --> [!INCLUDE [permissions-table](../includes/permissions/directoryrole-post-members-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Directoryroletemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/directoryroletemplate-get.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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/v1.0/api/directoryroletemplate-list.md | doc_type: apiPageType Namespace: microsoft.graph +> [!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 | Domain Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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 Rootdomain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-get-rootdomain.md | + + Title: "Get rootDomain" +description: "Get the root domain of a subdomain." ++ms.localizationpriority: medium ++++# Get rootDomain ++Namespace: microsoft.graph ++Get the [root domain](../resources/domain.md) of a subdomain. ++This API returns a single 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": "domain_get_rootdomain" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /domains/{id}/rootDomain +``` +> For {id}, specify the domain with its fully qualified domain name. ++## Optional query parameters ++This method does not support OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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 [domain](../resources/domain.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["sub.contoso.com"], + "name": "get_rootDomain" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/domains/sub.contoso.com/rootDomain +``` ++# [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": "microsoft.graph.domain" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": + { + "@odata.type": "#microsoft.graph.domain", + "id": "contoso.com", + "authenticationType": "Managed", + "availabilityStatus": null, + "isAdminManaged": true, + "isDefault": true, + "isInitial": true, + "isRoot": true, + "isVerified": true, + "passwordNotificationWindowInDays": 14, + "passwordValidityPeriodInDays": 2147483647, + "supportedServices": [ + "Email", + "OfficeCommunicationsOnline" + ], + "state": null + } +} +``` |
v1.0 | Domain Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 atleast one of the following Microsoft Entra roles: --* 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 |
v1.0 | Domain List Domainnamereferences | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/domain-list-domainnamereferences.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "domain_list_domainnamereferences" } --> [!INCLUDE [permissions-table](../includes/permissions/domain-list-domainnamereferences-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). - [!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: *Domain Name Administrator* or *Global Reader*. + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Domain List Serviceconfigurationrecords | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/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 one of the following Microsoft Entra roles: --* 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" } --> GET https://graph.microsoft.com/v1.0/domains ### Response ->**Note:** The response object shown here might be shortened for readability. +>**Note:*> - The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, |
v1.0 | Domain Post Domains | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/api/domain-post-federationconfiguration.md | You can specify the following properties when creating an **internalDomainFedera |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.| |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`.| +|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`.| |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).| |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.| |
v1.0 | Domain Promote | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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] +> 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 +> - 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/v1.0/api/domain-verify.md | Validates the ownership of the 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 Getretentionlabel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/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/v1.0/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/v1.0/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 | Educationassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationassignment-get.md | 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**. You can use `$expand` with the following navigation properties of the [educationAssignment](../resources/educationassignment.md) resource: **categories**, **resources**, **rubric**, **submissions**, and **gradingCategory**. You can also use `*` to specify all the navigation properties. |
v1.0 | Educationassignment Post Categories | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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. Content-type: application/json { "@odata.id": "https://graph.microsoft.com/v1.0/education/classes/acdefc6b-2dc6-4e71-b1e9-6d9810ab1793/assignmentCategories/ec98f158-341d-4fea-9f8c-14a250d489ac" }- ``` # [C#](#tab/csharp) Content-type: application/json -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. <!-- { "blockType": "response",- "truncated": true, - "@odata.type": "microsoft.graph.educationAssignmentResource" + "truncated": true } --> ```http HTTP/1.1 204 No Content--{ -} ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationassignment Remove Category | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationassignment-remove-category.md | The following example shows a request. <!-- { "blockType": "request", "sampleKeys": ["ec98f158-341d-4fea-9f8c-14a250d489ac"],- "name": "add_educationcategory_to_educationassignment_classID_assignID" + "name": "remove_educationcategory_from_educationassignment" }--> ```http DELETE https://graph.microsoft.com/v1.0/education/classes/acdefc6b-2dc6-4e71-b1e9-6d9810ab1793/assignments/ad8afb28-c138-4ad7-b7f5-a6986c2655a8/categories/ec98f158-341d-4fea-9f8c-14a250d489ac/$ref ``` # [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)] The following example shows the response. <!-- { "blockType": "response",- "truncated": true, - "@odata.type": "microsoft.graph.educationAssignmentResource" + "truncated": true } --> ```http HTTP/1.1 204 No Content--{ -} ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Educationcategory Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 | Educationfeedbackresourceoutcome Post Outcomes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationfeedbackresourceoutcome-post-outcomes.md | HTTP/1.1 201 Created Content-type: application/json {- "@odata.context": "https://graph.microsoft.com/v1.0/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/v1.0/$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-10-21T18:58:42.019513Z", - "id": "8c3d65c1-eacb-40f7-9360-7e47bb5b7d75", + "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-10-21T18:58:42.0195022Z", - "lastModifiedDateTime": "2022-10-21T18:58:42.019513Z", - "fileUrl": "https://graph.microsoft.com/v1.0/drives/b!-Ik2sRPLDEWy_bR8l75jfeDcpXQcRKVOmcml10NQLQ1F8CNZWU38SarWxPyWM7jx/items/01VANVJQ5X3ULNDOWTJJEYSIBXZIK42E5G", + "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 | Educationsubmission Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/api/educationsubmission-list-outcomes.md | The following example shows a request. }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/education/classes/acdefc6b-2dc6-4e71-b1e9-6d9810ab1793/assignments/cf6005fc-9e13-44a2-a6ac-a53322006454/submissions/d1bee293-d8bb-48d4-af3e-c8cb0e3c7fe7/outcomes +GET https://graph.microsoft.com/v1.0/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/v1.0/$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 { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#education/classes('37d99af7-cfc5-4e3b-8566-f7d40e4a2070')/assignments('a3cce0ba-2008-4c4d-bf62-079408562d96')/submissions('2185e6d7-2924-4ed1-dde1-269f89e29184')/outcomes",+ "@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>')/assignments('<guid>')/submissions('<guid>')/outcomes?$select=lastModifiedBy,lastModifiedDateTime", "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/v1.0/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, Content-type: application/json } } }+ }, + { + "@odata.type": "#microsoft.graph.educationFeedbackResourceOutcome", + "lastModifiedDateTime": "2022-05-06T00:52:21.8011514Z", + "id": "4176c991-c263-4772-9b01-5a27d55e123e", + "resourceStatus": "notPublished", + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "cb1a4af3-0aba-4679-aa12-9f99bab0b61a", + "displayName": null + } + }, + "feedbackResource": { + "@odata.type": "#microsoft.graph.educationWordResource", + "displayName": "Document4.docx", + "createdDateTime": "2022-05-06T00:52:21.8011302Z", + "lastModifiedDateTime": "2022-05-06T00:52:21.8011514Z", + "fileUrl": "https://graph.microsoft.com/v1.0/drives/b!-Ik2sRPLDEWy_bR8l75jfeDcpXQcRKVOmcml10NQLQ1F8CNZWU38SarWxPyWM7jx/items/01VANVJQ3OHVMMZAEQPRC3LQJLBEQQY4BI", + "createdBy": { + "application": null, + "device": null, + "user": { + "id": "cb1a4af3-0aba-4679-aa12-9f99bab0b61a", + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "device": null, + "user": { + "id": "cb1a4af3-0aba-4679-aa12-9f99bab0b61a", + "displayName": null + } + } + } } ] } |
v1.0 | Educationsubmission Reassign | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationsubmission-reassign.md | POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566- The following is an example of the response when `Prefer: include-unknown-enum-members` isn't 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 The following is an example of the response when `Prefer: include-unknown-enum-m <!-- { "blockType": "response",+ "truncated": true, "@odata.type": "microsoft.graph.educationSubmission" } --> ```http |
v1.0 | Educationuser List Assignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/educationuser-list-assignments.md | GET /education/users/{user-id}/assignments This method supports the `$top`, `$filter`, `$orderby`, and `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). -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 | Employeeexperience List Communities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/employeeexperience-list-communities.md | + + Title: "List communities" +description: "Get a list of the Viva Engage community objects and their properties." ++ms.localizationpriority: medium ++++# List communities ++Namespace: microsoft.graph ++Get a list of the Viva Engage [community](../resources/community.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": "employeeexperience_list_communities" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /employeeExperience/communities +``` ++## Optional query parameters ++This method supports the `$top`, `$select`, and `$expand` [OData query parameters](/graph/query-parameters) to help customize the response. It also supports the `$orderby` parameter for the **displayName** property. ++## 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 [community](../resources/community.md) objects in the response body. ++## Examples ++### Example 1: Get a list of communities ++The following example shows how to get a list of Viva Engage communities. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_community" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/employeeExperience/communities +``` ++# [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.community)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#employeeExperience/communities", + "value": [ + { + "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTEzMjYyODk5MjAifQ", + "displayName": "All Company", + "description": "This is the default group for everyone in the network", + "privacy": "public", + "groupId": "195d9ecd-f80e-4bab-af95-176eba253dfa" + }, + { + "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTE0NzY2Mzc2OTYifQ", + "displayName": "TestCommunity5", + "description": "Test community created via API", + "privacy": "public", + "groupId": "0bed8b86-5026-4a93-ac7d-56750cc099f1" + } + ] +} +``` ++### Example 2: Get a list of communities with pagination ++The following example shows how to get a list of Viva Engage communities using the `$top` query parameter to set the page size of results. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_community_top" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/employeeExperience/communities?$top=2 +``` ++# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) ++++#### Response ++If the number of communities exceeds 20 or you use the `$top` query parameter to set the page size of results, multiple query requests might be necessary to retrieve all results. In this scenario, the API continues to return a reference to the next page of results in the **@odata.nextLink** property with each response until no more pages remain to be retrieved. ++The following example shows the response that includes the **@odata.nextLink** property. ++>**Note:** The response object shown here might be shortened for readability. ++<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "Collection(microsoft.graph.community)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#employeeExperience/communities", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/employeeExperience/communities?$skiptoken=UVWlYzI7VjE7MTE2NDUzNDU3OTIwOzIwO0RlbW8tdGVzdC01OztEaXNwbGF5TmFtZTtmYWXYZTs", + "value": [ + { + "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTEzMjYyODk5MjAifQ", + "displayName": "All Company", + "description": "This is the default group for everyone in the network", + "privacy": "public", + "groupId": "195d9ecd-f80e-4bab-af95-176eba253dfa" + }, + { + "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTE0NzY2Mzc2OTYifQ", + "displayName": "TestCommunity5", + "description": "Test community created via API", + "privacy": "public", + "groupId": "0bed8b86-5026-4a93-ac7d-56750cc099f1" + } + ] +} +``` + |
v1.0 | Employeeexperience Post Communities | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/employeeexperience-post-communities.md | + + Title: "Create community" +description: "Create a new community in Viva Engage." ++ms.localizationpriority: medium ++++# Create community ++Namespace: microsoft.graph ++Create a new [community](../resources/community.md) in Viva Engage. +++## 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": "employeeexperience_post_communities" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /employeeExperience/communities +``` ++## 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 [community](../resources/community.md) object. ++You can specify the following properties when you create a **community**. ++|Property|Type|Description| +|:|:|:| +| description | String | The description of the community. Maximum length is 1,024 characters. | +| displayName | String | The name of the community. Maximum length is 255 characters. | +| privacy | [communityPrivacy](../resources/community.md#communityprivacy-values) | Defines the privacy level of the community. The possible values are: `public`, `private`, `unknownFutureValue`. | ++## Response ++If successful, this method returns a `202 Accepted` response code. The response also contains an `Operation-Location` header with a link to the [engagementAsyncOperation](../resources/engagementasyncoperation.md). You can poll the `Operation-Location` endpoint for status update on the creation operation. ++## Examples ++### Example 1: Delegated permissions ++#### Request ++The following example shows a request with delegated permissions. When the **owners** property isn't specified in the request body, the calling user is automatically assigned as the community owner. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_community_from_minimal_e1" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/employeeExperience/communities +Content-Type: application/json ++{ + "displayName": "Financial Advice for Software Engineers", + "description": "A community where financial advisors who represent customers from software engineering profession can discuss advice and suggestions for their clients.", + "privacy": "public" +} +``` ++# [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 +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Type: application/json +Operation-Location: https://graph.microsoft.com/v1.0/employeeExperience/engagementAsyncOperations('3a6fdce1-c261-48bc-89de-1cfef658c0d5') +``` ++### Example 2: Application permissions ++#### Request ++The following example shows a minimal request that requires application permissions. If the **owners** property isn't specified in the request body, the request fails. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_community_from_app_only_e2" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/employeeExperience/communities +Content-Type: application/json ++{ + "displayName": "Financial Advice for Software Engineers", + "description": "A community where financial advisors who represent customers from software engineering profession can discuss advice and suggestions for their clients.", + "privacy": "public", + "owners@odata.bind": [ + "https://graph.microsoft.com/v1.0/users/26be1845-4119-4801-a799-aea79d09f1a2" + ] +} +``` ++# [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 +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Type: application/json +Operation-Location: https://graph.microsoft.com/v1.0/employeeExperience/engagementAsyncOperations('3a6fdce1-c261-48bc-89de-1cfef658c0d5') +``` |
v1.0 | Engagementasyncoperation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/engagementasyncoperation-get.md | + + Title: "Get engagementAsyncOperation" +description: "Get an engagementAsyncOperation to track a long-running operation request." ++ms.localizationpriority: medium ++++# Get engagementAsyncOperation ++Namespace: microsoft.graph ++Get an [engagementAsyncOperation](../resources/engagementasyncoperation.md) to track a long-running operation request. +++## 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": "engagementasyncoperation_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /employeeExperience/engagementAsyncOperations/{engagementAsyncOperationId} +``` ++## 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 an [engagementAsyncOperation](../resources/engagementasyncoperation.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_engagementasyncoperation" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/employeeExperience/engagementAsyncOperations/a6fdce1-c261-48bc-89de-1cfef658c0d5 +``` ++# [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.engagementAsyncOperation" +} +--> +```http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/employeeExperience/engagementAsyncOperations/$entity", + "id": "eyJfdHlwZSI6IkxvbmdSdW5uaW5nT3BlcmF0aW9uIiwiaWQiOiI0ZmVhMjE5Ni0yZTRjLTQ4MzctYTlhNi1iMTVjOTBhNTM2ODkiLCJvcGVyYXRpb24iOiJDcmVhdGVDb21tdW5pdHkifQ", + "createdDateTime": "2023-12-06T09:42:54.367629-08:00", + "lastActionDateTime": "2023-12-06T09:42:54.367663-08:00", + "status": "succeeded", + "statusDetail": null, + "resourceLocation": "https://graph.microsoft.com/v1.0/employeeExperience/communities('eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0')", + "operationType": "createCommunity", + "resourceId": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI4MzIxMjc1In0" +} +``` |
v1.0 | Entitlementmanagement Post Assignmentrequests | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/entitlementmanagement-post-assignmentrequests.md | doc_type: apiPageType Namespace: microsoft.graph -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/all-clouds.md)] For an administrator to request to update an assignment (for example to extend t For an administrator to request to remove an assignment, the value of the **requestType** property is `adminRemove`, and the **assignment** property contains the **id** property identifying the [accessPackageAssignment](../resources/accesspackageassignment.md) being removed. -For a non-administrator user to request to create their own assignment for either a first assignment or renew assignment, the value of the **requestType** property is `userAdd`. The **assignment** property contains an object with the `targetId` with the `id` of the user. The **assignmentPolicyId** property identifies the [accessPackageAssignmentPolicy](../resources/accesspackageassignmentpolicy.md). The **accessPackageId** property identifies the [accessPackage](../resources/accesspackage.md). The user making the request must already exist in the directory. +For a non-administrator user to request to create their own assignment for either a first assignment or to renew an assignment, the value of the **requestType** property is `userAdd`. The **assignment** property contains an object with the `targetId` with the `id` of the user. The **assignmentPolicyId** property identifies the [accessPackageAssignmentPolicy](../resources/accesspackageassignmentpolicy.md). The **accessPackageId** property identifies the [accessPackage](../resources/accesspackage.md). The user making the request must already exist in the directory. -For a non-administrator user to request to update their own assignments, the value of the **requestType** property is `userUpdate`. The **assignment** property contains the `targetId` with the `id` of the users. The **assignmentPolicyId** property identifies the [accessPackageAssignmentPolicy](../resources/accesspackageassignmentpolicy.md). The **accessPackageId** property identifies the [accessPackage](../resources/accesspackage.md). The user making the request must already exist in the directory. +For a non-administrator user to request to update their own assignment, the value of the **requestType** property is `userUpdate`. The **assignment** property contains the **ID** property identifying the [accessPackageAssignment](../resources/accesspackageassignment.md) being updated. The **schedule** property contains the updated schedule. ## Response 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-assignments.md). +If this is an `adminAdd` or `userAdd` request, then after any approval checks 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-assignments.md). ## Examples Content-type: application/json { "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest",- "id": "7a6ab703-0780-4b37-8445-81f679b2d75c", "requestType": "adminUpdate", "answers": [ { Content-type: application/json "customExtensionCalloutInstances": [] } ```++### Example 8: Update the answers and expiration date for an access package assignment ++The following example shows how a user can update their answers and the expiration date for their access package assignment. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_accesspackageassignmentrequest_expiration_answers" +}--> +```http +POST https://graph.microsoft.com/v1.0/identityGovernance/entitlementManagement/assignmentRequests +Content-type: application/json ++{ + "requestType": "userUpdate", + "answers": [ + { + "@odata.type": "#microsoft.graph.accessPackageAnswerString", + "value": "My updated answer.", + "answeredQuestion": { + "@odata.type": "#microsoft.graph.accessPackageTextInputQuestion", + "id": "0d31cc60-968e-4f92-955b-443fed03d6f6" + } + } ++ ], + "schedule": { + "startDateTime": "2024-09-18T20:49:16.17Z", + "recurrence": null, + "expiration": { + "endDateTime": "2024-10-18T20:49:15.17Z", + "duration": null, + "type": "afterDateTime" + } + }, + "assignment": { + "id": "329f8dac-8062-4c1b-a9b8-39b7132f9bff" + } +} +``` ++# [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": "e0f8458c-7681-42ad-a0b5-0c9587c4dad8", + "requestType": "userUpdate", + "state": "submitted", + "status": "Accepted" +} +``` |
v1.0 | Entitlementmanagement Post Catalogs | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/entitlementmanagement-post-catalogs.md | Title: "Create accessPackageCatalog" -description: "Create a new accessPackageCatalog." +description: "Create a new accessPackageCatalog object." ms.localizationpriority: medium |
v1.0 | Entitlementmanagement Post Connectedorganizations | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/entitlementmanagement-post-connectedorganizations.md | If successful, this method returns a `201 Created` response code and a new [conn ## Examples +### Example 1: Create a connected organization + ### Request # [HTTP](#tab/http) Content-type: application/json } ``` +### Example 2: Create a connected organization with an identitySource based on a tenant ID ++This example shows creating a connected organization with an identity source based on a tenant ID. The tenant ID can be found, by the domain name, using the [tenantRelationship: findTenantInformationByDomainName](../api/tenantrelationship-findtenantinformationbydomainname.md) call. ++### Request +++<!-- { + "blockType": "request", + "name": "create_connectedorganization_from_connectedorganizations_based_on_tenantID" +} +--> +``` http +POST https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/connectedOrganizations/ +Content-Type: application/json ++{ + "displayName":"Connected organization name", + "description":"Connected organization description", + "identitySources": [ + { + "@odata.type": "#microsoft.graph.azureActiveDirectoryTenant", + "displayName": "Contoso", + "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee" + } + ], + "state":"proposed" +} ++``` ++### Response ++**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.connectedOrganization" +} +--> +``` http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#identityGovernance/entitlementManagement/connectedOrganizations/$entity", + "id": "922c86cf-65b8-4d94-b6a6-477dde331c7b", + "displayName": "Connected organization name", + "description": "Connected organization description", + "createdDateTime": "2024-10-29T21:55:39.6051923Z", + "modifiedDateTime": "2024-10-29T21:55:39.6051923Z", + "state": "proposed", + "identitySources": [] +} ++``` |
v1.0 | Exchangeprotectionpolicy List Mailboxinclusionrules | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/exchangeprotectionpolicy-list-mailboxinclusionrules.md | If successful, this method returns a `200 OK` response code and a [mailboxProtec The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangeprotectionpolicy_list_mailboxinclusionrule" GET https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtectionP Authorization: Bearer <Access-Token> ``` +# [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 | Exchangeprotectionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangeprotectionpolicy_update" Authorization: Bearer <Access-Token> } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ ### Response The following example shows the response. |
v1.0 | Exchangerestoresession List Mailboxrestoreartifacts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "mailboxrestoreartifact_list" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeRestoreSessions/845457dc-4bb2-4815-bef3-8628ebd1952e/mailboxRestoreArtifacts ``` +# [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 | Exchangerestoresession Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangerestoresession_update" Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ ### Response The following example shows the response. |
v1.0 | Filestoragecontainer Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/filestoragecontainer-get.md | Content-Type: application/json "description": "Description of My Application Storage Container", "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73", "status": "active",- "createdDateTime": "2021-11-24T15:41:52.347Z" + "createdDateTime": "2021-11-24T15:41:52.347Z", + "settings": { + "isOcrEnabled": false + } } ``` |
v1.0 | Filestoragecontainer Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/filestoragecontainer-post.md | Namespace: microsoft.graph Create a new [fileStorageContainer](../resources/filestoragecontainer.md) object. -The respective container type identified by **containerTypeId** must be enabled in the tenant. +The container type identified by **containerTypeId** must be enabled in the tenant. For delegated calls, the calling user is set as the owner of the **fileStorageContainer**. You can specify the following properties when you create a **fileStorageContaine |Property|Type|Description| |:|:|:| |displayName|String|The display name of the container. Required.|-|description|String|Provides a user-visible description of the item. Optional.| +|description|String|A user-visible description of the item. Optional.| |containerTypeId|GUID|The container type of the container instance. Required.|+|settings|[fileStorageContainerSettings](../resources/filestoragecontainersettings.md)|Settings associated with the container. Optional.| ## Response Content-Type: application/json { "displayName": "My Application Storage Container", "description": "Description of My Application Storage Container",- "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73" + "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73", + "settings": { + "isOcrEnabled": true + } } ``` Content-type: application/json "description": "Description of My Application Storage Container", "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73", "status": "inactive",- "createdDateTime": "2021-11-24T15:41:52.347Z" + "createdDateTime": "2021-11-24T15:41:52.347Z", + "settings": { + "isOcrEnabled": true + } } ``` |
v1.0 | Filestoragecontainer Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/filestoragecontainer-update.md | Content-Type: application/json { "displayName": "Updated Name",- "description": "Updated Description" + "description": "Updated Description", + "settings": { + "isOcrEnabled": false + } } ``` Content-type: application/json "description": "Updated Description", "containerTypeId": "91710488-5756-407f-9046-fbe5f0b4de73", "status": "active",- "createdDateTime": "2021-11-24T15:41:52.347Z" + "createdDateTime": "2021-11-24T15:41:52.347Z", + "settings": { + "isOcrEnabled": false + } } ``` |
v1.0 | Group Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-assignlicense.md | doc_type: "apiPageType" Namespace: microsoft.graph -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](../resources/subscribedsku.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/d056d009-17b3-4106-8173-cd3978ada898/di "deletedDateTime": null, "classification": null, "createdDateTime": "2018-04-18T22:05:03Z",- "securityEnabled": true, + "securityEnabled": true } ``` |
v1.0 | Group Delete Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/api/group-delta.md | doc_type: apiPageType Namespace: microsoft.graph -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/v1.0/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 Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-list-members.md | Namespace: microsoft.graph Get a list of the group's direct members. A group can have users, organizational contacts, devices, service principals and other groups as members. This operation is not transitive. > [!IMPORTANT]-> This API has a known issue where service principals are not listed as group members in v1.0. Use this API on the `beta` endpoint instead or the `/groups/{id}?$expand=members` API. Note the [limitations of $expand on directory objects](https://developer.microsoft.com/en-us/graph/known-issues/?search=13635). +> This API has a known issue where service principals are not listed as group members in v1.0. As a workaround, use this API on the `beta` endpoint or use the `/groups/{id}?$expand=members` API. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=25984). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | Group List Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-list-owners.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve a list of the group's owners. The owners are a set of users or service principals who are allowed to modify the group object. Owners are currently not available in Microsoft Graph for groups that were created in Exchange or groups that are synchronized from an on-premises environment. +Retrieve a list of the group's owners. The owners are a set of users or service principals who are allowed to modify the group object. Owners are currently not available in Microsoft Graph for groups that were created in Exchange, distribution groups, or groups that are synchronized from an on-premises environment. > **Note:** Currently, service principals are not listed as group owners due to the staged rollout of service principals to the Microsoft Graph v1.0 endpoint. |
v1.0 | Group List Settings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/group-list-settings.md | Retrieve a list of tenant-level or group-specific group settings objects. ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +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). ### List tenant-wide settings <!-- { "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) | Directory.Read.All, Directory.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Directory.Read.All, Directory.ReadWrite.All | + ### List group-specific settings <!-- { "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, Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Group.Read.All, Group.ReadWrite.All | ++ [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
v1.0 | Group List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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 -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 The following example shows a request. This request requires the **ConsistencyLe }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/groups?$count=true&$filter=hasMembersWithLicenseErrors+eq+true&$select=id,displayName -ConsistencyLevel: eventual +GET https://graph.microsoft.com/v1.0/groups?$filter=hasMembersWithLicenseErrors+eq+true&$select=id,displayName ``` # [C#](#tab/csharp) Content-type: application/json { "@odata.context":"https://graph.microsoft.com/v1.0/$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/v1.0/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/v1.0/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](group-post-members.md) 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 # [HTTP](#tab/http) |
v1.0 | Group Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/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/v1.0/api/group-upsert.md | The following table lists the properties that are required when you create the [ > > - 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](group-post-members.md) 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 | Groupsetting Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/groupsetting-delete.md | Delete a tenant-level or group-specific [groupSetting](../resources/groupsetting ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +The following 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). ++### For tenant-wide settings -### For all settings except the Consent Policy Settings object <!-- { "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) | Directory.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Directory.ReadWrite.All | -### For the Consent Policy Settings object +### For group-specific settings -The following permissions are required to update the "Consent Policy Settings" **directorySetting** object. <!-- { "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) | Policy.ReadWrite.Authorization | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Policy.ReadWrite.Authorization | [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
v1.0 | Groupsetting Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/groupsetting-get.md | Retrieve the properties of a specific group setting object. The setting can be a ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +The following 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). ### List tenant-wide settings <!-- { "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) | Directory.Read.All, Directory.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Directory.Read.All, Directory.ReadWrite.All | ### List group-specific settings+ <!-- { "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, Group.ReadWrite.All | -| Delegated (personal Microsoft account) | Not supported. | -| Application | Group.Read.All, Group.ReadWrite.All | [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
v1.0 | Groupsetting Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/groupsetting-update.md | Update the properties of a [groupSetting](../resources/groupsetting.md) object f ## Permissions -One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +The following 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). ++### For all settings *except* the Consent Policy Settings object -### For all settings except the Consent Policy Settings object <!-- { "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) | Directory.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Directory.ReadWrite.All | ### For the Consent Policy Settings object The following permissions are required to update the "Consent Policy Settings" **directorySetting** object.+ <!-- { "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) | Policy.ReadWrite.Authorization | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Policy.ReadWrite.Authorization | [!INCLUDE [rbac-group-directorysettings-all](../includes/rbac-for-apis/rbac-group-directorysettings-all.md)] |
v1.0 | Groupsettingtemplate Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/groupsettingtemplate-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "groupsettingtemplate_get" } --> [!INCLUDE [permissions-table](../includes/permissions/groupsettingtemplate-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" } --> |
v1.0 | Groupsettingtemplate List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/groupsettingtemplate-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "groupsettingtemplate_list" } --> [!INCLUDE [permissions-table](../includes/permissions/groupsettingtemplate-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" } --> |
v1.0 | Identitycontainer List Authenticationeventlisteners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-authenticationeventlisteners.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_authenticationeventlisteners" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-authenticationeventlisteners-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitycontainer List Authenticationeventsflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-authenticationeventsflows.md | GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows [!INCLUDE [sample-code](../includes/snippets/php/list-authenticationeventsflow-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/list-authenticationeventsflow-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows?$filter= [!INCLUDE [sample-code](../includes/snippets/php/list-authenticationeventsflow-selfservicesignup-identityproviders-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/list-authenticationeventsflow-selfservicesignup-identityproviders-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows?$filter= [!INCLUDE [sample-code](../includes/snippets/php/list-authenticationeventsflow-filter-selfservicesignup-attributes-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/list-authenticationeventsflow-filter-selfservicesignup-attributes-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows?$filter= [!INCLUDE [sample-code](../includes/snippets/php/list-authenticationeventsflow-filter-includeapplications-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/list-authenticationeventsflow-filter-includeapplications-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitycontainer List Customauthenticationextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-customauthenticationextensions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_list_customauthenticationextensions" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-customauthenticationextensions-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitycontainer List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-list-identityproviders.md | Content-type: application/json #### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_identityproviderbase_CIAM" The following example shows a request. GET https://graph.microsoft.com/v1.0/identity/identityProviders ``` +# [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. Content-type: application/json } ] }-``` +``` |
v1.0 | Identitycontainer Post Authenticationeventlisteners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-authenticationeventlisteners.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_authenticationeventlisteners" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-authenticationeventlisteners-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitycontainer Post Authenticationeventsflows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-authenticationeventsflows.md | You can specify the following properties when creating an **authenticationEvents |priority|Int32|Optional. 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. Default is 500. | |onInteractiveAuthFlowStart|[onInteractiveAuthFlowStartHandler](../resources/oninteractiveauthflowstarthandler.md)|Required. The configuration for what to invoke when an authentication flow is ready to be initiated. | |onAuthenticationMethodLoadStart|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|Required. The configuration for what to invoke when authentication methods are ready to be presented to the user. Must have at least one identity provider linked.|-|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Optional. The configuration for what to invoke when attributes are ready to be collected from the user. To configure this property when it wasn't configured during user flow creation, call the [Add attributes to a user flow](../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md) API.| +|onAttributeCollection|[onAttributeCollectionHandler](../resources/onattributecollectionhandler.md)|Optional. The configuration for what to invoke when attributes are ready to be collected from the user. To configure this property, you must specify both **attributes** and **onAttributeCollectionPage** > **views** objects.| |onUserCreateStart|[onUserCreateStartHandler](../resources/onusercreatestarthandler.md)|Optional. The configuration for what to invoke during user creation.| ## Response Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-authenticationeventsflow-selfservicesignup-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/create-authenticationeventsflow-selfservicesignup-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-authenticationeventsflow-selfservicesignup-includeapplications-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/create-authenticationeventsflow-selfservicesignup-includeapplications-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/create-authenticationeventsflow--selfservicesignup-socialproviders-customattribute-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/create-authenticationeventsflow--selfservicesignup-socialproviders-customattribute-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Identitycontainer Post Customauthenticationextensions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitycontainer-post-customauthenticationextensions.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identitycontainer_post_customauthenticationextensions" } --> [!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-customauthenticationextensions-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identitygovernance Deleteditemcontainer Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-deleteditemcontainer-delete.md | Delete a [workflow](../resources/identitygovernance-workflow.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": "identitygovernance_deletedItemcontainer_delete" } --> +<!-- { "blockType": "permissions", "name": "identitygovernance_deleteditemcontainer_delete" } --> [!INCLUDE [rbac-lifecycle-workflows-apis-write](../includes/rbac-for-apis/rbac-lifecycle-workflows-apis-write.md)] |
v1.0 | Identitygovernance Insights Toptasksprocessedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-insights-toptasksprocessedsummary.md | + + Title: "insights: topTasksProcessedSummary" +description: "Get a summary of the most processed tasks by Lifecycle Workflows in a tenant." ++ms.localizationpriority: medium ++++# insights: topTasksProcessedSummary ++Namespace: microsoft.graph.identityGovernance ++Provide a summary of the most processed tasks, known as top tasks, for a specified time period in a tenant. The task definition is provided, along with numerical counts of total, successful, and failed runs. For information about workflows processed, see [insights: topWorkflowsProcessedSummary](identitygovernance-insights-topworkflowsprocessedsummary.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": "identitygovernance-insights-toptasksprocessedsummary-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identityGovernance/lifecycleWorkflows/insights/topTasksProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime}) +``` ++## Function parameters ++In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function. ++|Parameter|Type|Description| +|:|:|:| +|startDateTime|DateTimeOffset|The start date, and time, of the insight summary for most tasks processed in a tenant.| +|endDateTime|DateTimeOffset|The end date, and time, of the insight summary for most tasks processed in a tenant.| ++## 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 [microsoft.graph.identityGovernance.topTasksInsightsSummary](../resources/identitygovernance-toptasksinsightssummary.md) collection in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "insightsthis.toptasksprocessedsummary" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/insights/topTasksProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` ++# [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.identityGovernance.topTasksInsightsSummary)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.identityGovernance.topTasksInsightsSummary)", +"value": [ + { + "taskDefinitionId" : "gbc28c8e-f522-43b1-9d30-ee62b4ee941c", + "taskDefinitionDisplayName" : "Disable User Account", + "totalTasks" : 32, + "successfulTasks" : 15, + "failedTasks" : 17, + "totalUsers" : 46 , + "successfulUsers" : 25 , + "failedUsers" : 21 + }, + { + "taskDefinitionId" : "afg23h8e-a522-53b1-5d30-ft62b4ee941d", + "taskDefinitionDisplayName" : "Add user to groups", + "totalProcessedTasks" : 30, + "successfulTasks" : 14, + "failedTasks" : 16, + "totalUsers" : 36 , + "successfulUsers" : 25 , + "failedUsers" : 11 + }, + { + "taskDefinitionId" : "mcd28c8e-t523-83b1-3d70-jl62b4hh944g", + "taskDefinitionDisplayName" : "Send onboarding reminder email", + "totalProcessedTasks" : 28, + "successfulTasks" : 13, + "failedTasks" : 15, + "totalUsers" : 37 , + "successfulUsers" : 23 , + "failedUsers" : 14 + }, + { + "taskDefinitionId" : "beg28c8e-h23-53b1-8f60-kv62b4ee941c", + "taskDefinitionDisplayName" : "Generate TAP and Send Email", + "totalProcessedTasks" : 30, + "successfulTasks" : 18, + "failedTasks" : 12, + "totalUsers" : 35 , + "successfulUsers" : 24 , + "failedUsers" : 11 + }, + { + "taskDefinitionId" : "efc28c8e-j322-73b1-9e30-fh62b4ee941d", + "taskDefinitionDisplayName" : "Run a custom task extension", + "totalProcessedTasks" : 25, + "successfulTasks" : 15, + "failedTasks" : 10, + "totalUsers" : 26 , + "successfulUsers" : 17 , + "failedUsers" : 9 + }, + { + "taskDefinitionId" : "nmd28c8e-k822-53b1-3d30-ee62b4ee941e", + "taskDefinitionDisplayName" : "Request user access package assignment", + "totalProcessedTasks" : 26, + "successfulTasks" : 18, + "failedTasks" : 8, + "totalUsers" : 32, + "successfulUsers" : 24 , + "failedUsers" : 8 + }, + { + "taskDefinitionId" : "qbc28c8e-f522-43b1-9d30-ee62b4ee941c", + "taskDefinitionDisplayName" : "Send Welcome Email", + "totalProcessedTasks" : 25, + "successfulTasks" : 20, + "failedTasks" : 5, + "totalUsers" : 28 , + "successfulUsers" : 22 , + "failedUsers" : 6 + }, + ] +} +``` |
v1.0 | Identitygovernance Insights Topworkflowsprocessedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-insights-topworkflowsprocessedsummary.md | + + Title: "insights: topWorkflowsProcessedSummary" +description: "Get a summary of the most processed workflows by Lifecycle Workflows in a tenant." ++ms.localizationpriority: medium ++++# insights: topWorkflowsProcessedSummary ++Namespace: microsoft.graph.identityGovernance ++Provide a summary of the workflows processed the most, known as top workflows, for a specified period in a tenant. Workflow basic details are given, along with run information. For information about tasks processed, see [insights: topTasksProcessedSummary](identitygovernance-insights-toptasksprocessedsummary.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": "identitygovernance-insights-topworkflowsprocessedsummary-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime}) +``` ++## Function parameters ++In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function. ++|Parameter|Type|Description| +|:|:|:| +|startDateTime|DateTimeOffset|The start date, and time, of the summary of the most workflows processed in a tenant.| +|endDateTime|DateTimeOffset|The end date, and time, of the summary of the most workflows processed in a tenant.| ++## 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 [microsoft.graph.identityGovernance.topWorkflowsInsightsSummary](../resources/identitygovernance-topworkflowsinsightssummary.md) collection in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "insightsthis.topworkflowsprocessedsummary" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/insights/topWorkflowsProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` ++# [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.identityGovernance.topWorkflowsInsightsSummary)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.identityGovernance.topWorkflowsInsightsSummary)", + "value": [ + { + "workflowId" : "6a98cceb-503b-709c-996c-3cg0f24481eb", + "workflowDisplayName" : "Pre-hire workflow", + "workflowCategory" : "Joiner", + "totalRuns" : 30 , + "successfulRuns" : 28 , + "failedRuns" : 2 , + "scheduledRuns" : 26, + "onDemandRuns" : 4, + "totalUsers" : 45, + "successfulUsers" : 38, + "failedUsers": 7, + "workflowVersion" : 3 + }, + { + "workflowId" : "8b67ddeb-603b-609c-293f-4dg0f28481ek", + "workflowDisplayName" : "Pre-Hire workflow", + "workflowCategory" : "Joiner", + "totalRuns" : 35 , + "successfulRuns" : 26 , + "failedUsers" : 9, + "scheduledRuns" : 30, + "onDemandRuns" : 5, + "totalUsers" : 56, + "successfulUsers" : 47 , + "failedUsers": 9, + "workflowVersion" : 1 + }, + { + "workflowId" : "1f67cceb-203b-909c-096f-6cg0f28481fg", + "workflowDisplayName" : "Post-Hire Workflow", + "workflowCategory" : "Jeaver", + "totalRuns" : 32 , + "successfulRuns" : 25 , + "failedRuns" : 7 , + "scheduldedRuns" : 15, + "onDemandRuns" : 17, + "totalUsers": 53, + "successfulUsers" : 45, + "failedUsers" : 8, + "workflowVersion" : 2 + }, + { + "workflowId" : "2s67ddeb-303b-709c-896f-4cg0f28481ed", + "workflowDisplayName" : "Pre-Hire Workflow", + "workflowCategory" :"Joiner" , + "totalRuns" : 28 , + "successfulRuns" : 23, + "failedRuns" : 5, + "scheduldedRuns" : 20, + "onDemandRuns" : 8, + "totalUsers" : 40, + "successfulUsers" : 32 , + "failedUsers" : 8, + "workflowVersion" : 2 + }, + { + "workflowId" : "7a67ddeb-503b-909d-995f-3cg0f26481eh", + "workflowDisplayName" : "Post-Hire Workflow", + "workflowCategory" : "Leaver", + "totalRuns" : 26 , + "successfulRuns" : 20 , + "failedRuns" : 6 , + "scheduldedRuns" : 12, + "onDemandRuns" : 14, + "totalUsers" : 34, + "successfulUsers" : 23, + "failedUsers" : 11, + "workflowVersion" : 1 + }, + ] +} +``` |
v1.0 | Identitygovernance Insights Workflowsprocessedbycategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-insights-workflowsprocessedbycategory.md | + + Title: "insights: workflowsProcessedByCategory" +description: "Provide a summary of workflows processed in a tenant by the workflow category." ++ms.localizationpriority: medium ++++# insights: workflowsProcessedByCategory ++Namespace: microsoft.graph.identityGovernance ++Provide a summary of workflows processed, by category, in a tenant. This allows you to quickly get category information, by numerical value, bypassing other information found in the [WorkflowsProcessedSummary](identitygovernance-insights-workflowsprocessedsummary.md) call. +++## 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": "identitygovernance-insights-workflowsprocessedbycategory-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory(startDateTime={startDateTime},endDateTime={endDateTime}) +``` ++## Function parameters ++In the request URL, provide the following query parameters with values. ++|Parameter|Type|Description| +|:|:|:| +|startDateTime|DateTimeOffset|The start date, and time, of the insight summary for workflows processed by category in a tenant.| +|endDateTime|DateTimeOffset|The end date, and time, of the insight summary for workflows processed by category in a tenant.| ++## 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 [workflowsInsightsByCategory](../resources/identitygovernance-workflowsinsightsbycategory.md) in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "insightsthis.workflowsprocessedbycategory" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/insights/workflowsProcessedByCategory(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` ++# [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": "microsoft.graph.identityGovernance.workflowsInsightsByCategory" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "totalJoinerRuns" : 136, + "successfulJoinerRuns" : 112, + "failedJoinerRuns" : 24, + "totalMoverRuns" : 97, + "successfulMoverRuns" : 79, + "failedMoverRuns" : 18, + "totalLeaverRuns" : 103, + "successfulLeaverRuns" : 96, + "failedLeaverRuns" : 7, +} +``` |
v1.0 | Identitygovernance Insights Workflowsprocessedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-insights-workflowsprocessedsummary.md | + + Title: "insights: workflowsProcessedSummary" +description: "Get the summary of workflows processed by Lifecycle Workflows within a tenant." ++ms.localizationpriority: medium ++++# insights: workflowsProcessedSummary ++Namespace: microsoft.graph.identityGovernance ++Provide a summary of all workflows processed within a tenant for a specified period. Because the amount of results for listed workflows as returned by the [List workflows](../api/identitygovernance-lifecycleworkflowscontainer-list-workflows.md) does not tell you which workflows were processed from the list of created workflows, this summary gives you a quick overview of processed status based on counts. +++## 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": "identitygovernance-insights-workflowsprocessedsummary-permissions" +} +--> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /identityGovernance/lifecycleWorkflows/insights/workflowsProcessedSummary(startDateTime={startDateTime},endDateTime={endDateTime}) +``` ++## Function parameters ++In the request URL, provide the following query parameters with values. The following table lists the parameters that are required when you call this function. ++|Parameter|Type|Description| +|:|:|:| +|startDateTime|DateTimeOffset|The start date, and time, of the summary report of workflows processed in a tenant.| +|endDateTime|DateTimeOffset|The end date, time, of the summary report of workflows processed in a tenant.| ++## 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 [workflowsInsightsSummary](../resources/identitygovernance-workflowsinsightssummary.md) in the response body. ++## Examples ++### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "insightsthis.workflowsprocessedsummary" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/insights/workflowsProcessedSummary(startDateTime=2023-01-01T00:00:00Z,endDateTime=2023-01-31T00:00:00Z) +``` ++# [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": "microsoft.graph.identityGovernance.workflowsInsightsSummary" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.identityGovernance.workflowsInsightsSummary", + "totalRuns" : 106, + "successfulRuns" : 71, + "failedRuns": 35, + "totalUsers" : 150, + "successfulUsers" : 112, + "failedUsers" : 38 , + "totalTasks" : 75, + "successfulTasks" : 56, + "failedTasks" :19 , +} +``` |
v1.0 | Identitygovernance Lifecycleworkflowscontainer List Taskdefinitions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-lifecycleworkflowscontainer-list-taskdefinitions.md | Title: "List taskDefinitions" -description: "Get a list of the taskDefinition objects and their properties." +description: "Get a list of built-in tasks in Lifecycle Workflows." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph.identityGovernance -Get a list of the [taskDefinition](../resources/identitygovernance-taskdefinition.md) objects and their properties. +Get a list of built-in tasks in Lifecycle Workflows. A task is represented by the [taskDefinition](../resources/identitygovernance-taskdefinition.md) object. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] GET https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/taskD #### Response The following example shows the response.+<!-- Keep the full response object for this example for other internal purposes--> <!-- { "blockType": "response", Content-Type: application/json { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identityGovernance/lifecycleWorkflows/taskDefinitions",- "@odata.count": 16, + "@odata.count": 24, + "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET identityGovernance/lifecycleWorkflows/taskDefinitions?$select=category,continueOnError", "value": [ {- "category": "joiner,leaver", + "category": "joiner,leaver,mover", "description": "Add user to selected groups",- "displayName": "Add User To Groups", + "displayName": "Add user to groups", "id": "22085229-5809-45e8-97fd-270d28d66910", "version": 1, "parameters": [ Content-Type: application/json { "category": "joiner,leaver", "description": "Disable user account in the directory",- "displayName": "Disable User Account", + "displayName": "Disable user account", "id": "1dfdfcc7-52fa-4c2e-bf3a-e3919cc12950", "version": 1,- "parameters": [] + "parameters": [ + { + "name": "disableOnPremisesAccount", + "values": [ + "true", + "false" + ], + "valueType": "enum" + } + ] }, { "category": "joiner,leaver", "description": "Enable user account in the directory",- "displayName": "Enable User Account", + "displayName": "Enable user account", "id": "6fc52c9d-398b-4305-9763-15f42c1676fc", "version": 1,- "parameters": [] + "parameters": [ + { + "name": "enableOnPremisesAccount", + "values": [ + "true", + "false" + ], + "valueType": "enum" + } + ] }, {- "category": "joiner,leaver", + "category": "joiner,leaver,mover", "description": "Remove user from membership of selected Azure AD groups", "displayName": "Remove user from selected groups", "id": "1953a66c-751c-45e5-8bfe-01462c70da3c", Content-Type: application/json { "category": "joiner", "description": "Generate Temporary Access Pass and send via email to user's manager",- "displayName": "Generate TAP And Send Email", + "displayName": "Generate TAP and send email", "id": "1b555e50-7f65-41d5-b514-5894a026d10d", "version": 1, "parameters": [ Content-Type: application/json "false" ], "valueType": "enum"+ }, + { + "name": "cc", + "values": [], + "valueType": "string" + }, + { + "name": "customSubject", + "values": [], + "valueType": "string" + }, + { + "name": "customBody", + "values": [], + "valueType": "string" + }, + { + "name": "locale", + "values": [], + "valueType": "string" } ] }, { "category": "joiner", "description": "Send welcome email to new hire",- "displayName": "Send Welcome Email", + "displayName": "Send welcome email", "id": "70b29d51-b59a-4773-9280-8841dfd3f2ea", "version": 1,- "parameters": [] + "parameters": [ + { + "name": "cc", + "values": [], + "valueType": "string" + }, + { + "name": "customSubject", + "values": [], + "valueType": "string" + }, + { + "name": "customBody", + "values": [], + "valueType": "string" + }, + { + "name": "locale", + "values": [], + "valueType": "string" + } + ] }, {- "category": "joiner,leaver", - "description": "Add user to selected teams", - "displayName": "Add User To Teams", + "category": "joiner,leaver,mover", + "description": "Add user to selected Teams", + "displayName": "Add user to Teams", "id": "e440ed8d-25a1-4618-84ce-091ed5be5594", "version": 1, "parameters": [ Content-Type: application/json { "category": "leaver", "description": "Delete user account in Azure AD",- "displayName": "Delete User Account", + "displayName": "Delete user account", "id": "8d18588d-9ad3-4c0f-99d0-ec215f0e3dff", "version": 1,- "parameters": [] + "parameters": [ + { + "name": "deleteOnPremisesAccount", + "values": [ + "true", + "false" + ], + "valueType": "enum" + } + ] }, {- "category": "joiner,leaver", + "category": "joiner,leaver,mover", "description": "Remove user from membership of selected Teams", "displayName": "Remove user from selected Teams", "id": "06aa7acb-01af-4824-8899-b14e5ed788d6", Content-Type: application/json "parameters": [] }, {- "category": "joiner,leaver", + "category": "joiner,leaver,mover", "description": "Run a Custom Task Extension to callout to an external system.", "displayName": "Run a Custom Task Extension", "id": "4262b724-8dba-4fad-afc3-43fcbb497a0e", Content-Type: application/json }, { "category": "leaver",- "description": "Send offboarding email to userΓÇÖs manager before the last day of work", - "displayName": "Send email before userΓÇÖs last day", + "description": "Send offboarding email to user's manager before the last day of work", + "displayName": "Send email before user's last day", "id": "52853a3e-f4e5-4eb8-bb24-1ac09a1da935", "version": 1,- "parameters": [] + "parameters": [ + { + "name": "cc", + "values": [], + "valueType": "string" + }, + { + "name": "customSubject", + "values": [], + "valueType": "string" + }, + { + "name": "customBody", + "values": [], + "valueType": "string" + }, + { + "name": "locale", + "values": [], + "valueType": "string" + } + ] }, { "category": "leaver",- "description": "Send offboarding email to userΓÇÖs manager on the last day of work", - "displayName": "Send email on userΓÇÖs last day", + "description": "Send offboarding email to user's manager on the last day of work", + "displayName": "Send email on user's last day", "id": "9c0a1eaf-5bda-4392-9d9e-6e155bb57411", "version": 1,- "parameters": [] + "parameters": [ + { + "name": "cc", + "values": [], + "valueType": "string" + }, + { + "name": "customSubject", + "values": [], + "valueType": "string" + }, + { + "name": "customBody", + "values": [], + "valueType": "string" + }, + { + "name": "locale", + "values": [], + "valueType": "string" + } + ] }, { "category": "leaver",- "description": "Send offboarding email to userΓÇÖs manager after the last day of work", - "displayName": "Send email after userΓÇÖs last day", + "description": "Send offboarding email to user's manager after the last day of work", + "displayName": "Send email after user's last day", "id": "6f22ddd4-b3a5-47a4-a846-0d7c201a49ce", "version": 1,+ "parameters": [ + { + "name": "cc", + "values": [], + "valueType": "string" + }, + { + "name": "customSubject", + "values": [], + "valueType": "string" + }, + { + "name": "customBody", + "values": [], + "valueType": "string" + }, + { + "name": "locale", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "joiner", + "description": "Send onboarding reminder email to user's manager", + "displayName": "Send onboarding reminder email", + "id": "3C860712-2D37-42A4-928F-5C93935D26A1", + "version": 1, + "parameters": [ + { + "name": "cc", + "values": [], + "valueType": "string" + }, + { + "name": "customSubject", + "values": [], + "valueType": "string" + }, + { + "name": "customBody", + "values": [], + "valueType": "string" + }, + { + "name": "locale", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "joiner,mover", + "description": "Request user assignment to selected access package", + "displayName": "Request user access package assignment", + "id": "c1ec1e76-f374-4375-aaa6-0bb6bd4c60be", + "version": 1, + "parameters": [ + { + "name": "assignmentPolicyId", + "values": [], + "valueType": "string" + }, + { + "name": "accessPackageId", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "leaver,mover", + "description": "Remove user assignment of selected access package", + "displayName": "Remove access package assignment for user", + "id": "4a0b64f2-c7ec-46ba-b117-18f262946c50", + "version": 1, + "parameters": [ + { + "name": "accessPackageId", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "leaver", + "description": "Remove all access packages assigned to the user", + "displayName": "Remove all access package assignments for user", + "id": "42ae2956-193d-4f39-be06-691b8ac4fa1d", + "version": 1, + "parameters": [] + }, + { + "category": "leaver", + "description": "Cancel all pending access packages assignment requests for the user", + "displayName": "Cancel pending access package assignment requests for user", + "id": "498770d9-bab7-4e4c-b73d-5ded82a1d0b3", + "version": 1, "parameters": []+ }, + { + "category": "mover", + "description": "Send email to notify user's manager of user move", + "displayName": "Send email to notify manager of user move", + "id": "aab41899-9972-422a-9d97-f626014578b7", + "version": 1, + "parameters": [ + { + "name": "cc", + "values": [], + "valueType": "string" + }, + { + "name": "customSubject", + "values": [], + "valueType": "string" + }, + { + "name": "customBody", + "values": [], + "valueType": "string" + }, + { + "name": "locale", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "joiner,mover", + "description": "Assign selected licenses to the user", + "displayName": "Assign licenses to user", + "id": "683c87a4-2ad4-420b-97d4-220d90afcd24", + "version": 1, + "parameters": [ + { + "name": "licenses", + "values": [], + "valueType": "string" + } + ] + }, + { + "category": "leaver,mover", + "description": "Remove selected licenses assigned to the user", + "displayName": "Remove licenses from user", + "id": "5fc402a8-daaf-4b7b-9203-da868b05fc5f", + "version": 1, + "parameters": [ + { + "name": "licenses", + "values": [], + "valueType": "string" + } + ] } ] } |
v1.0 | Identitygovernance Taskdefinition Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identitygovernance-taskdefinition-get.md | Title: "Get taskDefinition" -description: "Read the details of a built-in workflow task." +description: "Read the details of a built-in workflow task in Lifecycle Workflows." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph.identityGovernance -Read the details of a built-in workflow [task](../resources/identitygovernance-taskdefinition.md). +Read the details of a built-in workflow [task](../resources/identitygovernance-taskdefinition.md) in Lifecycle Workflows. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Identityprotectionroot List Riskyserviceprincipals | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprotectionroot-list-riskyserviceprincipals.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprotectionroot_list_riskyserviceprincipals" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprotectionroot-list-riskyserviceprincipals-permissions.md)] ## HTTP request |
v1.0 | Identityprotectionroot List Serviceprincipalriskdetections | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityprotectionroot-list-serviceprincipalriskdetections.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityprotectionroot_list_serviceprincipalriskdetections" } --> [!INCLUDE [permissions-table](../includes/permissions/identityprotectionroot-list-serviceprincipalriskdetections-permissions.md)] ## HTTP request |
v1.0 | Identityuserflowattributeassignment Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityuserflowattributeassignment-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-delete-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityuserflowattributeassignment-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_get" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-get-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Getorder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityuserflowattributeassignment-getorder.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_getorder" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-getorder-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Setorder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityuserflowattributeassignment-setorder.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_setorder" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-setorder-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Identityuserflowattributeassignment Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/identityuserflowattributeassignment-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "identityuserflowattributeassignment_update" } --> [!INCLUDE [permissions-table](../includes/permissions/identityuserflowattributeassignment-update-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Internaldomainfederation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/internaldomainfederation-update.md | PATCH /domains/{domainsId}/federationConfiguration/{internalDomainFederationId} |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications.| |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 into Microsoft Entra services. |-|preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`. | +|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`.| |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. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |
v1.0 | Invitation Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/invitation-post.md | doc_type: apiPageType Namespace: microsoft.graph -Use this API to create a new [invitation](../resources/invitation.md) or reset the redemption status for a guest user who already redeemed their invitation. Invitation adds an external user to the organization. +Use this API to create a new [invitation](../resources/invitation.md) or reset the redemption status for a guest user who already redeemed their invitation. The invitation adds the external user to the organization as part of B2B collaboration. B2B collaboration is supported in both Microsoft Entra External ID in workforce and external tenants. When creating a new invitation, you have several options available: Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/invitation-post-permissions.md)] > [!IMPORTANT]-> Application permissions (app-only) do not work if B2B invitations are disabled on the tenant or if B2B invitations are restricted to administrators. --When resetting the redemption status for a guest user, the *User.ReadWrite.All* permission is the least privileged permission for the operation. --For delegated scenarios, the signed-in user must have at least the *Guest Inviter*, *Directory Writers*, or *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). To reset the redemption status, the signed-in user must have at least the *Helpdesk Administrator* or *User Administrator* role. +> +> 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: +> - To invite guests: +> - Both nonadmin member users and guest users can invite guests if the tenant admin hasn't restricted the [default user permissions](/entra/fundamentals/users-default-permissions?toc=%2Fgraph%2Ftoc.json). +> - Guest Inviter, Directory Writers, or User Administrator. +> - To reset the redemption status: Helpdesk Administrator or User Administrator. +> - Application permissions (app-only) don't work if B2B invitations are disabled on the tenant or if B2B invitations are restricted to administrators. +> - When resetting the redemption status for a guest user, the *User.ReadWrite.All* permission is the least privileged permission for the operation. ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Ipnamedlocation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/ipnamedlocation-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/ipnamedlocation-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Ipnamedlocation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/ipnamedlocation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "ipnamedlocation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/ipnamedlocation-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Ipnamedlocation Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/ipnamedlocation-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/ipnamedlocation-update-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Learningcourseactivity Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/learningcourseactivity-delete.md | If unsuccessful, this method returns one of the responses below: |Scenario|HTTP code|Code|Message| |:|:|:|:|:| |Method not supported for entity|405|methodNotAllowed|This method isn't supported for this entity type. See the Microsoft Graph documentation for the methods applicable to this entity.|-|User doesn't have the appropriate permissions scope|403|Forbidden|Your account doesn't have access to this report or data. Contact your global administrator to request access.| +|User doesn't have the appropriate permissions scope|403|Forbidden|Your account doesn't have access to this report or data. Contact your administrator to request access.| |Forbidden|403|Forbidden|You don't have an adequate service plan for this request.| |Bad request|400|badRequest|This provider isn't enabled for the given tenant.| |Bad request|400|badRequest|There was an issue with your request. Make sure the registrationId you entered is valid or registered for your tenant.|-|Bad request|404|notFound|The requested assignment ID doesnΓÇÖt exist.| +|Bad request|404|notFound|The requested assignment ID doesn't exist.| |Internal server error|500|internalServerError|Internal server error.| |Request throttled|429|tooManyRequests|{"code": "tooManyRequests","message": "Retry after {noOfMinutes} minutes"}.| |Service unavailable|503|serviceUnavailable|{"code": "serviceUnavailable","message": "Retry after {noOfMinutes} minutes"}.| The following example shows the response. ``` http HTTP/1.1 204 No Content ```--### Error conditions --|Scenario|HTTP code|Code|Message|Details| -|:|:|:|:|:| -|Method not supported for entity|405|MethodNotAllowed|This method isn't supported for this entity type. See the Microsoft Graph documentation for the methods applicable to this entity| -|User doesn't have the appropriate permissions scope|403|Forbidden|Your account doesn't have access to this report or data. Contact your global administrator to request access.| -|Forbidden|403|Forbidden|You don't have a service plan adequate for this request.| -|Bad request|400|Bad Request|This provider isn't enabled for the given tenant.| -|Bad request|400|Bad Request|There was an issue with your request. Make sure the registrationId you entered is valid or registered for your tenant| -|Bad request|404|Not Found|The requested assignment {id} doesnΓÇÖt exist.| -|Internal server error|500|Internal Server Error|Internal Server Error| -|Request throttled|429|Too Many Requests|{"code": "TooManyRequests","message": "Retry after {noOfMinutes} minutes"}| -|Service unavailable|503|Service Unavailable|{"code": "ServiceUnavailable","message": "Retry after {noOfMinutes} minutes"}| |
v1.0 | Learningcourseactivity Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/learningcourseactivity-get.md | To get a specific learning course activity based on its **externalCourseActivity } --> ``` http-GET /employeeExperience/learningProviders/{registrationId}/learningCourseActivities(externalCourseActivityId={externalCourseActivityId}) +GET /employeeExperience/learningProviders/{registrationId}/learningCourseActivities(externalCourseActivityId='{externalCourseActivityId}') ``` To get the details of a learning course activity for a user: If unsuccessful, this method returns one of the responses below: |Scenario|HTTP code|Code|Message| |:|:|:|:|:| |Method not supported for entity|405|methodNotAllowed|This method isn't supported for this entity type. See the Microsoft Graph documentation for the methods applicable to this entity.|-|User doesn't have appropriate permission scope|403|Forbidden|Your account doesn't have access to this report or data. Contact your global administrator to request access.| +|User doesn't have appropriate permission scope|403|Forbidden|Your account doesn't have access to this report or data. Contact your administrator to request access.| |Forbidden|403|Forbidden|You don't have an adequate service plan for this request.| |Bad request|400|badRequest|This provider isn't enabled for the given tenant.| |Bad request|400|badRequest|There was an issue with your request. Make sure the registrationId you entered is valid or registered for your tenant.| The following example shows a request to get the details of a learning course ac }--> ``` http-GET https://graph.microsoft.com/v1.0/employeeExperience/learningProviders/01e8f81b-3060-4dec-acf0-0389665a0a38/learningCourseActivities(externalCourseActivityId=12a2228a-e020-11ec-9d64-0242ac120002) +GET https://graph.microsoft.com/v1.0/employeeExperience/learningProviders/01e8f81b-3060-4dec-acf0-0389665a0a38/learningCourseActivities(externalCourseActivityId='12a2228a-e020-11ec-9d64-0242ac120002') ``` # [C#](#tab/csharp) |
v1.0 | Learningcourseactivity Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/learningcourseactivity-update.md | If unsuccessful, this method returns one of the responses below: |Scenario|HTTP code|Code|Message|Details| |:|:|:|:|:| |Method not supported for entity|405|methodNotAllowed|This method isn't supported for this entity type. See the Microsoft Graph documentation for the methods applicable to this entity.|-|User doesn't have appropriate permission scope|403|Forbidden|Your account doesn't have access to this report or data. Contact your global administrator to request access.| +|User doesn't have appropriate permission scope|403|Forbidden|Your account doesn't have access to this report or data. Contact your administrator to request access.| |Forbidden|403|Forbidden|You don't have an adequate service plan for this request.| |Bad request|400|badRequest|This provider isn't enabled for the given tenant.| |Bad request|400|badRequest|There was an issue with your request. Make sure the registrationId you entered is valid or registered for your tenant.| |
v1.0 | M365appsinstallationoptions Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/m365appsinstallationoptions-get.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/m365appsinstallationoptions-get-permissions.md)] When calling on behalf of a user, the user needs to belong to the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):-+ Global administrator -+ Global reader -+ Office apps administrator ++ Office apps administrator (recommended)++ Global Reader ## HTTP request |
v1.0 | M365appsinstallationoptions Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/m365appsinstallationoptions-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "m365appsinstallationoptions_update" } --> [!INCLUDE [permissions-table](../includes/permissions/m365appsinstallationoptions-update-permissions.md)] -When calling on behalf of a user, the user needs to belong to the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json): --+ Global administrator -+ Office apps administrator +When calling on behalf of a user, the user needs to belong to the Office apps administrator role. ## HTTP request |
v1.0 | Meetingattendancereport List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/meetingattendancereport-list.md | doc_type: apiPageType Namespace: microsoft.graph -Get a list of [meetingAttendanceReport](../resources/meetingAttendanceReport.md) objects for an [onlineMeeting](../resources/onlinemeeting.md) or a [virtualEvent](../resources/virtualevent.md). Each time an online meeting or a virtual event ends, an attendance report is generated for that session. +Get a list of [meetingAttendanceReport](../resources/meetingattendancereport.md) objects for an [onlineMeeting](../resources/onlinemeeting.md) or a [virtualEvent](../resources/virtualevent.md). Each time an online meeting or a virtual event ends, an attendance report is generated for that session. > [!WARNING] >-> This method does not support channel meetings, and only returns up to 50 of the most recent reports. +>- This method only returns up to 50 of the most recent reports. +>- When you use this method to list attendance reports for a channel meeting, the API returns attendance reports for every meeting in the channel, rather than just the attendance reports for the specified meeting, which is the expected behavior for scheduled meetings. This behavior is the same regardless of where the channel meeting was created. [!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
v1.0 | Multitenantorganization Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multitenantorganization-update.md | Content-Type: application/json [!INCLUDE [sample-code](../includes/snippets/php/update-multitenantorganization-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/update-multitenantorganization-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Multivaluelegacyextendedproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/multivaluelegacyextendedproperty-get.md | Title: "Get multiValueLegacyExtendedProperty" -description: "expand`." +description: "Get a resource instance that contains a multi-value extended property by using $expand." ms.localizationpriority: medium |
v1.0 | Namedlocation Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/namedlocation-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/namedlocation-delete-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Namedlocation Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/namedlocation-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "namedlocation_get" } --> [!INCLUDE [permissions-table](../includes/permissions/namedlocation-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Notebook Getrecentnotebooks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/notebook-getrecentnotebooks.md | The `{id | userPrincipalName}` for the user must match the user encoded in the a ## 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 | Oauth2permissiongrant Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/oauth2permissiongrant-delta.md | doc_type: apiPageType Namespace: microsoft.graph -Get newly created, updated, or deleted [oauth2permissiongrant](../resources/oauth2permissiongrant.md) objects without performing a full read of the entire resource collection. For details, see [Using delta query](/graph/delta-query-overview). +Get newly created, updated, or deleted [oauth2permissiongrant](../resources/oauth2permissiongrant.md) objects 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)] |
v1.0 | Onattributecollectionexternalusersselfservicesignup Delete Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onattributecollectionexternalusersselfservicesignup-delete-attributes.md | doc_type: apiPageType # Remove attribute (from user flow) Namespace: microsoft.graph - Remove an attribute from an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. You can add both custom and built-in attributes to a user flow. -After this step, [PATCH the user flow](../api/authenticationeventsflow-update.md) to remove the attribute from the attribute collection step. +The attribute is removed from both the **onAttributeCollection** > **attributes** and **onAttributeCollection** > **attributeCollectionPage** > **views** collections of the user flow. ++This API operation fails when you attempt to remove the last remaining attribute on the user flow. ## 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). Don't supply a request body for this method. ## Response -If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. +If successful, this method returns a `204 No Content` response code. If unsuccessful, a `4xx` error is returned with specific details. Attempting to remove the last remaining attribute results in a `400 Bad Request` error code. ## Examples #### Request-The following example shows a request that removes city as an attribute from the attribute collection step of an external identities self-service sign-up user flow. After executing this step, [update the attributes collected in the userflow](../api/authenticationeventsflow-update.md). +The following example shows a request that removes city as an attribute from the attribute collection step of an external identities self-service sign-up user flow. # [HTTP](#tab/http) <!-- { "blockType": "request", DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313c [!INCLUDE [sample-code](../includes/snippets/php/delete-onattributecollectionexternalusersselfservicesignup-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/delete-onattributecollectionexternalusersselfservicesignup-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Onattributecollectionexternalusersselfservicesignup List Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onattributecollectionexternalusersselfservicesignup-list-attributes.md | GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37 [!INCLUDE [sample-code](../includes/snippets/php/get-onattributecollectionexternalusersselfservicesignup-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-onattributecollectionexternalusersselfservicesignup-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Onattributecollectionexternalusersselfservicesignup Post Attributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onattributecollectionexternalusersselfservicesignup-post-attributes.md | doc_type: apiPageType # Add attribute (to user flow) Namespace: microsoft.graph -Add an attribute to an external identities self-service user flow represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. You can add both custom and built-in attributes to a user flow. +Add an attribute to an external identities self-service sign up user flow that's represented by an [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md) object. You can add both custom and built-in attributes to a user flow. -Prerequisite: [PATCH the user flow](../api/authenticationeventsflow-update.md) with the updated onAttributeCollection event that includes the new attribute. +The attribute is added to both the **attributeCollection**> **attributes** and **attributeCollection**> **attributeCollectionPage** > **views** collections on the user flow. In the **views** collection, the attribute is assigned the default settings. You can [PATCH the user flow](../api/authenticationeventsflow-update.md) to customize the settings of the attribute on the **views** object, for example, marking it as required or updating the allowed input types. ## 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). If successful, this method returns a `204 No Content` response code. If unsucces #### Request -The following example shows a request that adds city as an attribute for attribute collection step of an external identities self-service sign-up user flow. Before you can add an attribute to the attribute collection step, you must first [add it among the attributes to be collected in the user flow](../api/authenticationeventsflow-update.md). +The following example shows a request that adds city as an attribute for attribute collection step of an external identities self-service sign-up user flow. If the request is successful, the attribute is added to both the **attributeCollection**> **attributes** and **attributeCollection**> **attributeCollectionPage** > **views** collections on the user flow. After adding the attribute to the user flow, you can [PATCH the user flow](../api/authenticationeventsflow-update.md) to customize the settings of the attribute on the **views** object, that is, customize the page layout. # [HTTP](#tab/http) <!-- { POST https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc3 [!INCLUDE [sample-code](../includes/snippets/php/onattributecollectionexternalusersselfservicesignup-post-attributes-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/onattributecollectionexternalusersselfservicesignup-post-attributes-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Onauthenticationmethodloadstartexternalusersselfservicesignup Delete Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onauthenticationmethodloadstartexternalusersselfservicesignup-delete-identityproviders.md | DELETE https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313c [!INCLUDE [sample-code](../includes/snippets/php/delete-onauthenticationmethodloadstartexternalusersselfservicesignup-identityproviders-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/delete-onauthenticationmethodloadstartexternalusersselfservicesignup-identityproviders-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Onauthenticationmethodloadstartexternalusersselfservicesignup List Identityproviders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders.md | GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37 [!INCLUDE [sample-code](../includes/snippets/php/list-onauthenticationmethodloadstartexternalusersselfservicesignup-identityproviders-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/list-onauthenticationmethodloadstartexternalusersselfservicesignup-identityproviders-python-snippets.md)] [!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)] |
v1.0 | Onedriveforbusinessprotectionpolicy List Driveinclusionrules | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onedriveforbusinessprotectionpolicy-list-driveinclusionrules.md | If successful, this method returns a `200 OK` response code and a [driveProtecti The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "onedriveforbusinessprotectionpolicy_list_driveinclusionrule" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveInclusionRules ``` +# [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 | Onedriveforbusinessprotectionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onedriveforbusinessprotectionpolicy-update.md | To remove a **driveProtectionUnit** from the policy, specify the `@removed` anno If successful, this method returns a `200 OK` response code and an updated [oneDriveForBusinessProtectionPolicy](../resources/onedriveforbusinessprotectionpolicy.md) in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "onedriveforbusinessprotectionpolicy_update" PATCH https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusine } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ ### Response The following example shows the response. |
v1.0 | Onedriveforbusinessrestoresession List Driverestoreartifacts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onedriveforbusinessrestoresession-list-driverestoreartifacts.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [driveRestoreArtifact](../resources/driverestoreartifact.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "list_driverestoreartifact" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessRestoreSessions/845457dc-4bb2-4815-bef3-8628ebd1952e/driveRestoreArtifacts ``` +# [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 | Onedriveforbusinessrestoresession Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onedriveforbusinessrestoresession-update.md | To remove a drive restore artifact, specify the `@removed` annotation in the req If successful, this method returns a `200 OK` response code and an updated [oneDriveForBusinessRestoreSession](../resources/driverestoreartifact.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "onedriveforbusinessrestoresession_update" PATCH https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusine } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ ### Response The following example shows the response. |
v1.0 | Onlinemeeting Getallrecordings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onlinemeeting-getallrecordings.md | + + Title: "onlineMeeting: getAllRecordings" +description: "Get recordings from all online meetings that a user is an organizer of." ++ms.localizationpriority: medium ++++# onlineMeeting: getAllRecordings ++Namespace: microsoft.graph ++Get all recordings from scheduled [onlineMeeting](../resources/onlinemeeting.md) instances for which the specified user is the organizer. This API currently doesn't support getting call recordings from channel meetings. ++You can apply the [delta](callrecording-delta.md) function on **getAllRecordings** to synchronize and get [callRecording](../resources/callrecording.md) resources as they're added for **onlineMeeting** instances organized by the specified user. ++The delta query supports both full synchronization and incremental synchronization. Full synchronization gets all the recordings for online meetings organized by the user. Incremental synchronization gets recordings that are added since the last synchronization. Typically, you perform an initial full synchronization, and then get incremental changes to that recording view periodically. ++Find more information in the [delta query](/graph/delta-query-overview) documentation. For more examples, see [callRecording: delta](callrecording-delta.md). ++To learn more about using the Microsoft Teams export APIs to export content, see [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content). ++++## 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": "onlinemeeting_getallrecordings" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> +``` http +GET /users/{usersId}/onlineMeetings/getAllRecordings(meetingOrganizerUserId='{userId}',startDateTime={startDateTime},endDateTime={endDateTime}) +``` +>**Note:** The request fails if you don't pass the function parameter **meetingOrganizerUserId** or a filter clause with **MeetingOrganizer/User/Id**. ++## Function parameters +In the request URL, provide the following query parameters with values. ++|Parameter|Type|Description| +|:|:|:| +|endDateTime|DateTimeOffset|Optional parameter to filter for artifacts created before the given end date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|meetingOrganizerUserId|String|The user identifier of the meeting organizer to filter for artifacts for meetings organized by the given user identifier.| +|startDateTime|DateTimeOffset|Optional parameter to filter for artifacts created after the given start date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| ++## Optional query parameters ++This method supports the following OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++| Name | Description | +| :- | :-- | +| `$top` | Allows the caller to specify the max number of objects per page as the page size. | ++## Request headers ++| Header | Value | +|:|:--| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [callRecording](../resources/callrecording.md) objects in the response body. ++## Examples ++### Example 1: Get all recordings ++The following example shows a request to get all the recordings of a given meeting organizer. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["8b081ef6-4792-4def-b2c9-c363a1bf41d5"], + "name": "get_allrecordings" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings?$filter=MeetingOrganizer/User/Id eq '8b081ef6-4792-4def-b2c9-c363a1bf41d5' +``` ++# [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, + "name": "get_allrecordings", + "@odata.type": "Collection(microsoft.graph.callRecording)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')?skipToken={skipToken}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callRecording", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/recordings/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++### Example 2: Get all recordings of a given meeting organizer using a date range filter ++The following example shows a request to get all recordings of a given meeting organizer that are created between a given start date and an end date. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["8b081ef6-4792-4def-b2c9-c363a1bf41d5", "2024-01-15T00:00:00Z", "2024-01-31T00:00:00Z"], + "name": "get_allrecordings_with_dates" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5', startDateTime=2024-01-15T00:00:00Z, endDateTime=2024-01-31T00:00:00Z) +``` ++# [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, + "name": "get_allrecordings_with_dates", + "@odata.type": "Collection(microsoft.graph.callRecording)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callRecording)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllRecordings(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5', startDateTime=2024-01-15T00:00:00Z, endDateTime=2024-01-31T00:00:00Z)?skipToken={skipToken}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callRecording", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "recordingContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/recordings/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++## Related content ++- [Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) +- [Delta query overview](/graph/delta-query-overview) +- [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content) |
v1.0 | Onlinemeeting Getalltranscripts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onlinemeeting-getalltranscripts.md | + + Title: "onlineMeeting: getAllTranscripts" +description: "Get transcripts from all online meetings that a user is an organizer of." ++ms.localizationpriority: medium ++++# onlineMeeting: getAllTranscripts ++Namespace: microsoft.graph ++Get all transcripts from scheduled [onlineMeeting](../resources/onlinemeeting.md) instances for which the specified user is the organizer. This API currently doesn't support getting call transcripts from channel meetings. ++You can apply the [delta](calltranscript-delta.md) function on **getAllTranscripts** to synchronize and get [callTranscript](../resources/calltranscript.md) resources as they're added for **onlineMeeting** instances organized by the specified user. ++Delta query supports both full synchronization and incremental synchronization. Full synchronization gets all the transcripts for online meetings organized by the user. Incremental synchronization gets transcripts that are added since the last synchronization. Typically, you perform an initial full synchronization, and then get incremental changes to that recording view periodically. ++For more information, see [delta query](/graph/delta-query-overview). For more examples, see [callTranscript: delta](calltranscript-delta.md). ++To learn more about using the Microsoft Teams export APIs to export content, see [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content). ++++## 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": "onlinemeeting_getalltranscripts" } --> ++## HTTP request ++<!-- { "blockType": "ignored" } --> +``` http +GET /users/{usersId}/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='{userId}',startDateTime={startDateTime},endDateTime={endDateTime}) +``` +>**Note:** The request fails if you don't pass the function parameter **meetingOrganizerUserId**, or a filter clause with **MeetingOrganizer/User/Id**. ++## Function parameters +In the request URL, provide the following query parameters with values. ++|Parameter|Type|Description| +|:|:|:| +|endDateTime|DateTimeOffset|Optional parameter to filter for artifacts created before the given end date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|meetingOrganizerUserId|String|The user identifier of the meeting organizer that is used to filter artifacts for meetings organized by that specific user.| +|startDateTime|DateTimeOffset|Optional parameter to filter for artifacts created after the given start date. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| ++## Optional query parameters ++This method supports the following OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++| Name | Description | +| :- | :-- | +| `$top` | Allows the caller to specify the max number of objects per page as the page size. | ++## Request headers ++| Header | Value | +|:|:--| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ++## Response ++If successful, this method returns a `200 OK` response code and a collection of [callTranscript](../resources/calltranscript.md) objects in the response body. ++## Examples ++### Example 1: Get all transcripts ++The following example shows a request to get all the transcripts of a given meeting organizer. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["8b081ef6-4792-4def-b2c9-c363a1bf41d5"], + "name": "get_alltranscripts" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts?$filter=MeetingOrganizer/User/Id eq '8b081ef6-4792-4def-b2c9-c363a1bf41d5' +``` ++# [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, + "name": "get_alltranscripts", + "@odata.type": "Collection(microsoft.graph.callTranscript)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5')?skipToken={skipToken}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callTranscript", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/transcripts/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++### Example 2: Get all transcripts of a given meeting organizer using the date range filter ++The following example shows a request to get all transcripts of a given meeting organizer, that are created between a given start date and an end date. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "sampleKeys": ["8b081ef6-4792-4def-b2c9-c363a1bf41d5", "2024-01-15T00:00:00Z", "2024-01-31T00:00:00Z"], + "name": "get_alltranscripts_with_dates" +}--> +```msgraph-interactive +GET https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5', startDateTime=2024-01-15T00:00:00Z, endDateTime=2024-01-31T00:00:00Z) +``` ++# [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, + "name": "get_alltranscripts_with_dates", + "@odata.type": "Collection(microsoft.graph.callTranscript)" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(callTranscript)", + "@odata.nextLink": "https://graph.microsoft.com/v1.0/users({userId})/onlineMeetings/getAllTranscripts(meetingOrganizerUserId='8b081ef6-4792-4def-b2c9-c363a1bf41d5', startDateTime=2024-01-15T00:00:00Z, endDateTime=2024-01-31T00:00:00Z)?skipToken={skipToken}", + "@odata.count": 1, + "value": [ + { + "@odata.type": "#microsoft.graph.callTranscript", + "id": "VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=", + "meetingId": "MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy", + "createdDateTime": "2023-12-02T06:59:34.7411768Z", + "transcriptContentUrl": "https://graph.microsoft.com/v1.0/users/8b081ef6-4792-4def-b2c9-c363a1bf41d5/onlineMeetings/MSoxYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTEqMCoqMTk6bWVldGluZ19PVEJsT1RjeE16QXROemMwWVMwMFl6QTFMVGhpWldFdFpUaGtNMlk0WkRKaFlUQTFAdGhyZWFkLnYy/transcripts/VjIjIzExYzkxNjVmZi1hZTkyLTQ5YWYtODliNC00MTU1NTRhMzZhNTFhMWQyODZkYi02MTQ5LTRiM2QtOTVhZC0yM2M5ZTFiZjY4NTMwNDAwMDAwMDgyMDBFMDAwNzRDNUI3MTAxQTgyRTAwODA3ZTcwYzAyM2U4MGEwOWVmN2ZmZDkwMTAwMDAwMDAwMDAwMDAwMDAxMDAwMDAwMDI3N2Q3NzZjYmNmMjQ5NGNiNDk0NDExZGE3YzRhMmM1IyM3YTM2NDRjYi1mMDA3LTRjMDAtOWJiMy1jMTUzYzE4ODY4NGY=/content", + "meetingOrganizer": { + "application": null, + "device": null, + "user": { + "@odata.type": "#microsoft.graph.teamworkUserIdentity", + "id": "8b081ef6-4792-4def-b2c9-c363a1bf41d5", + "displayName": null, + "userIdentityType": "aadUser", + "tenantId": "a1d286db-6149-4b3d-95ad-23c9e1bf6853" + } + } + } + ] +} +``` ++## Related content ++- [Microsoft Graph service-specific throttling limits](/graph/throttling-limits#microsoft-teams-service-limits) +- [Delta query overview](/graph/delta-query-overview) +- [Export content with the Microsoft Teams export APIs](/microsoftteams/export-teams-content) |
v1.0 | Onpremisesdirectorysynchronization Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onpremisesdirectorysynchronization-get.md | Title: "Get onPremisesDirectorySynchronization" description: "Read the properties and relationships of an onPremisesDirectorySynchronization object."-++ ms.localizationpriority: medium doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "onpremisesdirectorysynchronization_get" } --> [!INCLUDE [permissions-table](../includes/permissions/onpremisesdirectorysynchronization-get-permissions.md)] -For delegated scenarios, the user needs to be assigned the *Global Administrator* [role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). +> [!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 Administrator* is the only role supported for this operation. ## HTTP request |
v1.0 | Onpremisesdirectorysynchronization Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/onpremisesdirectorysynchronization-update.md | Title: "Update onPremisesDirectorySynchronization" description: "Update the properties of an onPremisesDirectorySynchronization object."-++ ms.localizationpriority: medium doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "onpremisesdirectorysynchronization_update" } --> [!INCLUDE [permissions-table](../includes/permissions/onpremisesdirectorysynchronization-update-permissions.md)] -For delegated scenarios, the user needs to be assigned the *Global Administrator* [role](/azure/active-directory/users-groups-roles/directory-assign-admin-roles#available-roles). +> [!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 Administrator* is the only role supported for this operation. ## HTTP request |
v1.0 | Openshift Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshift-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshift_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/openshift-delete-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshift Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshift-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshift_get" } --> [!INCLUDE [permissions-table](../includes/permissions/openshift-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshift List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshift-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshift_list" } --> [!INCLUDE [permissions-table](../includes/permissions/openshift-list-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshift Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshift-post.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshift_post" } --> [!INCLUDE [permissions-table](../includes/permissions/openshift-post-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshift Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshift-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshift_update" } --> [!INCLUDE [permissions-table](../includes/permissions/openshift-update-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshiftchangerequest Approve | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshiftchangerequest-approve.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshiftchangerequest_approve" } --> [!INCLUDE [permissions-table](../includes/permissions/openshiftchangerequest-approve-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshiftchangerequest Decline | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshiftchangerequest-decline.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshiftchangerequest_decline" } --> [!INCLUDE [permissions-table](../includes/permissions/openshiftchangerequest-decline-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshiftchangerequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshiftchangerequest-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshiftchangerequest_get" } --> [!INCLUDE [permissions-table](../includes/permissions/openshiftchangerequest-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshiftchangerequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshiftchangerequest-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshiftchangerequest_list" } --> [!INCLUDE [permissions-table](../includes/permissions/openshiftchangerequest-list-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Openshiftchangerequest Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/openshiftchangerequest-post.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "openshiftchangerequest_post" } --> [!INCLUDE [permissions-table](../includes/permissions/openshiftchangerequest-post-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Orgcontact Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-delta.md | doc_type: apiPageType Namespace: microsoft.graph -Get newly created, updated, or deleted organizational contacts without having to perform a full read of the entire collection. See [change tracking](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted organizational contacts without having to perform a full read of the entire 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": "orgcontact_delta" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-delta-permissions.md)] + ## HTTP request To begin tracking changes, you make a request including the delta function on the contacts 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 organization contact 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 organization contact collection. | |
v1.0 | Orgcontact Get Manager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-get-manager.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_get_manager" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-get-manager-permissions.md)] + [!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request |
v1.0 | Orgcontact Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_get" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Orgcontact List Directreports | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-list-directreports.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_list_directreports" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-list-directreports-permissions.md)] + [!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request |
v1.0 | Orgcontact List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-list-memberof.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_list_memberof" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-list-memberof-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 +> - Directory Writers +> - Intune Administrator +> - User Administrator + [!INCLUDE [limited-info](../../includes/limited-info.md)] ## HTTP request |
v1.0 | Orgcontact List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-list-transitivememberof.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/orgcontact-list-transitivememberof-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 +> - Directory Writers +> - Intune Administrator +> - User Administrator ++ ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Orgcontact List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_list" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Orgcontact Retryserviceprovisioning | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/orgcontact-retryserviceprovisioning.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "orgcontact_retryserviceprovisioning" } --> [!INCLUDE [permissions-table](../includes/permissions/orgcontact-retryserviceprovisioning-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 Writers +> - Intune Administrator +> - User Administrator + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Payload Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/payload-get.md | Choose the permission or permissions marked as least privileged for this API. Us --> ``` http GET /security/attackSimulation/payloads/{payloadId}+GET /security/attackSimulation/simulations/{simulationId}/payload ``` ## Optional query parameters |
v1.0 | Peopleadminsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/peopleadminsettings-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "peopleadminsettings_get" } --> [!INCLUDE [permissions-table](../includes/permissions/peopleadminsettings-get-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Peopleadminsettings List Profilecardproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/peopleadminsettings-list-profilecardproperties.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "peopleadminsettings_list_profilecardproperties" } --> [!INCLUDE [permissions-table](../includes/permissions/peopleadminsettings-list-profilecardproperties-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Peopleadminsettings Post Profilecardproperties | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/peopleadminsettings-post-profilecardproperties.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "peopleadminsettings_post_profilecardproperties" } --> [!INCLUDE [permissions-table](../includes/permissions/peopleadminsettings-post-profilecardproperties-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Printjob Cancel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/printjob-cancel.md | Cancel a print job. Print jobs can be canceled only on behalf of a user, using d ## 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). +> **Note:** For an app with delegated permissions to cancel other users' jobs, the signed-in user must be a member of the Printer Administrator role. + <!-- { "blockType": "permissions", "name": "printjob_cancel" } --> [!INCLUDE [permissions-table](../includes/permissions/printjob-cancel-permissions.md)] -For an app with delegated permissions to cancel other users' jobs, the signed-in user must be a member of one of the following administrator roles: -- Global Administrator-- Printer Administrator- ## HTTP request <!-- { |
v1.0 | Printjob Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/printjob-get.md | Retrieve the properties and relationships of a print job. ## 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": "printjob_get" } --> --For an app with delegated permissions to retrieve other users' jobs, the signed-in user must be a member of one of the following administrator roles: -- Global Administrator-- Printer Administrator+> **Note:** For an app with delegated permissions to cancel other users' jobs, the signed-in user must be a member of the Printer Administrator role. For an app with application permissions to retrieve users' jobs, the app needs a permission that grants [Get printer](printer-get.md) access along with one of the application permissions described in the [Permissions](#permissions) table. +<!-- { "blockType": "permissions", "name": "printjob_get" } --> + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Profilecardproperty Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/profilecardproperty-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "profilecardproperty_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/profilecardproperty-delete-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Profilecardproperty Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/profilecardproperty-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "profilecardproperty_get" } --> [!INCLUDE [permissions-table](../includes/permissions/profilecardproperty-get-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Profilecardproperty Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/profilecardproperty-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "profilecardproperty_update" } --> [!INCLUDE [permissions-table](../includes/permissions/profilecardproperty-update-permissions.md)] ->**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator or Global Administrator role. +>**Note:** Using delegated permissions for this operation requires the signed-in user to have a Tenant Administrator role. ## HTTP request |
v1.0 | Profilephoto Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/profilephoto-update.md | The following tables show the least privileged permission or permissions require > [!NOTE] >-> - Global admin and User admin can update the photo of any user in the organization by using delegated permissions. This operation is also supported with application permissions. Updating the photo of any user in the organization requires *ProfilePhoto.ReadWrite.All* or *User.ReadWrite.All* permission. Updating the photo of the signed-in user only requires *User.ReadWrite* permission. +> - Users with admin roles such as User admins can update the photo of any user in the organization by using delegated permissions. This operation is also supported with application permissions. Updating the photo of any user in the organization requires *ProfilePhoto.ReadWrite.All* or *User.ReadWrite.All* permission. Updating the photo of the signed-in user only requires *User.ReadWrite* permission. > - Updating a user's photo using the Microsoft Graph API is currently not supported in Azure AD B2C tenants. ## HTTP request |
v1.0 | Protectionpolicybase Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionpolicybase-activate.md | Namespace: microsoft.graph Activate a [protectionPolicyBase](../resources/protectionpolicybase.md). +Currently, only one active backup policy per underlying service is supported (that is, one for OneDrive accounts, one for SharePoint sites, and one for Exchange Online users). You can add or remove artifacts (sites or user accounts) to or from each active policy. + [!INCLUDE [national-cloud-support](../../includes/global-only.md)] ## Permissions Don't supply a request body for this method. If successful, this action returns a `202 Accepted` response code and a [protectionPolicyBase](../resources/protectionpolicybase.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 : Activate an inactive protection policy +### Example 1: Activate an inactive protection policy -Activate an inactive protection policy. +The following example shows a request to activate an inactive protection policy. #### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "protectionpolicybase_activate_example_1" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/ProtectionPolicies/61633878-8321-4950-bfaf-ed285bdd1461/activate ``` +# [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. Content-Location: https://graph.microsoft.com/v1.0/solutions/backupRestore/prote } ``` -### Example 2 : Activate an active protection policy +### Example 2: Activate an active protection policy -Activate an already active protection policy. +The following example shows a request to activate a protection policy that's already active. This request results in an error. #### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "protectionpolicybase_activate_example_2" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionPolicies/61633878-8321-4950-bfaf-ed285bdd1461/activate ``` +# [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 | Protectionpolicybase Deactivate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionpolicybase-deactivate.md | Don't supply a request body for this method. If successful, this action returns a `202 Accepted` response code and a [protectionPolicyBase](../resources/protectionpolicybase.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: Deactivate an active protection policy Deactivating the protection policy when it is in active state. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "protectionpolicybase_deactivate_example_1" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/ProtectionPolicies/61633878-8321-4950-bfaf-ed285bdd1461/deactivate ``` +# [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. Deactivating the protection policy when it is in updating state. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "protectionpolicybase_deactivate_example_2" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionPolicies/61633878-8321-4950-bfaf-ed285bdd1461/deactivate ``` +# [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 | Protectionpolicybase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionpolicybase-delete.md | Don't supply a request body for this method. If successful, this method returns a `204 No Content` response code. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_protectionpolicybase" DELETE https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionPolici Authorization: Bearer <Access-Token> ``` +# [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 | Protectionpolicybase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionpolicybase-get.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [protectionPolicyBase](../resources/protectionpolicybase.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "protectionpolicybase_get" GET https://graph.microsoft.com/v1.0/solutions/backupRestore/ProtectionPolicies/ Authorization: Bearer <Access-Token> ``` +# [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 | Protectionrulebase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionrulebase-delete.md | The following example shows how to delete a siteInclusionRule associated with a The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "siteprotectionrule_delete" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteInclusionRules/51633878-8321-4950-bfaf-ed285bdd1461 ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. The following example shows how to delete a driveInclusionRule associated with a The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "delete_driveprotectionrule" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveInclusionRules/51633878-8321-4950-bfaf-ed285bdd1461 ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. The following example shows how to delete a mailboxInclusionRule associated with The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "mailboxprotectionrule_delete" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxInclusionRules/51633878-8321-4950-bfaf-ed285bdd1461 ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. |
v1.0 | Protectionrulebase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionrulebase-get.md | The following example shows how to get a **siteInclusionRule** associated with a The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "sharepointprotectionpolicy_get_siteinclusionrules" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteInclusionRules/61633878-8321-4950-bfaf-ed285bdd1461 ``` +# [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. he following example shows how to get a **driveInclusionRule** associated with a The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "onedriveforbusinessprotectionpolicy_get_driveinclusionrule" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveInclusionRules/61633878-8321-4950-bfaf-ed285bdd1461 ``` +# [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. he following example shows how to get a **mailboxInclusionRule** associated with The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangeprotectionpolicy_get_mailboxinclusionrule" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/mailboxInclusionRules/61633878-8321-4950-bfaf-ed285bdd1461 ``` +# [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 | Protectionrulebase Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionrulebase-post.md | doc_type: apiPageType Namespace: microsoft.graph -Create a new [protection rule](../resources/protectionrulebase.md) associated with a [protection policy](../resources/protectionpolicybase.md). You can use this method to create a [mailbox](../resources/mailboxprotectionrule.md), [driveProtectionRule](../resources/driveprotectionrule.md), or [siteIProtectionRule](../resources/siteprotectionrule.md). +Create a new [protection rule](../resources/protectionrulebase.md) associated with a [protection policy](../resources/protectionpolicybase.md). You can use this method to create a [mailboxProtectionRule](../resources/mailboxprotectionrule.md), [driveProtectionRule](../resources/driveprotectionrule.md), or [siteProtectionRule](../resources/siteprotectionrule.md). An inclusion rule indicates that a protection policy should contain protection units that match the specified rule criteria. The initial status of a protection rule upon creation is `active`. After the rule is applied, the state is either `completed` or `completedWithErrors`. You can specify the following properties when you create a **mailboxInclusionRul If successful, this method returns a `201 Created` response code and a [protectionRuleBase](../resources/protectionRuleBase.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 a new siteInclusionRule associated with a SharePoint protection policy The following example shows how to create a new **siteInclusionRule** associated The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "sharepointprotectionpolicy_create_siteinclusionrules" Content-Type: application/json } ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. The following example shows how to create a new **driveInclusionRule** associate The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "onedriveforbusinessprotectionpolicy_create_driveinclusionrules" Content-Type: application/json } ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. The following example shows how to create a new **mailboxInclusionRule** associa The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "exchangeprotectionpolicy-create-mailboxinclusionrules" POST https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtection } ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. |
v1.0 | Protectionrulebase Run | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionrulebase-run.md | The following example shows how to activate a **siteInclusionRule** associated w The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "siteprotectionrulethis.run" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteInclusionRules/61633878-8321-4950-bfaf-ed285bdd1461/run ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. The following example shows how to activate a **driveInclusionRule**associated w The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "driveprotectionrulethis_run" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/oneDriveForBusinessProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/driveInclusionRules/61633878-8321-4950-bfaf-ed285bdd1461/run ``` +# [JavaScript](#tab/javascript) +++ ### Response The following example shows the response. The following example shows how to activate a **mailboxInclusionRule** associate The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "mailboxprotectionrulethis.run" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/exchangeProtectionPolicies/{exchangeProtectionPolicyId}/mailboxInclusionRules/{mailboxProtectionRuleId}/run ``` +# [JavaScript](#tab/javascript) +++ #### Response The following example shows the response. |
v1.0 | Protectionunitbase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/protectionunitbase-get.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [protectionUnitBase](../resources/protectionunitbase.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "protectionunitbase_get" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/protectionUnits/89014d8c-71fe-4d00-a01a-31850bc5b32c ``` +# [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 | Provisioningobjectsummary List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/provisioningobjectsummary-list.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/provisioningobjectsummary-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: +> - Reports Reader +> - Security Reader +> - Security Administrator +> - Global Reader +> - Security Administrator +> - Security Operator +> - Application Administrator +> - Cloud Application Administrator + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Range Boundingrect | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-boundingrect.md | Title: "Range: BoundingRect" -description: "." + Title: "range: boundingRect" +description: "Get the smallest range object that encompasses the given ranges." ms.localizationpriority: medium doc_type: apiPageType -# Range: BoundingRect +# range: boundingRect Namespace: microsoft.graph -Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of "B2:C5" and "D10:E15" is "B2:E16". +Get the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of *B2:C5* and *D10:E15* is *B2:E16*. ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body In the request body, provide a JSON object with the following parameters. |
v1.0 | Range Cell | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-cell.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/cell(row=5,column=6) ``` +# [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. <!-- { |
v1.0 | Range Clear | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-clear.md | Namespace: microsoft.graph Clear range values such as format, fill, and border. + ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_clear" 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 The following example shows the response. <!-- { |
v1.0 | Range Column | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-column.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/column(column=5) ``` +# [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. <!-- { |
v1.0 | Range Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-delete.md | doc_type: apiPageType Namespace: microsoft.graph Deletes the cells associated with the range.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_delete" 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 The following example shows the response. <!-- { |
v1.0 | Range Entirecolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-entirecolumn.md | doc_type: apiPageType Namespace: microsoft.graph Gets an object that represents the entire column of the range.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/entireColumn ``` +# [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. <!-- { |
v1.0 | Range Entirerow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-entirerow.md | doc_type: apiPageType Namespace: microsoft.graph Gets an object that represents the entire row of the range.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/entireRow ``` +# [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. <!-- { |
v1.0 | Range Insert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-insert.md | doc_type: apiPageType Namespace: microsoft.graph Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_insert" 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 The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Range Lastcell | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-lastcell.md | Title: "Range: LastCell" -description: "." + Title: "range: lastCell" +description: "Get the last cell within the range." ms.localizationpriority: medium doc_type: apiPageType -# Range: LastCell +# range: lastCell Namespace: microsoft.graph -Gets the last cell within the range. For example, the last cell of "B2:D5" is "D5". +Get the last cell within the range. For example, the last cell of *B2:D5* is *D5*. ++ ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookRange](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/lastCell ``` +# [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. <!-- { |
v1.0 | Range Lastcolumn | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-lastcolumn.md | Title: "Range: LastColumn" -description: "." + Title: "range: lastColumn" +description: "Get the last column within the range." ms.localizationpriority: medium doc_type: apiPageType -# Range: LastColumn +# range: lastColumn Namespace: microsoft.graph -Gets the last column within the range. For example, the last column of "B2:D5" is "D2:D5". +Get the last column within the range. For example, the last column of *B2:D5* is *D2:D5*. ++ ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookRange](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/lastColumn ``` +# [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. <!-- { |
v1.0 | Range Lastrow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-lastrow.md | Title: "Range: LastRow" -description: "." + Title: "range: lastRow" +description: "Get the last row within the range." ms.localizationpriority: medium doc_type: apiPageType -# Range: LastRow +# range: lastRow Namespace: microsoft.graph -Gets the last row within the range. For example, the last row of "B2:D5" is "B5:D5". +Get the last row within the range. For example, the last row of *B2:D5* is *B5:D5*. ++ ## 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). GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/ran | Name | Description| |:|:-| |Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|-| Workbook-Session-Id | Workbook session Id that determines if changes are persisted or not. Optional.| +| Workbook-Session-Id | Workbook session ID that determines if changes are persisted or not. Optional.| ## Request body ## Response -If successful, this method returns `200 OK` response code and [Range](../resources/workbookrange.md) object in the response body. +If successful, this method returns `200 OK` response code and [workbookRange](../resources/workbookrange.md) object in the response body. ## Example Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/lastRow ``` +# [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. <!-- { |
v1.0 | Range Merge | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-merge.md | doc_type: apiPageType Namespace: microsoft.graph Merge the range cells into one region in the worksheet.++ ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_merge" 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 The following example shows the response. <!-- { |
v1.0 | Range Unmerge | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-unmerge.md | Namespace: microsoft.graph Unmerge the range cells into separate cells. + ## 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). If successful, this method returns a `204 No Content` response code. It doesn't ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "range_unmerge" The following example shows a request. POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/unmerge ``` +# [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 | Range Usedrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/range-usedrange.md | doc_type: apiPageType Namespace: microsoft.graph Returns the used range of the given range 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/usedRange ``` +# [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. Here is an example specifying the optional `valuesOnly` parameter. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/usedRange(valuesOnly=true) ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) +++ ##### Response <!-- { |
v1.0 | Rangeborder Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeborder-get.md | If successful, this method returns a `200 OK` response code and [workbookRangeBo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangeborder" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/borders/{sideIndex} ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeborder List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeborder-list.md | If successful, this method returns a `200 OK` response code and collection of [w ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangebordercollection" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/borders ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeborder Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeborder-update.md | If successful, this method returns a `200 OK` response code and updated [workboo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeborder" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangebordercollection Itemat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangebordercollection-itemat.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/borders/itemAt(index=1) ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefill Clear | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefill-clear.md | Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangefill_clear" The following example shows a request. POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/fill/clear ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Rangefill Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefill-get.md | If successful, this method returns a `200 OK` response code and [workbookRangeFi ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangefill" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/fill ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefill Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefill-update.md | If successful, this method returns a `200 OK` response code and updated [workboo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangefill" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefont Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefont-get.md | If successful, this method returns a `200 OK` response code and [workbookRangeFo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangefont" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/font ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangefont Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangefont-update.md | If successful, this method returns a `200 OK` response code and updated [workboo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangefont" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeformat Autofitcolumns | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-autofitcolumns.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangeformat_autofitcolumns" The following example shows a request. POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/autofitColumns ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Rangeformat Autofitrows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-autofitrows.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangeformat_autofitrows" The following example shows a request. POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/autofitRows ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Rangeformat Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-get.md | doc_type: apiPageType Namespace: microsoft.graph Retrieve the properties and relationships of rangeformat 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). If successful, this method returns a `200 OK` response code and [workbookRangeFo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rangeformat" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format ``` +# [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. <!-- { |
v1.0 | Rangeformat List Borders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-list-borders.md | If successful, this method returns a `200 OK` response code and collection of [w ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_borders" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/borders ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangeformat Post Borders | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-post-borders.md | If successful, this method returns `201 Created` response code and [workbookRang ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "create_rangeborder_from_rangeformat" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ In the request body, supply a JSON representation of [workbookRangeBorder](../resources/workbookrangeborder.md) object. ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. |
v1.0 | Rangeformat Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangeformat-update.md | doc_type: apiPageType Namespace: microsoft.graph Update the properties of rangeformat 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). The result of this set of requests is a table with three cells formatted like th This request updates the vertical alignment, row height, and column height of the first cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the font style, size, and color of the first cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_font" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the background color of the first cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_fill" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the vertical alignment, horizontal alignment, row height, and column height of the second cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_two" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the font style and size of the second cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_font_two1" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the background color of the second cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_fill_two1" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the horizontal alignment, vertical alignment, row height, and column height of the third cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_three" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the font style, size, and color of the third cell. The underline property takes **Single** or **Double** as values. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_font_rangeformat" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { Content-type: application/json This request updates the background color of the third cell. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_rangeformat_fill_three_v_one" Content-type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Rangesort Apply | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/rangesort-apply.md | Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "rangesort_apply" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. <!-- { |
v1.0 | Reportroot Getonedriveactivityuserdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/reportroot-getonedriveactivityuserdetail.md | Namespace: microsoft.graph Get details about OneDrive activity by user. -> **Note:** For details about different report views and names, see [Microsoft 365 reports - OneDrive for Business activity](https://support.office.com/client/OneDrive-for-Business-user-activity-8bbe4bf8-221b-46d6-99a5-2fb3c8ef9353). +> **Note:** For details about different report views and names, see [Microsoft 365 reports - OneDrive for Business activity](https://learn.microsoft.com/en-us/microsoft-365/admin/activity-reports/onedrive-for-business-activity-ww?view=o365-worldwide). [!INCLUDE [national-cloud-support](../../includes/global-only.md)] |
v1.0 | Reportroot Getrelyingpartydetailedsummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/reportroot-getrelyingpartydetailedsummary.md | Choose the permission or permissions marked as least privileged for this API. Us --> [!INCLUDE [permissions-table](../includes/permissions/reportroot-getrelyingpartydetailedsummary-permissions.md)] + ## HTTP request <!-- { |
v1.0 | Restorepoint Search | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/restorepoint-search.md | Title: "restorePoint: search" -description: "Search restore points for protection units." +description: "Search for the restorePoint objects associated with a protectionUnit." ms.localizationpriority: medium In the request body, supply a JSON representation of the following parameters. |:|:|:| |artifactQuery|[artifactQuery](../resources/artifactquery.md)|Contains an expression that specifies the criteria for search. Optional.| |protectionUnitIds|String collection|The ID of the protection units. Required.|-|protectionTimePeriod|[timePeriod](../resources/timeperiod.md)|The start and end date time of the protection period. Required.| +|protectionTimePeriod|[timePeriod](../resources/timeperiod.md)|The start and end date time of the protection period. Required.| |restorePointPreference|[restorePointPreference](../api/restorepoint-search.md#restorepointpreference-values)|Indicates which restore point to return. The possible values are `oldest`, `latest`. Optional.| |tags|[restorePointTags](../resources/restorepoint.md#restorepointtags-values)|The type of the restore point. The possible values are `None`, `FastRestore`, `UnknownFutureValue`. Optional.| In the request body, supply a JSON representation of the following parameters. If successful, this action returns a `200 OK` response code and a [restorePointSearchResponse](../resources/restorepointsearchresponse.md) object in the response body. +> [!NOTE] +> - Calls return a maximum of five restore points. +> - You can include a maximum of 20 protection units in a single request, and the response isn't paginated. +> - When you provide an expression for the **artifactQuery** property, you must provide only one protection unit ID in the **protectionUnitIds** property. ++For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Example 1: Search request If successful, this action returns a `200 OK` response code and a [restorePointS The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "restorepoint_search" 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 +- Calls return a maximum of five restore points. +- You can include a maximum of 20 protection units in a single request, and the response isn't paginated. + The following example shows the response. >**Note:** The response object shown here might be shortened for readability. <!-- { Content-Type: application/json } ``` -### Example 2 : Search with artifactQuery expression +### Example 2: Search with artifactQuery expression #### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "restorepoint_search_artifactquery" Content-Type: application/json { "artifactQuery": {- "queryExpression": "((subject -contains ΓÇÿFinanceΓÇÖ) -or (subject -contains ΓÇÿLegalΓÇÖ)) -and (sender -eq 'alex@contoso.com') -and (recipient -eq 'carol@contoso.com') -and hasAttachment -eq true", + "queryExpression": "(Sender -eq 'abc@contoso.com') -and (Subject -like '*Check email*' -or Subject -like ' Important') -and (HasAttachment -eq 'true') -and (PitrDumpsterActionTriggeredTime -gt '{2024-09-21T08:20:00.0000000Z}')", "artifactType": "message" }, "protectionUnitIds": ["23014d8c-71fe-4d00-a01a-31850bc5b42a"], 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 | Restoresessionbase Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/restoresessionbase-activate.md | Namespace: microsoft.graph Activate a draft [restoreSessionBase](../resources/restoresessionbase.md) object. +The following points apply to restoring a protection unit: ++- The SharePoint sites and OneDrive accounts being restored aren't locked in a ready-only state. +- For SharePoint and OneDrive sites restored to new URLs, users don't have the same permissions they had to the original site. Only the global admin or SharePoint admin has permission to the restored site. However, for in-place or restores to the same URL, the permissions from the original site at the time of restoration are preserved. +- Restoration of SharePoint site and OneDrive user content that was removed from the recycle bin isn't supported. +- Mailboxes, OneDrive accounts, and SharePoint sites that are under legal or in-place holds can't be restored unless the legal hold is removed. To restore a SharePoint site under legal hold, you need to restore the site to a new URL. +- Mailbox draft items aren't backed up and can't be restored. +- A restore isn't performed if the current state of the mailbox is same as the point in time you're trying to restore it to. +- SharePoint sites and OneDrive accounts that are restored to a new URL have a read-only lock on that new URL until the restore completes. The global admin can still download documents or remove the read-only lock manually. +- When a restore to a new location is performed, populating the property details of the new location can take more than 15 minutes. +- The global admin, SharePoint admin, or Exchange admin can initiate a restore of up to 1,000 SharePoint sites, 1,000 OneDrive users, and 1,000 mailboxes queued in parallel at a time. + [!INCLUDE [national-cloud-support](../../includes/global-only.md)] ## Permissions Don't supply a request body for this method. If successful, this action returns a `200 OK` response code and a [restoreSessionBase](../resources/restoresessionbase.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "restoresessionbasethis.activate" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/restoreSessions/61633878-8321-4950-bfaf-ed285bdd1461/activate ``` +# [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 | Restoresessionbase Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/restoresessionbase-delete.md | Don't supply a request body for this method. If successful, this method returns a `204 No Content` response code. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "restoresessionbase_delete" The following example shows a request. DELETE https://graph.microsoft.com/v1.0/solutions/backupRestore/restoreSessions/61633878-8321-4950-bfaf-ed285bdd1461 ``` +# [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 | Restoresessionbase Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/restoresessionbase-get.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a [restoreSessionBase](../resources/restoresessionbase.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "restoresessionbase_get" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/restoreSessions/959ba739-70b5-43c4-8c90-b2c22014f18b ``` +# [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 | Riskdetection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskdetection-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskdetection_get" } --> [!INCLUDE [permissions-table](../includes/permissions/riskdetection-get-permissions.md)] ## HTTP request |
v1.0 | Riskdetection List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskdetection-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskdetection_list" } --> [!INCLUDE [permissions-table](../includes/permissions/riskdetection-list-permissions.md)] ## HTTP request |
v1.0 | Riskyserviceprincipal Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyserviceprincipal-confirmcompromised.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyserviceprincipal_confirmcompromised" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyserviceprincipal-confirmcompromised-permissions.md)] ## HTTP request |
v1.0 | Riskyserviceprincipal Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyserviceprincipal-dismiss.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyserviceprincipal_dismiss" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyserviceprincipal-dismiss-permissions.md)] ## HTTP request |
v1.0 | Riskyserviceprincipal List History | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyserviceprincipal-list-history.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyserviceprincipal_list_history" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyserviceprincipal-list-history-permissions.md)] ## HTTP request |
v1.0 | Riskyuser Confirmcompromised | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyuser-confirmcompromised.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyuser_confirmcompromised" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyuser-confirmcompromised-permissions.md)] ## HTTP request The following table shows the parameters that can be used with this action. |Parameter|Type|Description| |:|:|:|-|userIds|String collection|Specify the risky user IDs to dismiss in the request body.| +|userIds|String collection|Specify the risky user IDs to mark as high risk.| |
v1.0 | Riskyuser Dismiss | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyuser-dismiss.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyuser_dismiss" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyuser-dismiss-permissions.md)] ## HTTP request |
v1.0 | Riskyuser Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyuser-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyuser_get" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyuser-get-permissions.md)] ## HTTP request |
v1.0 | Riskyuser List History | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyuser-list-history.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyuser_list_history" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyuser-list-history-permissions.md)] ## HTTP request |
v1.0 | Riskyuser List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/riskyuser-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "riskyuser_list" } --> [!INCLUDE [permissions-table](../includes/permissions/riskyuser-list-permissions.md)] ## HTTP request |
v1.0 | Schedule List Shifts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schedule-list-shifts.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "schedule_list_shifts" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-list-shifts-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Schedule List Timeoffreasons | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schedule-list-timeoffreasons.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "schedule_list_timeoffreasons" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-list-timeoffreasons-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Schedule List Timesoff | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schedule-list-timesoff.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "schedule_list_timesoff" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-list-timesoff-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Schedule Post Timeoffreasons | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schedule-post-timeoffreasons.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "schedule_post_timeoffreasons" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-post-timeoffreasons-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Schedule Post Timesoff | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/schedule-post-timesoff.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "schedule_post_timesoff" } --> [!INCLUDE [permissions-table](../includes/permissions/schedule-post-timesoff-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Security Alert Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-alert-get.md | Content-type: application/json "firstSeenDateTime": "2020-09-12T07:28:32.4321753Z", "mdeDeviceId": "73e7e2de709dff64ef64b1d0c30e67fab63279db", "azureAdDeviceId": null,- "deviceDnsName": "tempDns", + "deviceDnsName": "yonif-lap3.middleeast.corp.microsoft.com", + "hostName": "yonif-lap3", + "ntDomain": null, + "dnsDomain": "middleeast.corp.microsoft.com", "osPlatform": "Windows10", "osBuild": 22424, "version": "Other", |
v1.0 | Security Ediscoverycase Delete Legalholds | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverycase-delete-legalholds.md | + + Title: "Delete ediscoveryHoldPolicy" +description: "Delete an ediscoveryHoldPolicy object." ++ms.localizationpriority: medium ++++# Delete ediscoveryHoldPolicy +Namespace: microsoft.graph.security ++Delete an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.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": "security_ediscoverycase_delete_legalholds" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId} +``` ++## 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 `204 No Content` response code. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "delete_ediscoveryholdpolicy" +} +--> +``` http +DELETE https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalholds/a4d3421d-b756-47ac-ad43-5d587c5dfe75/ +``` ++# [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 | Security Ediscoverycase List Legalholds | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverycase-list-legalholds.md | + + Title: "List ediscoveryHoldPolicies" +description: "Get a list of the ediscoveryHoldPolicy objects and their properties." ++ms.localizationpriority: medium ++++# List ediscoveryHoldPolicies +Namespace: microsoft.graph.security ++Get a list of the [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.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": "security_ediscoverycase_list_legalholds" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) objects in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_ediscoveryholdpolicy" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds +``` ++# [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.security.ediscoveryHoldPolicy)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds", + "@odata.count": 2, + "value": [ + { + "isEnabled": false, + "errors": [], + "contentQuery": "", + "description": null, + "createdDateTime": "2022-05-23T01:09:53Z", + "lastModifiedDateTime": "2022-05-23T02:36:26Z", + "status": "pending", + "id": "783c3ea4-d474-4051-9c13-08707ce8c8b6", + "displayName": "CustodianHold-b0073e4e-4184-41c6-9eb7-8c8cc3e2288b", + "createdBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + } + }, + { + "isEnabled": false, + "errors": [], + "contentQuery": "", + "description": null, + "createdDateTime": "2022-05-23T02:09:27Z", + "lastModifiedDateTime": "2022-05-23T02:41:26Z", + "status": "pending", + "id": "ff7e8841-b1ac-41f0-87c5-fa00da045ae0", + "displayName": "NCDSHold-b0073e4e-4184-41c6-9eb7-8c8cc3e2288b", + "createdBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + } + } + ] +} +``` + |
v1.0 | Security Ediscoverycase Post Legalholds | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverycase-post-legalholds.md | + + Title: "Create ediscoveryHoldPolicy" +description: "Create a new ediscoveryHoldPolicy object." ++ms.localizationpriority: medium ++++# Create ediscoveryHoldPolicy +Namespace: microsoft.graph.security ++Create a new [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.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": "security_ediscoverycase_post_legalholds" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds +``` ++## 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 [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object. ++You can specify the following properties when you create an **ediscoveryHoldPolicy**. ++|Property|Type|Description| +|:|:|:| +|displayName|String|The display name of the legal hold policy. Required.| +|description|String|The description of the legal hold policy. Optional.| +|contentQuery|String|KQL query that specifies content to be held in the specified locations. Optional. | ++## Response ++If successful, this method returns a `201 Created` response code and an [microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_ediscoveryholdpolicy_from_" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds +Content-Type: application/json ++{ + "displayName": "My legalHold with sources", + "description": "Created from Graph API", + "contentQuery": "KQL content query" +} +``` ++# [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": "microsoft.graph.security.ediscoveryHoldPolicy" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds/$entity", + "isEnabled": true, + "errors": [], + "description": "Created from Graph API", + "createdDateTime": "2022-05-23T03:54:11.1Z", + "lastModifiedDateTime": "2022-05-23T03:54:11.1Z", + "status": "pending", + "id": "b9758bbc-ddbd-45e0-8484-3eb49cf1ded3", + "displayName": "My legalHold with sources", + "createdBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + } +} +``` + |
v1.0 | Security Ediscoverycustodian List Sitesources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverycustodian-list-sitesources.md | doc_type: apiPageType # List siteSources Namespace: microsoft.graph.security ---Get a list of the [siteSource](../resources/security-sitesource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md). +Get a list of the [siteSource](../resources/security-sitesource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md) or [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md). [!INCLUDE [national-cloud-support](../../includes/global-us.md)] Choose the permission or permissions marked as least privileged for this API. Us --> ``` http GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/custodians/{custodianId}/siteSources+GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}/siteSources ``` ## Optional query parameters GET https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-418 ++ ### Response The following example shows the response. >**Note:** The response object shown here might be shortened for readability. |
v1.0 | Security Ediscoverycustodian List Usersources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverycustodian-list-usersources.md | doc_type: apiPageType # List userSources Namespace: microsoft.graph.security ---Get a list of the [userSource](../resources/security-usersource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md). +Get a list of the [userSource](../resources/security-usersource.md) objects associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md) or [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md). [!INCLUDE [national-cloud-support](../../includes/global-us.md)] GET https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-418 ++ ### Response The following example shows the response. >**Note:** The response object shown here might be shortened for readability. |
v1.0 | Security Ediscoverycustodian Post Usersources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverycustodian-post-usersources.md | You can specify the following properties when you create a **userSource**. |Property|Type|Description| |:|:|:| |email|String|SMTP address of the user.|-|includedSources|microsoft.graph.security.sourceType|Specifies which sources are included in this group. Possible values are: `mailbox`, `site`.| +|includedSources|microsoft.graph.security.sourceType|Specifies which sources are included in this group. Possible values are: `mailbox`, `site`. Only `mailbox` is applicable for user sources.| ## Response POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-41 { "email": "admin@contoso.com",- "includedSources": "mailbox, site" + "includedSources": "mailbox" } ``` |
v1.0 | Security Ediscoveryholdpolicy Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoveryholdpolicy-get.md | + + Title: "Get ediscoveryHoldPolicy" +description: "Read the properties and relationships of an ediscoveryHoldPolicy object." ++ms.localizationpriority: medium ++++# Get ediscoveryHoldPolicy +Namespace: microsoft.graph.security ++Read the properties and relationships of an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.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": "security_ediscoveryholdpolicy_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId} +``` ++## Optional query parameters +This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers +|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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 an [microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_ediscoveryholdpolicy" +} +--> +``` http +GET https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalholds/783c3ea4-d474-4051-9c13-08707ce8c8b6 +``` ++# [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": "microsoft.graph.security.ediscoveryHoldPolicy" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds/$entity", + "isEnabled": true, + "errors": [], + "contentQuery": "does api fetch query?", + "description": "does api fetch description?", + "createdDateTime": "2022-05-23T01:09:53.497Z", + "lastModifiedDateTime": "2022-05-25T23:15:04.317Z", + "status": "success", + "id": "783c3ea4-d474-4051-9c13-08707ce8c8b6", + "displayName": "CustodianHold-b0073e4e-4184-41c6-9eb7-8c8cc3e2288b", + "createdBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + }, + "lastModifiedBy": { + "application": null, + "user": { + "id": "MOD Administrator", + "displayName": null + } + } +} +``` |
v1.0 | Security Ediscoveryholdpolicy Post Sitesources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoveryholdpolicy-post-sitesources.md | + + Title: "Create siteSource" +description: "Create a new siteSource object." ++ms.localizationpriority: medium ++++# Create siteSource +Namespace: microsoft.graph.security ++Create a new [siteSource](../resources/security-sitesource.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": "security_ediscoveryholdpolicy_post_sitesources" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}/siteSources +``` ++## 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 [siteSource](../resources/security-sitesource.md) object. ++You can specify the following properties when you create a **siteSource**. ++|Property|Type|Description| +|:|:|:| +|site|String|URL of the site; for example, `https://contoso.sharepoint.com/sites/HumanResources`.| ++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.siteSource](../resources/security-sitesource.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_sitesource_from__weburl" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalHolds/0053a61a3b6c42738f7606791716a22a/siteSources +Content-Type: application/json ++{ + "site": { + "webUrl": "https://m365x809305.sharepoint.com/sites/Retail" + } +} +``` ++# [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": "microsoft.graph.security.siteSource" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json +++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds('0053a61a3b6c42738f7606791716a22a')/siteSources/$entity", + "@odata.id": "https://graph.microsoft.com/v1.0/sites/dbe4b18e-2765-4989-8647-48139180c45f", + "displayName": "Retail", + "createdDateTime": "0001-01-01T00:00:00Z", + "holdStatus": "applied", + "id": "dbe4b18e-2765-4989-8647-48139180c45f", + "createdBy": { + "user": { + "id": "c25c3914-f9f7-43ee-9cba-a25377e0cec6", + "displayName": "MOD Administrator", + "userPrincipalName": "admin@contoso.com" + }, + "application": { + "id": "de8bc8b5-d9f9-48b1-a8ad-b748da725064", + "displayName": "Graph Explorer" + } + } +} +``` |
v1.0 | Security Ediscoveryholdpolicy Post Usersources | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoveryholdpolicy-post-usersources.md | + + Title: "Create userSource" +description: "Create a new userSource object." ++ms.localizationpriority: medium ++++# Create userSource +Namespace: microsoft.graph.security ++Create a new [userSource](../resources/security-usersource.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": "security_ediscoveryholdpolicy_post_usersources" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}/userSources +``` ++## 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 [userSource](../resources/security-usersource.md) object. ++You can specify the following properties when you create a **userSource**. ++|Property|Type|Description| +|:|:|:| +|email|String|SMTP address of the user.| +|includedSources|microsoft.graph.security.sourceType|Specifies which sources are included in this group. Possible values are: `mailbox`, `site`.| +++## Response ++If successful, this method returns a `201 Created` response code and a [microsoft.graph.security.userSource](../resources/security-usersource.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_usersource_and_include_sources" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId}/userSources +Content-Type: application/json ++{ + "email": "admin@contoso.com", + "includedSources": "mailbox, site" +} +``` ++# [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": "microsoft.graph.security.userSource" +} +--> +``` http +HTTP/1.1 201 Created +Content-Type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/cases/ediscoveryCases('b0073e4e-4184-41c6-9eb7-8c8cc3e2288b')/legalHolds('0053a61a3b6c42738f7606791716a22a')/userSources/$entity", + "displayName": "MOD Administrator", + "createdDateTime": "0001-01-01T00:00:00Z", + "holdStatus": "applied", + "id": "c25c3914-f9f7-43ee-9cba-a25377e0cec6", + "email": "admin@contoso.com", + "includedSources": "mailbox,site", + "siteWebUrl": "", + "createdBy": { + "user": { + "id": "c25c3914-f9f7-43ee-9cba-a25377e0cec6", + "displayName": "MOD Administrator", + "userPrincipalName": "admin@contoso.com" + }, + "application": { + "id": "de8bc8b5-d9f9-48b1-a8ad-b748da725064", + "displayName": "Graph Explorer" + } + } +} +``` |
v1.0 | Security Ediscoveryholdpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoveryholdpolicy-update.md | + + Title: "Update ediscoveryHoldPolicy" +description: "Update the properties of an ediscoveryHoldPolicy object." ++ms.localizationpriority: medium ++++# Update ediscoveryHoldPolicy +Namespace: microsoft.graph.security ++Update the properties of an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.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": "security_ediscoveryholdpolicy_update" } --> +++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/cases/ediscoveryCases/{ediscoveryCaseId}/legalHolds/{ediscoveryHoldPolicyId} +``` ++## 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| +|:|:|:| +|description|String|The description of the legal hold policy. Optional.| +++## Response ++If successful, this method returns a `204 No Content` response code and an updated [microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object in the response body. ++## Examples ++### Request +The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_ediscoveryholdpolicy" +} +--> +``` http +PATCH https://graph.microsoft.com/beta/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/legalholds/783c3ea4-d474-4051-9c13-08707ce8c8b6 ++{ + "description": "updated description", +} +``` ++# [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 | Security Ediscoverysearch Exportreport | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverysearch-exportreport.md | + + Title: "ediscoverySearch: exportReport" +description: "Export an item report from an estimated ediscoverySearch." ++ms.localizationpriority: medium ++++# ediscoverySearch: exportReport ++Namespace: microsoft.graph.security ++Export an item report from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md). For details, see [Manage a collection estimate](/purview/ediscovery-create-draft-collection#manage-a-collection-estimate). +++## 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": "security_ediscoverysearch_exportreport" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySearchId}/exportReport +POST /security/cases/ediscoveryCases('{ediscoveryCaseId}')/searches('{ediscoverySearchId}')/exportReport +``` ++## 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 lists the parameters that you can use with this action. ++| Parameter | Type | Description | +|:|:|:| +| additionalOptions | [microsoft.graph.security.additionalOptions](../resources/security-ediscoverysearchexportoperation.md#additionaloptions-values) | The additional options for the export. The possible values are: `none`, `teamsAndYammerConversations`, `cloudAttachments`, `allDocumentVersions`, `subfolderContents`, `listAttachments`, `unknownFutureValue`. Required.| +| description | String | The description of the export report. | +| displayName | String | The display name of the export report. | +| exportCriteria | [microsoft.graph.security.exportCriteria](../resources/security-ediscoverysearchexportoperation.md#exportcriteria-values) | The portion of the estimate report to be exported. The possible values are: `searchHits`, `partiallyIndexed`, `unknownFutureValue`. Required.| +| exportLocation | [microsoft.graph.security.exportLocation](../resources/security-ediscoverysearchexportoperation.md#exportlocation-values) | Location scope for partially indexed items. You can choose to include partially indexed items only in responsive locations with search hits or in all targeted locations. The possible values are: `responsiveLocations`, `nonresponsiveLocations`, `unknownFutureValue`.| ++## Response ++If the export has started successfully, this action returns a `202 Accepted` response code. The response also contains a `Location` header that includes the location of the [microsoft.graph.security.ediscoverySearchExportOperation](../resources/security-ediscoverysearchexportoperation.md) that was created to handle the export. To check the status of the export operation, make a GET request to the location URL. ++## Examples ++### Example 1: Export a report of items with search hits only, excluding partially indexed items, without additional options ++The following example shows how to export a report of items with search hits only, excluding partially indexed items, with no additional options selected. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_report1" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport +Content-Type: application/json ++{ + "displayName": "Export 1", + "exportCriteria": "searchHits", + "additionalOptions": "none" +} +``` ++# [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, + "name": "export_report1" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('f57fc79d-bea8-42ac-b0be-217302d5683c') +``` ++### Example 2: Export a report of items with search hits and partially indexed items in all targeted locations, without additional options ++The following example shows how to export a report of items with search hits and partially indexed items in all targeted locations, with no additional options selected. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_report2" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport +Content-Type: application/json ++{ + "displayName": "Export 2", + "exportCriteria": "searchHits, partiallyIndexed", + "exportLocation": "responsiveLocations, nonresponsiveLocations", + "additionalOptions": "none" +} +``` ++# [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, + "name": "export_report2" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('cbcb4807-e76e-4ef0-bd5b-e2177c13f07e') +``` ++### Example 3: Export a report of items with search hits and partially indexed items in locations with search hits, without additional options ++The following example shows how to export a report of items with search hits and partially indexed items in locations with search hits, with no additional options selected. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "truncated": true, + "name": "export_report3" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport +Content-Type: application/json ++{ + "displayName": "Export 3", + "exportCriteria": "searchHits, partiallyIndexed", + "exportLocation": "responsiveLocations", + "additionalOptions": "none" +} +``` ++# [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, + "name": "export_report3" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('c56f66de-b780-4efc-aa0c-4ef3271ad6b4') +``` ++### Example 4: Export a report of partially indexed items in all targeted locations with all additional options selected ++The following example shows how to export a report of partially indexed items in all targeted locations with all additional options selected. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_report4" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport +Content-Type: application/json ++{ + "displayName": "Export 4", + "exportCriteria": "partiallyIndexed", + "exportLocation": "responsiveLocations, nonresponsiveLocations", + "additionalOptions": "teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments" +} +``` ++# [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, + "name": "export_report4" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('572d44e2-5e77-4443-a2ed-cd036bdc0304') +``` ++### Example 5: Export a report of partially indexed items in locations with search hits and cloud attachments ++The following example shows how to export a report of partially indexed items in locations with search hits and cloud attachments. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_report5" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportReport +Content-Type: application/json ++{ + "displayName": "Export 5", + "exportCriteria": "partiallyIndexed", + "exportLocation": "responsiveLocations", + "additionalOptions": "cloudAttachments" +} +``` ++# [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, + "name": "export_report5" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/v1.0/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('788159f9-f860-43f2-8fc5-0fc17df0e696') +``` |
v1.0 | Security Ediscoverysearch Exportresult | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverysearch-exportresult.md | + + Title: "ediscoverySearch: exportResult" +description: "Export results from an estimated ediscoverySearch." ++ms.localizationpriority: medium ++++# ediscoverySearch: exportResult ++Namespace: microsoft.graph.security ++Export results from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md). For details, see [Manage a collection estimate](/purview/ediscovery-create-draft-collection#manage-a-collection-estimate). +++## 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": "security_ediscoverysearch_exportresult" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySearchId}/exportResult +POST /security/cases/ediscoveryCases('{ediscoveryCaseId}')/searches('{ediscoverySearchId}')/exportResult +``` ++## 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 lists the parameters that you can use with this action. ++| Parameter | Type | Description | +|:|:|:| +| additionalOptions | [microsoft.graph.security.additionalOptions](../resources/security-ediscoverysearchexportoperation.md#additionaloptions-values) | The additional options for the export. The possible values are: `none`, `teamsAndYammerConversations`, `cloudAttachments`, `allDocumentVersions`, `subfolderContents`, `listAttachments`, `unknownFutureValue`. Required.| +| description | String | The description of the export result. | +| displayName | String | The display name of the export result. | +| exportCriteria | [microsoft.graph.security.exportCriteria](../resources/security-ediscoverysearchexportoperation.md#exportcriteria-values) | The portion of the estimate results to be exported. The possible values are: `searchHits`, `partiallyIndexed`, `unknownFutureValue`. Required.| +| exportFormat | [microsoft.graph.security.exportFormat](../resources/security-ediscoverysearchexportoperation.md#exportformat-values) | The desired format of the exported emails. The possible values are: `pst`, `msg`, `eml`, `unknownFutureValue`. Required. | +| exportLocation | [microsoft.graph.security.exportLocation](../resources/security-ediscoverysearchexportoperation.md#exportlocation-values) | Location scope for partially indexed items. You can choose to include partially indexed items only in responsive locations with search hits or in all targeted locations. The possible values are: `responsiveLocations`, `nonresponsiveLocations`, `unknownFutureValue`.| ++## Response ++If the export starts successfully, this action returns a `202 Accepted` response code. The response also contains a `Location` header that includes the location of the [microsoft.graph.security.ediscoverySearchExportOperation](../resources/security-ediscoverysearchexportoperation.md) that was created to handle the export. To check the status of the export operation, make a GET request to the location URL. ++## Examples ++### Example 1: Export results with search hits only, excluding partially indexed items, with no additional options, as .pst files for each mailbox ++The following example shows how to export results with search hits only as .pst files for each mailbox, excluding partially indexed items. The example selects no other options selected. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_result1" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult +Content-Type: application/json ++{ + "displayName": "Export 1 - simple PST", + "exportCriteria": "searchHits", + "additionalOptions": "none", + "exportFormat": "pst" +} +``` ++# [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, + "name": "export_result1" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('01826ce3-43a3-4235-a121-81d05926efae') +``` ++### Example 2: Export results with search hits and partially indexed items in all locations, with no additional options, as .pst files for each mailbox. ++The following example shows how to export results with search hits and partially indexed items in all locations, with no additional options selected, as .pst files for each mailbox. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_result2" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult +Content-Type: application/json ++{ + "displayName": "Export 2", + "exportCriteria": "searchHits, partiallyIndexed", + "exportLocation": "responsiveLocations, nonresponsiveLocations", + "additionalOptions": "none", + "exportFormat": "pst" +} +``` ++# [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, + "name": "export_result2" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('c74d3039-5c79-4093-8e45-2abb94e32ba9') +``` ++### Example 3: Export results with search hits and partially indexed items in locations with search hits, with no additional options, as .msg files for each message ++The following example shows how to export results with search hits and partially indexed items in locations with search hits, with no additional options selected, as .msg files for each message. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_result3" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult +Content-Type: application/json ++{ + "displayName": "Export 3", + "exportCriteria": "searchHits, partiallyIndexed", + "exportLocation": "responsiveLocations", + "additionalOptions": "none", + "exportFormat": "msg" +} +``` ++# [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, + "name": "export_result3" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('4bf812e0-44ad-4856-a302-b4ea79725573') +``` ++### Example 4: Export results with partially indexed items in all targeted locations, with all additional options, as .eml files for each message ++The following example shows how to export results with partially indexed items in all targeted locations, with all additional options selected, as .eml files for each message. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_result4" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult +Content-Type: application/json ++{ + "displayName": "Export 4", + "exportCriteria": "partiallyIndexed", + "exportLocation": "responsiveLocations, nonresponsiveLocations", + "additionalOptions": "teamsAndYammerConversations, cloudAttachments, allDocumentVersions, subfolderContents, listAttachments", + "exportFormat": "eml" +} +``` ++# [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, + "name": "export_result4" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('05b5c707-ed0d-4f5c-bbfd-e4941137baf1') +``` ++### Example 5: Export results with partially indexed items in search hit locations, with cloud attachments, as .eml files for each message ++The following example shows how to export results with partially indexed items in search hit locations, with cloud attachments, as .eml files for each message. ++#### Request ++The following example shows a request. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "export_result5" +} +--> +``` http +POST https://graph.microsoft.com/beta/security/cases/ediscoveryCases/dbc06feb-a6a5-46a2-8e4e-534353b071e4/searches/6c2ab774-2d2a-46b9-a601-3130f518757b/exportResult +Content-Type: application/json ++{ + "displayName": "Export 5", + "exportCriteria": "partiallyIndexed", + "exportLocation": "responsiveLocations", + "additionalOptions": "cloudAttachments", + "exportFormat": "eml" +} +``` ++# [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, + "name": "export_result5" +} +--> +``` http +HTTP/1.1 202 Accepted +Content-Length: 0 +Location: https://graph.microsoft.com/beta/security/cases/ediscoverycases('dbc06feb-a6a5-46a2-8e4e-534353b071e4')/operations('d488f23e-f3cb-4a1c-9b9f-88ac4342f534') +``` |
v1.0 | Security Ediscoverysearch Purgedata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-ediscoverysearch-purgedata.md | Title: "ediscoverySearch: purgeData" -description: "Use the purge data method to delete Teams messages in a eDiscovery search." +description: "Delete Exchange mailbox items or Microsoft Teams messages contained in an eDiscovery search." ms.localizationpriority: medium doc_type: "apiPageType" - # ediscoverySearch: purgeData Namespace: microsoft.graph.security -Delete Microsoft Teams messages contained in an [eDiscovery search](../resources/security-ediscoverysearch.md). +Delete Exchange mailbox items or Microsoft Teams messages contained in an [eDiscovery search](../resources/security-ediscoverysearch.md). ->**Note:** This request purges Teams data only. It does not purge other types of data such as mailbox items. +>**Note:** This request purges a maximum of 100 items per location only. You can collect and purge the following categories of Teams content: - **Teams 1:1 chats** - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called *conversations*. POST /security/cases/ediscoveryCases/{ediscoveryCaseId}/searches/{ediscoverySear ## 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. +The following table shows the parameters that you can use with this action. |Parameter|Type|Description| |:|:|:|-|purgeType|microsoft.graph.security.purgeType| Options that control whether the action is soft delete or hard delete. Possible values are `recoverable`, `permanentlydeleted`, `unknownFutureValue`. | |purgeAreas|microsoft.graph.security.purgeAreas| Option to define the locations to be in scope of the purge action. Possible values are: `mailboxes`, `teamsMessages`, `unknownFutureValue`. |+|purgeType|microsoft.graph.security.purgeType| Options that control whether the action is soft delete or hard delete. Possible values are: `recoverable`, `unknownFutureValue`, `permanentlyDelete`. | ## Response If successful, this action returns a `202 Accepted` response code. -If the purge data operation is started successfully, this action returns a `202 Accepted` response code. The response will also contain a `Location` header, which contains the location of the [Purge data operation](../resources/security-ediscoverypurgedataoperation.md) that was created to commit the purge. -To check the status of the purge data operation, make a GET request to the location URL. -+If the purge data operation is started successfully, this action returns a `202 Accepted` response code. The response also contains a `Location` header, which contains the location of the [Purge data operation](../resources/security-ediscoverypurgedataoperation.md) that was created to commit the purge. To check the status of the purge data operation, make a GET request to the location URL. ## Examples ### Request The following example shows a request. - # [HTTP](#tab/http) <!-- { "blockType": "request", The following example shows a request. POST https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/b0073e4e-4184-41c6-9eb7-8c8cc3e2288b/searches/c61a5860-d634-4d14-aea7-d82b6f4eb7af/purgeData {-+ "purgeType": "recoverable", + "purgeAreas": "teamsMessages" } ``` |
v1.0 | Security Healthissue Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-healthissue-get.md | + + Title: "Get healthIssue" +description: "Read the properties and relationships of a healthIssue object." +++++# Get healthIssue ++Namespace: microsoft.graph.security ++Read the properties and relationships of a [healthIssue](../resources/security-healthissue.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": "security_healthissue_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues/{healthIssueId} +``` ++## 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.security.healthIssue](../resources/security-healthissue.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "get_healthissue" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/identities/healthIssues/bf600aba-e975-0274-d332-c0f79dc75740 +``` ++# [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": "microsoft.graph.security.healthIssue" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.healthIssue", + "additionalInformation": ["Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)"], + "createdDateTime": "2022-07-15T12:19:27.7211305Z", + "description": "Directory Services Object Auditing isn't configured as required on domain1.contoso.com", + "displayName": "Directory Services Object Auditing isn't configured as required", + "domainNames": ["domain1.contoso.com", "domain2.contoso.com"], + "healthIssueType": "Global", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "issueTypeId": "1031", + "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z", + "recommendations": ["Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"], + "recommendedActionCommands": ["Import-Module DefenderForIdentity"], + "sensorDNSNames": ["DC1.domain1.contoso.com", "DC2.domain2.contoso.com"], + "severity": "medium", + "status": "open" +} +``` |
v1.0 | Security Healthissue Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-healthissue-update.md | + + Title: "Update healthIssue" +description: "Update the properties of a healthIssue object." ++ms.localizationpriority: medium ++++# Update healthIssue ++Namespace: microsoft.graph.security ++Update the properties of a [healthIssue](../resources/security-healthissue.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": "security_healthissue_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/identities/healthIssues/{healthIssueId} +``` ++## 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| +|:|:|:| +|status|microsoft.graph.security.healthIssueStatus|The status of the health issue. The possible values are: `open`, `closed`, `suppressed`, `unknownFutureValue`.| +++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.healthIssue](../resources/security-healthissue.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_healthissue" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/security/identities/healthIssues/b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c +Content-Type: application/json ++{ + "status": "closed" +} +``` ++# [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", + "@odata.type": "microsoft.graph.security.healthIssue", + "truncated": true +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.healthIssue", + "additionalInformation": ["Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)"], + "createdDateTime": "2022-07-15T12:19:27.7211305Z", + "description": "Directory Services Object Auditing isn't configured as required on domain1.contoso.com", + "displayName": "Directory Services Object Auditing isn't configured as required", + "domainNames": ["domain1.contoso.com", "domain2.contoso.com"], + "healthIssueType": "Global", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "issueTypeId": "1031", + "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z", + "recommendations": ["Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"], + "recommendedActionCommands": ["Import-Module DefenderForIdentity"], + "sensorDNSNames": ["DC1.domain1.contoso.com", "DC2.domain2.contoso.com"], + "severity": "medium", + "status": "closed" +} +``` |
v1.0 | Security Identitycontainer List Healthissues | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-identitycontainer-list-healthissues.md | + + Title: "List healthIssues" +description: "Get a list of the healthIssue objects and their properties." ++ms.localizationpriority: medium ++++# List healthIssues ++Namespace: microsoft.graph.security ++Get a list of [healthIssue](../resources/security-healthissue.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": "security_identitycontainer_list_healthissues" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues +``` ++## Optional query parameters ++This method supports the `$count`, `$filter`, `$skip`, `$top`, and `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++The following examples show how to use optional query parameters. ++### Get all open health alerts +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open' +``` ++### Get the top five open health alerts +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open'&$top=5 +``` ++### Get open health alerts based on issue type +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open' and healthIssueType eq 'global' +GET /security/identities/healthIssues?$filter=Status eq 'open' and healthIssueType eq 'sensor' +``` ++### Get open health alerts based on severity +<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq 'medium' +GET /security/identities/healthIssues?$filter=Status eq 'open' and severity eq 'low' +``` ++### Get open global health alerts where the domain name or sensor DNS name ends with a specific value ++The following example shows how to get global health alerts where the domain name or sensor DNS name ends with a specific value, for example, `contoso.com`. ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/healthissues?$filter=Status eq 'open' and healthIssueType eq 'global' and domainNames/any(s:endswith(s,'contoso.com')) +GET /security/identities/healthissues?$filter=Status eq 'open' and healthIssueType eq 'global' and sensorDNSNames/any(s:endswith(s,'contoso.com')) +``` ++## 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.security.healthIssue](../resources/security-healthissue.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "list_healthissues" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/identities/healthIssues +``` ++# [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.security.healthIssue)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.healthIssue", + "additionalInformation": ["Descendant User Objects (Schema-Id-Guid: bf967aba-0de6-11d0-a285-00aa003049e2)"], + "createdDateTime": "2022-07-15T12:19:27.7211305Z", + "description": "Directory Services Object Auditing isn't configured as required on domain1.contoso.com", + "displayName": "Directory Services Object Auditing isn't configured as required", + "domainNames": ["domain1.contoso.com", "domain2.contoso.com"], + "healthIssueType": "Global", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "issueTypeId": "1031", + "lastModifiedDateTime": "2022-07-15T12:19:27.7211305Z", + "recommendations": ["Please configure the Directory Services Object Auditing events according to the guidance as described in https://aka.ms/mdi/objectauditing"], + "recommendedActionCommands": ["Import-Module DefenderForIdentity"], + "sensorDNSNames": ["DC1.domain1.contoso.com", "DC2.domain2.contoso.com"], + "severity": "medium", + "status": "open" + } + ] +} +``` |
v1.0 | Security Identitycontainer List Sensors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-identitycontainer-list-sensors.md | + + Title: "List sensors" +description: "Get a list of sensor objects and their properties." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# List sensors ++Namespace: microsoft.graph.security ++Get a list of [sensor](../resources/security-sensor.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": "security_identitycontainer_list_sensors" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors +``` ++## Optional query parameters ++This method supports the `$count`, `$filter`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). ++## Request headers ++|Name|Description| +|:|:| +|Authorization|Bearer {token}. Required. 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.security.sensor](../resources/security-sensor.md) objects in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "list_sensor" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/identities/sensors +``` ++### 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.security.sensor)" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": [ + { + "@odata.type": "#microsoft.graph.security.sensor", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "displayName": "DC1", + "sensorType": "domainControllerIntegrated", + "version": "2.239.18124.58593", + "deploymentStatus": "upToDate", + "createdDateTime": "2023-11-16T09:41:24.2585071Z", + "domainName": "domain1.test.local", + "healthStatus": "healthy", + "openHealthIssuesCount": 0, + "settings": { + "@odata.type": "microsoft.graph.security.sensorSettings", + "description": "dc1 settings", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": true + } + } + ] +} +``` |
v1.0 | Security Incident Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-incident-update.md | PATCH /security/incidents/{incidentId} |assignedTo|String|Owner of the incident, or null if no owner is assigned. Free editable text.| |classification|microsoft.graph.security.alertClassification|The specification for the incident. Possible values are: `unknown`, `falsePositive`, `truePositive`, `informationalExpectedActivity`, `unknownFutureValue`.| |customTags|String collection|Array of custom tags associated with an incident.|-|determination|microsoft.graph.security.alertDetermination|Specifies the determination of the incident. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedUser`, `phishing`, `maliciousUserActivity`, `notMalicious`, `notEnoughDataToValidate`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| +|determination|microsoft.graph.security.alertDetermination|Specifies the determination of the incident. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedAccount`, `phishing`, `maliciousUserActivity`, `notMalicious`, `notEnoughDataToValidate`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| |status|microsoft.graph.security.incidentStatus|The status of the incident. Possible values are: `active`, `resolved`, `redirected`, `unknownFutureValue`.| |summary|String|The overview of an attack. When applicable, the summary contains details of what occurred, impacted assets, and the type of attack.| |
v1.0 | Security List Alerts_V2 | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-list-alerts_v2.md | GET https://graph.microsoft.com/v1.0/security/alerts_v2 <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.alert", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.security.alert)" } --> ``` http Content-type: application/json "firstSeenDateTime": "2020-09-12T07:28:32.4321753Z", "mdeDeviceId": "73e7e2de709dff64ef64b1d0c30e67fab63279db", "azureAdDeviceId": null,- "deviceDnsName": "tempDns", + "deviceDnsName": "yonif-lap3.middleeast.corp.microsoft.com", + "hostName": "yonif-lap3", + "ntDomain": null, + "dnsDomain": "middleeast.corp.microsoft.com", "osPlatform": "Windows10", "osBuild": 22424, "version": "Other", |
v1.0 | Security List Incidents | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-list-incidents.md | Title: "List incidents" description: "Get a list of the incident objects and their properties." Previously updated : 11/11/2022 ms.localizationpriority: medium The following example shows the response. <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.incident", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.security.incident)" } --> GET https://graph.microsoft.com/v1.0/security/incidents?$expand=alerts <!-- { "blockType": "response", "truncated": true,- "@odata.type": "microsoft.graph.security.incident", - "isCollection": true + "@odata.type": "Collection(microsoft.graph.security.incident)" } --> ``` http Content-Type: application/json "firstSeenDateTime": "2020-09-12T07:28:32.4321753Z", "mdeDeviceId": "73e7e2de709dff64ef64b1d0c30e67fab63279db", "azureAdDeviceId": null,- "deviceDnsName": "tempDns", + "deviceDnsName": "yonif-lap3.middleeast.corp.microsoft.com", + "hostName": "yonif-lap3", + "ntDomain": null, + "dnsDomain": "middleeast.corp.microsoft.com", "osPlatform": "Windows10", "osBuild": 22424, "version": "Other", |
v1.0 | Security Sensor Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-sensor-delete.md | + + Title: "Delete sensor" +description: "Delete a sensor object." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# Delete sensor ++Namespace: microsoft.graph.security ++Delete a [sensor](../resources/security-sensor.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": "security_sensor_delete" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +DELETE /security/identities/sensors/{sensorId} +``` ++## 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 `204 No Content` response code. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "sampleKeys": ["d31dd827-92cd-4cd6-b269-c151a0eec55d"], + "name": "delete_sensor" +} +--> +``` http +DELETE https://graph.microsoft.com/v1.0/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d +``` ++### Response ++The following example shows the response. ++<!-- { + "blockType": "response", + "truncated": true +} +--> +``` http +HTTP/1.1 204 No Content +``` |
v1.0 | Security Sensor Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-sensor-get.md | + + Title: "Get sensor" +description: "Read the properties and relationships of a sensor object." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# Get sensor ++Namespace: microsoft.graph.security ++Read the properties and relationships of a [sensor](../resources/security-sensor.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": "security_sensor_get" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors/{sensorId} +``` ++## 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). ++## 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.security.sensor](../resources/security-sensor.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "sampleKeys": ["d31dd827-92cd-4cd6-b269-c151a0eec55d"], + "name": "get_sensor" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d +``` +++### 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.security.sensor" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.sensor", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "displayName": "DC1", + "sensorType": "domainControllerIntegrated", + "version": "2.239.18124.58593", + "deploymentStatus": "upToDate", + "createdDateTime": "2023-11-16T09:41:24.2585071Z", + "domainName": "domain1.test.local", + "healthStatus": "healthy", + "openHealthIssuesCount": 0, + "settings": { + "@odata.type": "microsoft.graph.security.sensorSettings", + "description": "dc1 settings", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": true + } +} +``` |
v1.0 | Security Sensor Getdeploymentaccesskey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-sensor-getdeploymentaccesskey.md | + + Title: "sensor: getDeploymentAccessKey" +description: "Get the deployment access key for Microsoft Defender for Identity that is required to install sensors associated with the workspace." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# sensor: getDeploymentAccessKey ++Namespace: microsoft.graph.security ++Get the deployment access key for Microsoft Defender for Identity that is required to install sensors associated with the workspace. +++## 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": "security_sensor_getdeploymentaccesskey" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors/getDeploymentAccessKey +``` ++## 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 [microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md) in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "sensorthis.getdeploymentaccesskey" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/identities/sensors/getDeploymentAccessKey +``` ++### 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.security.deploymentAccessKeyType" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "microsoft.graph.security.deploymentAccessKeyType", + "sensorDeploymentAccessKey": "<Deployment access key (Secret)>" + } +} +``` |
v1.0 | Security Sensor Getdeploymentpackageuri | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-sensor-getdeploymentpackageuri.md | + + Title: "sensor: getDeploymentPackageUri" +description: "Get the sensor deployment package URL and version." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# sensor: getDeploymentPackageUri ++Namespace: microsoft.graph.security ++Get the [sensor](../resources/security-sensor.md) deployment package URL and version. You can use this URL to download the installer to install the sensor on a server. +++## 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": "security_sensor_getdeploymentpackageuri" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /security/identities/sensors/getDeploymentPackageUri +``` ++## 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 [microsoft.graph.security.sensorDeploymentPackage](../resources/security-sensordeploymentpackage.md) in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "sensorthis.getdeploymentpackageuri" +} +--> +``` http +GET https://graph.microsoft.com/v1.0/security/identities/sensors/getDeploymentPackageUri +``` ++### 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.security.sensorDeploymentPackage" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "microsoft.graph.security.sensorDeploymentPackage", + "downloadUrl": "<Download URL string>", + "version": "2.239.18124.58593" + } +} +``` |
v1.0 | Security Sensor Regeneratedeploymentaccesskey | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-sensor-regeneratedeploymentaccesskey.md | + + Title: "sensor: regenerateDeploymentAccessKey" +description: "Generate a new deployment access key that can be used to install sensors associated with the workspace." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# sensor: regenerateDeploymentAccessKey ++Namespace: microsoft.graph.security ++Generate a new deployment access key that can be used to install a [sensor](../resources/security-sensor.md) associated with the workspace. +++## 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": "security_sensor_regeneratedeploymentaccesskey" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /security/identities/sensors/regenerateDeploymentAccessKey +``` ++## 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 `200 OK` response code and a [microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md) in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "sensorthis.regeneratedeploymentaccesskey" +} +--> +``` http +POST https://graph.microsoft.com/v1.0/security/identities/sensors/regenerateDeploymentAccessKey +``` ++### 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.security.deploymentAccessKeyType" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "microsoft.graph.security.deploymentAccessKeyType", + "sensorDeploymentAccessKey": "<Deployment access key (Secret)>" + } +} +``` |
v1.0 | Security Sensor Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/security-sensor-update.md | + + Title: "Update sensor" +description: "Update the properties of a sensor object." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# Update sensor ++Namespace: microsoft.graph.security ++Update the properties of a [sensor](../resources/security-sensor.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": "security_sensor_update" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +PATCH /security/identities/sensors/{sensorId} +``` ++## 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| +|:|:|:| +|settings|[microsoft.graph.security.sensorSettings](../resources/security-sensorsettings.md)|Sensor settings information. The **description** property can be updated for all sensor types. The **isDelayedUpdateEnabled** property can be updated for all sensors with version < 3.X. The **domainControllerDnsNames** property can be updated for all sensors with version < 3.X except for domain controller sensors. | ++++## Response ++If successful, this method returns a `200 OK` response code and an updated [microsoft.graph.security.sensor](../resources/security-sensor.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "sampleKeys": ["d31dd827-92cd-4cd6-b269-c151a0eec55d"], + "name": "update_sensor" +} +--> +``` http +PATCH https://graph.microsoft.com/v1.0/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d +Content-Type: application/json ++{ + "settings": { + "description": "dc1 settings new description", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": false + } +} +``` ++### Response ++The following example shows the response. +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "@odata.type": "microsoft.graph.security.sensor", + "truncated": true, + "name": "update_sensor" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "@odata.type": "#microsoft.graph.security.sensor", + "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c", + "displayName": "DC1", + "sensorType": "domainControllerIntegrated", + "version": "2.239.18124.58593", + "deploymentStatus": "upToDate", + "createdDateTime": "2023-11-16T09:41:24.2585071Z", + "domainName": "domain1.test.local", + "healthStatus": "healthy", + "openHealthIssuesCount": 0, + "settings": { + "@odata.type": "microsoft.graph.security.sensorSettings", + "description": "dc1 settings new description", + "domainControllerDnsNames": [ + "DC1.domain1.test.local" + ], + "isDelayedDeploymentEnabled": false + } +} +``` |
v1.0 | Serviceapp Activate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceapp-activate.md | You can specify the following properties you activate a **serviceApp**. If successful, this action returns a `202 Accepted` response code and a [serviceApp](../resources/serviceapp.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "serviceappthis.activate" Authorization: Bearer <Access-Token> } ``` +# [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 | Serviceapp Deactivate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceapp-deactivate.md | If successful, this action returns a `202 Accepted` response code and a [service The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "serviceapp_deactivate" The following example shows a request. POST https://graph.microsoft.com/v1.0/solutions/backupRestore/serviceApps/71633878-8321-4950-bfaf-ed285bdd1461/deactivate ``` +# [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 | Serviceapp Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceapp-get.md | If successful, this method returns a `200 OK` response code and a [serviceApp](. The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "serviceapp_get" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/serviceApps/71633878-8321-4950-bfaf-ed285bdd1461 ``` +# [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 | Serviceprincipal Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-delta.md | -Get newly created, updated, or deleted service principals without having to perform a full read of the entire resource collection. +Get newly created, updated, or deleted service principals 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 | Serviceprincipal Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-get.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-get-permissions.md)] > [!NOTE]-> A service principal can retrieve its own application and service principal details without being granted any application permissions. -> The *Application.ReadWrite.OwnedBy* permission allows an app to call `GET /applications` and `GET /servicePrincipals` to list all applications and service principals in the tenant. This scope of access has been allowed for the permission. +> - A service principal can retrieve its own application and service principal details without being granted any application permissions. +> - The *Application.ReadWrite.OwnedBy* permission allows an app to call `GET /applications` and `GET /servicePrincipals` to list all applications and service principals in the tenant. This scope of access has been allowed for the permission. +> - To read the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.Read.All* delegated permission. +> - In app-only scenarios using Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.Reade.All* application permission. ## HTTP request |
v1.0 | Serviceprincipal List Approleassignedto | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-list-approleassignedto.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_list_approleassignedto" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-list-approleassignedto-permissions.md)] ## HTTP request |
v1.0 | Serviceprincipal List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-list-approleassignments.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipal_list_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-list-approleassignments-permissions.md)] ## HTTP request |
v1.0 | Serviceprincipal List Owners | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-list-owners.md | Title: "servicePrincipals: List owners" + Title: "List owners of a service principal" description: "Retrieve a list of owners of the servicePrincipal." ms.localizationpriority: high doc_type: apiPageType-# servicePrincipals: List owners +# List owners of a service principal Namespace: microsoft.graph 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 service principal 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 /servicePrincipals/{id}/owners GET /servicePrincipals(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 | 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": "serviceprincipal_get_owners" }--> ```msgraph-interactive-GET https://graph.microsoft.com/v1.0/servicePrincipals/00063ffc-54e9-405d-b8f3-56124728e051/owners +GET https://graph.microsoft.com/v1.0/serviceprincipals(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. HTTP/1.1 200 OK Content-type: application/json {- "value": [ - { - "id": "id-value" - } - ] + "@odata.context": "https://graph.microsoft.com/v1.0/$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 servicePrincipals(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 | Serviceprincipal Post Approleassignedto | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-post-approleassignedto.md | To grant an app role assignment, you need three identifiers: 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": "serviceprincipal_post_approleassignedto" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipal-post-approleassignedto-permissions.md)] [!INCLUDE [rbac-approleassignments-apis-write](../includes/rbac-for-apis/rbac-approleassignments-apis-write.md)] |
v1.0 | Serviceprincipal Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipal-update.md | Update the properties of [servicePrincipal](../resources/serviceprincipal.md) ob [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] ## Permissions-One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). +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) | Application.ReadWrite.All | -|Delegated (personal Microsoft account) | Not supported. | -|Application | Application.ReadWrite.OwnedBy, Application.ReadWrite.All | +<!-- { "blockType": "permissions", "name": "serviceprincipal_update" } --> ++> [!NOTE] +> - To update the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* delegated permission. +> - In app-only scenarios using Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* application permission. ## HTTP request In the request body, supply the values for relevant fields that should be update |alternativeNames|String collection| Used to retrieve service principals by subscription, identify resource group and full resource IDs for [managed identities](/azure/active-directory/managed-identities-azure-resources/overview).| |appRoleAssignmentRequired|Boolean|Specifies whether an **appRoleAssignment** to a user or group is required before Microsoft Entra ID will issue a user or access token to the application. Not nullable. | |appRoles|[appRole](../resources/approle.md) collection|The application roles exposed by the associated application. For more information, see the **appRoles** property definition on the [application](../resources/application.md) resource. Not nullable. |-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><br/>To update this property, the calling principal must be assigned the Attribute Assignment Administrator role and must be granted the *CustomSecAttributeAssignment.ReadWrite.All* permission.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><li>To update this property in delegated scenarios, the calling principal must be assigned the Attribute Assignment Administrator role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* delegated permission.<li>To update this property in app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* application permission. | |displayName|String|The display name for the service principal.| |homepage|String|Home page or landing page of the application.| |keyCredentials|[keyCredential](../resources/keycredential.md) collection|The collection of key credentials associated with the service principal. Not nullable. | In the request body, supply the values for relevant fields that should be update |oauth2PermissionScopes|[permissionScope](../resources/permissionScope.md) collection|The OAuth 2.0 permission scopes exposed by the associated application. For more information, see the **oauth2PermissionScopes** property definition on the [application](../resources/application.md) resource. Not nullable.| |preferredSingleSignOnMode|string|Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are `password`, `saml`, `external`, and `oidc`.| |replyUrls|String collection|The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. |-|servicePrincipalNames|String collection|Contains the list of **identifiersUris**, copied over from the associated [application](../resources/application.md). Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,<ul><li>Client apps requesting permissions to this resource can use these URIs to specify needed permissions in the **requiredResourceAccess** property of their application manifest, or in the "API permissions" blade on the App registrations experience.</li><li>Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the ΓÇ£audΓÇ¥ claim.</li></ul><br>The any operator is required for filter expressions on multi-valued properties. Not nullable.| +|servicePrincipalNames|String collection|Contains the list of **identifiersUris**, copied over from the associated [application](../resources/application.md). Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,<ul><li>Client apps requesting permissions to this resource can use these URIs to specify needed permissions in the **requiredResourceAccess** property of their application manifest, or in the "API permissions" blade on the App registrations experience.</li><li>Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the "aud" claim.</li></ul><br>The any operator is required for filter expressions on multi-valued properties. Not nullable.| |tags|String collection| Custom strings that can be used to categorize and identify the application. Not nullable. | | tokenEncryptionKeyId |String|Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.| |
v1.0 | Serviceprincipalriskdetection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/serviceprincipalriskdetection-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "serviceprincipalriskdetection_get" } --> [!INCLUDE [permissions-table](../includes/permissions/serviceprincipalriskdetection-get-permissions.md)] ## HTTP request |
v1.0 | Sharedwithchannelteaminfo Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharedwithchannelteaminfo-delete.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-delete-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharedwithchannelteaminfo Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharedwithchannelteaminfo-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "sharedwithchannelteaminfo_get" } --> [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharedwithchannelteaminfo List Allowedmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharedwithchannelteaminfo-list-allowedmembers.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-list-allowedmembers-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharedwithchannelteaminfo List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharedwithchannelteaminfo-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "sharedwithchannelteaminfo_list" } --> [!INCLUDE [permissions-table](../includes/permissions/sharedwithchannelteaminfo-list-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Sharepointprotectionpolicy List Siteinclusionrules | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharepointprotectionpolicy-list-siteinclusionrules.md | If successful, this method returns a `200 OK` response code and a [siteProtectio The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "sharepointprotectionpolicy_list_siteinclusionrules" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointProtectionPolicies/71633878-8321-4950-bfaf-ed285bdd1461/siteInclusionRules ``` +# [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 | Sharepointprotectionpolicy Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharepointprotectionpolicy-update.md | To remove a **siteProtectionUnit** from the policy, specify the `@removed` annot If successful, this method returns a `200 OK` response code and an updated [sharePointProtectionPolicy](../resources/sharepointprotectionpolicy.md) in the response body. +For a list of possible error responses, see [Backup Storage API error responses](/graph/backup-storage-error-codes). + ## Examples ### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "sharepointprotectionpolicy_update" Content-Type: application/json } ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [PowerShell](#tab/powershell) ++# [Python](#tab/python) +++ ### Response The following example shows the response. |
v1.0 | Sharepointrestoresession List Siterestoreartifacts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharepointrestoresession-list-siterestoreartifacts.md | Don't supply a request body for this method. If successful, this method returns a `200 OK` response code and a collection of [siteRestoreArtifact](../resources/siterestoreartifact.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 The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "siterestoreartifact_list" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/backupRestore/sharePointRestoreSessions/845457dc-4bb2-4815-bef3-8628ebd1952e/siteRestoreArtifacts ``` +# [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 | Sharepointrestoresession Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharepointrestoresession-update.md | PATCH /solutions/backupRestore/sharePointRestoreSessions/{sharePointRestoreSessi If successful, this method returns a `200 OK` response code and an updated [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 | Sharepointsettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharepointsettings-get.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/sharepointsettings-get-permissions.md)] When calling on behalf of a user, the user needs to belong to one of the following admin roles. To learn more about admin roles, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles):-* Global Administrator * Global Reader * SharePoint Administrator |
v1.0 | Sharepointsettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/sharepointsettings-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "sharepointsettings_update" } --> [!INCLUDE [permissions-table](../includes/permissions/sharepointsettings-update-permissions.md)] -When calling on behalf of a user, the user needs to belong to one of the following admin roles. To learn more about admin roles, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles): -* Global Administrator -* SharePoint Administrator +When calling on behalf of a user, the user needs to belong to the SharePoint Administrator role. To learn more about admin roles, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles). ## HTTP request |
v1.0 | Shiftpreferences Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/shiftpreferences-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "shiftpreferences_get" } --> [!INCLUDE [permissions-table](../includes/permissions/shiftpreferences-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Shiftpreferences Put | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/shiftpreferences-put.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "shiftpreferences_put" } --> [!INCLUDE [permissions-table](../includes/permissions/shiftpreferences-put-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Signin Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/signin-get.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve a specific Microsoft Entra user sign-in event for your tenant. Sign-ins that are interactive in nature (where a username/password is passed as part of auth token) and successful federated sign-ins are currently included in the sign-in logs. +Retrieve a specific Microsoft Entra user [sign-in](../resources/signin.md) event for your tenant. Sign-ins that are interactive in nature (where a username/password is passed as part of auth token) and successful federated sign-ins are currently included in the sign-in logs. [!INCLUDE [GDPR-related-guidance](../../includes/gdpr-msgraph-export-note.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/signin-get-permissions.md)] -Apps must be [properly registered](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to Microsoft Entra ID. --In addition to the delegated permissions, the signed-in user needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference): --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader - ## HTTP request This method supports OData query parameters to help customize the response. For | Name |Description| |:-|:-|-| Authorization | Bearer {code}| +| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| ## Request body |
v1.0 | Signin List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/signin-list.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve the Microsoft Entra user sign-ins for your tenant. Sign-ins that are interactive in nature (where a username/password is passed as part of auth token) and successful federated sign-ins are currently included in the sign-in logs. +Retrieve the Microsoft Entra user [sign-ins](../resources/signin.md) for your tenant. Sign-ins that are interactive in nature (where a username/password is passed as part of auth token) and successful federated sign-ins are currently included in the sign-in logs. The maximum and default page size is 1,000 objects and by default, the most recent sign-ins are returned first. Only sign-in events that occurred within the Microsoft Entra ID [default retention period](/azure/active-directory/reports-monitoring/reference-reports-data-retention#how-long-does-azure-ad-store-the-data) are available. 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/signin-list-permissions.md)] -Apps must be [properly registered](/azure/active-directory/active-directory-reporting-api-prerequisites-azure-portal) to Microsoft Entra ID. --In addition to the delegated permissions, the signed-in user 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): --+ Global Reader -+ Reports Reader -+ Security Administrator -+ Security Operator -+ Security Reader --### Viewing applied conditional access (CA) policies in sign-ins - ## HTTP request |
v1.0 | Site Post Permissions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/site-post-permissions.md | Create a new [permission](../resources/permission.md) object on a site. ## 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": "site_post_permissions" } --> +<!-- { "blockType": "ignored", "name": "site_post_permissions" } --> +|Permission type|Least privileged permissions|Higher privileged permissions| +|:|:|:| +|Delegated (work or school account)|Not supported.|Not supported.| +|Delegated (work or school account)|Sites.FullControl.All|Not available.| +|Delegated (personal Microsoft account)|Not supported.|Not supported.| ++> **Note:** In delegated workflows, the user must have an administrator role, such as SharePoint Administrator or higher. ## HTTP request |
v1.0 | Subscribedsku Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscribedsku-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "subscribedsku_get" } --> [!INCLUDE [permissions-table](../includes/permissions/subscribedsku-get-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | Subscribedsku List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscribedsku-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "subscribedsku_list" } --> [!INCLUDE [permissions-table](../includes/permissions/subscribedsku-list-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | Subscription Post Subscriptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/subscription-post-subscriptions.md | Depending on the resource and the permission type (delegated or application) req |[conversationMember](../resources/conversationmember.md) <br />/appCatalogs/teamsApps/{id}/installedToChats/getAllMembers <br />Chat members for all chats in an organization where a particular Teams app is installed. | Not supported. | Not supported. | ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled | |[conversationMember](../resources/conversationmember.md) (/teams/{id}/members) | TeamMember.Read.All | Not supported | TeamMember.Read.All | |[conversationMember](../resources/conversationmember.md) (/teams/{id}/channels/getAllMembers) | Not supported | Not supported | ChannelMember.Read.All |-|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported | Files.ReadWrite | Not supported | -|[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.ReadWrite.All | Not supported | Files.ReadWrite.All | +|[driveItem](../resources/driveitem.md) (user's personal OneDrive) | Not supported | Files.Read | Not supported | +|[driveItem](../resources/driveitem.md) (OneDrive for Business) | Files.Read.All | Not supported | Files.Read.All | |[event](../resources/event.md) | Calendars.Read | Calendars.Read | Calendars.Read | |[group](../resources/group.md) | Group.Read.All | Not supported | Group.Read.All | |[group conversation](../resources/conversation.md) | Group.Read.All | Not supported | Not supported |-|[list](../resources/list.md) | Sites.ReadWrite.All | Not supported | Sites.ReadWrite.All | +|[list](../resources/list.md) | Sites.Read.All | Not supported | Sites.Read.All | |[message](../resources/message.md) | Mail.ReadBasic, Mail.Read | Mail.ReadBasic, Mail.Read | Mail.Read | |[offerShiftRequest](../resources/offershiftrequest.md)<br/>(/teams/{id}/schedule/offerShiftRequests)<br/>Changes to any offer shift request in a team. | Schedule.Read.All, Schedule.ReadWrite.All| Not supported. | Schedule.Read.All, Schedule.ReadWrite.All | |[openShiftChangeRequest](../resources/openshiftchangerequest.md)<br/>(/teams/{id}/schedule/openShiftChangeRequests)<br/>Changes to any open shift request in a team.| Schedule.Read.All, Schedule.ReadWrite.All| Not supported. | Schedule.Read.All, Schedule.ReadWrite.All | |
v1.0 | Swapshiftschangerequest Approve | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/swapshiftschangerequest-approve.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "swapshiftschangerequest_approve" } --> [!INCLUDE [permissions-table](../includes/permissions/swapshiftschangerequest-approve-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Swapshiftschangerequest Decline | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/swapshiftschangerequest-decline.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "swapshiftschangerequest_decline" } --> [!INCLUDE [permissions-table](../includes/permissions/swapshiftschangerequest-decline-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Swapshiftschangerequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/swapshiftschangerequest-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "swapshiftschangerequest_get" } --> [!INCLUDE [permissions-table](../includes/permissions/swapshiftschangerequest-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Swapshiftschangerequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/swapshiftschangerequest-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "swapshiftschangerequest_list" } --> [!INCLUDE [permissions-table](../includes/permissions/swapshiftschangerequest-list-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Swapshiftschangerequest Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/swapshiftschangerequest-post.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "swapshiftschangerequest_post" } --> [!INCLUDE [permissions-table](../includes/permissions/swapshiftschangerequest-post-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Synchronization Serviceprincipal Put Synchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/synchronization-serviceprincipal-put-synchronization.md | PUT /servicePrincipals/{id}/synchronization/secrets ## 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. |
v1.0 | Synchronization Synchronizationjob Validatecredentials | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/synchronization-synchronizationjob-validatecredentials.md | POST /servicePrincipals/{id}/synchronization/jobs/{id}/validateCredentials ## 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. |
v1.0 | Synchronization Synchronizationschema Parseexpression | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/synchronization-synchronizationschema-parseexpression.md | POST /servicePrincipals/{id}/synchronization/templates/{id}/schema/parseExpressi ## 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. |
v1.0 | Synchronization Synchronizationschema Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/synchronization-synchronizationschema-update.md | In the request body, supply the [synchronizationSchema](../resources/synchroniza If successful, returns a `204 No Content` response code. It doesn't return anything in the response body. -## Example +## Examples -##### Request +### Example 1: Update schema ++#### Request The following example shows a request. >**Note:** The request object shown here is shortened for readability. Supply all the properties in an actual call. Content-type: application/json -##### Response +#### Response +The following example shows the response. +<!-- { + "blockType": "response" +} --> +```http +HTTP/1.1 204 No Content +``` ++### Example 2: Add attribute "CustomAttribute" to the target system schema ++#### Request +The following example shows a request. It assumes that the attribute "CustomAttribute" does not exist in the target directory schema. If it does exist, the attribute is updated. ++>**Note:** The request object shown here is shortened for readability. Supply all the properties in an actual call. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_synchronizationschema_customattribute" +}--> +```http +PUT https://graph.microsoft.com/v1.0/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema +Content-type: application/json ++{ + "directories":[ + { + "id":"09760868-cafb-47ac-9031-0a3262300427", + "name":"customappsso", + "objects":[ + { + "name":"User", + "attributes":[ + { + "anchor":false, + "caseExact":false, + "defaultValue":null, + "flowNullValues":false, + "multivalued":false, + "mutability":"ReadWrite", + "name":"urn:ietf:params:scim:schemas:extension:CustomExtensionName:2.0:User:CustomAttribute", + "required":false, + "type":"String", + "apiExpressions":[], + "metadata":[], + "referencedObjects":[] + } + ] + } + ] + } + ] +} +``` ++# [JavaScript](#tab/javascript) ++++#### Response +The following example shows the response. +<!-- { + "blockType": "response" +} --> +```http +HTTP/1.1 204 No Content +``` +++### Example 3: Add a new attribute mapping to the synchronization rules ++#### Request +The following example shows a request. The synchronizationSchema has a one-to-many relationship between **targetAttributeName** and **source** attributes. If your schema doesn't have "timezone" as a target attribute, the service adds a new mapping for extensionAttribute11 --> timezone. If your application has timezone as a target attribute in the schema, the service throws an error because an attribute can only be mapped as a target once. In addition, the attribute must exist in the schema before it can be added to the mappings. ++>**Note:** The request object shown here is shortened for readability. Supply all the properties in an actual call. ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "update_synchronizationschema_newattributemapping" +}--> +```http +PUT https://graph.microsoft.com/v1.0/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema +Content-type: application/json ++{ + "@odata.type":"#microsoft.graph.synchronizationSchema", + "synchronizationRules":[ + { + "defaultValue":"", + "exportMissingReferences":false, + "flowBehavior":"FlowWhenChanged", + "flowType":"Always", + "matchingPriority":0, + "source":{ + "expression":"[extensionAttribute11]", + "name":"extensionAttribute11", + "parameters":[], + "type":"Attribute" + }, + "targetAttributeName":"timezone" + } + ] +} +``` ++# [JavaScript](#tab/javascript) ++++#### Response The following example shows the response. <!-- { "blockType": "response" HTTP/1.1 204 No Content } --> - |
v1.0 | Team Archive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-archive.md | Title: "Archive team" description: "Archive the specified team. "-+ ms.localizationpriority: high doc_type: apiPageType To restore a team from its archived state, use the API to [unarchive](team-unarc ## 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": "team_archive" } --> [!INCLUDE [permissions-table](../includes/permissions/team-archive-permissions.md)] |
v1.0 | Team Clone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-clone.md | Title: "team: clone" description: "Create a copy of a team. This operation also creates a copy of the corresponding group."-+ ms.localizationpriority: medium doc_type: apiPageType |
v1.0 | Team Delete Incomingchannels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-delete-incomingchannels.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/team-delete-incomingchannels-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Team Delete Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-delete-members.md | Title: "Remove member from team" description: "Remove a conversationMember from a team."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | Team Get Primarychannel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-get-primarychannel.md | Title: "Get primaryChannel" description: "Retrieve the navigation property of a team that allows access to its default General channel."-+ ms.localizationpriority: high doc_type: apiPageType Get the default [channel](../resources/channel.md), **General**, of a [team](../ ## 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 can access groups that they aren't a member of. +This API supports admin permissions. Users with admin roles can access teams that they aren't members of. <!-- { "blockType": "permissions", "name": "team_get_primarychannel" } --> [!INCLUDE [permissions-table](../includes/permissions/team-get-primarychannel-permissions.md)] |
v1.0 | Team Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-get.md | Title: "Get team" description: "Retrieve the properties and relationships of the specified team."-+ ms.localizationpriority: high doc_type: apiPageType Retrieve the properties and relationships of the specified [team](../resources/t ## 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": "team_get" } --> [!INCLUDE [permissions-table](../includes/permissions/team-get-permissions.md)] |
v1.0 | Team List Allchannels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-list-allchannels.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/team-list-allchannels-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Team List Incomingchannels | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-list-incomingchannels.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "team_list_incomingchannels" } --> [!INCLUDE [permissions-table](../includes/permissions/team-list-incomingchannels-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access teams that they are not a member of. ## HTTP request |
v1.0 | Team Post Installedapps | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-post-installedapps.md | The following table lists additional properties that can be included in the requ |consentedPermissionSet|[teamsAppPermissionSet](../resources/teamsapppermissionset.md)|The set of resource-specific permissions that are being consented to.| > **Note**:-> The permissions consented to during the installation must match the resource-specific permissions specified in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. +> The permissions consented to during the installation must match the resource-specific permissions specified in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. ## Response HTTP/1.1 200 OK ### Example 2: Install an app in a team with consent to the resource-specific permissions required by the app -To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). +To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). #### Request |
v1.0 | Team Post Members | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-post-members.md | Title: "Add member to team" description: "Add a new member to a team."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | Team Put Teams | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-put-teams.md | Title: "Create team from group" description: "Create a new team under a group."-+ ms.localizationpriority: high doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "team_put_teams" } --> [!INCLUDE [permissions-table](../includes/permissions/team-put-teams-permissions.md)] -> **Note**: This API supports admin permissions. Global admins and Microsoft Teams service admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Microsoft Teams service admins can access groups that they are not a member of. ## HTTP request |
v1.0 | Team Teamsappinstallation Upgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-teamsappinstallation-upgrade.md | The following table shows more parameters that can be used with the upgrade acti |consentedPermissionSet|[teamsAppPermissionSet](../resources/teamsapppermissionset.md)|Set of resource specific permissions that are being consented.| > **Note**:-> The permissions consented to during the installation must match the resource-specific permissions specified in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. +> The permissions consented to during the installation must match the resource-specific permissions specified in the [teamsAppDefinition](../resources/teamsAppDefinition.md) of the app. To get the application and delegated resource-specific permissions, see [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). If only delegated resource-specific permissions are specified in the **teamsAppDefinition**, permissions can be omitted in the request body. ## Response HTTP/1.1 204 No Content ### Example 2: Upgrade app installed in a team and consent to the resource-specific permissions required by the app -To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 7](../api/appcatalogs-list-teamsapps.md#example-7-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). +To get the list of resource-specific permissions required by the app, get the app from **appCatalog**, as shown in [Example 6](../api/appcatalogs-list-teamsapps.md#example-6-list-applications-with-a-given-id-and-return-only-the-resource-specific-permissions-required-by-the-app). #### Request |
v1.0 | Team Unarchive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-unarchive.md | Title: "Unarchive team" description: "Restore an archived team. This API restores users' ability to send messages and edit the team, abiding by tenant and team settings. A Teams is archived using the archive API." ms.localizationpriority: medium-+ doc_type: apiPageType Unarchiving is an async operation. A team is unarchived once the async operation ## 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": "team_unarchive" } --> [!INCLUDE [permissions-table](../includes/permissions/team-unarchive-permissions.md)] |
v1.0 | Team Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/team-update.md | Title: "Update team" description: "Update the properties of the specified team."-+ ms.localizationpriority: medium doc_type: apiPageType Update the properties of the specified [team](../resources/team.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": "team_update" } --> [!INCLUDE [permissions-table](../includes/permissions/team-update-permissions.md)] |
v1.0 | Teamsapp Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamsapp-delete.md | Title: "Delete teamsApp" description: "Delete an app from an organization's app catalog (the tenant app catalog)." ms.localizationpriority: medium-+ doc_type: apiPageType You can also use this API to remove a submitted app from the review process. 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). -Only global administrators can call this API. +O- Only Teams Service admins or a higher privileged role can call this API. <!-- { "blockType": "permissions", "name": "teamsapp_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/teamsapp-delete-permissions.md)] |
v1.0 | Teamsapp Publish | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamsapp-publish.md | Title: "Publish teamsApp" description: "Publish an app to the Microsoft Teams app catalog."-+ ms.localizationpriority: medium doc_type: apiPageType Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [permissions-table](../includes/permissions/teamsapp-publish-permissions.md)] > [!NOTE]-> The Directory.ReadWrite.All permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> +> * The `Directory.ReadWrite.All` permission is supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward. +> * The `AppCatalog.Submit` permission allows you to submit apps for review only, not to publish them to the catalog. ## HTTP request <!-- { "blockType": "ignored" } --> Each app in the app catalog must have a unique manifest ID. If successful, this method returns a `200 OK` response code and a [teamsApp](../resources/teamsapp.md) object. If the app manifest has any validation errors, the request returns an error response with details about the schema errors. +### Error response ++If you send a request to upload an app manifest that contains missing information or errors, you receive an error message that includes the inner error code `UnableToParseTeamsAppManifest`. The **details** property of the inner error contains the error code and the error message. The following table describes the error codes that you might encounter. ++<br> +<details><summary>Error response</summary> ++| Error code | Error message | Description | +| :- | : | : | +| `ActivityGroupIdFromActivitiesTypeValidation` | ActivityGroupId field in ActivityType must be a subset of ID field in ActivityGroup. | The `ActivityGroupId` field in `ActivityType` isn't a subset of the `Id` field in `ActivityGroup` in the app manifest. | +| `ActivityTypesMustExistWithActivitiesGroupValidation` | Manifest shouldn't contain Activity Group when Activity Types is missing. | The `ActivityGroup` property is available, but the `ActivityType` property is missing in the app manifest. | +| `ApiBasedComposeExtensionApiResponseRenderingTemplateFileNullOrEmpty` | API-based compose extension must have apiResponseRenderingTemplateFile defined on manifest. | The API-based compose extension doesn't have the `apiResponseRenderingTemplateFile` defined in the app manifest. | +| `ApiBasedComposeExtensionApiSpecificationFileNullOrEmpty` | API-based compose extension must have apiSpecificationFile defined on manifest. | The API-based compose extension doesn't have the `apiSpecificationFile` defined in the app manifest. | +| `ApiBasedComposeExtensionManifestCommandIdsNotIncludedInOperationIdsOnApiSpecficationFile` | Command Ids on manifest aren't included in Operation Ids on API specification file. | The error that occurs when the `Command Ids` in the app manifest aren't included in `Operation Ids` on API specification file. | +| `ApiBasedComposeExtensionWithBotId` | API-based compose extension can't have botId defined. | The API-based compose extension has `botId` defined in the app manifest. | +| `ApiBasedComposeExtensionWithCanUpdateConfiguration` | API-based compose extension can't have canUpdateConfiguration defined on manifest. | The API-based compose extension has `canUpdateConfiguration` defined in the app manifest. | +| `ApiBasedComposeExtensionWithNoParameter` | API-based compose extension must have command parameters defined on manifest. | The API-based compose extension doesn't have any command parameters defined in the app manifest. | +| `ApiSecretServiceAuthTypeComposeExtensionContainsMsftEntraConfiguration` | API-based compose extension with apiSecretServiceAuth authType have microsoftEntraConfiguration defined. | The API-based compose extension has `microsoftEntraConfiguration` defined in the app manifest. | +| `ApiSecretServiceAuthTypeComposeExtensionContainsNoApiSecretRegistrationId` | API-based compose extension with apiSecretServiceAuth authType have no apiSecretRegistrationId defined. | The API-based compose extension with `apiSecretServiceAuth` authType without `apiSecretRegistrationId` defined in the app manifest. | +| `ApiSecretServiceAuthTypeComposeExtensionContainsNoApiSecretServiceAuthConfiguration` | API-based compose extension with apiSecretServiceAuth authType have no apiSecretServiceConfiguration. | The API-based compose extension doesn't set `supportsSingleSignOn` to `true` in the app manifest. | +| `ApiSpecificationFileContainUnsupportedHttpMethod` | API-based compose extension have server urls that have unsupported http method defined on apiSpecificationFile. Currently only GET and POST are supported. | The API-based compose extension has an unsupported `http` method defined in the `apiSpecificationFile`. | +| `ApiSpecificationFileParameterContainUnsupportedSchemaType` | API-based compose extension have unsupported parameter schema type defined on apiSpecificationFile. Arrays aren't supported. | The API-based compose extension has an unsupported parameter schema type defined in the `apiSpecificationFile`. | +| `ApiSpecificationFileRequestBodyContainUnsupportedMediaType` | API-based compose extension have unsupported media type defined in request body on apiSpecificationFile. Currently only application/json is supported. | The API-based compose extension has an unsupported `media` type defined in request body in the `apiSpecificationFile`. | +| `ApiSpecificationFileRequestBodyContainUnsupportedSchemaType` | API-based compose extension have unsupported schema type defined in request body on apiSpecificationFile. Currently arrays aren't supported. | The API-based compose extension has an unsupported schema type defined in request body in the `apiSpecificationFile`. | +| `ApiSpecificationFileRequestBodySchemaContainKeywords` | API-based compose extension have keywords. | The API-based compose extension has keywords defined in request body in the `apiSpecificationFile`. | +| `ApiSpecificationFileRequiredParameterContainUnsupportedLocation` | API-based compose extension have unsupported parameter location defined on apiSpecificationFile for {0}. Currently only path and query supported. | The API-based compose extension has an unsupported parameter location defined in the `apiSpecificationFile`. | +| `ApiSpecificationFileRequiredParameterOrPropertyNotDefinedOnManifest` | API-based compose extension have required parameters or properties {0} not defined on manifest. | The API-based compose extension has a `required` parameter, which isn't defined in the app manifest. | +| `ApiSpecificationFileResponseContainUnsupportedMediaType` | API-based compose extension have unsupported media type defined in response on apiSpecificationFile. Currently only application/json supported. | The API-based compose extension has an unsupported `media` type defined in response in the `apiSpecificationFile`. | +| `ApiSpecificationFileServerUrlsContainHttp` | API-based compose extension have server urls that have http protocol defined on apiSpecificationFile. | The API-based compose extension has server urls that contain `http` protocol in the `apiSpecificationFile`. | +| `ApiSpecificationFileServerUrlsContainInvalidUrl` | API-based compose extension have server urls that are invalid URL defined on apiSpecificationFile. | The API-based compose extension has an `invalid` URL defined in the `apiSpecificationFile`. | +| `BotBasedComposeExtensionApiResponseRenderingTemplateFileExists` | Bot based compose extension can't have apiResponseRenderingTemplateFile defined. | The bot-based compose extension has an `apiResponseRenderingTemplateFile` property defined in the app manifest. | +| `BotBasedComposeExtensionApiSpecificationFileExists` | Bot based compose extension can't have apiSpecificationFile defined. | The bot-based compose extension has an API specification file defined in the app manifest. | +| `BotBasedComposeExtensionBotIdNotGuid` | Bot based compose extension must have GUID botId. | The bot-based compose extension `botId` isn't GUID. | +| `BotIdIsNotGuid` | BotId isn't a Guid value. | The `BotId` value in the app manifest isn't a GUID. | +| `CommonAppIdIsNotGuid` | Field 'ID' isn't a Guid in the manifest. | The `appId` isn't GUID. | +| `CommonAppIdIsRequiredField` | Required field 'ID' is missing in the manifest. | The `appId` isn't provided. | +| `CommonManifestVersionIsRequiredField` | The required field in manifest 'manifest Version' is missing. | The manifest version isn't provided. | +| `CommonSchemaUrlIsRequiredField` | Schema URL must be present. | The schema isn't provided. | +| `DashboardCardBothIconNameAndUrlPresent` | Dashboard cards icon shouldn't contain both icon name and URL. | Dashboard cards icon mustn't contain both icon name and URL. | +| `DashboardCardEntityIdsAreNotUnique` | Dashboard card entity IDs should be unique. | The returned entity Id for a dashboard card isn't unique within the manifest. | +| `DeveloperNameIsRequiredField` | Required field 'developer name' is missing in the manifest. | The developer name isn't provided. | +| `DeveloperNameLengthCheck` | Maximum character length must not exceed 32 chars. | The developer name is more than 32 characters long. | +| `DeveloperPrivacyUrlIsRequiredField` | Required field 'privacyUrl' is missing in the manifest. | The `privacyUrl` is missing in the app manifest. | +| `DeveloperPrivacyUrlMustBeHttps` | Privacy URL must be secured Support URL (HTTPS). | The developer privacy URL didn't use HTTPS. | +| `DeveloperTermsOfUseUrlIsRequiredField` | Required field 'termsOfUseUrl' is missing in the manifest. | The **termsOfUseUrl** is missing from the manifest. | +| `DeveloperTermsOfUseUrlMustBeHttps` | Terms Of Use URL must be secured Support URL (HTTPS). | The developer terms of use URL didn't use HTTPS. | +| `DeveloperWebsiteUrlIsRequiredField` | Required field 'websiteUrl' is missing in the manifest. | The developer website URL is missing. | +| `DeveloperWebsiteUrlMustBeHttps` | Website URL must be secured Support URL (HTTPS). | The developer website URL didn't use HTTPS. | +| `FullDescriptionCannotBeEmpty` | Full Description can't be empty. | The full description is empty. | +| `FullDescriptionLengthCheck` | Maximum character length for long description must not exceed 4,000 chars. | The full description length is more than 4,000 characters. | +| `GroupChatForBotsLessThanV13` | Please upgrade the version of manifest to V1.3 as group chat bot is supported in manifest v1.3 onwards. | The `groupChat` scope for bots isn't supported in the app manifest version 1.3 and below. | +| `GroupChatForConfigurableTabsLessThanV13` | Please upgrade the version of manifest to V1.3 as group chat configurable tabs is supported in manifest v1.3 onwards. | The `groupChat` scope for configurable tabs isn't supported in the app manifest version 1.3 and below. | +| `InvalidColor32x32IconHeightAndWidth` | Color 32x32 icon should be 32x32 with only white and transparent. | The color 32x32 icon doesn't have the correct dimensions. | +| `InvalidColorIconHeightAndWidth` | Color Icon isn't as per the required dimension. | The dimensions of the color icon are incorrect. | +| `InvalidOutlineIconHeightAndWidth` | Small icon should be 32x32 with only white and transparent. | The dimensions of the outline icon are incorrect. | +| `InvalidOutlineIconTransparency` | Outline icon isn't transparent. It's Alpha. | The outline icon contains pixels that are neither transparent nor white, with Alpha, R, G, B values of {0}, {1}, {2}, and {3}. | +| `MsftEntraAuthTypeComposeExtensionContainsApiSecretServiceConfiguration` | API-based compose extension with microsoftEntra authType have apiSecretServiceConfiguration defined. | The API-based compose extension has `apiSecretServiceConfiguration` defined in the manifest. | +| `MsftEntraAuthTypeComposeExtensionContainsNoMsftEntraConfiguration` | API-based compose extension with microsoftEntra authType have no microsoftEntraConfiguration defined. | The API-based compose extension doesn't have `microsoftEntraConfiguration` defined in the app manifest. | +| `MsftEntraAuthTypeComposeExtensionResourceURLNotMatchServerURLOnApiSpec` | API-based compose extension with microsoftEntra authType resource URL on manifest doesn't match server URL on API specification file. | The API-based compose extension with `microsoftEntra` authType resource URL in the app manifest doesn't match server URL in the API specification file. | +| `MsftEntraAuthTypeComposeExtensionSupportsSingleSignOnFalse` | API-based compose extension with microsoftEntra authType doesn't set supportsSingleSignOn to true. | The API-based compose extension doesn't set **supportsSingleSignOn** to `true` in the app manifest. | +| `NoAuthTypeComposeExtensionContainsAuthConfiguration` | API-based compose extension with none authType have auth-related configuration defined. | The API-based compose extension with authType `microsoftEntraConfiguration` or `apiSecretServiceConfiguration` isn't defined in the app manifest. | +| `ParameterOnManifestNotDefinedOnApiSpecFile` | API-based compose extension have parameters {0} on manifest not defined on API specification file. | The API-based compose extension parameters in the app manifest aren't defined in the API specification file. | +| `ReservedActivitiesValidation` | Manifest shouldn't contain reserved Activity Type 'systemDefault'. | The `systemDefault` activity type is defined in the app manifest. | +| `ReservedStaticTabNameShouldBeNull` | Reserved tab "Name" property shouldn't be specified. | The reserved `staticTabs` name property was specified. | +| `SchemaError_AdditionalItems` | The schema doesn't allow additional items. | The app manifest file failed the `additionalItems` validation of the schema. | +| `SchemaError_AdditionalProperties` | Property {0} hasn't been defined and the schema doesn't allow additional properties. | The app manifest file failed the `additionalProperties` validation of the schema. Here, {0} represents the additional property. | +| `SchemaError_AllOf` | JSON doesn't match all schemas from "allOf". | The app manifest file failed the `allOf` validation of the schema. | +| `SchemaError_AnyOf` | JSON doesn't match any schemas from "anyOf". | The app manifest file failed the `anyOf` validation of the schema. | +| `SchemaError_Const` | Value {0} doesn't match constant {1}. | The app manifest file failed the `const` validation of the schema. Here, {0} represents the value that failed and {1} represents the correct value. | +| `SchemaError_ContentEncoding` | String {0} doesn't validate against content encoding {1}. | The app manifest file failed the `contentEncoding` validation of the schema. Here, {0} represents the string that doesn't match content encoding and {1} represents the expected content encoding. | +| `SchemaError_Dependencies` | Dependencies for property {0} failed. Missing required keys. | The app manifest file failed the `dependencies` validation of the schema. Here, {0} represents the property that failed. | +| `SchemaError_Else` | JSON doesn't match schema from "else". | The app manifest file failed the `else` validation of the schema. | +| `SchemaError_Enum` | Value {0} isn't defined in the enum. | The app manifest file failed the `enum` validation of the schema. Here, {0} represents the value that isn't in the enum. | +| `SchemaError_Format` | String {0} doesn't validate against format {1}. | The app manifest file failed the `format` validation of the schema. Here, {0} represents the string that isn't in the expected format and {1} represents the expected format. | +| `SchemaError_Id` | Duplicate schema ID {0} encountered. | The app manifest file failed the `id` validation of the schema. Here, {0} represents the `id` of the schema. | +| `SchemaError_Maximum` | Integer {0} exceeds maximum value of {1}. | The app manifest file failed the `maximum` validation of the schema. Here, {0} represents the value that exceeds the maximum limit and {1} represents the maximum limit. | +| `SchemaError_MaximumItems` | Array item count {0} exceeds maximum count of {1}. | The app manifest file failed the `maximumItems` validation of the schema. Here, {0} represents the number of elements in the array and {1} represents the maximum allowed. | +| `SchemaError_MaximumLength` | String {0} exceeds maximum length of {1}. | The app manifest file failed the `maximumLength` validation of the schema. Here, {0} represents the string that exceeds the maximum length and {1} represents the maximum length. | +| `SchemaError_MaximumProperties` | Object property count {0} exceeds maximum count of {1}. | The app manifest file failed the `maximumProperties` validation of the schema. Here, {0} represents the number of properties provided and {1} represents the maximum allowed properties. | +| `SchemaError_Minimum` | Integer {0} is less than minimum value of {1}. | The app manifest file failed the `minimum` validation of the schema. Here, {0} represents the value that exceeds the minimum limit and {1} represents the minimum limit. | +| `SchemaError_MinimumItems` | Array item count {0} is less than minimum count of {1}. | The app manifest file failed the `minimumItems` validation of the schema. Here, {0} represents the number of elements in the array and {1} represents the minimum allowed. | +| `SchemaError_MinimumLength` | String {0} is less than minimum length of {1}. | The app manifest file failed the `minimumLength` validation of the schema. Here, {0} represents the string that is less than the minimum length and {1} represents the minimum. | +| `SchemaError_MinimumProperties` | Object property count {0} is less than minimum count of {1}. | The app manifest file failed the `minimumProperties` validation of the schema. Here, {0} represents the number of properties provided and {1} represents the minimum allowed properties. | +| `SchemaError_Not` | JSON is valid against schema from "not". | The app manifest file failed the `not` validation of the schema. | +| `SchemaError_OneOf` | JSON is valid against more than one schema from "oneOf". | The app manifest file failed the `oneOf` validation of the schema. | +| `SchemaError_Pattern` | String {0} doesn't match regex pattern "{1}". | The app manifest file failed the `pattern` validation of the schema. Here, {0} represents the value that doesn't match the pattern and {1} represents the expected pattern. | +| `SchemaError_PatternProperties` | Couldn't test property names with regex pattern "{0}". | The app manifest file failed the `patternProperties` validation of the schema. Here, {0} represents the pattern for the properties. | +| `SchemaError_Required` | Required properties are missing from object: {0}. | The app manifest file failed the `required` validation of the schema. Here, {0} represents the required properties. | +| `SchemaError_Then` | JSON doesn't match schema from "then". | The app manifest file failed the `then` validation of the schema. | +| `SchemaError_Type` | Value {0} isn't of the expected type {1}. | The app manifest file failed the `type` validation of the schema. Here, {0} represents the string that isn't in the expected type and {1} represents the expected type. | +| `SchemaError_UniqueItems` | Array contains items that aren't unique. | The app manifest file failed the `uniqueItems` validation of the schema. | +| `SchemaError_Valid` | Schema always fails validation. | The app manifest file failed the `valid` validation of the schema. | +| `Serialization_FileMissing` | The file {0} couldn't be found in the app package. | The expected file is missing in the app package. | +| `Serialization_FileNotValidJson` | The file couldn't be parsed as a JSON object. | The submitted file didn't comply with a valid JSON format. | +| `Serialization_ManifestVersionPropertyMissing` | The file doesn't contain the "{0}" property. | The **manifestVersion** property is missing in the app manifest file. Here, {0} represents the string for the **manifestVersion** property. | +| `Serialization_TrailingCommaInManifestJsonFile` | Manifest json file contains trailing comma. | The app manifest file contains a trailing comma. | +| `ServerUrlsMissingOnApiSpecificationFile` | API-based compose extension have no server urls defined on apiSpecificationFile. | The error that occurs The API-based compose extension has no server urls defined in the `apiSpecificationFile`. | +| `ShortDescriptionCannotBeEmpty` | Short Description canΓÇÖt be empty. | The short description was empty. | +| `ShortDescriptionLengthCheck` | Maximum character length for short description must not exceed 80 chars. | The short description is more than 80 characters long. | +| `ShortNameEqualsReservedName` | Short name of the app can't be reserved name. | The short name is a reserved name. | +| `ShortNameIsRequiredField` | Short name of the app can't be empty. | The short name is empty. | +| `ShortNameLengthCheck` | Maximum character length for Short Name must not exceed 30 chars. | The short name exceeds 30 characters. | +| `UniqueActivityTypeInActivitiesValidation` | Manifest shouldn't contain duplicate Activity Type. | The activity type isn't unique in the app manifest. | +| `UniqueIdInActivitiesGroupValidation` | Manifest shouldn't contain duplicate ID in Activity Groups. | The activity group ID isn't unique in the app manifest. | +| `VersionCannotBeEmpty` | Required field "version" is missing in the manifest. | The app package version is missing. | +| `VersionContainsOnlyNumbersDotSeparated` | App version supports only numbers in the '#.#.#' format. | The version in the app package isn't matched by the pattern, `#.#.#`. | +| `VersionHasMajorLessThan1` | App version shouldn't start with '0'. For example, 0.0.1 or 0.1 aren't valid app versions and 1.0 / 1.5.1 / 1.0.0 / 2.5.0 are valid app versions. In case of new update in manifest to an existing app in store. | The app version is less than 1.0. You need to upgrade your app version. For example, if the current version of your app in the store is 1.0 and youΓÇÖre submitting an update for validation, the app version must be higher than 1.0. | ++</details> + ## Examples ### Example 1: Publish an app to the app catalog Content-type: application/json } ``` ++ ## Related content - [App catalog C# sample](https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main/samples/graph-appcatalog-lifecycle/csharp) |
v1.0 | Teamsapp Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/teamsapp-update.md | Title: "Update teamsApp" description: "Update an app previously published to a Teams app catalog."-+ ms.localizationpriority: medium doc_type: apiPageType This API specifically updates an app published to your organization's app catalo 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). -Only Global Administrators can call this API. +- Only Teams Service admins or a higher privileged role can call this API. <!-- { "blockType": "permissions", "name": "teamsapp_update" } --> [!INCLUDE [permissions-table](../includes/permissions/teamsapp-update-permissions.md)] |
v1.0 | Tenantrelationship Findtenantinformationbydomainname | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tenantrelationship-findtenantinformationbydomainname.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "tenantrelationship_findtenantinformationbydomainname" } --> [!INCLUDE [permissions-table](../includes/permissions/tenantrelationship-findtenantinformationbydomainname-permissions.md)] +> [!IMPORTANT] +> This API operation doesn't require the calling user to be assigned any [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). + ## HTTP request <!-- { |
v1.0 | Tenantrelationship Findtenantinformationbytenantid | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/tenantrelationship-findtenantinformationbytenantid.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "tenantrelationship_findtenantinformationbytenantid" } --> [!INCLUDE [permissions-table](../includes/permissions/tenantrelationship-findtenantinformationbytenantid-permissions.md)] +> [!IMPORTANT] +> This API operation doesn't require the calling user to be assigned any [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). + ## HTTP request <!-- { |
v1.0 | Timeoff Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoff-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoff_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoff-delete-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoff Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoff-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoff_get" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoff-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoff Put | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoff-put.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoff_put" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoff-put-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoffreason Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffreason-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffreason_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffreason-delete-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoffreason Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffreason-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffreason_get" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffreason-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoffreason Put | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffreason-put.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffreason_put" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffreason-put-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoffrequest Approve | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffrequest-approve.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffrequest_approve" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffrequest-approve-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoffrequest Decline | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffrequest-decline.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffrequest_decline" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffrequest-decline-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoffrequest Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffrequest-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffrequest_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffrequest-delete-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Timeoffrequest Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffrequest-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffrequest_get" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffrequest-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. currently in private preview only and are not available for public use. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. currently in private preview only and are not available for public use. ## HTTP request |
v1.0 | Timeoffrequest List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/timeoffrequest-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "timeoffrequest_list" } --> [!INCLUDE [permissions-table](../includes/permissions/timeoffrequest-list-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. currently in private preview only and are not available for public use. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. currently in private preview only and are not available for public use. ## HTTP request |
v1.0 | User Assignlicense | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-assignlicense.md | doc_type: apiPageType Namespace: microsoft.graph -Add or remove licenses for the user to enable or disable their use of Microsoft cloud offerings that the company has licenses to. For example, an organization can have a Microsoft 365 Enterprise E3 subscription with 100 licenses, and this request assigns one of those licenses to a specific user. You can also enable and disable specific plans associated with a subscription. +Add or remove licenses for the user to enable or disable their use of Microsoft cloud offerings that the company has licenses to. For example, an organization can have a Microsoft 365 Enterprise E3 subscription with 100 licenses, and this request assigns one of those licenses to a specific user. You can also enable and disable specific plans associated with a subscription. Direct user licensing method is an alternative to [group-based licensing](../api/group-assignlicense.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": "user_assignlicense" } --> [!INCLUDE [permissions-table](../includes/permissions/user-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). --- Directory Writers-- License Administrator-- User 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 the `microsoft.directory/users/assignLicense` role permission. The following least privileged roles are supported for this operation: +> - Directory Writers +> - License Administrator +> - User Administrator ## HTTP request <!-- { "blockType": "ignored" } --> 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 If successful, this method returns `200 OK` response code and [user](../resources/user.md) object in the response body. -## Example -Here is an example of how to call this API. -##### Request -The following example shows a request. +## Examples ++### Example 1: Assign licenses to the signed-in user ++#### Request # [HTTP](#tab/http) <!-- { POST https://graph.microsoft.com/v1.0/me/assignLicense Content-type: application/json {- "addLicenses": [ - { - "disabledPlans": [ "11b0131d-43c8-4bbb-b2c8-e80f9a50834a" ], - "skuId": "45715bb8-13f9-4bf6-927f-ef96c102d394" - } - ], - "removeLicenses": [ "bea13e0c-3828-4daa-a392-28af7ff61a0f" ] + "addLicenses": [ + { + "disabledPlans": [ + "8a256a2b-b617-496d-b51b-e76466e88db0" + ], + "skuId": "84a661c4-e949-4bd2-a560-ed7766fcaf2b" + }, + { + "disabledPlans": [], + "skuId": "f30db892-07e9-47e9-837c-80727f46fd3d" + } + ], + "removeLicenses": [] } ``` Content-type: application/json -##### Response -The following example shows the response. Note: The response object shown here might be shortened for readability. +#### Response +>**Note:** The response object shown here might be shortened for readability. <!-- { "blockType": "response", "truncated": true, Content-type: application/json { "accountEnabled": true, "assignedLicenses": [- { - "disabledPlans": [ "11b0131d-43c8-4bbb-b2c8-e80f9a50834a" ], - "skuId": "0118A350-71FC-4EC3-8F0C-6A1CB8867561" - } - ], - "assignedPlans": [ - { - "assignedDateTime": "2016-10-02T12:13:14Z", - "capabilityStatus": "capabilityStatus-value", - "service": "service-value", - "servicePlanId": "bea13e0c-3828-4daa-a392-28af7ff61a0f" - } - ], - "businessPhones": [ - "businessPhones-value" - ], - "city": "city-value", - "companyName": "companyName-value" + { + "disabledPlans": [ + "8a256a2b-b617-496d-b51b-e76466e88db0" + ], + "skuId": "84a661c4-e949-4bd2-a560-ed7766fcaf2b" + }, + { + "disabledPlans": [], + "skuId": "f30db892-07e9-47e9-837c-80727f46fd3d" + } + ], + "city": "Nairobi", + "companyName": "Contoso" } ``` -<!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 -2015-10-25 14:57:30 UTC --> +### Example 2: Remove licenses from the signed-in user ++#### Request ++# [HTTP](#tab/http) <!-- {- "type": "#page.annotation", - "description": "user: assignLicense", - "keywords": "", - "section": "documentation", - "tocPath": "", - "suppressions": [ - ] + "blockType": "request", + "name": "user_assignlicense_removelicenses" }-->+```http +POST https://graph.microsoft.com/v1.0/me/assignLicense +Content-type: application/json ++{ + "addLicenses": [], + "removeLicenses": [ + "f30db892-07e9-47e9-837c-80727f46fd3d", + "84a661c4-e949-4bd2-a560-ed7766fcaf2b" + ] +} +``` ++# [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 +>**Note:** The response object shown here might be shortened for readability. +<!-- { + "blockType": "response", + "truncated": true, + "@odata.type": "microsoft.graph.user" +} --> +```http +HTTP/1.1 200 OK +Content-type: application/json ++{ + "accountEnabled": true, + "assignedLicenses": [], + "city": "Nairobi", + "companyName": "Contoso" +} +``` |
v1.0 | User Changepassword | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-changepassword.md | doc_type: apiPageType Namespace: microsoft.graph -Enable the user to update their password. Any user can update their password without belonging to any administrator role. +Update the signed-in [user's](../resources/user.md) password. Any user can update their password without belonging to any administrator role. [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] |
v1.0 | User Delete Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delete-approleassignments.md | -Delete an [appRoleAssignment](../resources/approleassignment.md) that has been granted to a user. +Delete an [appRoleAssignment](../resources/approleassignment.md) that has been granted to a [user](../resources/user.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": "user_delete_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/user-delete-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Delete Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delete-sponsors.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_delete_sponsors" } --> [!INCLUDE [permissions-table](../includes/permissions/user-delete-sponsors-permissions.md)] + ## HTTP request <!-- { |
v1.0 | User Delta | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-delta.md | doc_type: apiPageType Namespace: microsoft.graph -Get newly created, updated, or deleted users without having to perform a full read of the entire user collection. See [change tracking](/graph/delta-query-overview) for details. +Get newly created, updated, or deleted users without having to perform a full read of the entire [user](../resources/user.md) collection. For more information, see [Use delta query to track changes in Microsoft Graph data](/graph/delta-query-overview) for details. > [!NOTE] > Changes to the **licenseAssignmentStates** property are currently not tracked. You only need to specify any desired query parameters once upfront. In subsequent requests, copy and apply the `@odata.nextLink` or `@odata.deltaLink` URL from the previous response, as that URL already includes the encoded, desired 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 user 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 user collection. | |
v1.0 | User Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-get.md | doc_type: apiPageType Namespace: microsoft.graph -Retrieve the properties and relationships of user object. +Retrieve the properties and relationships of [user](../resources/user.md) object. This operation returns by default only a subset of the more commonly used properties for each user. These _default_ properties are noted in the [Properties](../resources/user.md#properties) section. To get properties that are _not_ returned by default, do a [GET operation](user-get.md) for the user and specify the properties in a `$select` OData query option. Because the **user** resource supports [extensions](/graph/extensibility-overview), you can also use the `GET` operation to get custom properties and extension data in a **user** instance. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "ignored", "name": "user_get" } --> [!INCLUDE [permissions-table](../includes/permissions/user-get-permissions.md)] -> [!TIP] -> 1. Calling the `/me` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when using the `/me` endpoint. ->2. The `User.Read` permission allows the app to read the profile, and discover relationships such as the group membership, reports and manager of the signed-in user only. +>[!NOTE] +> - Calling the `/me` endpoint requires a signed-in user and therefore a delegated permission. Application permissions are not supported when using the `/me` endpoint. +> - The `User.Read` permission allows the app to read the profile, and discover relationships such as the group membership, reports and manager of the signed-in user only. +> - To read the **employeeLeaveDateTime** property: +> - In delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator* (least privilege), *Global Reader*; the app must be granted the *User-LifeCycleInfo.Read.All* delegated permission. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *User-LifeCycleInfo.Read.All* permission. +> - To read the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.Read.All* permission. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.Read.All* permission. ## HTTP request For a specific user: |
v1.0 | User List Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-approleassignments.md | -Retrieve the list of [appRoleAssignments](../resources/approleassignment.md) that are currently granted to a user. This operation also returns app role assignments granted to groups that the user is a direct member of. +Retrieve the list of [appRoleAssignments](../resources/approleassignment.md) that are currently granted to a [user](../resources/user.md). This operation also returns app role assignments granted to groups that the user is a direct member of. > [!IMPORTANT] > To ensure complete results for users with many indirect app role assignments, use the **ConsistencyLevel** header set to `eventual` and `$count`, as described in [Advanced query capabilities on Azure AD directory objects](/graph/aad-advanced-queries#group-properties). For an example, see [Example 1](#example-1-list-approleassignments-granted-to-a-user). Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_list_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/user-list-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User List Joinedteams | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-joinedteams.md | Title: "List joinedTeams" description: "Get the teams in Microsoft Teams that the user is a direct member of."-+ ms.localizationpriority: high doc_type: apiPageType |
v1.0 | User List Licensedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-licensedetails.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_list_licensedetails" } --> [!INCLUDE [permissions-table](../includes/permissions/user-list-licensedetails-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 the `microsoft.directory/users/licenseDetails/read` role permission. The following least privileged roles are supported for this operation: +> - Guest Inviter +> - Directory Readers +> - Directory Writers +> - License Administrator +> - User Administrator + ## HTTP request <!-- { "blockType": "ignored" } --> ```http |
v1.0 | User List Memberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-memberof.md | Choose the permission or permissions marked as least privileged for this API. Us ### Permissions for the signed-in user's direct memberships -<!-- { "blockType": "permissions", "name": "user_list_memberof_1" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> ### Permissions for another user's direct memberships -<!-- { "blockType": "permissions", "name": "user_list_memberof_2" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/user-list-memberof-2-permissions.md)] [!INCLUDE [limited-info](../../includes/limited-info.md)] |
v1.0 | User List Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-sponsors.md | Choose the permission or permissions marked as least privileged for this API. Us [!INCLUDE [limited-info](../../includes/limited-info.md)] + ## HTTP request Get sponsors. |
v1.0 | User List Transitivememberof | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list-transitivememberof.md | Choose the permission or permissions marked as least privileged for this API. Us ### Permissions for the signed-in user's memberships -<!-- { "blockType": "permissions", "name": "user_list_transitivememberof_1" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> ### Permissions for another user's memberships -<!-- { "blockType": "permissions", "name": "user_list_transitivememberof_2" } --> +<!-- { "blockType": "ignored" } // Note: Removing this line will result in the permissions autogeneration tool overwriting the table. --> [!INCLUDE [permissions-table](../includes/permissions/user-list-transitivememberof-2-permissions.md)] [!INCLUDE [limited-info](../../includes/limited-info.md)] |
v1.0 | User List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-list.md | Content-type: application/json #### Request -The following example shows a request. Details for the **signInActivity** property require a Microsoft Entra ID P1 or P2 license and the AuditLog.Read.All permission. +The following example shows a request. ->**Note:** When you specify `$select=signInActivity` or `$filter=signInActivity` while listing users, the maximum page size for `$top` is 120. Requests with `$top` set higher than 120 will return pages with up to 120 users. signInActivity supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`) *but* not with any other filterable properties. +> [!Note] +> * Details for the **signInActivity** property require a Microsoft Entra ID P1 or P2 license and the `AuditLog.Read.All` permission. +> * When you specify `$select=signInActivity` or `$filter=signInActivity` when listing users, the maximum page size for `$top` is 120. Requests with `$top` set higher than 120 return pages with up to 120 users. The **signInActivity** property supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`) *but* not with any other filterable properties. # [HTTP](#tab/http) <!-- { |
v1.0 | User Post Approleassignments | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-post-approleassignments.md | -Use this API to assign an app role to a user. To grant an app role assignment to a user, you need three identifiers: +Assign an [app role](../resources/approle.md) to a [user](../resources/user.md), creating an [appRoleAssignment](../resources/approleassignment.md) object. To grant an app role assignment to a user, you need three identifiers: - `principalId`: The `id` of the user to whom you are assigning the app role. - `resourceId`: The `id` of the resource `servicePrincipal` that has defined the app role. Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_post_approleassignments" } --> [!INCLUDE [permissions-table](../includes/permissions/user-post-approleassignments-permissions.md)] + ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Post Sponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-post-sponsors.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_post_sponsors" } --> [!INCLUDE [permissions-table](../includes/permissions/user-post-sponsors-permissions.md)] + ## HTTP request <!-- { |
v1.0 | User Post Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-post-users.md | Create a new [user](../resources/user.md). The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties. >[!NOTE]->To create external users, use the [invitation API](invitation-post.md). +>To create external users as part of B2B collaboration with your organization, use the [invitation API](invitation-post.md). To create a customer, citizen, or business partner in Microsoft Entra External ID in external tenants, see [Example 3: Create a customer account](#example-3-create-a-customer-account-in-external-tenants). [!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] Content-type: application/json } ``` -### Example 2: Create a user with social and local account identities +### Example 2: Create a user with social and local account identities in Azure AD B2C -Create a new user, with a local account identity with a sign-in name, an email address as sign-in, and with a social identity. This example is typically used for migration scenarios in B2C tenants. +Create a new user, with a local account identity with a sign-in name, an email address as sign-in, and with a social identity. This example is typically used for migration scenarios in Azure AD B2C tenants. >[!NOTE] >For local account identities, password expirations must be disabled, and force change password at next sign-in must also be disabled. Content-type: application/json "passwordPolicies": "DisablePasswordExpiration" } ```++### Example 3: Create a customer account in external tenants ++This example shows how to create a customer account in Microsoft Entra External ID in external tenants. ++>[!NOTE] +>For local account identities, password expirations must be disabled, and force change password at next sign-in must also be disabled. ++#### Request ++# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "create_user_customer_external_tenant" +}--> ++```http +POST https://graph.microsoft.com/v1.0/users +Content-type: application/json ++{ + "displayName": "Test User", + "identities": [ + { + "signInType": "emailAddress", + "issuer": "contoso.onmicrosoft.com", + "issuerAssignedId": "adelev@adatum.com" + } + ], + "mail": "adelev@adatum.com", + "passwordProfile": { + "password": "passwordValue", + "forceChangePasswordNextSignIn": false + }, + "passwordPolicies": "DisablePasswordExpiration" +} +``` ++# [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": "microsoft.graph.user", +} --> +```http +HTTP/1.1 201 Created +Content-type: application/json ++{ + "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity", + "id": "daabd280-3978-4d29-acce-d677b9cf2e4d", + "businessPhones": [], + "displayName": "Test User", + "givenName": null, + "jobTitle": null, + "mail": "adelev@adatum.com", + "mobilePhone": null, + "officeLocation": null, + "preferredLanguage": null, + "surname": null, + "userPrincipalName": "daabd280-3978-4d29-acce-d677b9cf2e4d@contoso.onmicrosoft.com" +} +``` + ## Related content - [Add custom data to resources using extensions](/graph/extensibility-overview) |
v1.0 | User Reprocesslicenseassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-reprocesslicenseassignment.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "user_reprocesslicenseassignment" } --> [!INCLUDE [permissions-table](../includes/permissions/user-reprocesslicenseassignment-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). --- Directory Writers-- License Administrator-- User 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 the `microsoft.directory/users/reprocessLicenseAssignment` role permission. The following least privileged roles are supported for this operation: +> - Directory Writers +> - License Administrator +> - User Administrator ## HTTP request <!-- { "blockType": "ignored" } --> |
v1.0 | User Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/user-update.md | Choose the permission or permissions marked as least privileged for this API. Us > - In app-only scenarios, the app must be assigned a higher privileged administrator role as indicated in [Who can perform sensitive actions](../resources/users.md#who-can-perform-sensitive-actions). > - Your personal Microsoft account must be tied to a Microsoft Entra tenant to update your profile with the *User.ReadWrite* delegated permission on a personal Microsoft account. > - Updating the **identities** property requires the *User.ManageIdentities.All* permission. Also, adding a [B2C local account](../resources/objectidentity.md) to an existing **user** object is not allowed, unless the **user** object already contains a local account identity.+> - To update the **employeeLeaveDateTime** property: +> - In delegated scenarios, the admin needs the *Global Administrator* role; the app must be granted the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* delegated permissions. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* permissions. +> - To update the **customSecurityAttributes** property: +> - In delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* permission. +> - In app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* permission. ## HTTP request <!-- { "blockType": "ignored" } --> PATCH /users/{id | userPrincipalName} | Property | Type |Description| |:|:--|:-| |aboutMe|String|A freeform text entry field for the user to describe themselves.|-|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. This property is required when a user is created. Apart from a global administrator, a privileged authentication administrator assigned the _Directory.AccessAsUser.All_ delegated permission can update the **accountEnabled** status of all administrators in the tenant.| +|accountEnabled|Boolean| `true` if the account is enabled; otherwise, `false`. This property is required when a user is created. A Privileged Authentication Administrator assigned the _Directory.AccessAsUser.All_ delegated permission is the least privileged role that's allowed to update the **accountEnabled** status of all administrators in the tenant.| | ageGroup | [ageGroup](../resources/user.md#agegroup-values) | Sets the age group of the user. Allowed values: `null`, `Minor`, `NotAdult`, and `Adult`. Refer to the [legal age group property definitions](../resources/user.md#legal-age-group-property-definitions) for further information. | |birthday|DateTimeOffset|The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |businessPhones| String collection | The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property.| PATCH /users/{id | userPrincipalName} | companyName | String | The name of the company that the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters. | | consentProvidedForMinor | [consentProvidedForMinor](../resources/user.md#consentprovidedforminor-values) | Sets whether consent has been obtained for minors. Allowed values: `null`, `Granted`, `Denied` and `NotRequired`. Refer to the [legal age group property definitions](../resources/user.md#legal-age-group-property-definitions) for further information. | |country|String|The country/region in which the user is located; for example, `US` or `UK`.|-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><br/>To update this property, the calling principal must be assigned the Attribute Assignment Administrator role and must be granted the *CustomSecAttributeAssignment.ReadWrite.All* permission.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object.<br/><li>To update this property in delegated scenarios, the calling principal must be assigned the Attribute Assignment Administrator role and the app granted the *CustomSecAttributeAssignment.ReadWrite.All* delegated permission.<li>To update this property in app-only scenarios with Microsoft Graph permissions, the app must be granted the *CustomSecAttributeAssignment.ReadWrite.All* application permission. | |department|String|The name for the department in which the user works.| |displayName|String|The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it can't be cleared during updates. | | employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. | | employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Returned only on `$select`.| |givenName|String|The given name (first name) of the user.| |employeeHireDate|DateTimeOffset|The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`|-|employeeLeaveDateTime|DateTimeOffset|The date and time when the user left or will leave the organization. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.<br><br> For delegated scenarios, the calling user must have the Global Administrator role and the calling app assigned the _User.Read.All_ and _User-LifeCycleInfo.ReadWrite.All_ delegated permissions. | +|employeeLeaveDateTime|DateTimeOffset|The date and time when the user left or will leave the organization. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.<br><br> For delegated scenarios, the calling user must have the *Global Administrator* role and the calling app assigned the _User.Read.All_ and _User-LifeCycleInfo.ReadWrite.All_ delegated permissions. | |employeeOrgData|[employeeOrgData](../resources/employeeorgdata.md) |Represents organization data (for example, division and costCenter) associated with a user. | |interests|String collection|A list for the user to describe their interests.| |jobTitle|String|The user's job title.| PATCH /users/{id | userPrincipalName} |onPremisesImmutableId|String|This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's **userPrincipalName** (UPN) property. **Important:** The **$** and **_** characters can't be used when specifying this property. | |otherMails|String collection |A list of additional email addresses for the user; for example: `["bob@contoso.com", "Robert@fabrikam.com"]`.| |passwordPolicies|String|Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two can be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`.|-|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. This can't be used for federated users. <br><br> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. In application-only access, the calling app must be assigned the *User.ReadWrite.All* application permission and at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).| +|passwordProfile|[PasswordProfile](../resources/passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. This can't be used for federated users. <br><li> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. <li> In application-only access, the calling app must be assigned the *User.ReadWrite.All* (least privilege) or *Directory.ReadWrite.All* (higher privilege) application permission *and* at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).| |pastProjects|String collection|A list for the user to enumerate their past projects.| |postalCode|String|The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.| |preferredLanguage|String|The preferred language for the user. Should follow ISO 639-1 Code; for example, `en-US`.| HTTP/1.1 204 No Content The following example shows a request to reset the password of another user. As a best practice, always set the **forceChangePasswordNextSignIn** to `true`. + #### Request |
v1.0 | Userinsightssettings Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userinsightssettings-get.md | If successful, this method returns a `200 OK` response code and a [userInsightsS The following example shows a request to get user item insights and meeting hours insights settings. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_userInsightsSettings" The following example shows a request to get user item insights and meeting hour GET https://graph.microsoft.com/v1.0/me/settings/itemInsights ``` +# [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 | Userinsightssettings Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/userinsightssettings-update.md | If successful, this method returns a `200 OK` response code and a [userInsightsS The following example shows how a user updates the **isEnabled** privacy setting to disable their item insights and meeting hours insights. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_userInsightsSettings" 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 | Virtualeventsroot List Webinars | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualeventsroot-list-webinars.md | Title: "List webinars" -description: "Get the list of all virtual event webinars created in a tenant." +description: "Get the list of all virtualEventWebinar objects created in a tenant." ms.localizationpriority: medium doc_type: apiPageType Namespace: microsoft.graph -Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in the tenant. +Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in a tenant. [!INCLUDE [national-cloud-support](../../includes/global-only.md)] 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_virtualeventwebinars" The following example shows a request. GET https://graph.microsoft.com/v1.0/solutions/virtualEvents/webinars ``` +# [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 | Virtualeventsroot Post Townhalls | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualeventsroot-post-townhalls.md | You can specify the following properties when you create a [virtualEventTownhall | endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time when the town hall ends. | | invitedAttendees | [identity](../resources/identity.md) collection | The identities of the attendees invited to the town hall. The supported identities are: [communicationsGuestIdentity](../resources/communicationsguestidentity.md) and [communicationsUserIdentity](../resources/communicationsuseridentity.md). | | isInviteOnly | Boolean | Indicates whether the town hall is only open to invited people and groups within your organization. The **isInviteOnly** property can only be `true` if the value of the **audience** property is set to `organization`. |+| settings | [virtualEventSettings](../resources/virtualeventsettings.md) | The virtual event settings. | | startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time when the town hall starts. | ## Response Content-Type: application/json "id":ΓÇ»"7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", "tenantId":ΓÇ»"77229959-e479-4a73-b6e0-ddac27be315c" }- ] + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + } } ``` Content-Type: application/json "tenantId":ΓÇ»"77229959-e479-4a73-b6e0-ddac27be315c" } ],+ "settings": { + "isAttendeeEmailNotificationEnabled": false + }, "invitedAttendees": [], "isInviteOnly": false } |
v1.0 | Virtualeventsroot Post Webinars | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualeventsroot-post-webinars.md | You can specify the following properties when you create a [virtualEventWebinar] | description | [itemBody](../resources/itembody.md) | A description of the webinar. | | displayName | String | The display name of the webinar. | | endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time when the webinar ends. |+| settings | [virtualEventSettings](../resources/virtualeventsettings.md) | The webinar settings. Inherited from [virtualEvent](../resources/virtualevent.md). | | startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | The date and time when the webinar starts. | ## Response Content-Type: application/json "id": "7b7e1acd-a3e0-4533-8c1d-c1a4ca0b2e2b", "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" }- ] + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + } } ``` Content-Type: application/json "displayName": "Kenneth Brown", "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" }- ] + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + } } ``` |
v1.0 | Virtualeventtownhall Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualeventtownhall-get.md | Content-Type: application/json "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" } ],+ "settings": { + "isAttendeeEmailNotificationEnabled": false + }, "invitedAttendees": [ { "@odata.type": "microsoft.graph.communicationsUserIdentity", |
v1.0 | Virtualeventtownhall Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualeventtownhall-update.md | PATCH /solutions/virtualEvents/townhalls/{id} | displayName | String | Display name of the virtual event. | | endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the virtual event ends. | | invitedAttendees | [identity](../resources/identity.md) collection | The identities of the attendees invited to the town hall. The supported identities are: [communicationsGuestIdentity](../resources/communicationsguestidentity.md) and [communicationsUserIdentity](../resources/communicationsuseridentity.md). |+| settings | [virtualEventSettings](../resources/virtualeventsettings.md) | The virtual event settings. | | startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the virtual event starts. | ## Response Content-Type: application/json "displayName": "Emilee Pham", "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" }- ] + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + } } ``` |
v1.0 | Virtualeventwebinar Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/virtualeventwebinar-update.md | PATCH /solutions/virtualEvents/webinars/{id} | description | [itemBody](../resources/itembody.md) | Description of the virtual event. | | displayName | String | Display name of the virtual event. | | endDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the virtual event ends. |+| settings | [virtualEventSettings](../resources/virtualeventsettings.md) | The webinar settings. Inherited from [virtualEvent](../resources/virtualevent.md). | | startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the virtual event starts. | ## Response Content-Type: application/json "displayName": "Kenneth Brown", "tenantId": "77229959-e479-4a73-b6e0-ddac27be315c" }- ] + ], + "settings": { + "isAttendeeEmailNotificationEnabled": false + } } ``` |
v1.0 | Webpart Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/webpart-delete.md | DELETE /sites/{site-id}/pages/{page-id}/microsoft.graph.sitePage/canvasLayout/ho ``` ## Request headers -| Name | Value | Description -|:--|:|:-- -|Authorization|Bearer {token}.| Required| -| _if-match_ | etag | If this request header is included and the eTag provided does not match the current tag on the item, a `412 Precondition Failed` response is returned and the item will not be deleted. +|Name|Description| +|:|:| +|Authorization| Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +| _if-match_ | eTag. If this request header is included and the eTag provided does not match the current tag on the item, a `412 Precondition Failed` response is returned and the item will not be deleted.| ## Request body |
v1.0 | Workbookformatprotection Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookformatprotection-get.md | Retrieve the properties and relationships of formatprotection 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": "formatprotection_get" } --> +<!-- { "blockType": "permissions", "name": "workbookformatprotection_get" } --> ## HTTP request <!-- { "blockType": "ignored" } --> If successful, this method returns a `200 OK` response code and [FormatProtectio ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_formatprotection" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/format/protection ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookformatprotection Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookformatprotection-update.md | Update the properties of formatprotection 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": "formatprotection_update" } --> +<!-- { "blockType": "permissions", "name": "workbookformatprotection_update" } --> ## HTTP request <!-- { "blockType": "ignored" } --> If successful, this method returns a `200 OK` response code and updated [workboo ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "update_formatprotection" Content-type: application/json } ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrange Columnsafter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-columnsafter.md | Namespace: microsoft.graph Gets a certain number of columns to the right of the given range. + ## 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). Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range/columnsAfter(count=2) ``` +# [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. <!-- { |
v1.0 | Workbookrange Columnsbefore | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-columnsbefore.md | Namespace: microsoft.graph Gets a certain number of columns to the left of the given range. + ## 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). Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range/columnsBefore(count=2) ``` +# [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. <!-- { |
v1.0 | Workbookrange Rowsabove | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-rowsabove.md | Namespace: microsoft.graph Gets a certain number of rows above a given range. + ## 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). Here's an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range/rowsAbove(count=2) ``` +# [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. If called without the optional `count` parameter, this function returns the sing ##### Request +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, If called without the optional `count` parameter, this function returns the sing GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range/rowsAbove ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [Java](#tab/java) ++# [JavaScript](#tab/javascript) ++# [PHP](#tab/php) ++# [Python](#tab/python) +++ ##### Response <!-- { "blockType": "response", |
v1.0 | Workbookrange Rowsbelow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-rowsbelow.md | Namespace: microsoft.graph Gets certain number of rows below a given range. + ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range/rowsBelow(count=2) ``` +# [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. If called without the `count` parameter, this function defaults to one row. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range/rowsBelow ``` +# [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. <!-- { |
v1.0 | Workbookrange Visibleview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrange-visibleview.md | doc_type: apiPageType Namespace: microsoft.graph + ## 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). Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "workbookrange_visibleview" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range(address='A1:Z10')/visibleView ``` +# [C#](#tab/csharp) ++# [CLI](#tab/cli) ++# [Go](#tab/go) ++# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrangeview List Rows | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrangeview-list-rows.md | If successful, this method returns a `200 OK` response code and collection of [w ##### Request The following example shows a request. +# [HTTP](#tab/http) <!-- { "blockType": "request", "name": "get_rows" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range(address='A1:Z10')/visibleView/rows ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workbookrangeview Range | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workbookrangeview-range.md | Here is an example of how to call this API. ##### Request The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "isComposable": true, The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/root/workbook/worksheets/{id}/range(address='A1:Z10')/visibleView/range ``` +# [JavaScript](#tab/javascript) +++ ##### Response The following example shows the response. Note: The response object shown here might be shortened for readability. <!-- { |
v1.0 | Workforceintegration Delete | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workforceintegration-delete.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "workforceintegration_delete" } --> [!INCLUDE [permissions-table](../includes/permissions/workforceintegration-delete-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Workforceintegration Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workforceintegration-get.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "workforceintegration_get" } --> [!INCLUDE [permissions-table](../includes/permissions/workforceintegration-get-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Workforceintegration List | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workforceintegration-list.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "workforceintegration_list" } --> [!INCLUDE [permissions-table](../includes/permissions/workforceintegration-list-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Workforceintegration Post | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workforceintegration-post.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "workforceintegration_post" } --> [!INCLUDE [permissions-table](../includes/permissions/workforceintegration-post-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Workforceintegration Update | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workforceintegration-update.md | Choose the permission or permissions marked as least privileged for this API. Us <!-- { "blockType": "permissions", "name": "workforceintegration_update" } --> [!INCLUDE [permissions-table](../includes/permissions/workforceintegration-update-permissions.md)] -> **Note**: This API supports admin permissions. Global admins can access groups that they are not a member of. +> **Note**: This API supports admin permissions. Users with admin roles can access groups that they are not a member of. ## HTTP request |
v1.0 | Workingtimeschedule Endworkingtime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workingtimeschedule-endworkingtime.md | + + Title: "workingTimeSchedule: endWorkingTime" +description: "Trigger the policies associated with the end of working hours for a specific user." ++ms.localizationpriority: medium ++++# workingTimeSchedule: endWorkingTime ++Namespace: microsoft.graph +++Trigger the policies associated with the end of working hours for a specific user. +++## 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": "workingtimeschedule_endworkingtime" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{userId}/solutions/workingTimeSchedule/endWorkingTime +``` ++## Path parameters ++|Parameter|Type|Description| +|:|:|:| +|userId|String|ID of the user whose working time ended.| ++## 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 `202 Accepted` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "workingtimeschedulethis.endworkingtime" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/ccdf8279-8a3f-4c10-af1a-4a7f46b1489f/solutions/workingTimeSchedule/endWorkingTime +``` ++# [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 202 Accepted +``` |
v1.0 | Workingtimeschedule Get | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workingtimeschedule-get.md | + + Title: "Get workingTimeSchedule" +description: "Read the properties and relationships of a workingTimeSchedule object." ++ms.localizationpriority: medium ++++# Get workingTimeSchedule ++Namespace: microsoft.graph +++Read the properties and relationships of a [workingTimeSchedule](../resources/workingtimeschedule.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": "workingtimeschedule-get-permissions" +} +--> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +GET /users/{usersId}/solutions/schedule +``` ++## Optional query parameters ++This method doesn't support [OData query parameters](/graph/query-parameters) to 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 [workingTimeSchedule](../resources/workingtimeschedule.md) object in the response body. ++## Examples ++### Request ++The following example shows a request. +<!-- { + "blockType": "request", + "name": "get_workingtimeschedule" +} +--> +``` http +GET https://graph.microsoft.com/beta/users/ccdf8279-8a3f-4c10-af1a-4a7f46b1489f/solutions/schedule +``` +++### 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.workingTimeSchedule" +} +--> +``` http +HTTP/1.1 200 OK +Content-Type: application/json ++{ + "value": { + "@odata.type": "#microsoft.teams.workingTime.workingTimeSchedule", + "id": "da5f72af-450e-56fc-10d7-afc9acb40cc0" + } +} +``` |
v1.0 | Workingtimeschedule Startworkingtime | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/api/workingtimeschedule-startworkingtime.md | + + Title: "workingTimeSchedule: startWorkingTime" +description: "Trigger the policies associated with the start of working hours for a specific user." ++ms.localizationpriority: medium ++++# workingTimeSchedule: startWorkingTime ++Namespace: microsoft.graph +++Trigger the policies associated with the start of working hours for a specific user. +++## 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": "workingtimeschedule_startworkingtime" } --> ++## HTTP request ++<!-- { + "blockType": "ignored" +} +--> +``` http +POST /users/{userId}/solutions/workingTimeSchedule/startWorkingTime +``` ++## Path parameters ++|Parameter|Type|Description| +|:|:|:| +|userId|String|ID of the user whose working hours started.| ++## 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 `202 Accepted` response code. ++## Examples ++### Request ++The following example shows a request. +# [HTTP](#tab/http) +<!-- { + "blockType": "request", + "name": "workingtimeschedulethis.startworkingtime" +} +--> +``` http +POST https://graph.microsoft.com/beta/users/ccdf8279-8a3f-4c10-af1a-4a7f46b1489f/solutions/workingTimeSchedule/startWorkingTime +``` ++# [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 202 Accepted +``` |
v1.0 | Link Validation Config.Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/config/link-validation-config.json | a/api-reference/v1.0/config/link-validation-config.json "/universal-print", "/training", "/troubleshoot", + "/viva", "/windows", "/windows-hardware" ] |
v1.0 | Accesspackageapprovalstage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageapprovalstage.md | ms.localizationpriority: medium doc_type: resourcePageType -# accessPackageApprovalStage complex type +# accessPackageApprovalStage resource type Namespace: microsoft.graph |
v1.0 | Accesspackageassignmentapprovalsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageassignmentapprovalsettings.md | Title: "accessPackageAssignmentApprovalSettings complex type" + Title: "accessPackageAssignmentApprovalSettings resource type" description: "Specifies the settings for approval of a request for an access package assignment in an access package assignment policy." ms.localizationpriority: medium doc_type: resourcePageType -# accessPackageAssignmentApprovalSettings complex type +# accessPackageAssignmentApprovalSettings resource type Namespace: microsoft.graph |
v1.0 | Accesspackageassignmentrequest | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageassignmentrequest.md | In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md), | [Create](../api/entitlementmanagement-post-assignmentrequests.md) | [accessPackageAssignmentRequest](accesspackageassignmentrequest.md) | Creates a new **accessPackageAssignmentRequest** object. | |[Get](../api/accesspackageassignmentrequest-get.md)|[accessPackageAssignmentRequest](accesspackageassignmentrequest.md)|Read properties and relationships of an **accessPackageAssignmentRequest** object. | |[Delete](../api/accesspackageassignmentrequest-delete.md)|None|Delete an **accessPackageAssignmentRequest**. |-|[Filter by current user](../api/accesspackageassignmentrequest-filterbycurrentuser.md)|[accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) collection|Retrieve the list of **accessPackageAssignmentRequest** objects filtered on the signed-in user.| |[Cancel](../api/accesspackageassignmentrequest-cancel.md)|[accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) collection|Cancel an **accessPackageAssignmentRequest** object that is in a cancelable state.|+|[Filter by current user](../api/accesspackageassignmentrequest-filterbycurrentuser.md)|[accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) collection|Retrieve the list of **accessPackageAssignmentRequest** objects filtered on the signed-in user.| |[Reprocess](../api/accesspackageassignmentrequest-reprocess.md) | None | Automatically retry a userΓÇÖs request for access to an access package.|+|[Resume](../api/accesspackageassignmentrequest-resume.md) | None | Resume a user's access package request after waiting for a callback from a custom extension.| ## Properties |Property|Type|Description| In [Microsoft Entra Entitlement Management](entitlementmanagement-overview.md), |createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. Supports `$filter`.| |id|String|Read-only.| |requestType|accessPackageRequestType|The type of the request. The possible values are: `notSpecified`, `userAdd`, `UserExtend`, `userUpdate`, `userRemove`, `adminAdd`, `adminUpdate`, `adminRemove`, `systemAdd`, `systemUpdate`, `systemRemove`, `onBehalfAdd` (not supported), `unknownFutureValue`. Requests from the user have a **requestType** of `userAdd`, `userUpdate`, or `userRemove`. This property can't be changed once set.|-|schedule|[entitlementManagementSchedule](../resources/entitlementmanagementschedule.md)|The range of dates that access is to be assigned to the requestor. This property can't be changed once set.| +|schedule|[entitlementManagementSchedule](../resources/entitlementmanagementschedule.md)|The range of dates that access is to be assigned to the requestor. This property can't be changed once set, but a new schedule for an assignment can be included in another `userUpdate` or `UserExtend` or `adminUpdate` assignment request.| |state|accessPackageRequestState|The state of the request. The possible values are: `submitted`, `pendingApproval`, `delivering`, `delivered`, `deliveryFailed`, `denied`, `scheduled`, `canceled`, `partiallyDelivered`, `unknownFutureValue`. Read-only. Supports `$filter` (`eq`). | |status|String|More information on the request processing status. Read-only.| |
v1.0 | Accesspackageassignmentreviewsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accesspackageassignmentreviewsettings.md | Title: "accessPackageAssignmentReviewSettings complex type" -description: "Used for the access reviews of an access package's assignments." + Title: "accessPackageAssignmentReviewSettings resource type" +description: "Settings configured in an access package assignment policy for the access reviews of assignments to an access package that were made through that policy." ms.localizationpriority: medium doc_type: resourcePageType -# accessPackageAssignmentReviewSettings complex type +# accessPackageAssignmentReviewSettings resource type Namespace: microsoft.graph |
v1.0 | Accessreviewhistoryschedulesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewhistoryschedulesettings.md | Defines the settings of an [accessReviewHistoryDefinition](accessreviewhistoryde | recurrence|[patternedRecurrence](patternedrecurrence.md) | Detailed settings for recurrence using the standard Outlook recurrence object. <br/><br/>**Note:** Only **dayOfMonth**, **interval**, and **type** (`weekly`, `absoluteMonthly`) properties are supported. Use the property **startDate** on **recurrenceRange** to determine the day the review starts. Required. | |reportRange|String|A duration string in ISO 8601 duration format specifying the lookback period of the generated review history data. For example, if a history definition is scheduled to run on the first of every month, the **reportRange** is `P1M`. In this case, on the first of every month, access review history data is collected containing only the previous month's review data. <br/><br/>**Note:** Only **years**, **months**, and **days** ISO 8601 properties are supported. Required.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessReviewHistoryScheduleSettings" |
v1.0 | Accessreviewstagesettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/accessreviewstagesettings.md | Represents the settings of the stages that are associated with a [multi-stage ac |reviewers|[accessReviewReviewerScope](../resources/accessreviewreviewerscope.md) collection|Defines who the reviewers are. If none is specified, the review is a self-review (users review their own access). For examples of options for assigning reviewers, see [Assign reviewers to your access review definition using the Microsoft Graph API](/graph/accessreviews-reviewers-concept). <br/><br/>**NOTE:** The value of this property overrides the corresponding setting on the [accessReviewScheduleDefinition](accessReviewScheduleDefinition.md). | |stageId|String|Unique identifier of the **accessReviewStageSettings** object. The **stageId** is used by the **dependsOn** property to indicate the order of the stages. Required. | +## Relationships ++None. + ## JSON representation-HEre's a JSON representation of the resource. ++The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.accessReviewStageSettings" |
v1.0 | Admin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/admin.md | None. | edge | [edge](edge.md) | A container for Microsoft Edge resources. Read-only. | | microsoft365Apps |[adminMicrosoft365Apps](../resources/adminmicrosoft365apps.md)|A container for the Microsoft 365 apps admin functionality.| | people | [peopleAdminSettings](../resources/peopleadminsettings.md) | Represents a setting to control people-related admin settings in the tenant. |+| reportSettings |[adminReportSettings](../resources/adminreportsettings.md)|A container for administrative resources to manage reports.| | serviceAnnouncement | [serviceAnnouncement](serviceannouncement.md) | A container for service communications resources. Read-only. | | sharepointSettings | [sharepointSettings](../resources/sharepointSettings.md) | A container for administrative resources to manage tenant-level settings for SharePoint and OneDrive. | |
v1.0 | Administrativeunit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/administrativeunit.md | This resource supports: |description|String|An optional description for the administrative unit. Supports `$filter` (`eq`, `ne`, `in`, `startsWith`), `$search`.| |displayName|String|Display name for the administrative unit. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$search`, and `$orderby`.| |id|String|Unique identifier for the administrative unit. Read-only. Supports `$filter` (`eq`).|-|visibility|String|Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership`. If not set (value is `null`), the default behavior is public. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit.| +| 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|Controls whether the administrative unit and its members are hidden or public. Can be set to `HiddenMembership`. If not set, the default value is `null` and the default behavior is public. When set to `HiddenMembership`, only members of the administrative unit can list other members of the administrative unit.| > [!TIP] > Directory extensions and associated data are returned by default while schema extensions and associated data returned only on `$select`. The following JSON representation shows the resource type. "description": "String", "displayName": "String", "id": "String (identifier)",+ "membershipRule": "String", + "membershipRuleProcessingState": "String", + "membershipType": "String", "visibility": "String" }- ``` |
v1.0 | Adminreportsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/adminreportsettings.md | + + Title: "adminReportSettings resource type" +description: "Represents the tenant-level settings for Microsoft 365 reports." +ms.localizationpriority: medium +++++# adminReportSettings resource type ++Namespace: microsoft.graph ++Represents the tenant-level settings for Microsoft 365 reports. ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get](../api/adminreportsettings-get.md)|[adminReportSettings](../resources/adminreportsettings.md)|Get the tenant-level settings for Microsoft 365 reports.| +|[Update](../api/adminreportsettings-update.md)|[adminReportSettings](../resources/adminreportsettings.md)|Update tenant-level settings for Microsoft 365 reports.| ++## Properties ++| Property | Type | Description | +| -- | -- | - | +| 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. | ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.adminReportSettings", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.adminReportSettings", + "displayConcealedNames": "Boolean" +} +``` |
v1.0 | Aggregationoption | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/aggregationoption.md | Specifies which aggregations should be returned alongside the search results. Th |field|String|Computes aggregation on the field while the field exists in the current entity type. Required.| |size|Int32|The number of [searchBucket](searchBucket.md) resources to be returned. This isn't required when the range is provided manually in the search request. The minimum accepted size is 1, and the maximum is 65535. Optional.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Agreementfiledata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/agreementfiledata.md | Represents a Microsoft Entra terms of use agreement file. |:-|:|:| |data|Binary|Data that represents the terms of use PDF document. Read-only.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Alterationresponse | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/alterationresponse.md | Provides information related to spelling corrections in the alteration response. |queryAlteration|[searchAlteration](searchalteration.md)| Defines the details of the alteration information for the spelling correction.| |queryAlterationType|searchAlterationType| Defines the type of the spelling correction. Possible values are: `suggestion`, `modification`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Alteredquerytoken | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/alteredquerytoken.md | Represents changed segments related to an original user query. |offset|Int32| Defines the offset of a changed segment.| |suggestion|String| Represents the corrected segment string.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Appidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/appidentity.md | Title: "appIdentity resource type" -description: "Indicates the identity of the application that performed the action or was changed. Includes Application Id, Name, Service Principal ID and Name. This resource is called by the directoryAudit API" +description: "Indicates the identity of the application that performed the action or was changed. This resource is called by the directoryAudit API" ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -Indicates the identity of the application that performed the action or was changed. Includes application ID, name, and service principal ID and name. This resource is used by the [Get directoryAudit](../api/directoryaudit-get.md) operation. +Indicates the identity of the application that performed the action or was changed. Includes the application ID, name, and service principal ID and name. This resource is used by the [directoryAudit](../api/directoryaudit-get.md) operation. ## Properties Indicates the identity of the application that performed the action or was chang |servicePrincipalId|String|Refers to the unique ID for the service principal in Microsoft Entra ID.| |servicePrincipalName|String|Refers to the Service Principal Name is the Application name in the tenant. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Appliedconditionalaccesspolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/appliedconditionalaccesspolicy.md | Namespace: microsoft.graph Indicates the attributes related to applied conditional access policy or policies that are triggered by a [sign-in](signin.md) activity. -The data in this object is returned only for callers with privileges to read conditional access data. For more information, see [Viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#viewing-applied-conditional-access-ca-policies-in-sign-ins). +The data in this object is returned only for callers with privileges to read conditional access data. For more information, see [Permissions for viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#permissions). ## Properties |
v1.0 | Appmanagementpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/appmanagementpolicy.md | To learn more about how to use app management policy, see [Microsoft Entra appli | [Update](../api/appmanagementpolicy-update.md) | None | Update an app management policy. | | [Delete](../api/appmanagementpolicy-delete.md) | None | Delete an app management policy from the collection of policies in appManagementPolicies. | | [List applies to](../api/appmanagementpolicy-list-appliesto.md)| [appManagementPolicy](../resources/appmanagementpolicy.md)|Return a list of applications and service principals to which the policy is applied. |-| [Create applies to](../api/appmanagementpolicy-post-appliesto.md)| None |Return a list of applications and service principals to which the policy is applied. | +| [Create applies to](../api/appmanagementpolicy-post-appliesto.md)| None |Assign an appManagementPolicy policy object to an application or service principal object. | +| [Delete applies to](../api/appmanagementpolicy-delete-appliesto.md)| None |Remove an appManagementPolicy policy object from an application or service principal object. | ## Properties |
v1.0 | Approleassignment | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/approleassignment.md | Title: "appRoleAssignment resource type" -description: "Used to record when a user, group, or service principal is assigned to an app role on an application's service principal. You can create, read and delete app role assignments." +description: "Used to record when a user, group, or service principal is assigned to an app role on an application's service principal. You can create, read, and delete app role assignments." ms.localizationpriority: high doc_type: resourcePageType Used to record when a user, group, or service principal is assigned an app role An app role assignment is a relationship between the assigned principal (a user, a group, or a service principal), a resource application (the app's service principal) and an app role defined on the resource application. -When the [app role](approle.md) which has been assigned to a principal has a non-empty **value** property, this will be included in the **roles** claim of tokens where the subject is the assigned principal (e.g. SAML responses, ID tokens, access tokens identifying a signed-in user, or an access token identifying a service principal). Applications and APIs use these claims as part of their authorization logic. +When the [app role](approle.md) that has been assigned to a principal has a nonempty **value** property, it's included in the **roles** claim of tokens where the subject is the assigned principal (for example, SAML responses, ID tokens, access tokens identifying a signed-in user, or an access token identifying a service principal). Applications and APIs use these claims as part of their authorization logic. A user can be assigned an app role directly. If an app role is assigned to a group, direct members of the group are also considered to have been assigned the app role. When a user is assigned an app role for an application, a tile for that application is displayed in the user's [MyApps portal](/azure/active-directory/user-help/my-apps-portal-end-user-access) and [Microsoft 365 app launcher](https://support.office.com/article/meet-the-office-365-app-launcher-79f12104-6fed-442f-96a0-eb089a3f476a). An app role assignment where the assigned principal is a service principal is an ## Methods |Method|Return type|Description| |:|:|:|-|[List appRoleAssignments granted to a group](../api/group-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[List appRoleAssignments granted to a user](../api/user-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[List appRoleAssignments granted to a service principal](../api/serviceprincipal-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[List appRoleAssignments granted to users, groups, and client service principals for a resource service principal](../api/serviceprincipal-list-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties.| -|[Grant an appRole to a group](../api/group-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Grant an appRole to a user](../api/user-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Grant an appRole to a service principal](../api/serviceprincipal-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Grant a user, group, or client service principal an appRoleAssignment for a resource service principal](../api/serviceprincipal-post-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object. -|[Get appRoleAssignment](../api/approleassignment-get.md)|[appRoleAssignment](../resources/approleassignment.md)|Get a new [appRoleAssignment](../resources/approleassignment.md) object.| -|[Delete an appRoleAssignment from a group](../api/group-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| -|[Delete an appRoleAssignment from a user](../api/user-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| -|[Delete an appRoleAssignment from a service principal](../api/serviceprincipal-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| -|[Delete an appRoleAssignment granted to a user, group, or client service principal for a resource service principal](../api/serviceprincipal-delete-approleassignedto.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object.| +|[List app role assignments for a group](../api/group-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for a group.| +|[List app role assignments for a user](../api/user-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for a user.| +|[List app role assignments for a client service principal](../api/serviceprincipal-list-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for a client service principal.| +|[List app role assignments for users, groups, and client service principals for a resource service principal](../api/serviceprincipal-list-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Get a list of the [appRoleAssignment](../resources/approleassignment.md) objects and their properties for users, groups, and client service principals for a specified resource service principal.| +|[Grant app role to a group](../api/group-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object for a group.| +|[Grant app role to a user](../api/user-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md)|Create a new [appRoleAssignment](../resources/approleassignment.md) object for a user.| +|[Grant app role to a client service principal](../api/serviceprincipal-post-approleassignments.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object for a client service principal.| +|[Grant app role assignment to user, group, or client service principal for a resource service principal](../api/serviceprincipal-post-approleassignedto.md)|[appRoleAssignment](../resources/approleassignment.md) collection|Create a new [appRoleAssignment](../resources/approleassignment.md) object to a user, group, or client service principal for a specified resource service principal.| +|[Get app role assignment](../api/approleassignment-get.md)|[appRoleAssignment](../resources/approleassignment.md)|Get an [appRoleAssignment](../resources/approleassignment.md) object assigned to a user, group, or client service principal for a resource service principal.| +|[Delete app role assignment for a group](../api/group-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a group.| +|[Delete app role assignment for a user](../api/user-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a user.| +|[Delete app role assignment for a client service principal](../api/serviceprincipal-delete-approleassignments.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a client service principal.| +|[Delete app role assignment for user, group, or client service principal to a resource service principal](../api/serviceprincipal-delete-approleassignedto.md)|None|Delete an [appRoleAssignment](../resources/approleassignment.md) object from a user, group, or client service principal for a specified resource service principal.| ## Properties | Property | Type | Description | |:|:--|:-|-| appRoleId | Guid | The identifier (**id**) for the [app role](approle.md) which is assigned to the principal. This app role must be exposed in the **appRoles** property on the resource application's service principal (**resourceId**). If the resource application has not declared any app roles, a default app role ID of `00000000-0000-0000-0000-000000000000` can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. | +| appRoleId | Guid | The identifier (**id**) for the [app role](approle.md) that's assigned to the principal. This app role must be exposed in the **appRoles** property on the resource application's service principal (**resourceId**). If the resource application hasn't declared any app roles, a default app role ID of `00000000-0000-0000-0000-000000000000` can be specified to signal that the principal is assigned to the resource app without any specific app roles. Required on create. | | createdDateTime | DateTimeOffset | The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. | | deletedDateTime | DateTimeOffset | The date and time when the app role assignment was deleted. Always `null` for an appRoleAssignment object that hasn't been deleted. Inherited from [directoryObject](directoryobject.md). | | id | String | A unique identifier for the **appRoleAssignment** key. Not nullable. Read-only. | |
v1.0 | Archivedprintjob | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/archivedprintjob.md | A record of a "final state" (completed, aborted, or canceled) print job that is |processingState|printJobProcessingState|The print job's final processing state. Read-only.| |createdDateTime|DateTimeOffset|The dateTimeOffset when the job was created. Read-only.| |acquiredDateTime|DateTimeOffset|The dateTimeOffset when the job was acquired by the printer, if any. Read-only.|-|completionDateTime|DateTimeOffset|The dateTimeOffset when the job was completed, canceled or aborted. Read-only.| +|completionDateTime|DateTimeOffset|The dateTimeOffset when the job was completed, canceled, or aborted. Read-only.| |acquiredByPrinter|Boolean|True if the job was acquired by a printer; false otherwise. Read-only.| |copiesPrinted|Int32|The number of copies that were printed. Read-only.| |createdBy|[userIdentity](useridentity.md)|The user who created the print job. Read-only.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Authenticationcontextclassreference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/authenticationcontextclassreference.md | Represents a Microsoft Entra authentication context class reference. Authenticat | Method | Return Type | Description | |:-|:|:| | [List](../api/conditionalaccessroot-list-authenticationcontextclassreferences.md) | [authenticationContextClassReference](authenticationContextClassReference.md) collection | Get all of the authenticationContextClassReference objects in the organization. |-| [Create or update authenticationContextClassReference](../api/authenticationcontextclassreference-update.md)) | [authenticationContextClassReference](authenticationContextClassReference.md) | Create or update an authenticationContextClassReference object. | +| [Create or update](../api/authenticationcontextclassreference-update.md)) | [authenticationContextClassReference](authenticationContextClassReference.md) | Create or update an authenticationContextClassReference object. | | [Get](../api/authenticationcontextclassreference-get.md) | [authenticationContextClassReference](authenticationContextClassReference.md) | Read properties and relationships of a authenticationContextClassReference object. | | [Delete](../api/authenticationcontextclassreference-delete.md) | [authenticationContextClassReference](authenticationContextClassReference.md) | Delete an authenticationContextClassReference object. | |
v1.0 | Availabilityitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/availabilityitem.md | Indicates the status of a [staff member](bookingstaffmember.md) for a given time |status |bookingsAvailabilityStatus |The status of the staff member. Possible values are: `available`, `busy`, `slotsAvailable`, `outOfOffice`, `unknownFutureValue`.| |startDateTime |dateTimeTimeZone |The start time of the time slot.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Azureactivedirectorytenant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/azureactivedirectorytenant.md | Namespace: microsoft.graph Used in the identity sources of an [connectedOrganization](connectedOrganization.md). The `@odata.type` value `#microsoft.graph.azureActiveDirectoryTenant` indicates that this type identifies another Microsoft Entra tenant as an identity source for a connected organization. -When [creating a new connectedOrganization](../api/entitlementmanagement-post-connectedorganizations.md), if the caller provides in the identitySources collection a domainIdentitySource and the domain corresponds to a registered domain of a Microsoft Entra tenant, then the resulting connectedOrganization that is created will have an identitySources collection containing a single member of the [azureActiveDirectoryTenant](azureactivedirectorytenant.md) type. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Bookingbusiness | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingbusiness.md | Represents a business in Microsoft Bookings. This is the top level object in the |[List calendarView](../api/bookingbusiness-list-calendarview.md)|[bookingAppointment](bookingappointment.md) collection|Get the collection of **bookingAppointment** objects that occurs in the specified date range.| |[Publish](../api/bookingbusiness-publish.md)|None|Make the scheduling page of this business available to external customers. Set the **isPublished** property to `true`, and **publicUrl** property to the URL of the scheduling page.| |[Unpublish](../api/bookingbusiness-unpublish.md)|None| Make the scheduling page of this business not available to external customers. Set the **isPublished** property to `false`, and the **publicUrl** property to `null`.|+|[Get staff availability](../api/bookingbusiness-getstaffavailability.md) |[staffAvailabilityItem](staffavailabilityitem.md) collection| Get the availability information of staff members of a Microsoft Bookings calendar.| ## Properties |
v1.0 | Bookingcustomerinformationbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingcustomerinformationbase.md | Abstract base type for an appointment's customer information. Base type of [bookingCustomerInformation](bookingcustomerinformation.md). +## Properties ++None. ++## Relationships ++None. + ## JSON representation+ The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.bookingCustomerInformationBase" |
v1.0 | Bookingreminder | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingreminder.md | Represents when and whom to send an email reminder. |offset|Duration|The amount of time before the start of an appointment that the reminder should be sent. It's denoted in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.| |recipients|bookingReminderRecipients|The persons who should receive the reminder. Possible values are: `allAttendees`, `staff`, `customer`, `unknownFutureValue`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Bookingschedulingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingschedulingpolicy.md | Namespace: microsoft.graph Represents the set of policies that determine how appointments should be created in a Microsoft Bookings calendar. +> [!NOTE] +> +> If the Default Scheduling Policy is enabled at the service level, the values of this resource are limited to those defined in the policy in the [List services](/graph/api/bookingbusiness-list-services) API response. In this case, the client must fall back to the Default Scheduling Policy for the business. + ## Properties | Property | Type |Description| |:|:--|:-| Represents the set of policies that determine how appointments should be created |sendConfirmationsToOwner|Boolean| `True` to notify the business via email when a booking is created or changed. Use the email address specified in the **email** property of the **bookingBusiness** entity for the business. | |timeSlotInterval|Duration|Duration of each time slot, denoted in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Bookingworkhours | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingworkhours.md | Represents the set of working hours in a single day of the week, for a [bookingB |day|String| The day of the week represented by this instance. Possible values are: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.| |timeSlots|[bookingWorkTimeSlot](bookingworktimeslot.md) collection|A list of start/end times during a day.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Bookingworktimeslot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bookingworktimeslot.md | Defines the start and end times for work. |endTime|TimeOfDay|The time of the day when work stops. For example, 17:00:00.0000000.| |startTime|TimeOfDay|The time of the day when work starts. For example, 08:00:00.0000000.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Bucketaggregationdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bucketaggregationdefinition.md | Provides the details on how to generate the aggregations in the results. |minimumCount|Int32|The minimum number of items that should be present in the aggregation to be returned in a bucket. Optional.| |prefixFilter|String|A filter to define a matching criteria. The key should start with the specified prefix to be returned in the response. Optional.| |ranges|[bucketAggregationRange](bucketaggregationrange.md) collection|Specifies the manual ranges to compute the aggregations. This is only valid for nonstring refiners of date or numeric type. Optional.|-|sortBy|bucketAggregationSortProperty| The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString`to sort alphabetically based on the key in the aggregation, `keyAsNumber` for numerical sorting based on the key in the aggregation. Required. +|sortBy|bucketAggregationSortProperty| The possible values are `count` to sort by the number of matches in the aggregation, `keyAsString`to sort alphabetically based on the key in the aggregation, `keyAsNumber` for numerical sorting based on the key in the aggregation. Required.| ++## Relationships ++None. ## JSON representation |
v1.0 | Bucketaggregationrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/bucketaggregationrange.md | Specifies the lower and upper limit to a range for aggregating search results. A |from|String| Defines the lower bound from which to compute the aggregation. This can be a numeric value or a string representation of a date using the `YYYY-MM-DDTHH:mm:ss.sssZ` format. Required.| |to|String| Defines the upper bound up to which to compute the aggregation. This can be a numeric value or a string representation of a date using the `YYYY-MM-DDTHH:mm:ss.sssZ` format. Required.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Call | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/call.md | Becomes: https://teams.microsoft.com/l/meetup-join/19:meeting_NTg0NmQ3NTctZDVkZC00YzRhLThmNmEtOGQ3M2E0ODdmZDZk@thread.v2/0?context={"Tid":"72f988bf-86f1-41af-91ab-2d7cd011db47","Oid":"4b444206-207c-42f8-92a6-e332b41c88a2"} ``` +> [!NOTE] +> The following known issues are associated with this resource: +> - [Webhook message processing exception: System.Security.Cryptography.CryptographicException](https://developer.microsoft.com/en-us/graph/known-issues/?search=24752) +> - [Support for multi-endpoint use case in delta roster notification mode is missing](https://developer.microsoft.com/en-us/graph/known-issues/?search=24894) + ## Methods | Method | Return Type | Description | |:-|:--|:--|+| [Create](../api/application-post-calls.md) | [call](call.md) | Create **call** enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. | | [Get](../api/call-get.md) | [call](call.md) | Read properties of the **call** object. | | [Delete/hang up](../api/call-delete.md) | None | Delete or Hang-up an active **call**. | | [Keep alive](../api/call-keepalive.md) | None | Ensure that the call remains active. | The following JSON representation shows the resource type. "suppressions": [] } -->- |
v1.0 | Calloptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/calloptions.md | Namespace: microsoft.graph Represents an abstract base class that contains the optional features for a call. +Base type of [incomingCallOptions](../resources/incomingcalloptions.md) and [outgoingCallOptions](../resources/outgoingcalloptions.md). + ## Properties |Property |Type |Description | |: |: |: | | hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. | | isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. |+| isDeltaRosterEnabled | Boolean | Indicates whether delta roster is enabled for the call. | ## JSON representation The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.callOptions", "hideBotAfterEscalation": "Boolean",- "isContentSharingNotificationEnabled": "Boolean" + "isContentSharingNotificationEnabled": "Boolean", + "isDeltaRosterEnabled": "Boolean" } ``` |
v1.0 | Callrecording | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/callrecording.md | Represents a recording associated with an [online meeting](onlinemeeting.md). |:|:--|:-| |[List](../api/onlinemeeting-list-recordings.md) | [callRecording](callrecording.md) collection | Get the list of [callRecording](../resources/callrecording.md) objects associated with a scheduled [onlineMeeting](../resources/onlinemeeting.md).| |[Get](../api/callrecording-get.md) | [callRecording](callrecording.md) | Get a [callRecording](../resources/callrecording.md) object associated with a scheduled [onlineMeeting](../resources/onlinemeeting.md).|+|[Get delta by organizer](../api/callrecording-delta.md) | [callRecording](callrecording.md) collection | Get a set of [callRecording](../resources/callrecording.md) resources that were added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| +|[List recordings by organizer](../api/onlinemeeting-getallrecordings.md) | [callRecording](callrecording.md) collection | Get the [callRecording](../resources/callrecording.md) objects for all the [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| ## Properties |
v1.0 | Callrecords Media | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/callrecords-media.md | Title: "media resource type" -description: "The media type" +description: "Represents the media (for example, audio, video, and video-based screen-sharing) used in a call." ms.localizationpriority: medium doc_type: "resourcePageType" Namespace: microsoft.graph.callRecords -Represents the media (audio, video, video-based screen-sharing, etc.) used in a call. +Represents the media (for example, audio, video, and video-based screen-sharing) used in a call. ## Properties |
v1.0 | Calltranscript | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/calltranscript.md | Represents a transcript associated with an [online meeting](onlinemeeting.md). |:|:--|:-| |[List transcripts](../api/onlinemeeting-list-transcripts.md) | [callTranscript](calltranscript.md) collection | Get the list of [callTranscript](../resources/calltranscript.md) objects associated with an [onlineMeeting](../resources/onlinemeeting.md).| |[Get transcript](../api/calltranscript-get.md) | [callTranscript](calltranscript.md) | Get a [callTranscript](../resources/calltranscript.md) object associated with an [onlineMeeting](../resources/onlinemeeting.md).|+|[Get delta by organizer](../api/calltranscript-delta.md) | [callTranscript](calltranscript.md) collection | Get a set of [callTranscript](../resources/calltranscript.md) resources that were added for [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| +|[List transcripts by organizer](../api/onlinemeeting-getalltranscripts.md) | [callTranscript](calltranscript.md) collection | Get the [callTranscript](../resources/calltranscript.md) objects for all the [onlineMeeting](../resources/onlinemeeting.md) instances organized by the specified user.| ## Properties |
v1.0 | Channel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/channel.md | Title: "channel resource type" description: "A channel is a collection of chatMessages within a team."-+ ms.localizationpriority: high doc_type: resourcePageType where files are shared, and where tabs are added. |[Get primary channel](../api/team-get-primarychannel.md)|[channel](channel.md)| The general channel for the team. | |[Update channel](../api/channel-patch.md) | [channel](channel.md) | Update properties of the channel.| |[Delete channel](../api/channel-delete.md) | None | Delete a channel.|-|[Get message delta](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) | Get incremental messages in a channel. | |[List channel messages](../api/channel-list-messages.md) | [chatMessage](../resources/chatmessage.md) | Get messages in a channel | |[Get all channel messages](../api/channel-getallmessages.md)|[channel](channel.md) collection | Get all messages from all channels that a user is a participant in. |+|[Get all retained channel messages](../api/channel-getallretainedmessages.md)|[chatMessage](../resources/chatmessage.md) collection|Get all retained [messages](../resources/chatmessage.md) across all [channels](../resources/channel.md) in a [team](../resources/team.md). | |[Create channel message post](../api/channel-post-messages.md) | [chatMessage](../resources/chatmessage.md) | Send a message to a channel. | |[Create reply to channel message post](../api/chatmessage-post-replies.md) | [chatMessage](../resources/chatmessage.md) | Reply to a message in a channel.| |[Get files folder](../api/channel-get-filesfolder.md)| [driveItem](driveitem.md) | Retrieves the details of the SharePoint folder where the files for the channel are stored. | |
v1.0 | Chat | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chat.md | A chat is a collection of [chatMessages](chatmessage.md) between one or more par |[List messages in a chat](../api/chat-list-messages.md) | [chatMessage](../resources/chatmessage.md) | Get messages in a chat. | |[Get message reply](../api/chatmessage-get.md) | [chatMessage](../resources/chatmessage.md) | Get a single message in a chat. | |[Get messages across all chats](../api/chats-getallmessages.md)| [chat](chat.md) collection| Get messages from all chats that a user is a participant in. |+|[Get retained messages across all chats](../api/chat-getallretainedmessages.md)|[chatMessage](../resources/chatmessage.md) collection| 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. | +|[Get delta chat messages for user](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) collection | 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. | | **Apps** ||| |[List apps in chat](../api/chat-list-installedapps.md) |[teamsAppInstallation](teamsappinstallation.md) collection | List apps installed in a chat (and associated meeting).| |[Get app installed in chat](../api/chat-get-installedapps.md) | [teamsAppInstallation](teamsappinstallation.md) | Get a specific app installed in a chat (and associated meeting).| |
v1.0 | Chatmessage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chatmessage.md | Represents an individual chat message within a [channel](channel.md) or [chat](c |:|:--|:-| |**Channel messages**| | | |[List messages in channel](../api/channel-list-messages.md) | [chatMessage](chatmessage.md) collection | List of all root messages in a channel.|-|[Get delta of messages in channel](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) | Get incremental messages in a channel. | |[Create subscription for new channel messages](../api/subscription-post-subscriptions.md) | [subscription](subscription.md) | Listen for new, edited, and deleted messages, and reactions to them. | |[Get message in channel](../api/chatmessage-get.md) | [chatMessage](chatmessage.md) | Get a single root message in a channel.| |[Send message in channel](../api/chatmessage-post.md) | [chatMessage](chatmessage.md)| Create a new root message in a channel.| Represents an individual chat message within a [channel](channel.md) or [chat](c |[List messages in chat](../api/chat-list-messages.md) | [chatMessage](../resources/chatmessage.md) | List chat messages in a chat. | |[Get message in chat](../api/chatmessage-get.md) | [chatMessage](../resources/chatmessage.md) | Get a single chat message in a chat. | |[Get messages across all chats for user](../api/chats-getallmessages.md)| [chat](chat.md) collection| Get messages from all chats that a user is a participant in, that includes 1:1 chats, group chats, and meeting chats. |+|[Get delta chat messages for user](../api/chatmessage-delta.md) | [chatMessage](../resources/chatmessage.md) collection | 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. | |[Get all channel messages](../api/channel-getallmessages.md)|[channel](channel.md) collection | Get all messages from all channels that a user is a participant in. | |[Create subscription for new chat messages](../api/subscription-post-subscriptions.md) | [subscription](subscription.md) | Listen for new, edited, and deleted chat messages, and reactions to them. | |[Send message in chat](../api/chat-post-messages.md) | [chatMessage](chatmessage.md)| Send a chat message in an existing 1:1 or group chat conversation.| |
v1.0 | Chatmessagereaction | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/chatmessagereaction.md | An entity of type `chatMessageReaction` is returned as part of the [Get channel | Property | Type | Description | |:-|:|:|-|createdDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| -|reactionType|String|Supported values are `like`, `angry`, `sad`, `laugh`, `heart`, `surprised`. | +|createdDateTime|DateTimeOffset|The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|displayName|String|The name of the reaction.| +|reactionContentUrl|String|The hosted content URL for the custom reaction type. | +|reactionType|String|The reaction type. Supported values include Unicode characters, `custom`, and some backward-compatible reaction types, such as `like`, `angry`, `sad`, `laugh`, `heart`, and `surprised`. | |user|[chatMessageReactionIdentitySet](chatmessagereactionidentityset.md)|The user who reacted to the message.| ## JSON representation The following JSON representation shows the resource type. ```json { "createdDateTime": "String (timestamp)",+ "displayName": "String", + "reactionContentUrl": "String", "reactionType": "String", "user": {"@odata.type": "microsoft.graph.chatMessageReactionIdentitySet"} } |
v1.0 | Claimsmappingpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/claimsmappingpolicy.md | The number of claims and transformations that can be added to a claims-mapping p For more scenario and configuration details, see [Claims mapping policy type](/azure/active-directory/develop/reference-claims-mapping-policy-type) and [How to: Customize claims emitted in tokens for a specific app in a tenant](/azure/active-directory/develop/active-directory-claims-mapping#claims-mapping-policy-properties). +Additionally, visit [Claims customization using a policy](/entra/identity-platform/reference-claims-customization) to learn the difference between this policy and the [custom claims policy](/graph/api/resources/customclaimspolicy). + Inherits from [stsPolicy](stsPolicy.md). ## Methods |
v1.0 | Clonableteamparts | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/clonableteamparts.md | Title: "clonableTeamParts enum type" description: "Describes which part of a team should be cloned. " ms.localizationpriority: medium-+ doc_type: enumPageType |
v1.0 | Collapseproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/collapseproperty.md | Specifies the criteria used for collapsing search results. Applies only to sorta |fields|String Collection| Defines the collapse group to trim results. The properties in this collection must be sortable/refinable properties. Required.| |limit|Int16| Defines a maximum limit count for this field. This numeric value must be a positive integer. Required.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Community | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/community.md | + + Title: "community resource type" +description: "Represents a community in Viva Engage that is a central place for conversations, files, events, and updates for people sharing a common interest or goal." ++ms.localizationpriority: medium ++++# community resource type ++Namespace: microsoft.graph ++Represents a community in Viva Engage that is a central place for conversations, files, events, and updates for people sharing a common interest or goal. ++Every community is associated with a [Microsoft 365 group](../resources/group.md), but the group doesn't have the same ID as the community. For more information about managing communities in Viva Engage, see [Use the Microsoft Graph API to work with Viva Engage](../resources/engagement-api-overview.md). ++This resource is an open type that allows other properties to be passed in. ++Inherits from [entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[List](../api/employeeexperience-list-communities.md)|[community](../resources/community.md) collection|Get a list of the Viva Engage [community](../resources/community.md) objects and their properties.| +|[Create](../api/employeeexperience-post-communities.md)|[engagementAsyncOperation](../resources/engagementasyncoperation.md)|Create a new [community](../resources/community.md) in Viva Engage.| +|[Get](../api/community-get.md)|[community](../resources/community.md)|Read the properties and relationships of a [community](../resources/community.md) object.| +|[Update](../api/community-update.md)|None|Update the properties of an existing Viva Engage [community](../resources/community.md).| +|[Delete](../api/community-delete.md)|None|Delete a Viva Engage [community](../resources/community.md) along with all associated Microsoft 365 content, including the connected Microsoft 365 group, OneNote notebook, and Planner plans.| ++## Properties ++|Property|Type|Description| +|:|:|:| +| description | String | The description of the community. The maximum length is 1,024 characters. | +| displayName | String | The name of the community. The maximum length is 255 characters. | +| groupId | String | The ID of the [Microsoft 365 group](../resources/group.md) that manages the membership of this community. | +| id | String | The unique identifier of the community. Read-only. Inherited from [entity](../resources/entity.md). | +| privacy | [communityPrivacy](../resources/community.md#communityprivacy-values) | Defines the privacy level of the community. The possible values are: `public`, `private`, `unknownFutureValue`. | ++### communityPrivacy values ++| Member | Description | +|:|:-| +| public | Any user from the tenant can join and participate in the community. | +| private | A community administrator must add tenant users to the community before they can participate. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|group|[group](../resources/group.md)|The [Microsoft 365 group](group.md) that manages the membership of this community.| +|owners|[user](../resources/user.md) collection| The admins of the community. Limited to 100 users. If this property isn't specified when you create the community, the calling user is automatically assigned as the community owner. | ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.community", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.community", + "description": "String", + "displayName": "String", + "groupId": "String", + "id": "String (identifier)", + "privacy": "String" +} +``` ++## Related content ++- [Use the Microsoft Graph API to work with Viva Engage](engagement-api-overview.md) +- [Create a community](../api/employeeexperience-post-communities.md) |
v1.0 | Connectedorganizationmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/connectedorganizationmembers.md | Title: "connectedOrganizationMembers complex type" -description: "The connectedOrganizationMembers type identifies a collection of users in the tenant who will be allowed as requestor, approver or reviewer." + Title: "connectedOrganizationMembers resource type" +description: "Represents a collection of users in the tenant who are allowed as requestor, approver, or reviewer." ms.localizationpriority: medium doc_type: resourcePageType -# connectedOrganizationMembers complex type +# connectedOrganizationMembers resource type Namespace: microsoft.graph -Used in the request settings of an access package assignment policy. The `@odata.type` value `#microsoft.graph.connectedOrganizationMembers` indicates that this type identifies a collection of users, those who are associated with a [connected organization](connectedorganization.md), who will be allowed to request an access package. +Used in the request settings of an access package assignment policy. The `@odata.type` value `#microsoft.graph.connectedOrganizationMembers` indicates that this type identifies a collection of users, those who are associated with a [connected organization](connectedorganization.md), who are allowed to request an access package. ## Properties |Property|Type|Description| |
v1.0 | Customextensionauthenticationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customextensionauthenticationconfiguration.md | The type of token authentication used depends on the token security. If the toke None. +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration", |
v1.0 | Customextensionendpointconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/customextensionendpointconfiguration.md | Abstract base type that exposes the derived types used to configure the **endpoi None. +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration", |
v1.0 | Datetimetimezone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/datetimetimezone.md | Pacific/Apia Pacific/Kiritimati +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Device | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/device.md | This resource supports: |[List member of](../api/device-list-memberof.md) |[directoryObject](directoryobject.md) collection| List the groups and administrative units that the device is a direct member of. | |[List transitive member of](../api/device-list-transitivememberof.md) |[directoryObject](directoryobject.md) collection| List the groups and administrative units that the device is a member of. This operation is transitive. | |[List registered owners](../api/device-list-registeredowners.md) |[directoryObject](directoryobject.md) collection| Get the users that are registered owners of the device from the registeredOwners navigation property.|+|[Add registered owners](../api/device-post-registeredowners.md) |[directoryObject](directoryobject.md) collection| Add registered owners of the device.| +|[Remove registered owners](../api/device-delete-registeredowners.md) |[directoryObject](directoryobject.md) collection| Delete registered owners from the device.| |[List registered users](../api/device-list-registeredusers.md) |[directoryObject](directoryobject.md) collection| Get the registered users of the device from the registeredUsers navigation property.|+|[Add registered users](../api/device-post-registeredusers.md) |[directoryObject](directoryobject.md) collection| Add registered users of the device .| +|[Remove registered users](../api/device-delete-registeredusers.md) |[directoryObject](directoryobject.md) collection| Remove registered users from the device .| |[Check member objects](../api/directoryobject-checkmemberobjects.md) | String collection | Check for membership in a list of groups, directory role, or administrative unit objects. | |[Get member objects](../api/directoryobject-checkmemberobjects.md) | String collection | Return all groups, administrative units, and directory roles that the device is a member of. The check is transitive. | |
v1.0 | Devicedetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/devicedetail.md | doc_type: resourcePageType Namespace: microsoft.graph -Indicates device details associated with a device used for signing in. The information includes information like device browser and operating system, and whether the device is Microsoft Entra ID managed. +Indicates details of the device used in a sign-in activity. Includes information like device browser and OS info and if the device is Microsoft Entra ID-managed. ## Properties- | Property | Type |Description| |:|:--|:-|-|browser|String|Indicates the browser information of the used for signing in.| -|deviceId|String|Refers to the UniqueID of the device used for signing in.| -|displayName|String|Refers to the name of the device used for signing in.| -|isCompliant|Boolean|Indicates whether the device is compliant.| -|isManaged|Boolean|Indicates whether the device is managed.| -|operatingSystem|String|Indicates the operating system name and version used for signing in.| -|trustType|String|Provides information about whether the signed-in device is Workplace Joined, AzureAD Joined, Domain Joined. | +|browser|String|Indicates the browser information of the used in the sign-in. Populated for devices registered in Microsoft Entra.| +|deviceId|String|Refers to the unique ID of the device used in the sign-in. Populated for devices registered in Microsoft Entra.| +|displayName|String|Refers to the name of the device used in the sign-in. Populated for devices registered in Microsoft Entra.| +|isCompliant|Boolean|Indicates whether the device is compliant or not.| +|isManaged|Boolean|Indicates if the device is managed or not.| +|operatingSystem|String|Indicates the OS name and version used in the sign-in.| +|trustType|String|Indicates information on whether the device used in the sign-in is workplace-joined, Microsoft Entra-joined, domain-joined.| ## JSON representation |
v1.0 | Directoryrole | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/directoryrole.md | doc_type: resourcePageType Namespace: microsoft.graph +> [!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 [unifiedRoleDefinition resource type](./unifiedroledefinition.md). + Represents a Microsoft Entra directory role. Microsoft Entra directory roles are also known as *administrator roles*. For more information about directory (administrator) roles, see [Assigning Microsoft Entra administrator roles](/azure/active-directory/users-groups-roles/directory-assign-admin-roles). With the Microsoft Graph, you can assign users to directory roles to grant them the permissions of the target role. To read a directory role or update its members, it must first be activated in the tenant. Only the Company Administrators directory role is activated by default. To activate other available directory roles you send a POST request with the ID of the [directoryRoleTemplate](directoryroletemplate.md) on which the directory role is based. [List directory role templates](../api/directoryroletemplate-list.md) to get all the other available directory roles. Inherits from [directoryObject](directoryobject.md). This resource supports: |
v1.0 | Directoryroletemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/directoryroletemplate.md | doc_type: resourcePageType Namespace: microsoft.graph +> [!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 [unifiedRoleDefinition resource type](./unifiedroledefinition.md). + Represents a directory role template. A directory role template specifies the property values of a directory role ([directoryRole](directoryrole.md)). There's an associated directory role template object for each of the directory roles that may be activated in a tenant. To read a directory role or update its members, it must first be activated in the tenant. Only the Company Administrators directory role is activated by default. To activate other available directory roles, you send a POST request to the `/directoryRoles` endpoint with the ID of the directory role template on which the directory role is based specified in the **roleTemplateId** parameter of the request. Upon successful completion of this request, you can then start to read and assign members to the directory role. **Note**: A directory role template is exposed for the Users directory role. The Users directory role is implicit and isn't visible to directory clients. Every User in the tenant is assigned to this role by the infrastructure. The role is already activated. Don't use this template. |
v1.0 | Domain | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domain.md | Namespace: microsoft.graph Represents a domain associated with the tenant. -Use domain operations to associate domains to a tenant, verify domain ownership, and configure supported services. Domain operations enable registrars to automate domain association for services such as Microsoft 365. For example, as part of domain sign-up, a registrar can enable a vanity domain for email, websites, authentication, etc. +Use domain operations to associate domains to a tenant, verify domain ownership, and configure supported services. 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). To associate a domain with a tenant: To associate a domain with a tenant: |[List](../api/domain-list.md) | [domain](domain.md) | Retrieve all domains linked to the tenant. | |[Create](../api/domain-post-domains.md) | [domain](domain.md) | Adds a domain to the tenant. | |[Get](../api/domain-get.md) | [domain](domain.md) | Read properties and relationships of a domain object.|+|[Get root domain](../api/domain-get-rootdomain.md) | [domain](domain.md) | Get the root domain of a subdomain.| |[Update](../api/domain-update.md) | [domain](domain.md) |Updates a domain.| |[Delete](../api/domain-delete.md) | None |Deletes a domain.| |[Force delete](../api/domain-forcedelete.md)|None|Deletes a domain using an asynchronous operation.| To associate a domain with a tenant: |availabilityStatus|String| This property is always `null` except when the [verify](../api/domain-verify.md) action is used. When the [verify](../api/domain-verify.md) action is used, a **domain** entity is returned in the response. The **availabilityStatus** property of the **domain** entity in the response is either `AvailableImmediately` or `EmailVerifiedDomainTakeoverScheduled`.| |id|String| The fully qualified name of the domain. Key, immutable, not nullable, unique. | |isAdminManaged|Boolean| The value of the property is `false` if the DNS record management of the domain is delegated to Microsoft 365. Otherwise, the value is `true`. Not nullable |-|isDefault|Boolean| `true` if this is the default domain that is used for user creation. There's only one default domain per company. Not nullable | +|isDefault|Boolean| `true` if this is the default domain that is used for user creation. There's only one default domain per company. Not nullable. | |isInitial|Boolean| `true` if this is the initial domain created by Microsoft Online Services (contoso.com). There's only one initial domain per company. Not nullable |-|isRoot|Boolean| `true` if the domain is a verified root domain. Otherwise, `false` if the domain is a subdomain or unverified. Not nullable | -|isVerified|Boolean| `true` if the domain has completed domain ownership verification. Not nullable | -|passwordNotificationWindowInDays|Int32|Specifies the number of days before a user receives notification that their password will expire. If the property isn't set, a default value of 14 days is used.| +|isRoot|Boolean| `true` if the domain is a verified root domain. Otherwise, `false` if the domain is a subdomain or unverified. Not nullable. | +|isVerified|Boolean| `true` if the domain completed domain ownership verification. Not nullable. | +|passwordNotificationWindowInDays|Int32|Specifies the number of days before a user receives notification that their password expires. If the property isn't set, a default value of 14 days is used.| |passwordValidityPeriodInDays|Int32| Specifies the length of time that a password is valid before it must be changed. If the property isn't set, a default value of 90 days is used. | |state|[domainState](domainstate.md)| Status of asynchronous operations scheduled for the domain. | |supportedServices|String collection| The capabilities assigned to the domain. Can include `0`, `1` or more of following values: `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer`, `Intune`. The values that you can add or remove using the API include: `Email`, `OfficeCommunicationsOnline`, `Yammer`. Not nullable.| Relationships between a domain and other objects in the directory such as its ve | Relationship | Type |Description| |:|:--|:-|-|domainNameReferences|[directoryObject](directoryobject.md) collection| The objects such as users and groups that reference the domain ID. Read-only, Nullable. Supports `$expand` and `$filter` by the OData type of objects returned. For example, `/domains/{domainId}/domainNameReferences/microsoft.graph.user` and `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.| -|serviceConfigurationRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Supports `$expand`. | -|verificationDnsRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Microsoft Entra ID. Read-only, Nullable. Supports `$expand`.| -|federationConfiguration|[internalDomainFederation](internaldomainfederation.md)| Domain settings configured by a customer when federated with Microsoft Entra ID. Supports `$expand`.| +|domainNameReferences|[directoryObject](directoryobject.md) collection| The objects such as users and groups that reference the domain ID. Read-only, Nullable. Doesn't support `$expand`. Supports `$filter` by the OData type of objects returned. For example, `/domains/{domainId}/domainNameReferences/microsoft.graph.user` and `/domains/{domainId}/domainNameReferences/microsoft.graph.group`.| +|federationConfiguration|[internalDomainFederation](internaldomainfederation.md)| Domain settings configured by a customer when federated with Microsoft Entra ID. Doesn't support `$expand`.| +|rootDomain|[domain](domain.md)| Root domain of a subdomain. Read-only, Nullable. Supports `$expand`.| +|serviceConfigurationRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Doesn't support `$expand`. | +|verificationDnsRecords|[domainDnsRecord](domaindnsrecord.md) collection| DNS records that the customer adds to the DNS zone file of the domain before the customer can complete domain ownership verification with Microsoft Entra ID. Read-only, Nullable. Doesn't support `$expand`.| ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Domainidentitysource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/domainidentitysource.md | doc_type: resourcePageType Namespace: microsoft.graph - Used in the identity sources of an [connectedOrganization](connectedOrganization.md). The `@odata.type` value `#microsoft.graph.domainIdentitySource` indicates that this type identifies a domain as an identity source for a connected organization. -When you're [creating a new connectedOrganization](../api/entitlementmanagement-post-connectedorganizations.md), if the caller provides in the identitySources collection a domainIdentitySource and the domain corresponds to a registered domain of a Microsoft Entra tenant, then the resulting connectedOrganization that is created has an identitySources collection containing a single member of the [azureActiveDirectoryTenant](azureactivedirectorytenant.md) type. - ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Drive | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/drive.md | Namespace: microsoft.graph The top-level object that represents a user's OneDrive or a document library in SharePoint. -OneDrive users will always have at least one drive available, their default drive. +OneDrive users always have at least one drive available, their default drive. Users without a OneDrive license may not have a default drive available. ## Methods | Method | Return type | Description | | : | :-- |-|-| [Get drive][drive-get] | drive | Get metadata about a drive | -| [Get drive root][item-get] | [driveItem][] | Get root folder of a drive | -| [List followed items][drive-following] | [driveItem][] collection | List the user's followed driveItems | -| [List children][item-children] | [driveItem][] collection | List children of the root folder of a drive | -| [List changes][item-changes] | [driveItem][] collection | List changes for all driveItems in the Drive | +|[List drive][drive-list] | drive collection |Retrieve the list of drive resources available for a target user, group, or site.| +| [Get drive][drive-get] | drive | Get metadata about a drive.| +| [Get drive root][item-get] | [driveItem][] | Get root folder of a drive.| +| [List followed items][drive-following] | [driveItem][] collection | List the user's followed driveItems.| +| [List children][item-children] | [driveItem][] collection | List children of the root folder of a drive.| +| [List changes][item-changes] | [driveItem][] collection | List changes for all driveItems in the drive.| | [Search][item-search] | [driveItem][] collection | Search for driveItems in a drive |-| [Get special folder](../api/drive-get-specialfolder.md) | [driveItem][] | Access a special folder by its canonical name | +| [Get special folder](../api/drive-get-specialfolder.md) | [driveItem][] | Access a special folder by its canonical name.| ## Properties Users without a OneDrive license may not have a default drive available. | createdBy | [identitySet][] | Identity of the user, device, or application which created the item. Read-only. | | createdDateTime | dateTimeOffset | Date and time of item creation. Read-only. | | description | String | Provide a user-visible description of the drive. Read-write.-| driveType | String | Describes the type of drive represented by this resource. OneDrive personal drives will return `personal`. OneDrive for Business will return `business`. SharePoint document libraries will return `documentLibrary`. Read-only. | +| driveType | String | Describes the type of drive represented by this resource. OneDrive personal drives return `personal`. OneDrive for Business returns `business`. SharePoint document libraries return `documentLibrary`. Read-only. | | id | String | The unique identifier of the drive. Read-only. | | lastModifiedBy | [identitySet][] | Identity of the user, device, and application which last modified the item. Read-only. | | lastModifiedDateTime | dateTimeOffset | Date and time the item was last modified. Read-only. | | name | string | The name of the item. Read-write. | | owner | [identitySet](identityset.md) | Optional. The user account that owns the drive. Read-only. | | quota | [quota](quota.md) | Optional. Information about the drive's storage space quota. Read-only. |-| sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. This property is not returned by default and must be selected using the `$select` query parameter. | -| system | [systemFacet][] | If present, indicates that this is a system-managed drive. Read-only. +| sharepointIds | [sharepointIds][] | Returns identifiers useful for SharePoint REST compatibility. Read-only. This property isn't returned by default and must be selected using the `$select` query parameter. | +| system | [systemFacet][] | If present, indicates that it's a system-managed drive. Read-only. | webUrl | string (url) | URL that displays the resource in the browser. Read-only. | [identitySet]: identityset.md Users without a OneDrive license may not have a default drive available. ## JSON representation -The following is a JSON representation of this resource. +The following JSON representation shows the resource type. The **drive** resource is derived from [**baseItem**](baseitem.md) and inherits properties from that resource. The **drive** resource is derived from [**baseItem**](baseitem.md) and inherits [drive-following]: ../api/drive-list-following.md [drive-get]: ../api/drive-get.md [item-get]: ../api/driveitem-get.md+[drive-list]: ../api/drive-list.md [item-changes]: ../api/driveitem-delta.md [item-search]: ../api/driveitem-search.md [item-children]: ../api/driveitem-list-children.md |
v1.0 | Driveprotectionrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/driveprotectionrule.md | Title: "driveProtectionRule resource type" -description: "Represents a drive protection rule associated with a OneDrive for Buisness protection policy." +description: "Represents a drive protection rule associated with a OneDrive for Business protection policy." ms.localizationpriority: medium Inherits from [protectionRuleBase](../resources/protectionrulebase.md). |createdBy|[identitySet](../resources/identityset.md) entitySet|The identity of the person who created the rule.| |createdDateTime|DateTimeOffset|The date and time that the rule was created.| |driveExpression|String|Contains a drive expression. For examples, see [driveExpression examples](../resources/driveprotectionrule.md#driveexpression-examples).|-|error|[publicError](../resources/publicerror.md)|If the operation fails, contains the details of the error.| -|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic. Static rules run once; dynamic rules listen to all changes in the system and update the protection unit list.| +|error|[publicError](../resources/publicerror.md)|If the operation fails, contain the details of the error.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Static rules run one time while dynamic rules listen to all changes in the system and update the protection unit list. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified this rule.| |lastModifiedDateTime|DateTimeOffset|The timestamp of the last modification to this rule.| |status|[protectionRuleStatus](../resources/driveprotectionrule.md#protectionrulestatus-values )|The status of the protection rule. The following are the possible values: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| The following table shows possible formats for the drive expression. |:|:| |draft | The initial status of protection rule upon creation is draft.| |active | The status of the protection rule upon using the `/run` API.|-|completed | The status of the protection rule after it is successfully applied to the corresponding policy.| -|completedWithErrors | The status of the protection rule after it is applied to the corresponding policy and any failures occurred.| -|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.| +|completed | The status of the protection rule after it's successfully applied to the corresponding policy.| +|completedWithErrors | The status of the protection rule after it's applied to the corresponding policy and any failures occurred.| +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Educationassignmentclassrecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentclassrecipient.md | This resource is a subclass of [educationAssignmentRecipient](educationassignmen None. +## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. + <!-- { "blockType": "resource", |
v1.0 | Educationassignmentgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentgrade.md | This is an abstract type that will never be instantiated; however, all types of |gradedBy|[identitySet](identityset.md)| User who did the grading. | |gradedDateTime|DateTimeOffset| Moment in time when the grade was applied to this submission object. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationassignmentgradetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentgradetype.md | Base class for [educationAssignmentPointsGradeType](../resources/educationassign None. +## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Educationassignmentindividualrecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentindividualrecipient.md | This resource is a subclass of [educationAssignmentRecipient](educationassignmen |:|:--|:-| |recipients|String collection|A collection of IDs of the recipients.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationassignmentpointsgrade | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentpointsgrade.md | which will add the who data to this property. The max points are stored in the * |gradedDateTime|DateTimeOffset| Moment in time when the grade was applied to this submission object. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |points|Single|Number of points a teacher is giving this submission object.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationassignmentpointsgradetype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentpointsgradetype.md | an [educationAssignmentPointsGrade](educationassignmentpointsgrade.md) property |:|:--|:-| |maxPoints|Single| Max points possible for this assignment. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationassignmentrecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationassignmentrecipient.md | The [educationAssignmentClassRecipient](educationassignmentclassrecipient.md) an ## Properties None. +## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Educationcategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationcategory.md | A category that can be applied to assignments. |displayName|String|Unique identifier for the category.| |id|String|Unique identifier for the category.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationchannelresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationchannelresource.md | A subclass of [educationResource](educationresource.md) that represents a Micros | :- | :-- | : | | url | String | URL of the channel resource. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationexcelresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationexcelresource.md | or submission object to which this resource belongs. |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource.| |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationexternalresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationexternalresource.md | This complex type allows all SDK callers to work seamlessly. |displayName|string|The display name of the resource.| |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource.| |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|-|webUrl|String|Location of the resource. Required| +|webUrl|String|Location of the resource. Required.| ++## Relationships ++None. ## JSON representation The following JSON representation shows the resource type.- <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Educationfeedback | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationfeedback.md | This property represents both the text part of the feedback along with who provi |feedbackDateTime|DateTimeOffset|Moment in time when the feedback was given. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`| |text|[itemBody](itembody.md)|Feedback.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationfileresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationfileresource.md | In this case, the file isn't one of the special files (Word, Excel, and so on) b |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource.| |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationlinkedassignmentresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationlinkedassignmentresource.md | A subclass of [educationResource](educationresource.md) that represents a link t | :- | :-- | :- | | url | String | URL of the actual assignment. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationlinkresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationlinkresource.md | This resource is a link and doesn't have any other data associated with it. |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |link|String|URL to the resource.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationmediaresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationmediaresource.md | The following file types are media resources: `webm`, `mkv`, `avi`, `wmv`, `mp4` |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource| |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationpowerpointresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationpowerpointresource.md | assignment or submission. |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource.| |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationresource.md | This resource stores the common properties across all resource types. |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource.| |lastModifiedDateTime|DateTimeOffset|Moment in time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationsubmission | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationsubmission.md | If [setUpResourcesFolder](../api/educationsubmission-setupResourcesFolder.md) ha ## Properties | Property | Type |Description| |:|:--|:-|-|id|String|Unique identifier for the submission.| |excusedBy|[identitySet](identityset.md)| The user that marked the submission as excused.| |excusedDateTime|DateTimeOffset|The time that the submission was excused. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|+|id|String|Unique identifier for the submission.| |reassignedBy|[identitySet](identityset.md)|User who moved the status of this submission to reassigned.| |reassignedDateTime|DateTimeOffset|Moment in time when the submission was reassigned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |recipient|[educationSubmissionRecipient](educationsubmissionrecipient.md)|Who this submission is assigned to.| The following JSON representation shows the resource type. ```json {+ "excusedBy": {"@odata.type":"microsoft.graph.identitySet"}, + "excusedDateTime": "String (timestamp)", "id": "String (identifier)", "reassignedBy": {"@odata.type":"microsoft.graph.identitySet"}, "reassignedDateTime": "String (timestamp)", |
v1.0 | Educationsubmissionindividualrecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationsubmissionindividualrecipient.md | A subclass of [educationSubmissionRecipient](educationsubmissionrecipient.md) th |:|:--|:-| |userId|String|User ID of the user to whom the submission is assigned.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Educationsubmissionrecipient | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationsubmissionrecipient.md | Possible values include individuals or groups. This is used within the **submiss ## Properties None. +## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Educationteamsappresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationteamsappresource.md | Inherits from [educationResource](educationresource.md). | teamsEmbeddedContentUrl | String | URL for the app resource that will be opened by Teams. | | webUrl | String | URL for the app resource that can be opened in the browser. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.- <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Educationwordresource | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/educationwordresource.md | assignment or submission. |lastModifiedBy|[identitySet](identityset.md)|The last user to modify the resource.| |lastModifiedDateTime|DateTimeOffset|The date and time when the resource was last modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Employeeexperience | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/employeeexperience.md | Title: "employeeExperience resource type" description: "Represents a container that exposes navigation properties for employee experience resources." ms.localizationpriority: medium-+ doc_type: resourcePageType Represents a container that exposes navigation properties for employee experienc |Method|Return type|Description| |:|:|:|-|[List](../api/employeeexperience-list-learningproviders.md)|[learningProvider](../resources/learningprovider.md) collection|Get a list of the [learningProvider](../resources/learningprovider.md) resources registered in Viva Learning for a tenant.| -|[Create](../api/employeeexperience-post-learningproviders.md)|[learningProvider](../resources/learningprovider.md)|Create a new [learningProvider](../resources/learningprovider.md) object and register it with Viva Learning using the specified display name and logos for different themes.| +|[List communities](../api/employeeexperience-list-communities.md)|[community](../resources/community.md) collection|Get a list of the Viva Engage [community](../resources/community.md) objects and their properties.| +|[Create community](../api/employeeexperience-post-communities.md)|[community](../resources/community.md)|Create a new [community](../resources/community.md) in Viva Engage.| +|[List learningProviders](../api/employeeexperience-list-learningproviders.md)|[learningProvider](../resources/learningprovider.md) collection|Get a list of the [learningProvider](../resources/learningprovider.md) resources registered in Viva Learning for a tenant.| +|[Create learningProvider](../api/employeeexperience-post-learningproviders.md)|[learningProvider](../resources/learningprovider.md)|Create a new [learningProvider](../resources/learningprovider.md) object and register it with Viva Learning using the specified display name and logos for different themes.| ## Properties None. |Relationship|Type|Description| |:|:|:|+|communities|[community](../resources/community.md) collection| A collection of communities in Viva Engage. | +|engagementAsyncOperations|[engagementAsyncOperation](../resources/engagementasyncoperation.md) collection| A collection of long-running, asynchronous operations related to Viva Engage. | |learningProviders|[learningProvider](../resources/learningprovider.md) collection|A collection of learning providers.| ## JSON representation |
v1.0 | Employeeorgdata | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/employeeorgdata.md | description: "Represents organization data associated with a user." ms.localizationpriority: medium doc_type: resourcePageType -+ # employeeOrgData resource type |
v1.0 | Engagement Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/engagement-api-overview.md | + + Title: "Use the Microsoft Graph API to work with Viva Engage" +description: "The Microsoft Graph API enables apps to manage communities in Viva Engage." +ms.localizationpriority: medium +++++# Use the Microsoft Graph API to work with Viva Engage ++The Microsoft Graph API enables apps to manage communities in Viva Engage. Viva Engage is a social fabric for the Microsoft Viva suite of apps that connects people across the organization to share and learn. It's a place where employees can connect with leaders, coworkers, and communities, share their knowledge and ideas, and find belonging at work. ++> [!IMPORTANT] +> The Viva Engage API in Microsoft Graph is only supported for Viva Engage networks in [native mode](/viva/engage/overview-native-mode). You can't use this API to manage legacy or external Viva Engage networks. ++## Authorization ++To call the Viva Engage API in Microsoft Graph, your app needs to acquire an access token. For details about access tokens, see [Get access tokens to call Microsoft Graph](/graph/auth/). Your app also needs the appropriate permissions. For more information, see [Microsoft Graph permissions reference](/graph/permissions-reference). ++## Common use cases ++The following table lists common use cases for the Viva Engage API. ++| Use case | API | Notes | +|:--|:--|:--| +| Create a community | [POST /employeeExperience/communities](../api/employeeexperience-post-communities.md) | If successful, this method returns a `202 Accepted` response code that contains a link to an [engagementAsyncOperation](../resources/engagementasyncoperation.md) object. | +| Poll for community creation status | [GET /employeeExperience/engagementAsyncOperations/{engagementAsyncOperationId}](../api/engagementasyncoperation-get.md) | If successful, this method returns a `200 OK` response code and an [engagementAsyncOperation](../resources/engagementasyncoperation.md) object in the response body. Periodically check the status of the operation by making a GET request to this location; wait >30 seconds between checks. When the request completes successfully, the **status** indicates `succeeded` and the **resourceLocation** points to the created or modified resource. | +| Get a community after creation | [GET /employeeExperience/communities/{communityId}](../api/community-get.md) | If successful, this method returns a `200 OK` response code and a [community](../resources/community.md) object in the response body. The community object references the associated [Microsoft 365 group](../resources/group.md) ID that you can use for community membership and ownership management. | +| Get a list of communities | [GET /employeeExperience/communities](../api/employeeexperience-list-communities.md) | If successful, this method returns a `200 OK` response code and a collection of Viva Engage [community](../resources/community.md) objects in the response body.| +| Update a community | [PATCH /employeeExperience/communities/{communityId}](../api/community-update.md) | If successful, this method updates an existing Viva Engage [community](../resources/community.md) and returns a `204 No Content` response code. | +| Delete a community | [DELETE /employeeExperience/communities/{communityId}](../api/community-delete.md) | If successful, this method deletes a Viva Engage [community](../resources/community.md) along with all associated Microsoft 365 content, including the connected Microsoft 365 group, OneNote notebook, and Planner plans. For more information, see [What happens if I delete a Viva Engage community connected to Microsoft 365 groups](/viva/engage/engage-microsoft-365-groups#q-what-happens-if-i-delete-a-viva-engage-community-connected-to-microsoft-365-groups). | +| Add members to a community | [POST /groups/{groupId}/members/$ref](../api/group-post-members.md) | When new members are added to a group, the associated membership of the community is automatically updated. | +| Remove a member from a community | [DELETE /groups/{groupId}/members/{userId}/$ref](../api/group-delete-members.md) | When a member is removed from a group, the associated membership of the community is automatically updated. | +| Add a community admin | [POST /groups/{groupId}/owners/$ref](../api/group-post-owners.md) | When a user is added as a group owner, they automatically become an admin of the associated community. | +| Remove a community admin | [DELETE /groups/{groupId}/owners/{userId}/$ref](../api/group-delete-owners.md) | When a group owner is removed, they stop being admin for the associated community. You can't remove the last owner ([user](../resources/user.md) object) of a group. | ++## Communities and groups ++For Viva Engage networks in native mode, the creation of a new Viva Engage community also results in the creation of a connected Microsoft 365 group, along with a new SharePoint site, OneNote notebook, and Planner plan. Use the associated group to manage operations on a community, for example: ++* Add or remove group members +* Manage group ownership +* Delete a group +* Rename a group +* Update the group description ++For more information about the relationship between Viva Engage communities and Microsoft 365 groups, see [Viva Engage and Microsoft 365 Groups](/viva/engage/engage-microsoft-365-groups). ++>**Note:** You can't use the [Create group](../api/group-post-groups.md) API to provision a Viva Engage community. ++## API limits ++Viva Engage API calls are subject to rate limiting, allowing 10 requests per user, per app, within a 30-second time period. When you exceed the rate limit, all subsequent requests return a `429 Too Many Requests` response code. ++For guidance on how to handle throttling in Microsoft Graph, see [Microsoft Graph throttling guidance](/graph/throttling). ++## Next steps ++- Use the Microsoft Graph API to manage communities in Viva Engage. +- Try the Viva Engage API in the [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). |
v1.0 | Engagementasyncoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/engagementasyncoperation.md | + + Title: "engagementAsyncOperation resource type" +description: "Represents the status of a Viva Engage async operation that is an operation that transcends the lifetime of a single API request." ++ms.localizationpriority: medium ++++# engagementAsyncOperation resource type ++Namespace: microsoft.graph ++Represents the status of a Viva Engage async operation that is an operation that transcends the lifetime of a single API request. These operations are long-running or too expensive to complete within the time frame of their original request. ++When an async operation is initiated, the method returns a `202 Accepted` response code and an `Operation-Location` header that contains the location of the **engagementAsyncOperation**. Periodically check the status of the operation by making a GET request to this location; wait >30 seconds between checks. When the request completes successfully, the operation **status** indicates `succeeded` and the **resourceLocation** points to the created or modified resource. ++Inherits from [longRunningOperation](../resources/longrunningoperation.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +| [Get](../api/engagementasyncoperation-get.md) | [engagementAsyncOperation](../resources/engagementasyncoperation.md) | Get an [engagementAsyncOperation](../resources/engagementasyncoperation.md) to track a long-running operation request. | ++## Properties ++|Property|Type|Description| +|:|:|:| +| createdDateTime | DateTimeOffset | Date and time when the operation was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [longRunningOperation](../resources/longrunningoperation.md). | +| id | String | The unique identifier for the operation. Inherited from [longRunningOperation](../resources/longrunningoperation.md). | +| lastActionDateTime | DateTimeOffset | Date and time when the async operation was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [longRunningOperation](../resources/longrunningoperation.md). | +| operationType | [engagementAsyncOperationType](../resources/engagementasyncoperation.md#engagementasyncoperationtype-values) | The type of the long-running operation. The possible values are: `createCommunity`, `unknownFutureValue`. | +| resourceId | String | The ID of the object created or modified as a result of this async operation. | +| resourceLocation |String| The location of the object created or modified as a result of this async operation. Inherited from [longRunningOperation](../resources/longrunningoperation.md). | +| status | longRunningOperationStatus | The status of the operation. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `skipped`, `unknownFutureValue`. Inherited from [longRunningOperation](../resources/longrunningoperation.md). | +| statusDetail | String | Details about the status of the operation. Inherited from [longRunningOperation](../resources/longrunningoperation.md). | ++### engagementAsyncOperationType values ++| Member | Description | +|:|:-| +| createCommunity | Operation to create a Viva Engage community. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ++## JSON representation ++The following JSON representation shows the resource type. ++<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.engagementAsyncOperation", + "baseType": "microsoft.graph.longRunningOperation", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.engagementAsyncOperation", + "createdDateTime": "String (timestamp)", + "id": "String (identifier)", + "lastActionDateTime": "String (timestamp)", + "operationType": "String", + "resourceId": "String", + "resourceLocation": "String", + "status": "String", + "statusDetail": "String" +} +``` |
v1.0 | Entitlementmanagementschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/entitlementmanagementschedule.md | Title: "entitlementManagementSchedule resource type" -description: "An entitlement management schedule can be included in an access package assignment request and is present in an access package assignment, and is also used for access reviews schedules in a policy." +description: "An entitlement management schedule can be included in an access package assignment request and is present in an access package assignment. It's also used for access reviews schedules in a policy." ms.localizationpriority: medium doc_type: resourcePageType -# entitlementManagementSchedule complex type +# entitlementManagementSchedule resource type Namespace: microsoft.graph -The entitlement management schedule is used in three scenarios in [Microsoft Entra entitlement management](entitlementmanagement-overview.md). First, when an access package assignment request is created by a user who wants to obtain an access package assignment, this request can include a schedule for when the user would like to have an assignment. Second, an access package assignment that results from such a request also has a schedule. Third, the `entitlementManagementSchedule` is also used in the [accessPackageAssignmentReviewSettings](accesspackageassignmentreviewsettings.md) of an assignment policy, to specify when the first access review will start and how often access reviews should reoccur. +The entitlement management schedule is used in three scenarios in [Microsoft Entra entitlement management](entitlementmanagement-overview.md). First, when a user creates an access package assignment request, the request can include a schedule for when the user wants an assignment. Second, an access package assignment that results from such a request also has a schedule. Third, the `entitlementManagementSchedule` is also used in the [accessPackageAssignmentReviewSettings](accesspackageassignmentreviewsettings.md) of an assignment policy, to specify when the first access review starts and how often access reviews should reoccur. ## Properties |Property|Type|Description| |:|:|:|-|expiration|[expirationPattern](../resources/expirationpattern.md)|When the access should expire.| -|recurrence|[patternedRecurrence](../resources/patternedrecurrence.md)|For recurring access reviews. Not used in access requests.| +|expiration|[expirationPattern](../resources/expirationpattern.md)| When the access should expire. | +|recurrence|[patternedRecurrence](../resources/patternedrecurrence.md)|The recurring access review pattern. Not used in access requests.| |startDateTime|DateTimeOffset|The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| ## Relationships |
v1.0 | Enums Identitygovernance | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/enums-identitygovernance.md | Namespace: microsoft.graph.identityGovernance |employeeLeaveDateTime| |unknownFutureValue| +### membershipChangeType values ++++|Member| +|:| +|add| +|remove| +|unknownFutureValue| ++ <!-- { |
v1.0 | Enums | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/enums.md | Namespace: microsoft.graph |boolean| |unknownFutureValue| -## fileStorageContainerStatus values +### fileStorageContainerStatus values | Member | | -- | Namespace: microsoft.graph | active | | unknownfuturevalue | -## binaryOperator values +### binaryOperator values | Member | | - | | or | | and | -## entityType values +### entityType values | Member | | - | Namespace: microsoft.graph | acronym | | bookmark | -## conditionalAccessExternalTenantsMembershipKind values +### conditionalAccessExternalTenantsMembershipKind values | Member | | -- | Namespace: microsoft.graph | enumerated | | unknownFutureValue | -## conditionalAccessGuestOrExternalUserTypes values +### conditionalAccessGuestOrExternalUserTypes values | Member | | | Namespace: microsoft.graph | serviceProvider | | unknownFutureValue | -## migrationStatus values +### migrationStatus values | Member | | - | Namespace: microsoft.graph | additionalStepsRequired | | unknownFutureValue | -## appCredentialRestrictionType values +### appManagementRestrictionState values ++| Member | +| - | +| enabled | +| disabled | +| unknownFutureValue | ++### appCredentialRestrictionType values | Member | | -- | Namespace: microsoft.graph | symmetricKeyLifetime | | unknownFutureValue | -## appKeyCredentialRestrictionType values +### appKeyCredentialRestrictionType values | Member | | | | asymmetricKeyLifetime | | unknownFutureValue | -## assignmentType values +### assignmentType values | Member | | -- | Namespace: microsoft.graph | unknownFutureValue | | peerRecommeded | -## courseStatus values +### courseStatus values | Member | | | Namespace: microsoft.graph | inProgress | | completed | -## userPurpose values +### userPurpose values | Member | | | Namespace: microsoft.graph | others | | unknownFutureValue | -## bookingsAvailabilityStatus values +### bookingsAvailabilityStatus values | Member | | | Namespace: microsoft.graph | outOfOffice | | unknownFutureValue | -## signInFrequencyAuthenticationType values +### signInFrequencyAuthenticationType values | Member | | | Namespace: microsoft.graph | secondaryAuthentication | | unknownFutureValue | -## signInFrequencyInterval values +### signInFrequencyInterval values | Member | | | | timeBased | | everyTime | -## crossTenantAccessPolicyTargetConfigurationAccessType values +### crossTenantAccessPolicyTargetConfigurationAccessType values | Member | | | Namespace: microsoft.graph | blocked | | unknownFutureValue | -## crossTenantAccessPolicyTargetType values +### crossTenantAccessPolicyTargetType values | Member | | | Namespace: microsoft.graph | application | | unknownFutureValue | -## multiTenantOrganizationMemberProcessingStatus values +### multiTenantOrganizationMemberProcessingStatus values | Member | | - | Namespace: microsoft.graph | failed | | unknownFutureValue | -## multiTenantOrganizationMemberRole values +### multiTenantOrganizationMemberRole values | Member | | - | Namespace: microsoft.graph | member | | unknownFutureValue | -## multiTenantOrganizationMemberState values +### multiTenantOrganizationMemberState values | Member | | - | Namespace: microsoft.graph | removed | | unknownFutureValue | -## multiTenantOrganizationState values +### multiTenantOrganizationState values | Member | | - | Namespace: microsoft.graph | inactive | | unknownFutureValue | -## templateApplicationLevel values +### templateApplicationLevel values | Member | | - | Namespace: microsoft.graph | existingPartners | | unknownFutureValue | -## federatedIdpMfaBehavior values +### federatedIdpMfaBehavior values | Member | | -- | Namespace: microsoft.graph | rejectMfaByFederatedIdp | | unknownFutureValue | -## promptLoginBehavior values +### promptLoginBehavior values | Member | | -- | Namespace: microsoft.graph | disabled | | unknownFutureValue | -## expirationPatternType values +### expirationPatternType values | Member | | - | Namespace: microsoft.graph | afterDateTime | | afterDuration | -## recurrencePatternType values +### recurrencePatternType values | Member | | | Namespace: microsoft.graph | absoluteYearly | | relativeYearly | -## assignmentScheduleFilterByCurrentUserOptions values +### assignmentScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## assignmentScheduleInstanceFilterByCurrentUserOptions values +### assignmentScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## assignmentScheduleRequestFilterByCurrentUserOptions values +### assignmentScheduleRequestFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | approver | | unknownFutureValue | -## eligibilityScheduleFilterByCurrentUserOptions values +### eligibilityScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## eligibilityScheduleInstanceFilterByCurrentUserOptions values +### eligibilityScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## eligibilityScheduleRequestFilterByCurrentUserOptions values +### eligibilityScheduleRequestFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | approver | | unknownFutureValue | -## privilegedAccessGroupAssignmentType values +### privilegedAccessGroupAssignmentType values | Member | | | Namespace: microsoft.graph | activated | | unknownFutureValue | -## privilegedAccessGroupMemberType values +### privilegedAccessGroupMemberType values | Member | | | Namespace: microsoft.graph | group | | unknownFutureValue | -## privilegedAccessGroupRelationships values +### privilegedAccessGroupRelationships values | Member | | | Namespace: microsoft.graph | member | | unknownFutureValue | -## scheduleRequestActions values +### scheduleRequestActions values | Member | | | Namespace: microsoft.graph | selfRenew | | unknownFutureValue | -## roleAssignmentScheduleFilterByCurrentUserOptions values +### roleAssignmentScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## roleAssignmentScheduleInstanceFilterByCurrentUserOptions values +### roleAssignmentScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## roleAssignmentScheduleRequestFilterByCurrentUserOptions values +### roleAssignmentScheduleRequestFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | approver | | unknownFutureValue | -## roleEligibilityScheduleFilterByCurrentUserOptions values +### roleEligibilityScheduleFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## roleEligibilityScheduleInstanceFilterByCurrentUserOptions values +### roleEligibilityScheduleInstanceFilterByCurrentUserOptions values | Member | | | | principal | | unknownFutureValue | -## roleEligibilityScheduleRequestFilterByCurrentUserOptions values +### roleEligibilityScheduleRequestFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | approver | | unknownFutureValue | -## unifiedRoleManagementPolicyRuleTargetOperations values +### unifiedRoleManagementPolicyRuleTargetOperations values | Member | | | Namespace: microsoft.graph | renew | | unknownFutureValue | -## userSignInRecommendationScope values +### userSignInRecommendationScope values | Member | | | Namespace: microsoft.graph | application | | unknownFutureValue | -## unifiedRoleScheduleRequestActions values +### unifiedRoleScheduleRequestActions values | Member | | | Namespace: microsoft.graph | selfRenew | | unknownFutureValue | -## approvalFilterByCurrentUserOptions values +### approvalFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | approver | | unknownFutureValue | -## accessReviewExpirationBehavior values +### accessReviewExpirationBehavior values | Member | | -- | Namespace: microsoft.graph | acceptAccessRecommendation | | unknownFutureValue | -## allowedTargetScope values +### allowedTargetScope values | Member | | | Namespace: microsoft.graph | allExternalUsers | | unknownFutureValue | -## accessPackageAssignmentFilterByCurrentUserOptions values +### accessPackageAssignmentFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | createdBy | | unknownFutureValue | -## accessPackageAssignmentRequestFilterByCurrentUserOptions values +### accessPackageAssignmentRequestFilterByCurrentUserOptions values | Member | | | Namespace: microsoft.graph | approver | | unknownFutureValue | -## accessPackageAssignmentState values +### accessPackageAssignmentState values | Member | | | Namespace: microsoft.graph | deliveryFailed | | unknownFutureValue | -## accessPackageCatalogState values +### accessPackageCatalogState values | Member | | | Namespace: microsoft.graph | published | | unknownFutureValue | -## accessPackageCatalogType values +### accessPackageCatalogType values | Member | | | Namespace: microsoft.graph | serviceManaged | | unknownFutureValue | -## accessPackageExternalUserLifecycleAction values +### accessPackageExternalUserLifecycleAction values | Member | | -- | Namespace: microsoft.graph | blockSignInAndDelete | | unknownFutureValue | -## accessPackageFilterByCurrentUserOptions values +### accessPackageFilterByCurrentUserOptions values | Member | | | | allowedRequestor | | unknownFutureValue | -## accessPackageRequestState values +### accessPackageRequestState values | Member | | | Namespace: microsoft.graph | partiallyDelivered | | unknownFutureValue | -## accessPackageRequestType values +### accessPackageRequestType values | Member | | | Namespace: microsoft.graph | onBehalfAdd | | unknownFutureValue | -## accessPackageSubjectType values +### accessPackageSubjectType values | Member | | | Namespace: microsoft.graph | servicePrincipal | | unknownFutureValue | -## connectedOrganizationState values +### connectedOrganizationState values | Member | | - | | configured | | proposed | -## accessReviewInstanceDecisionItemFilterByCurrentUserOptions values +### accessReviewInstanceDecisionItemFilterByCurrentUserOptions values | Member | | | | reviewer | | unknownFutureValue | -## accessReviewStageFilterByCurrentUserOptions values +### accessReviewStageFilterByCurrentUserOptions values | Member | | | | reviewer | | unknownFutureValue | -## accessPackageCustomExtensionStage values +### accessPackageCustomExtensionStage values | Member | | - | Namespace: microsoft.graph | assignmentOneDayBeforeExpiration | | unknownFutureValue | -## customExtensionCalloutInstanceStatus values +### customExtensionCalloutInstanceStatus values | Member | | - | Namespace: microsoft.graph | waitingForCallback | | unknownFutureValue | -## volumeType values +### volumeType values | Member | | | Namespace: microsoft.graph | removableDataVolume | | unknownFutureValue | -## filterMode values +### filterMode values | Member | | - | | include | | exclude | -## lifecycleEventType values +### lifecycleEventType values | Member | | -- | Namespace: microsoft.graph | subscriptionRemoved | | reauthorizationRequired | -## changeType values +### changeType values | Member | | - | | clientIpAddress | | authenticatorAppGps | -## countryLookupMethodType values +### countryLookupMethodType values | Member | | - | | clientIpAddress | | authenticatorAppGps | -## consentRequestFilterByCurrentUserOptions values +### consentRequestFilterByCurrentUserOptions values | Member | | | | reviewer | | unknownFutureValue | -## educationFeedbackResourceOutcomeStatus values +### educationFeedbackResourceOutcomeStatus values | Member | | | Namespace: microsoft.graph | failedPublish | | unknownFutureValue | -## externalEmailOtpState values +### externalEmailOtpState values | Member | | | Namespace: microsoft.graph | disabled | | unknownFutureValue | -## educationAddedStudentAction values +### educationAddedStudentAction values | Member | | | Namespace: microsoft.graph | assignIfOpen | | unknownFutureValue | -## educationModuleStatus values +### educationModuleStatus values | Member | | | | draft | | published | -## fido2RestrictionEnforcementType values +### fido2RestrictionEnforcementType values | Member | | | | allow | | block | -## x509CertificateAuthenticationMode values +### x509CertificateAuthenticationMode values | Member | | | Namespace: microsoft.graph | x509CertificateMultiFactor | | unknownFutureValue | -## x509CertificateRuleType values +### x509CertificateRuleType values | Member | | | Namespace: microsoft.graph | policyOID | | unknownFutureValue | -## attestationLevel values +### attestationLevel values | Member | | -- | | attested | | notAttested | -## authenticationMethodTargetType values +### authenticationMethodTargetType values | Member | | | | user | | group | -## authenticationMethodState values +### authenticationMethodState values | Member | | -- | | enabled | | disabled | -## microsoftAuthenticatorAuthenticationMode values +### microsoftAuthenticatorAuthenticationMode values | Member | | | Namespace: microsoft.graph | push | | deviceBasedPush | -## keyStrength values +### keyStrength values | Member | | - | Namespace: microsoft.graph | weak | | unknown | -## authenticationMethodKeyStrength values +### authenticationMethodKeyStrength values | Member | | - | Namespace: microsoft.graph | weak | | unknown | -## allowInvitesFrom values +### allowInvitesFrom values | Member | | -- | Namespace: microsoft.graph | everyone | | unknownFutureValue | -## dataPolicyOperationStatus values +### dataPolicyOperationStatus values | Member | | | Namespace: microsoft.graph | failed | | unknownFutureValue | -## conditionalAccessDevicePlatform values +### conditionalAccessDevicePlatform values | Member | | | Namespace: microsoft.graph | all | | unknownFutureValue | -## signinFrequencyType values +### signinFrequencyType values | Member | | | | days | | hours | -## persistentBrowserSessionMode values +### persistentBrowserSessionMode values | Member | | | | always | | never | -## cloudAppSecuritySessionControlType values +### cloudAppSecuritySessionControlType values | Member | | | Namespace: microsoft.graph | blockDownloads | | unknownFutureValue | -## conditionalAccessGrantControl values +### conditionalAccessGrantControl values | Member | | -- | Namespace: microsoft.graph | passwordChange | | unknownFutureValue | -## conditionalAccessClientApp values +### conditionalAccessClientApp values | Member | | | Namespace: microsoft.graph | other | | unknownFutureValue | -## conditionalAccessPolicyState values +### conditionalAccessPolicyState values | Member | | | Namespace: microsoft.graph | disabled | | enabledForReportingButNotEnforced | -## deviceProfileType values +### deviceProfileType values | Member | | - | Namespace: microsoft.graph | Shared | | IoT | -## appliedConditionalAccessPolicyResult values +### appliedConditionalAccessPolicyResult values | Member | | | Namespace: microsoft.graph | unknown | | unknownFutureValue | -## groupType values +### groupType values | Member | | | Namespace: microsoft.graph | azureAD | | unknownFutureValue | -## conditionalAccessStatus values +### conditionalAccessStatus values | Member | | | Namespace: microsoft.graph | notApplied | | unknownFutureValue | -## templateScenarios values +### templateScenarios values | Member | | | Namespace: microsoft.graph | emergingThreats | | unknownFutureValue | -## operationResult values +### operationResult values | Member | | | Namespace: microsoft.graph | timeout | | unknownFutureValue | -## tone values +### tone values | Member | | | Namespace: microsoft.graph | d | | flash | -## mediaState values +### mediaState values | Member | | | Namespace: microsoft.graph | inactive | | unknownFutureValue | -## basicStatus values +### basicStatus values | Member | | -- | | active | | inactive | -## callState values +### callState values | Member | | - | Namespace: microsoft.graph | terminating | | terminated | -## callType values +### callType values | Member | | | Namespace: microsoft.graph | peerToPeer | | unknownFutureValue | -## educationAddToCalendarOptions values +### educationAddToCalendarOptions values | Member | | | Namespace: microsoft.graph | unknownFutureValue | | studentsOnly | -## educationSubmissionStatus values +### educationSubmissionStatus values | Member | | | Namespace: microsoft.graph | unknownFutureValue | | reassigned | -## onlineMeetingRole values +### onlineMeetingRole values | Member | | | Namespace: microsoft.graph | presenter | | unknownFutureValue | -## modality values +### modality values | Member | | -- | Namespace: microsoft.graph | screenSharing | | unknownFutureValue | -## endpointType values +### endpointType values | Member | | - | Namespace: microsoft.graph | skypeForBusinessVoipPhone | | unknownFutureValue | -## callDirection values +### callDirection values | Member | | -- | | incoming | | outgoing | -## signInAudience values +### signInAudience values | Member | | - | Namespace: microsoft.graph | AzureADandPersonalMicrosoftAccount | | PersonalMicrosoftAccount | -## groupMembershipClaims values +### groupMembershipClaims values | Member | | - | Namespace: microsoft.graph | SecurityGroup | | All | -## recipientScopeType values +### recipientScopeType values | Member | | | Namespace: microsoft.graph | externalPartner | | externalNonPartner | -## activityType values +### activityType values | Member | | | Namespace: microsoft.graph | unknownFutureValue | | servicePrincipal | -## riskDetectionTimingType values +### riskDetectionTimingType values | Member | | | Namespace: microsoft.graph | offline | | unknownFutureValue | -## tokenIssuerType values +### tokenIssuerType values | Member | | -- | Namespace: microsoft.graph | ADFederationServices | | UnknownFutureValue | -## attachmentType values +### attachmentType values | Member | | | Namespace: microsoft.graph | item | | reference | -## contactRelationship values +### contactRelationship values | Member | Value | Description | | | -- | - | Namespace: microsoft.graph | other | 6 | An unspecified relationship to the user. | | unknownFutureValue | 7 | Marker value for future compatibility. | -## scheduleEntityTheme values +### scheduleEntityTheme values | Member | | -- | Namespace: microsoft.graph | darkYellow | | unknownFutureValue | -## timeOffReasonIconType values +### timeOffReasonIconType values | Member | | | Namespace: microsoft.graph | sunny | | unknownFutureValue | -## windowsSettingType values +### windowsSettingType values Possible types of Windows settings. Possible types of Windows settings. | backup | | unknownFutureValue | -## workforceIntegrationEncryptionProtocol values +### workforceIntegrationEncryptionProtocol values | Member | | -- | | sharedSecret | | unknownFutureValue | -## workforceIntegrationSupportedEntities values +### workforceIntegrationSupportedEntities values | Member | | -- | Possible types of Windows settings. | offerShiftRequest | | unknownFutureValue | -## timeZoneStandard values +### timeZoneStandard values | Member | | | | windows | | iana | -## freeBusyStatus values +### freeBusyStatus values | Member | Value | | - | -- | Possible types of Windows settings. | workingElsewhere | 4 | | unknown | -1 | -## attendeeType values +### attendeeType values | Member | | -- | Possible types of Windows settings. | optional | | resource | -## externalAudienceScope values +### externalAudienceScope values | Member | | -- | Possible types of Windows settings. | contactsOnly | | all | -## automaticRepliesStatus values +### automaticRepliesStatus values | Member | | -- | Possible types of Windows settings. | alwaysEnabled | | scheduled | -## calendarColor values +### calendarColor values | Member | Value | | -- | -- | Possible types of Windows settings. | lightRed | 8 | | maxColor | 9 | -## educationExternalSource values +### educationExternalSource values | Member | | | Possible types of Windows settings. | manual | | unknownFutureValue | -## educationGender values +### educationGender values | Member | | -- | Possible types of Windows settings. | other | | unknownFutureValue | -## eventType values +### eventType values | Member | | -- | Possible types of Windows settings. | exception | | seriesMaster | -## sensitivity values +### sensitivity values | Member | | -- | Possible types of Windows settings. | private | | confidential | -## importance values +### importance values | Member | | -- | Possible types of Windows settings. | normal | | high | -## educationUserRole values +### educationUserRole values | Member | | | Possible types of Windows settings. | none | | unknownFutureValue | -## meetingMessageType values +### meetingMessageType values | Member | | | Possible types of Windows settings. | meetingTenativelyAccepted | | meetingDeclined | -## followupFlagStatus values +### followupFlagStatus values | Member | | -- | Possible types of Windows settings. | complete | | flagged | -## inferenceClassificationType values +### inferenceClassificationType values | Member | | | | focused | | other | -## iosNotificationAlertType values +### iosNotificationAlertType values | Member | | -- | Possible types of Windows settings. | modal | | none | -## deviceEnrollmentFailureReason values +### deviceEnrollmentFailureReason values | Member | | -- | Possible types of Windows settings. | enrollmentRestrictionsEnforced | | clientDisconnected | -## bodyType values +### bodyType values | Member | | - | | text | | html | -## locationType values +### locationType values | Member | | -- | Possible types of Windows settings. | localBusiness | | postalAddress | -## locationUniqueIdType values +### locationUniqueIdType values | Member | | -- | Possible types of Windows settings. | private | | bing | -## messageActionFlag values +### messageActionFlag values | Member | | -- | Possible types of Windows settings. | replyToAll | | review | -## onenoteUserRole values +### onenoteUserRole values | Member | Value | | -- | -- | Possible types of Windows settings. | Reader | 2 | | None | -1 | -## operationStatus values +### operationStatus values | Member | | | Possible types of Windows settings. | Completed | | Failed | -## onenotePatchActionType values +### onenotePatchActionType values | Member | | -- | Possible types of Windows settings. | Insert | | Prepend | -## onenotePatchInsertPosition values +### onenotePatchInsertPosition values | Member | | -- | | After | | Before | -## phoneType values +### phoneType values | Member | | -- | Possible types of Windows settings. | pager | | radio | -## plannerContainerType values +### plannerContainerType values | Member | | | Possible types of Windows settings. | unknownFutureValue | | roster | -## plannerPreviewType values +### plannerPreviewType values | Member | | -- | Possible types of Windows settings. | description | | reference | -## status values +### status values | Member | | | Possible types of Windows settings. | ignored | | unknownFutureValue | -## weekIndex values +### weekIndex values | Member | | -- | Possible types of Windows settings. | fourth | | last | -## dayOfWeek values +### dayOfWeek values | Member | | -- | Possible types of Windows settings. | friday | | saturday | -## recurrenceRangeType values +### recurrenceRangeType values | Member | | -- | Possible types of Windows settings. | noEnd | | numbered | -## onenoteSourceService values +### onenoteSourceService values | Member | | - | Possible types of Windows settings. | OneDriveForBusiness | | OnPremOneDriveForBusiness | -## responseType values +### responseType values | Member | | -- | Possible types of Windows settings. | declined | | notResponded | -## activityDomain values +### activityDomain values | Member | | -- | Possible types of Windows settings. | personal | | unrestricted | -## websiteType values +### websiteType values | Member | | -- | Possible types of Windows settings. | blog | | profile | -## categoryColor values +### categoryColor values | Member | Value | | -- | -- | Possible types of Windows settings. | preset23 | 23 | | preset24 | 24 | -## alertFeedback values +### alertFeedback values Possible feedback values on the alert provided by an analyst. Possible feedback values on the alert provided by an analyst. | falsePositive | 2 | Alert is false-positive. | | benignPositive | 3 | Alert is benign-positive. | -## fileHashType values +### fileHashType values Enum for file hash types. Enum for file hash types. | peSha1 | 7 | PESHA1 hash type. | | peSha256 | 8 | PESHA256 hash type. | -## connectionDirection values +### connectionDirection values Enum for the direction of the network connection (inbound/outbound). Enum for the direction of the network connection (inbound/outbound). | inbound | 1 | Inbound connection. | | outbound | 2 | Outbound connection. | -## connectionStatus values +### connectionStatus values Enum for the status of connections. Enum for the status of connections. | blocked | 3 | Connection blocked. | | failed | 4 | Connection failed. | -## processIntegrityLevel values +### processIntegrityLevel values Possible integrity level values of the process. Possible integrity level values of the process. | high | 40 | Integrity level is High. | | system | 50 | Integrity level is System. | -## registryHive values +### registryHive values Enum for registry hives as defined by [/windows/desktop/sysinfo/registry-hives](/windows/desktop/sysinfo/registry-hives). Enum for registry hives as defined by [/windows/desktop/sysinfo/registry-hives]( | localMachineSystem | 5 | HKEY_LOCAL_MACHINE\System hive. | | usersDefault | 6 | HKEY_USERS\\.DEFAULT hive. | -## registryOperation values +### registryOperation values Operation that changed the registry key name and/or value. Operation that changed the registry key name and/or value. | modify | 2 | Modify registry. | | delete | 3 | Delete registry. | -## registryValueType values +### registryValueType values Enum for registry value types as defined by [/windows/desktop/sysinfo/registry-value-types](/windows/desktop/sysinfo/registry-value-types). Enum for registry value types as defined by [/windows/desktop/sysinfo/registry-v | qwordlittleEndian | 10 | REG_QWORD_LITTLE_ENDIAN registry value type. | | sz | 11 | REG_SZ registry value type. | -## alertSeverity values +### alertSeverity values Enum for severity of alerts. Enum for severity of alerts. | medium | 3 | Severity is medium. | | high | 4 | Severity is high. | -## alertStatus values +### alertStatus values Possible values of an Alert lifecycle status (stage). Possible values of an Alert lifecycle status (stage). | inProgress | 20 | Alert is in progress. | | resolved | 30 | Alert is resolved. | -## emailRole values +### emailRole values Possible values for email roles. Possible values for email roles. | sender | 1 | Sender of the email. | | recipient | 2 | Recipient of the email. | -## logonType values +### logonType values Possible values for the method of user signin. Possible values for the method of user signin. | batch | 3 | Logon is batch. | | service | 4 | Logon is service. | -## userAccountSecurityType values +### userAccountSecurityType values Possible values for user account types (group membership), per Windows definition. Possible values for user account types (group membership), per Windows definitio | power | 1 | Member of Power Users group. | | administrator | 2 | Member of Administrators group. | -## riskDetail values +### riskDetail values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | adminDismissedRiskForSignIn | | adminConfirmedAccountSafe | -## riskEventTypes values +### riskEventTypes values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | generic | | unknownFutureValue | -## riskEventType values +### riskEventType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | maliciousIPAddressValidCredentialsBlockedIP | | unknownFutureValue | -## riskLevel values +### riskLevel values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | hidden | | unknownFutureValue | -## riskState values +### riskState values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | confirmedCompromised | | unknownFutureValue | -## exchangeIdFormat values +### exchangeIdFormat values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | restId | | restImmutableEntryId | -## onlineMeetingProviderType values +### onlineMeetingProviderType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | skypeForConsumer | | teamsForBusiness | -## delegateMeetingMessageDeliveryOptions values +### delegateMeetingMessageDeliveryOptions values | Member | | | Possible values for user account types (group membership), per Windows definitio | sendToDelegateAndPrincipal | | sendToDelegateOnly | -## calendarRoleType values +### calendarRoleType values | Member | | | Possible values for user account types (group membership), per Windows definitio | delegateWithPrivateEventAccess | | custom | -## threatAssessmentContentType values +### threatAssessmentContentType values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | url | 2 | URL threat. | | file | 3 | Attachment file threat. | -## threatExpectedAssessment values +### threatExpectedAssessment values | Member | Value | Description | | - | -- | | | block | 1 | The threat should be blocked. | | unblock | 2 | The threat shouldn't be blocked. | -## threatCategory values +### threatCategory values | Member | Value | Description | | | -- | | Possible values for user account types (group membership), per Windows definitio | malware | 3 | Malware threat. | | unknownFutureValue | 4 | A sentinel member. | -## threatAssessmentStatus values +### threatAssessmentStatus values | Member | Value | Description | | | -- | - | | pending | 1 | The threat assessment still in progress. | | completed | 2 | The threat assessment completed. | -## threatAssessmentRequestSource values +### threatAssessmentRequestSource values | Member | Value | Description | | - | -- | | Possible values for user account types (group membership), per Windows definitio | user | 1 | User submission. | | administrator | 2 | Tenant admin submission. | -## threatAssessmentResultType values +### threatAssessmentResultType values | Member | Value | Description | | | -- | - | Possible values for user account types (group membership), per Windows definitio | rescan | 2 | The rescan result. | | unknownFutureValue | 3 | A sentinel member. | -## mailDestinationRoutingReason values +### mailDestinationRoutingReason values | Member | Value | Description | | | -- | -- | Possible values for user account types (group membership), per Windows definitio | junk | 14 | Blocked due to junk. | | unknownFutureValue | 15 | A sentinel member. | -## chatMessageType values +### chatMessageType values | Value | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | systemEventMessage | -## chatMessagePolicyViolationDlpActionType values +### chatMessagePolicyViolationDlpActionType values | Value | | - | Possible values for user account types (group membership), per Windows definitio | BlockAccess | | BlockAccessExternal | -## chatMessagePolicyViolationUserActionType values +### chatMessagePolicyViolationUserActionType values | Member | Int value | Description | | - | | | Possible values for user account types (group membership), per Windows definitio | Override | 1 | Sender has overridden the message verdict and sent the message anyway. | | ReportFalsePositive | 2 | Sender has reported the message verdict to the admins as a false positive. | -## chatMessagePolicyViolationVerdictDetailsType values +### chatMessagePolicyViolationVerdictDetailsType values | Member | Int value | Description | | | | -- | Possible values for user account types (group membership), per Windows definitio | AllowOverrideWithoutJustification | 2 | User is allowed to override the block and send the message. Justification text isn't required. Exclusive to `AllowOverrideWithJustification`. | | AllowOverrideWithJustification | 4 | User is allowed to override the block and send the message. Justification text is required. Exclusive to `AllowOverrideWithoutJustification`. | -## wellknownListName values +### wellknownListName values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | flaggedEmails | | unknownFutureValue | -## taskStatus values +### taskStatus values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | waitingOnOthers | | deferred | -## columnTypes values +### columnTypes values | Member | Description | | | -- | Possible values for user account types (group membership), per Windows definitio | approvalStatus | Content approval status column. | | unknownFutureValue | UnknownFuturevalue | -## permissionClassificationType values +### permissionClassificationType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | medium | | high | -## permissionType values +### permissionType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | delegated | | delegatedUserConsentable | -## printColorMode values +### printColorMode values | Member | | | Possible values for user account types (group membership), per Windows definitio | auto | | unknownFutureValue | -## printDuplexMode values +### printDuplexMode values | Member | | | Possible values for user account types (group membership), per Windows definitio | oneSided | | unknownFutureValue | -## printerFeedOrientation values +### printerFeedOrientation values | Member | | | Possible values for user account types (group membership), per Windows definitio | shortEdgeFirst | | unknownFutureValue | -## printFinishing values +### printFinishing values | Member | | | Possible values for user account types (group membership), per Windows definitio | trimAfterCopies | | trimAfterJob | -## printMultipageLayout values +### printMultipageLayout values | Member | | - | Possible values for user account types (group membership), per Windows definitio | clockwiseFromBottomRight | | unknownFutureValue | -## printOrientation values +### printOrientation values | Member | | | Possible values for user account types (group membership), per Windows definitio | reversePortrait | | unknownFutureValue | -## printQuality values +### printQuality values | Member | | | Possible values for user account types (group membership), per Windows definitio | high | | unknownFutureValue | -## printScaling values +### printScaling values | Member | | | Possible values for user account types (group membership), per Windows definitio | none | | unknownFutureValue | -## userFlowType values +### userFlowType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | resourceOwner | | unknownFutureValue | -## identityUserFlowAttributeDataType values +### identityUserFlowAttributeDataType values | Member | | | Possible values for user account types (group membership), per Windows definitio | dateTime | | unknownFutureValue | -## identityUserFlowAttributeType values +### identityUserFlowAttributeType values | Member | | | Possible values for user account types (group membership), per Windows definitio | required | | unknownFutureValue | -## identityUserFlowAttributeInputType values +### identityUserFlowAttributeInputType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | emailBox | | checkboxMultiSelect | -## authenticationAttributeCollectionInputType values +### authenticationAttributeCollectionInputType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | boolean | | unknownFutureValue | -## teamworkActivityTopicSource values +### teamworkActivityTopicSource values | Member | | | | entityUrl | | text | -## provisioningResult values +### provisioningResult values | Member | | | Possible values for user account types (group membership), per Windows definitio | warning | | unknownFutureValue | -## provisioningStepType values +### provisioningStepType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | export | | unknownFutureValue | -## provisioningStatusErrorCategory values +### provisioningStatusErrorCategory values | Member | | | Possible values for user account types (group membership), per Windows definitio | success | | unknownFutureValue | -## provisioningAction values +### provisioningAction values | Member | | | Possible values for user account types (group membership), per Windows definitio | stagedDelete | | unknownFutureValue | -## initiatorType values +### initiatorType values | Member | | | Possible values for user account types (group membership), per Windows definitio | system | | unknownFutureValue | -## teamworkApplicationIdentityType values +### teamworkApplicationIdentityType values | Member | | | Possible values for user account types (group membership), per Windows definitio | outgoingWebhook | | unknownFutureValue | -## teamworkConversationIdentityType values +### teamworkConversationIdentityType values | Member | | | Possible values for user account types (group membership), per Windows definitio | chat | | unknownFutureValue | -## teamworkUserIdentityType values +### teamworkUserIdentityType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | emailUser | -## postType values +### postType values | Member | | | Possible values for user account types (group membership), per Windows definitio | strategic | | unknownFutureValue | -## searchAlterationType values +### searchAlterationType values | Member | | | | modification | | suggestion | -## serviceHealthClassificationType values +### serviceHealthClassificationType values | Member | | | Possible values for user account types (group membership), per Windows definitio | incident | | unknownFutureValue | -## serviceHealthOrigin values +### serviceHealthOrigin values | Member | | | Possible values for user account types (group membership), per Windows definitio | customer | | unknownFutureValue | -## featureTargetType values +### featureTargetType values | Member | | | Possible values for user account types (group membership), per Windows definitio | role | | unknownFutureValue | -## serviceHealthStatus values +### serviceHealthStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | reported | | unknownFutureValue | -## serviceUpdateCategory values +### serviceUpdateCategory values | Member | | | Possible values for user account types (group membership), per Windows definitio | stayInformed | | unknownFutureValue | -## serviceUpdateSeverity values +### serviceUpdateSeverity values | Member | | | Possible values for user account types (group membership), per Windows definitio | critical | | unknownFutureValue | -## subjectRightsRequestStage values +### subjectRightsRequestStage values | Member | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | approval | -## subjectRightsRequestStageStatus values +### subjectRightsRequestStageStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | failed | | unknownFutureValue | -## subjectRightsRequestStatus values +### subjectRightsRequestStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | closed | | unknownFutureValue | -## subjectRightsRequestType values +### subjectRightsRequestType values | Member | | | Possible values for user account types (group membership), per Windows definitio | tagForAction | | unknownFutureValue | -## dataSubjectType values +### dataSubjectType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | other | | unknownFutureValue | -## advancedConfigState values +### advancedConfigState values | Member | | | Possible values for user account types (group membership), per Windows definitio | disabled | | unknownFutureValue | -## callRecordingStatus values +### callRecordingStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | chunkFinished | | unknownFutureValue | -## endUserNotificationPreference values +### endUserNotificationPreference values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## endUserNotificationSettingType values +### endUserNotificationSettingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | noNotification | | unknownFutureValue | -## endUserNotificationType values +### endUserNotificationType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | trainingReminder | | unknownFutureValue | -## notificationDeliveryFrequency values +### notificationDeliveryFrequency values | Member | | - | Possible values for user account types (group membership), per Windows definitio | biWeekly | | unknownFutureValue | -## notificationDeliveryPreference values +### notificationDeliveryPreference values | Member | | - | Possible values for user account types (group membership), per Windows definitio | deliverAfterCampaignEnd | | unknownFutureValue | -## oAuthAppScope values +### oAuthAppScope values | Member | | - | Possible values for user account types (group membership), per Windows definitio | sendMail | | unknownFutureValue | -## targettedUserType values +### targettedUserType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | allUsers | | unknownFutureValue | -## trainingAssignedTo values +### trainingAssignedTo values | Member | | - | Possible values for user account types (group membership), per Windows definitio | didNothing | | unknownFutureValue | -## trainingAvailabilityStatus values +### trainingAvailabilityStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | delete | | unknownFutureValue | -## trainingCompletionDuration values +### trainingCompletionDuration values | Member | | - | Possible values for user account types (group membership), per Windows definitio | month | | unknownFutureValue | -## trainingSettingType values +### trainingSettingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## trainingType values +### trainingType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | phishing | | unknownFutureValue | -## payloadDeliveryPlatform values +### payloadDeliveryPlatform values | Member | | | Possible values for user account types (group membership), per Windows definitio | teams | | unknownFutureValue | -## trainingStatus values +### trainingStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | overdue | | unknownFutureValue | -## teamworkCallEventType values +### teamworkCallEventType values | Member | | | Possible values for user account types (group membership), per Windows definitio | screenShare | | unknownFutureValue | -## bookingReminderRecipients values +### bookingReminderRecipients values | Member | | | Possible values for user account types (group membership), per Windows definitio | customer | | unknownFutureValue | -## bookingStaffRole values +### bookingStaffRole values | Member | | | Possible values for user account types (group membership), per Windows definitio | scheduler | | teamMember | -## answerInputType values +### answerInputType values | Member | | | Possible values for user account types (group membership), per Windows definitio | radioButton | | unknownFutureValue | -## bookingPriceType values +### bookingPriceType values | Member | | | Possible values for user account types (group membership), per Windows definitio | notSet | | unknownFutureValue | -## accessReviewHistoryStatus values +### accessReviewHistoryStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | requested | | unknownFutureValue | -## accessReviewHistoryDecisionFilter values +### accessReviewHistoryDecisionFilter values | Member | | | Possible values for user account types (group membership), per Windows definitio | notNotified | | unknownFutureValue | -## weakAlgorithms values +### weakAlgorithms values | Member | | - | | rsaSha1 | | unknownFutureValue | -## authenticationProtocol values +### authenticationProtocol values | Member | | | | wsFed | | saml | -## longRunningOperationStatus values +### longRunningOperationStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | failed | | unknownFutureValue | -## delegatedAdminAccessAssignmentStatus values +### delegatedAdminAccessAssignmentStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | error | | unknownFutureValue | -## delegatedAdminAccessContainerType values +### delegatedAdminAccessContainerType values | Member | | | | securityGroup | | unknownFutureValue | -## delegatedAdminRelationshipOperationType values +### delegatedAdminRelationshipOperationType values | Member | | | | delegatedAdminAccessAssignmentUpdate | | unknownFutureValue | -## delegatedAdminRelationshipRequestAction values +### delegatedAdminRelationshipRequestAction values | Member | | | Possible values for user account types (group membership), per Windows definitio | unknownFutureValue | | reject | -## delegatedAdminRelationshipRequestStatus values +### delegatedAdminRelationshipRequestStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | failed | | unknownFutureValue | -## delegatedAdminRelationshipStatus values +### delegatedAdminRelationshipStatus values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | terminationRequested | | unknownFutureValue | -## onPremisesDirectorySynchronizationDeletionPreventionType values +### onPremisesDirectorySynchronizationDeletionPreventionType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | enabledForCount | | enabledForPercentage | -## searchContent values +### searchContent values | Member | | | Possible values for user account types (group membership), per Windows definitio | privateContent | | unknownFutureValue | -## authenticationMethodsPolicyMigrationState values +### authenticationMethodsPolicyMigrationState values | Member | | | Possible values for user account types (group membership), per Windows definitio | migrationComplete | | unknownFutureValue | -## authenticationStrengthPolicyType values +### authenticationStrengthPolicyType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | custom | | unknownFutureValue | -## authenticationStrengthRequirements values +### authenticationStrengthRequirements values | Member | | - | Possible values for user account types (group membership), per Windows definitio | mfa | | unknownFutureValue | -## authenticationMethodModes values +### authenticationMethodModes values | Member | | - | Possible values for user account types (group membership), per Windows definitio | federatedMultiFactor | | unknownFutureValue | -## baseAuthenticationMethod values +### baseAuthenticationMethod values | Member | | - | Possible values for user account types (group membership), per Windows definitio | federation | | unknownFutureValue | -## browserSharedCookieSourceEnvironment values +### browserSharedCookieSourceEnvironment values | Member | | | Possible values for user account types (group membership), per Windows definitio | both | | unknownFutureValue | -## browserSiteCompatibilityMode values +### browserSiteCompatibilityMode values | Member | | | Possible values for user account types (group membership), per Windows definitio | internetExplorer5 | | unknownFutureValue | -## browserSiteMergeType values +### browserSiteMergeType values | Member | | | Possible values for user account types (group membership), per Windows definitio | default | | unknownFutureValue | -## browserSiteTargetEnvironment values +### browserSiteTargetEnvironment values | Member | | | Possible values for user account types (group membership), per Windows definitio | none | | unknownFutureValue | -## browserSiteStatus values +### browserSiteStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | pendingDelete | | unknownFutureValue | -## browserSharedCookieStatus values +### browserSharedCookieStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | pendingDelete | | unknownFutureValue | -## browserSiteListStatus values +### browserSiteListStatus values | Member | | | Possible values for user account types (group membership), per Windows definitio | pending | | unknownFutureValue | -## chatMessageActions values +### chatMessageActions values | Member | | - | Possible values for user account types (group membership), per Windows definitio | actionUndefined | | unknownFutureValue | -## attributeDefinitionMetadata values +### attributeDefinitionMetadata values | Member | | - | Possible values for user account types (group membership), per Windows definitio | MaximumLength | | ReferencedProperty | -## attributeFlowBehavior values +### attributeFlowBehavior values | Member | | - | | FlowWhenChanged | | FlowAlways | -## attributeFlowType values +### attributeFlowType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | ValueAddOnly | | AttributeAddOnly | -## attributeMappingSourceType values +### attributeMappingSourceType values | Member | | | Possible values for user account types (group membership), per Windows definitio | Constant | | Function | -## directoryDefinitionDiscoverabilities values +### directoryDefinitionDiscoverabilities values | Member | | - | Possible values for user account types (group membership), per Windows definitio | ReferenceAttributes | | UnknownFutureValue | -## attributeType values +### attributeType values | Member | | | Possible values for user account types (group membership), per Windows definitio | Boolean | | DateTime | -## mutability values +### mutability values | Member | | | Possible values for user account types (group membership), per Windows definitio | Immutable | | WriteOnly | -## objectDefinitionMetadata values +### objectDefinitionMetadata values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Extensions | | BaseObjectName | -## objectFlowTypes values +### objectFlowTypes values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Update | | Delete | -## objectMappingMetadata values +### objectMappingMetadata values | Member | | - | Possible values for user account types (group membership), per Windows definitio | ExcludeFromReporting | | Unsynchronized | -## synchronizationMetadata values +### synchronizationMetadata values | Member | | - | Possible values for user account types (group membership), per Windows definitio | SynchronizationLearnMoreIbizaFwLink | | ConfigurationFields | -## synchronizationSecret values +### synchronizationSecret values | Member | | - | Possible values for user account types (group membership), per Windows definitio | TestReferences | | ConnectionString | -## synchronizationStatusCode values +### synchronizationStatusCode values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Paused | | Quarantine | -## synchronizationTaskExecutionResult values +### synchronizationTaskExecutionResult values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Failed | | EntryLevelErrors | -## stagedFeatureName values +### stagedFeatureName values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | certificateBasedAuthentication | | multiFactorAuthentication | -## synchronizationJobRestartScope values +### synchronizationJobRestartScope values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Full | | ForceDeletes | -## quarantineReason values +### quarantineReason values | Member | | | Possible values for user account types (group membership), per Windows definitio | TooManyDeletes | | IngestionInterrupted | -## synchronizationScheduleState values +### synchronizationScheduleState values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | Disabled | | Paused | -## scopeOperatorMultiValuedComparisonType values +### scopeOperatorMultiValuedComparisonType values | Member | | - | | All | | Any | -## scopeOperatorType values +### scopeOperatorType values | Member | | | | Binary | | Unary | -## entryExportStatus values +### entryExportStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | PermanentError | | Error | -## entrySyncOperation values +### entrySyncOperation values | Member | | - | Possible values for user account types (group membership), per Windows definitio | Delete | | Update | -## escrowBehavior values +### escrowBehavior values | Member | | | | Default | | IgnoreLookupReferenceResolutionFailure | -## synchronizationDisposition values +### synchronizationDisposition values | Member | | -- | Possible values for user account types (group membership), per Windows definitio | Discard | | Escrow | -## outlierMemberType values +### outlierMemberType values | Member | | - | | user | | unknownFutureValue | -## outlierContainerType values +### outlierContainerType values | Member | | - | | group | | unknownFutureValue | -## authenticationMethodFeature values +### authenticationMethodFeature values | Member | | - | Possible values for user account types (group membership), per Windows definitio | mfaCapable | | unknownFutureValue | -## featureType values +### featureType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | reset | | unknownFutureValue | -## includedUserRoles values +### includedUserRoles values | Member | | - | Possible values for user account types (group membership), per Windows definitio | user | | unknownFutureValue | -## includedUserTypes values +### includedUserTypes values | Member | | - | Possible values for user account types (group membership), per Windows definitio | guest | | unknownFutureValue | -## signInUserType values +### signInUserType values | Member | | - | Possible values for user account types (group membership), per Windows definitio | guest | | unknownFutureValue | -## userDefaultAuthenticationMethod values +### userDefaultAuthenticationMethod values | Member | | - | Possible values for user account types (group membership), per Windows definitio | none | | unknownFutureValue | -## layoutTemplateType values +### layoutTemplateType values | Member | | | Possible values for user account types (group membership), per Windows definitio | verticalSplit | | unknownFutureValue | -## meetingAudience values +### meetingAudience values | Member | | - | Possible values for user account types (group membership), per Windows definitio | organization | | unknownFutureValue | -## virtualEventAttendeeRegistrationStatus values +### virtualEventAttendeeRegistrationStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | rejectedByOrganizer | | unknownFutureValue | -## virtualEventStatus values +### virtualEventStatus values | Member | | - | Possible values for user account types (group membership), per Windows definitio | published | | canceled | -## socialIdentitySourceType values +### socialIdentitySourceType values | Member | | - | | facebook | | unknownFutureValue | -## devicePlatformType values +### devicePlatformType values | Member | | -- | Possible values for user account types (group membership), per Windows definitio ### nativeAuthenticationApisEnabled values -| Member| -|:| -|none| -|all| -|unknownFutureValue| -| unknown | -| androidAOSP | -| androidMobileApplicationManagement | -| iOSMobileApplicationManagement | -| unknownFutureValue | --## educationAssignmentStatus values --| Member | -| | -| draft | -| published | -| assigned | -| unknownFutureValue | -| inactive | --## b2bIdentityProvidersType values --| Member | -| | -| azureActiveDirectory | -| externalFederation | -| socialIdentityProviders | -| emailOneTimePasscode | -| microsoftAccount | -| defaultConfiguredIdp | -| unknownFutureValue | --## bookingStaffMembershipStatus values --| Member | -| - | -| active | -| pendingAcceptance | -| rejectedByStaff | -| unknownFutureValue | --## conditionalAccessInsiderRiskLevels values --| Member | -| - | -| minor | -| moderate | -| elevated | -| unknownFutureValue | --## nativeAuthenticationApisEnabled values - | Member | | - | | none | |
v1.0 | Externallink | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/externallink.md | Represents a URL that opens a OneNote page or notebook. |:|:--|:| | href | String | The URL of the link. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Externalsponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/externalsponsors.md | Title: "externalSponsors complex type" -description: "Identifies a relationship to another user in the tenant who will be allowed as approver." + Title: "externalSponsors resource type" +description: "Identifies a relationship to another user in the tenant who can approve." ms.localizationpriority: medium doc_type: resourcePageType -# externalSponsors complex type +# externalSponsors resource type Namespace: microsoft.graph |
v1.0 | Federatedidentitycredentials Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/federatedidentitycredentials-overview.md | Title: "Overview of federated identity credentials in Microsoft Entra ID" -description: "Federated identity credentials allow you to access Azure and Microsoft Graph resources without having to manage secrets. This is part of workload identity federation in Azure AD." +description: "Federated identity credentials allow you to access Microsoft Entra and Microsoft Graph resources without having to manage secrets. Federated identity credentials are part of workload identity federation in Microsoft Entra ID." ms.localizationpriority: medium Last updated 08/03/2022 Namespace: microsoft.graph -Traditionally, developers use certificates or client secrets for their application's credentials to authenticate with and access services in Microsoft Entra ID. To access the services in their Microsoft Entra tenant, developers have had to store and manage application credentials outside Azure, introducing the following bottlenecks: +Traditionally, developers use certificates or client secrets for their application's credentials to authenticate with and access services in Microsoft Entra ID. To access the services in their Microsoft Entra tenant, developers had to store and manage application credentials outside Azure, introducing the following bottlenecks: + A maintenance burden for certificates and secrets. + The risk of leaking secrets. Traditionally, developers use certificates or client secrets for their applicati ## How do federated identity credentials work? -You create a trust relationship between an external identity provider (IdP) and an app in Microsoft Entra ID by configuring a federated identity credential. The federated identity credential is used to indicate which token from the external IdP should be trusted by your application. After that trust relationship is created, your software workload can exchange trusted tokens from the external identity provider for access tokens from the Microsoft identity platform. Your software workload then uses that access token to access the Microsoft Entra protected resources to which the workload has been granted access. This eliminates the maintenance burden of manually managing credentials and eliminates the risk of leaking secrets or having certificates expire. For more information and supported scenarios, see [workload identity federation](/azure/active-directory/develop/workload-identity-federation). +You create a trust relationship between an external identity provider (IdP) and an app in Microsoft Entra ID by configuring a federated identity credential. The federated identity credential is used to indicate which token from the external IdP your application can trust. After that trust relationship is created, your software workload can exchange trusted tokens from the external identity provider for access tokens from the Microsoft identity platform. Your software workload then uses that access token to access the Microsoft Entra protected resources to which the workload has access. This process eliminates the maintenance burden of manually managing credentials and eliminates the risk of leaking secrets or having certificates expire. For more information and supported scenarios, see [workload identity federation](/azure/active-directory/develop/workload-identity-federation). ++> [!NOTE] +> The match performed between the Federated Identity Credential `issuer`, `subject`, and `audience` values and the corresponding values in the token being sent to Microsoft Entra ID by the external IdP is case-sensitive. These values must match exactly in order for the scenario to be authorized. For more information,see [Federated Identity Credentials now use case-sensitive matching](/entra/identity-platform/reference-breaking-changes#federated-identity-credentials-now-use-case-sensitive-matching). ## Set up federated identity credentials through Microsoft Graph -The [federatedIdentityCredential](federatedidentitycredential.md) resource represents the configuration of a federated identity credential via Microsoft Graph. The following properties are the building blocks of federated identity credentials: +The [federatedIdentityCredential](federatedidentitycredential.md) resource represents the configuration of a federated identity credential via Microsoft Graph. Use the [Create federatedIdentityCredential](../api/application-post-federatedidentitycredentials.md) API to configure the object. The following properties are the building blocks of federated identity credentials: -+ **audiences** — 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 might need to create a new application registration in your IdP to serve as the audience of this token. -+ **issuer** — The URL of the external identity provider. Must match the **issuer** claim of the external token being exchanged. -+ **subject** — The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each IdP 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. ++ **audiences** - 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 might need to create a new application registration in your IdP to serve as the audience of this token.++ **issuer** - The URL of the external identity provider. Must match the **issuer** claim of the external token being exchanged.++ **subject** - The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each IdP 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.++ **name** - A unique string to identify the credential. This property is an alternate key and the value can be used to reference the federated identity credential via the [GET](../api/federatedidentitycredential-get.md) and [UPSERT](../api/federatedidentitycredential-upsert.md) operations. -The combination of **issuer** and **subject** must be unique on the app. When the external software workload requests Microsoft identity platform to exchange the external token for an access token, the **issuer** and **subject** values of the federated identity credential are checked against the `issuer` and `subject` claims provided in the external token. If that validation check passes, Microsoft identity platform issues an access token to the external software workload. +The combination of **issuer** and **subject** must be unique on the app. When the external software workload requests Microsoft identity platform to exchange the external token for an access token, the **issuer** and **subject** values of the federated identity credential are checked against the `issuer` and `subject` claims provided in the external token. If that validation check passes, Microsoft identity platform issues an access token to the external software workload. ## Design considerations |
v1.0 | Filestoragecontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/filestoragecontainer.md | Represents a location where multiple users or a group of users can store files a |description|String|Provides a user-visible description of the **fileStorageContainer**. Read-write.| |displayName|String|The display name of the **fileStorageContainer**. Read-write.| |id|String|The unique stable identifier of the **filerStorageContainer**. Read-only.|-|status|fileStorageContainerStatus|Status of the **fileStorageContainer**. Containers are created as inactive and require activation. Inactive containers are subjected to automatic deletion in 24 hours. The possible values are: `inactive `, `active `. Read-only.| +|status|fileStorageContainerStatus|Status of the **fileStorageContainer**. Containers are created as inactive and require activation. Inactive containers are subjected to automatic deletion in 24 hours. The possible values are: `inactive `, `active `. Read-only.| |viewpoint|[fileStorageContainerViewpoint](../resources/filestoragecontainerviewpoint.md)|Data specific to the current user. Read-only.| ## Relationships Represents a location where multiple users or a group of users can store files a |:|:|:| |drive|[drive](../resources/drive.md)|The drive of the resource **fileStorageContainer**. Read-only.| |permissions|[permission](../resources/permission.md) collection|The set of permissions for users in the **fileStorageContainer**. Permission for each user is set by the **roles** property. The possible values are: `reader`, `writer`, `manager`, and `owner`. Read-write.|+|settings|[fileStorageContainerSettings](../resources/filestoragecontainersettings.md)|Settings associated with a **fileStorageContainer**. Read-write. ### roles property values |Value|Description| |:|:|-|reader|Readers can read **fileStorageContainer** metadata and the content inside.| +|reader|Readers can read **fileStorageContainer** metadata and the contents inside.| |writer|Writers can read and modify **fileStorageContainer** metadata and contents inside.| |manager|Managers can read and modify **fileStorageContainer** metadata and contents inside and manage the permissions to the container.| |owner|Owners can read and modify **fileStorageContainer** metadata and contents inside, manage container permissions, and delete and restore containers.| The following JSON representation shows the resource type. "@odata.type": "microsoft.graph.fileStorageContainerViewpoint" }, "status": "String",- "createdDateTime": "String (timestamp)" + "createdDateTime": "String (timestamp)", + "settings": { "@odata.type": "microsoft.graph.fileStorageContainerSettings" } } ``` |
v1.0 | Filestoragecontainercustompropertyvalue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/filestoragecontainercustompropertyvalue.md | Title: "fileStorageContainerCustomPropertyValue resource type" -description: "Contains the custom property values stored in a fileStorageContainerCustomPropertyDictionary." +description: "Contains the custom property values stored in a fileStorageContainerCustomPropertyDictionary resource." ms.localizationpriority: medium |
v1.0 | Filestoragecontainersettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/filestoragecontainersettings.md | + + Title: "fileStorageContainerSettings resource type" +description: "Represents settings of a fileStorageContainer." ++ms.localizationpriority: medium ++++# fileStorageContainerSettings resource type ++Namespace: microsoft.graph ++Represents settings associated with a [fileStorageContainer](../resources/filestoragecontainer.md). +++## Properties ++|Property|Type|Description| +|:|:|:| +|isOcrEnabled|Boolean|Indicates whether optical character recognition (OCR) is enabled for a given container. When OCR is enabled on a container, OCR extraction is performed for new and updated documents of supported types. The extracted fields are added to the metadata of the document, enabling end-user search and search-driven solutions. Changing this property from `true` to `false` doesn't remove OCR metadata that was created while it was `true`. Default value is `false`.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +++<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.fileStorageContainerSettings" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.fileStorageContainerSettings", + "isOcrEnabled": "Boolean" +} +``` |
v1.0 | Group | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/group.md | This resource supports: | Property | Type | Description | |:-|:-|:-| | allowExternalSenders | Boolean | Indicates if people external to the organization can send messages to the group. The default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). |-| assignedLabels | [assignedLabel](assignedlabel.md) collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. <br><br>Returned only on `$select`. | +| assignedLabels | [assignedLabel](assignedlabel.md) collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. <br><br>Returned only on `$select`. 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).| | assignedLicenses | [assignedLicense](assignedlicense.md) collection | The licenses that are assigned to the group. <br><br>Returned only on `$select`. Supports `$filter` (`eq`).Read-only. | | autoSubscribeNewMembers | Boolean | Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don't set it in the initial POST request that creates the group. Default value is `false`. <br><br>Returned only on `$select`. Supported only on the Get group API (`GET /groups/{ID}`). | | classification | String | Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList [setting](groupsetting.md) value, based on the [template definition](groupsettingtemplate.md).<br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`). | This resource supports: | members | [directoryObject](directoryobject.md) collection | The members of this group, who can be users, devices, other groups, or service principals. Supports the [List members](../api/group-list-members.md), [Add member](../api/group-post-members.md), and [Remove member](../api/group-delete-members.md) operations. Nullable. <br/>Supports `$expand` including nested `$select`. For example, `/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName)`. | | membersWithLicenseErrors | [User](user.md) collection | A list of group members with license errors from this group-based license assignment. Read-only. | | onenote | [Onenote](onenote.md) | Read-only. |-| owners | [directoryObject](directoryobject.md) collection | The owners of the group. Limited to 100 owners. Nullable. If this property isn't specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. <br/> Supports `$filter` (`/$count eq 0`, `/$count ne 0`, `/$count eq 1`, `/$count ne 1`). Supports `$expand` including nested `$select`. For example, `/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName)`. | +| owners | [directoryObject](directoryobject.md) collection | The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. <li>If this property isn't specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. <li>A non-admin user can't explicitly add themselves to this collection when they're creating the group. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419). <li>For security groups, the admin user isn't automatically added to this collection. For more information, see the related [known issue](https://developer.microsoft.com/en-us/graph/known-issues/?search=26419).<br/><br/> Supports `$filter` (`/$count eq 0`, `/$count ne 0`, `/$count eq 1`, `/$count ne 1`); Supports `$expand` including nested `$select`. For example, `/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName)`. | | photo | [profilePhoto](profilephoto.md) | The group's profile photo | | photos | [profilePhoto](profilephoto.md) collection | The profile photos owned by the group. Read-only. Nullable. | | planner | [plannerGroup](plannergroup.md) | Entry-point to Planner resource that might exist for a Unified Group. | The following JSON representation shows the resource type. "conversations": [{ "@odata.type": "microsoft.graph.conversation" }], "createdDateTime": "String (timestamp)", "createdOnBehalfOf": { "@odata.type": "microsoft.graph.directoryObject" },+ "deletedDateTime": "String (timestamp)", "description": "String", "displayName": "String", "drive": { "@odata.type": "microsoft.graph.drive" }, |
v1.0 | Groupmembers | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/groupmembers.md | Title: "groupMembers complex type" -description: "Identifies a collection of users in the tenant who will be allowed as requestor, approver, or reviewer." + Title: "groupMembers resource type" +description: "Identifies a collection of users in the tenant who are allowed as requestor, approver, or reviewer." ms.localizationpriority: medium doc_type: resourcePageType -# groupMembers complex type +# groupMembers resource type Namespace: microsoft.graph |
v1.0 | Groups Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/groups-overview.md | Using Microsoft Graph, you can perform the following common operations on groups ## Microsoft Entra roles for managing groups -To manage groups in delegated scenarios, the app must be granted the appropriate permissions and the signed-in user must be in a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +To manage groups in delegated scenarios, the app must be granted the appropriate Microsoft Graph permissions and the signed-in user must be in a supported [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). -The following Microsoft Entra roles are the least privileged roles for managing all aspects of groups through Microsoft Graph, except for role-assignable groups. The least privileged role for managing role-assignable groups is **Privileged Role Administrator**. +The following Microsoft Entra roles are the least privileged roles for all read and write operations on groups through Microsoft Graph, *except* for role-assignable groups. The least privileged role for managing role-assignable groups is **Privileged Role Administrator**. - Directory Writers - Groups Administrator - User Administrator +For a summary of the least privileged admin roles for different group-related tasks, see [Least privileged roles to manage groups](/entra/identity/role-based-access-control/delegate-by-task#groups). ++You can also create custom roles for group-related tasks. Refer to the [Microsoft Entra built-in roles reference](/entr) with the selected permissions. + ## Next step > [!div class="nextstepaction"] |
v1.0 | Identity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identity.md | Base type of [userIdentity](useridentity.md). | tenantId | String | Unique identity of the tenant. Optional. | | thumbnails | [thumbnailSet](thumbnailset.md) | Keyed collection of thumbnail resources. Optional. Applies to drive items, for example. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Identitygovernance Attributechangetrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-attributechangetrigger.md | + + Title: "attributeChangeTrigger resource type" +description: "Represents changes in user attributes that trigger the execution of workload conditions for a user." ++ms.localizationpriority: medium ++++# attributeChangeTrigger resource type ++Namespace: microsoft.graph.identityGovernance ++Represents changes in user attributes that trigger the execution of workload conditions for a user. ++Inherits from [microsoft.graph.identityGovernance.workflowExecutionTrigger](../resources/identitygovernance-workflowexecutiontrigger.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|triggerAttributes|[microsoft.graph.identityGovernance.triggerAttribute](../resources/identitygovernance-triggerattribute.md) collection|The trigger attribute being changed that triggers the workflowexecutiontrigger of a workflow.)| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.attributeChangeTrigger" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.attributeChangeTrigger", + "triggerAttributes": [ + { + "@odata.type": "microsoft.graph.identityGovernance.triggerAttribute" + } + ] +} +``` + |
v1.0 | Identitygovernance Groupbasedsubjectset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-groupbasedsubjectset.md | + + Title: "groupBasedSubjectSet resource type" +description: "Defines the group that is the scope of a lifecycle workflow membershipChangeTrigger configuration." ++ms.localizationpriority: medium ++++# groupBasedSubjectSet resource type ++Namespace: microsoft.graph.identityGovernance ++Defines the group that is the scope of a lifecycle workflow [membershipChangeTrigger](../resources/identitygovernance-membershipchangetrigger.md) configuration. ++Inherits from [microsoft.graph.subjectSet](../resources/subjectset.md). ++## Properties +None. ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|groups|[microsoft.graph.group](../resources/group.md) collection|The specific group a user is interacting with in a [membershipChangeTrigger](identitygovernance-membershipchangetrigger.md) workflow.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.groupBasedSubjectSet" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.groupBasedSubjectSet" +} +``` + |
v1.0 | Identitygovernance Insights | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-insights.md | + + Title: "insights resource type" +description: "Represents insights into the health and processing of lifecycle workflows across different workflows." ++ms.localizationpriority: medium ++++# insights resource type ++Namespace: microsoft.graph.identityGovernance ++Represents insights into the health and processing of lifecycle workflows across different workflows. The insights include the number of total, successful, and failed workflow executions, tasks processed, and users processed across all workflows for the tenant for a given period. ++Inherits from [microsoft.graph.entity](../resources/entity.md). ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get top workflows summary](../api/identitygovernance-insights-topworkflowsprocessedsummary.md)|[microsoft.graph.identityGovernance.topWorkflowsInsightsSummary](../resources/identitygovernance-topworkflowsinsightssummary.md) collection|Summarizes the top runs for workflows for a given data range.| +|[Get top tasks summary](../api/identitygovernance-insights-toptasksprocessedsummary.md)|[microsoft.graph.identityGovernance.topTasksInsightsSummary](../resources/identitygovernance-toptasksinsightssummary.md) collection|Summarizes the top runs for tasks for a given data range.| +|[Get workflows processed summary](../api/identitygovernance-insights-workflowsprocessedsummary.md)|[microsoft.graph.identityGovernance.workflowsInsightsSummary](../resources/identitygovernance-workflowsinsightssummary.md)|Summarizes the workflows, users, and tasks processed for a given date range.| +|[Get workflows processed by category](../api/identitygovernance-insights-workflowsprocessedbycategory.md)|[microsoft.graph.identityGovernance.workflowsInsightsByCategory](../resources/identitygovernance-workflowsinsightsbycategory.md)|Summarizes workflow processing for each workflow category for a given date range.| ++## Properties ++None. ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.identityGovernance.insights", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.insights", + "id": "String (identifier)" +} +``` |
v1.0 | Identitygovernance Lifecycleworkflowscontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-lifecycleworkflowscontainer.md | None. |:|:|:| |customTaskExtensions|[microsoft.graph.identityGovernance.customTaskExtension](../resources/identitygovernance-customtaskextension.md) collection|The **customTaskExtension** instance.| |deletedItems|[deletedItemContainer](../resources/deleteditemcontainer.md)|Deleted workflows in your lifecycle workflows instance.|+|insights|[microsoft.graph.identityGovernance.insights](../resources/identitygovernance-insights.md)|The insight container holding workflow insight summaries for a tenant.| |settings|[microsoft.graph.identityGovernance.lifecycleManagementSettings](../resources/identitygovernance-lifecyclemanagementsettings.md)|The settings of the lifecycle workflows instance.| |taskDefinitions|[microsoft.graph.identityGovernance.taskDefinition](../resources/identitygovernance-taskdefinition.md) collection|The definition of tasks within the lifecycle workflows instance.| |workflows|[microsoft.graph.identityGovernance.workflow](../resources/identitygovernance-workflow.md) collection|The workflows in the lifecycle workflows instance.| |
v1.0 | Identitygovernance Membershipchangetrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-membershipchangetrigger.md | + + Title: "membershipChangeTrigger resource type" +description: "Represents the change in group membership that triggers the execution conditions of a workflow for a user." ++ms.localizationpriority: medium ++++# membershipChangeTrigger resource type ++Namespace: microsoft.graph.identityGovernance ++Represents the change in group membership that triggers the execution conditions of a workflow for a user. ++Inherits from [microsoft.graph.identityGovernance.workflowExecutionTrigger](../resources/identitygovernance-workflowexecutiontrigger.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|changeType|microsoft.graph.identityGovernance.membershipChangeType|Defines what change that happens to the workflow group to trigger the [workflowExecutionTrigger](../resources/identitygovernance-workflowexecutiontrigger.md). Possible values are: `add`, `remove`, `unknownFutureValue`.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.membershipChangeTrigger" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.membershipChangeTrigger", + "changeType": "String" +} +``` |
v1.0 | Identitygovernance Toptasksinsightssummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-toptasksinsightssummary.md | + + Title: "topTasksInsightsSummary resource type" +description: "Represents a summary of top tasks ran within a tenant." ++ms.localizationpriority: medium ++++# topTasksInsightsSummary resource type ++Namespace: microsoft.graph.identityGovernance ++Represents a summary of the top tasks ran within a tenant, including total, failed, and successful tasks and user processing history. ++## Properties ++|Property|Type|Description| +|:|:|:| +|failedTasks|Int32|Count of failed runs of the task.| +|failedUsers|Int32|Count of failed users who were processed by the task.| +|successfulTasks|Int32|Count of successful runs of the task.| +|successfulUsers|Int32|Count of successful users processed by the task.| +|taskDefinitionDisplayName|String|The name of the task.| +|taskDefinitionId|String|The task ID.| +|totalTasks|Int32|Count of total runs of the task.| +|totalUsers|Int32|Count of total users processed by the task.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.topTasksInsightsSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.topTasksInsightsSummary", + "taskDefinitionId": "String", + "taskDefinitionDisplayName": "String", + "totalTasks": "Integer", + "successfulTasks": "Integer", + "failedTasks": "Integer", + "totalUsers": "Integer", + "successfulUsers": "Integer", + "failedUsers": "Integer" +} +``` |
v1.0 | Identitygovernance Topworkflowsinsightssummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-topworkflowsinsightssummary.md | + + Title: "topWorkflowsInsightsSummary resource type" +description: "Represents a summary of the workflows processed the most within a tenant." ++ms.localizationpriority: medium ++++# topWorkflowsInsightsSummary resource type ++Namespace: microsoft.graph.identityGovernance ++Represents a summary of the workflows that are processed the most, or the _top workflows_, within a tenant, including workflow details and the total, failed, and successful run and processing history for the workflow. ++## Properties ++|Property|Type|Description| +|:|:|:| +|failedRuns|Int32|Count of failed runs for workflow.| +|failedUsers|Int32|Count of failed users who were processed.| +|successfulRuns|Int32|Count of successful runs of the workflow.| +|successfulUsers|Int32|Count of successful users processed by the workflow.| +|totalRuns|Int32|Count of total runs of workflow.| +|totalUsers|Int32|Total number of users processed by the workflow.| +|workflowCategory|microsoft.graph.identityGovernance.lifecycleWorkflowCategory|The category of the workflow. The possible values are: `joiner`, `leaver`, `unknownFutureValue`, `mover`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `mover`.| +|workflowDisplayName|String|The name of the workflow.| +|workflowId|String|The workflow ID.| +|workflowVersion|Int32|The version of the workflow that was a top workflow ran.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.topWorkflowsInsightsSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.topWorkflowsInsightsSummary", + "workflowId": "String", + "workflowDisplayName": "String", + "workflowCategory": "String", + "totalRuns": "Integer", + "successfulRuns": "Integer", + "failedRuns": "Integer", + "totalUsers": "Integer", + "successfulUsers": "Integer", + "failedUsers": "Integer", + "workflowVersion": "Integer" +} +``` |
v1.0 | Identitygovernance Triggerattribute | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-triggerattribute.md | + + Title: "triggerAttribute resource type" +description: "Defines the trigger attribute, which is changed to activate a workflow using an attributeChangeTrigger." ++ms.localizationpriority: medium ++++# triggerAttribute resource type ++Namespace: microsoft.graph.identityGovernance ++Defines the trigger attribute, which is changed to activate a workflow using an [attributeChangeTrigger](../resources/identitygovernance-attributechangetrigger.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|name|String|The name of the trigger attribute that is changed to trigger an [attributeChangeTrigger](../resources/identitygovernance-attributechangetrigger.md) workflow.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.triggerAttribute" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.triggerAttribute", + "name": "String" +} +``` + |
v1.0 | Identitygovernance Workflowexecutionconditions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-workflowexecutionconditions.md | doc_type: resourcePageType Namespace: microsoft.graph.identityGovernance -This is an abstract type noting the workflow execution conditions in [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) and [workflowBase](../resources/identitygovernance-workflowbase.md) objects. Execution conditions define when a workflow will run and rules that identify the users that are the target of the workflow. The following types are derived from this abstract type: +The workflowExecutionConditions type notes the workflow execution conditions in [workflowTemplate](../resources/identitygovernance-workflowtemplate.md) and [workflowBase](../resources/identitygovernance-workflowbase.md) objects. Execution conditions define when a workflow will run and rules that identify the users that are the target of the workflow. The following types are derived from this abstract type: + [onDemandExecutionOnly](../resources/identitygovernance-ondemandexecutiononly.md) + [triggerAndScopeBasedConditions](../resources/identitygovernance-triggerandscopebasedconditions.md) |
v1.0 | Identitygovernance Workflowexecutiontrigger | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-workflowexecutiontrigger.md | doc_type: resourcePageType Namespace: microsoft.graph.identityGovernance -This is an abstract type that represents the workflow execution trigger when the [workflow runs on schedule](../resources/identitygovernance-triggerandscopebasedconditions.md). It's inherited by the following derived types: +The workflowExecutionTrigger type represents the workflow execution trigger when the [workflow runs on schedule](../resources/identitygovernance-triggerandscopebasedconditions.md). It's inherited by the following derived types: + [timeBasedAttributeTrigger](../resources/identitygovernance-timebasedattributetrigger.md) ## Properties |
v1.0 | Identitygovernance Workflowsinsightsbycategory | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-workflowsinsightsbycategory.md | + + Title: "workflowsInsightsByCategory resource type" +description: "Represents a summary of workflows ran by category in a tenant" ++ms.localizationpriority: medium ++++# workflowsInsightsByCategory resource type ++Namespace: microsoft.graph.identityGovernance ++Represents a summary of the total, successful, and failed workflows run in a tenant by category. The possible categories are *Joiner*, *Mover*, or *Leaver*. For more information about workflows processed in a tenant, see [topWorkflowsInsightsSummary](identitygovernance-topworkflowsinsightssummary.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|failedJoinerRuns|Int32|Failed "*Joiner*" workflows processed in a tenant.| +|failedLeaverRuns|Int32|Failed "*Leaver*" workflows processed in a tenant.| +|failedMoverRuns|Int32|Failed "*Mover*" workflows processed in a tenant.| +|successfulJoinerRuns|Int32|Successful "*Joiner*" workflows processed in a tenant.| +|successfulLeaverRuns|Int32|Successful "*Leaver*" workflows processed in a tenant.| +|successfulMoverRuns|Int32|Successful "*Mover*" workflows processed in a tenant.| +|totalJoinerRuns|Int32|Total "*Joiner*" workflows processed in a tenant.| +|totalLeaverRuns|Int32|Total "*Leaver*" workflows processed in a tenant.| +|totalMoverRuns|Int32|Total "*Mover*" workflows processed in a tenant.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.workflowsInsightsByCategory" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.workflowsInsightsByCategory", + "totalJoinerRuns": "Integer", + "successfulJoinerRuns": "Integer", + "failedJoinerRuns": "Integer", + "totalMoverRuns": "Integer", + "successfulMoverRuns": "Integer", + "failedMoverRuns": "Integer", + "totalLeaverRuns": "Integer", + "successfulLeaverRuns": "Integer", + "failedLeaverRuns": "Integer" +} +``` |
v1.0 | Identitygovernance Workflowsinsightssummary | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identitygovernance-workflowsinsightssummary.md | + + Title: "workflowsInsightsSummary resource type" +description: "Provides a summary of workflow usage, known as insights, of Lifecycle Workflows in a tenant." ++ms.localizationpriority: medium ++++# workflowsInsightsSummary resource type ++Namespace: microsoft.graph.identityGovernance ++Provides a numerical summary of run information for workflows in a tenant, including total, successful, and failed tasks and user processing information. This resource contains information reported in the insights of a Lifecycle workflow tenant. More detailed specific task and workflow insight summaries are included in the [topTasksInsightsSummary](identitygovernance-toptasksinsightssummary.md) and [topWorkflowsInsightsSummary](identitygovernance-topworkflowsinsightssummary.md) resources. ++## Properties ++|Property|Type|Description| +|:|:|:| +|failedRuns|Int32|Count of failed workflow runs processed in the tenant.| +|failedTasks|Int32|Count of failed tasks processed in the tenant.| +|failedUsers|Int32|Count of failed users processed by workflows in the tenant.| +|successfulRuns|Int32|Count of successful workflow runs processed in the tenant.| +|successfulTasks|Int32|Count of successful tasks processed in the tenant.| +|successfulUsers|Int32|Count of successful users processed by workflows in the tenant.| +|totalRuns|Int32|Count of total workflows processed in the tenant.| +|totalTasks|Int32|Count of total tasks processed by workflows in the tenant.| +|totalUsers|Int32|Count of total users processed by workflows in the tenant.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.identityGovernance.workflowsInsightsSummary" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.identityGovernance.workflowsInsightsSummary", + "totalRuns": "Integer", + "successfulRuns": "Integer", + "failedRuns": "Integer", + "totalUsers": "Integer", + "successfulUsers": "Integer", + "failedUsers": "Integer", + "totalTasks": "Integer", + "successfulTasks": "Integer", + "failedTasks": "Integer" +} +``` |
v1.0 | Identityset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identityset.md | Represents a keyed collection of [identity](identity.md) resources. It is used t | phone | [identity](identity.md) | Optional. The phone number associated with this action. | | user | [identity](identity.md) | Optional. The user associated with this action. | +## Relationships ++None. ## JSON representation |
v1.0 | Identityuserflow | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/identityuserflow.md | Title: "UserFlow resource type" + Title: "identityUserFlow resource type" description: "Represents an identity user flow that is included in a built-in authentication journey." ms.localizationpriority: medium doc_type: "resourcePageType"+toc. Title: User flows in Azure AD B2C (deprecated) -# UserFlow resource type +# identityUserFlow resource type Namespace: microsoft.graph |
v1.0 | Incomingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/incomingcalloptions.md | Inherits from [callOptions](calloptions.md). |:|:--|:| | hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | | isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). |+| isDeltaRosterEnabled | Boolean | Indicates whether delta roster is enabled for the call. Inherited from [callOptions](calloptions.md). | ## JSON representation The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.incomingCallOptions", "hideBotAfterEscalation": "Boolean", - "isContentSharingNotificationEnabled": "Boolean" + "isContentSharingNotificationEnabled": "Boolean", + "isDeltaRosterEnabled": "Boolean" } ``` |
v1.0 | Insights Insightidentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-insightidentity.md | Title: insightIdentity complex type -description: "Complex type containing properties of Shared items." + Title: insightIdentity resource type +description: "Contains the properties of sharedInsight items." ms.localizationpriority: medium doc_type: resourcePageType -# insightIdentity complex type +# insightIdentity resource type Namespace: microsoft.graph -Complex type containing properties of [sharedInsight](insights-shared.md) items. +Contains the properties of [sharedInsight](insights-shared.md) items. ++## Properties ++| Property | Type | Description | +| - |-- | -| +| address | String | The email address of the user who shared the item. | +| displayName | String | The display name of the user who shared the item. | +| id | String | The ID of the user who shared the item. | ++## Relationships ++None. ## JSON representation+ The following JSON representation shows the resource type. <!-- { The following JSON representation shows the resource type. } ``` -## Properties --| Property | Type | Description | -| - |-- | -| -| address | String | The email address of the user who shared the item. | -| displayName | String | The display name of the user who shared the item. | -| id | String | The ID of the user who shared the item. | - |
v1.0 | Insights Resourcereference | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-resourcereference.md | Namespace: microsoft.graph Complex type containing properties of [officeGraphInsights](officegraphinsights.md). +## Properties ++| Property | Type | Description | +| - |--| -| +| id | String | The item's unique identifier. | +| type | String | A string value that can be used to classify the item, such as "microsoft.graph.driveItem" | +| webUrl | String | A URL leading to the referenced item. | ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "optionalProperties": [ The following JSON representation shows the resource type. "type": "string" } ```--## Properties --| Property | Type | Description | -| - |--| -| -| id | String | The item's unique identifier. | -| type | String | A string value that can be used to classify the item, such as "microsoft.graph.driveItem" | -| webUrl | String | A URL leading to the referenced item. | - |
v1.0 | Insights Resourcevisualization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-resourcevisualization.md | Namespace: microsoft.graph Complex type containing properties of [officeGraphInsights](officegraphinsights.md). -## JSON representation --The following JSON representation shows the resource type. --<!-- { - "blockType": "resource", - "optionalProperties": [ - ], - "@odata.type": "microsoft.graph.resourceVisualization" -}--> -```json -{ - "title": "string", - "type" : "string", - "mediaType": "string", - "previewImageUrl": "string", - "previewText": "string", - "containerWebUrl": "string", - "containerDisplayName": "string", - "containerType": "string" -} -``` - ## Properties | Property | Type | Description | The following JSON representation shows the resource type. | previewText | String | A preview text for the item. | | type | String | The item's media type. Can be used for filtering for a specific file based on a specific type. See the section Type property values for supported types. | -## Type property values +### Type property values - PowerPoint - Word - Excel Example query: Notes: For `spsite`, you may need to sort by `lastUsed/lastAccessedDateTime` desc in order to retrieve valid results -## containerType property values +### containerType property values The supported types can differ based on containers from which [officeGraphInsights](officegraphinsights.md) returns files. For example, only the [sharedInsight](insights-shared.md) insight returns files from 'DropBox,' 'Box,' and 'GDrive.' - OneDriveBusiness The supported types can differ based on containers from which [officeGraphInsigh Example query: `https://graph.microsoft.com/v1.0/me/insights/trending?$filter=ResourceVisualization/containerType eq 'OneDriveBusiness'` +## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "optionalProperties": [ + ], + "@odata.type": "microsoft.graph.resourceVisualization" +}--> +```json +{ + "title": "string", + "type" : "string", + "mediaType": "string", + "previewImageUrl": "string", + "previewText": "string", + "containerWebUrl": "string", + "containerDisplayName": "string", + "containerType": "string" +} +``` + |
v1.0 | Insights Sharingdetail | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-sharingdetail.md | Contains properties of [sharedInsight](insights-shared.md) items. | sharingType | String | Determines the way the document was shared. Can be by a 1Link1, 1Attachment1, 1Group1, 1Site1. | | sharingReference | [resourceReference](insights-resourcereference.md) | Reference properties of the document, such as the URL and type of the document. Read-only | +## Relationships ++None. ## JSON representation+ The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Insights Usagedetails | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/insights-usagedetails.md | Namespace: microsoft.graph Complex type containing properties of [Used](insights-used.md) items. Information on when the resource was last accessed (viewed) or modified (edited) by the user. +## Properties ++| Property | Type | Description | +| - || -| +| lastAccessedDateTime | DateTimeOffset | The date and time the resource was last accessed by the user. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. | +| lastModifiedDateTime | DateTimeOffset | The date and time the resource was last modified by the user. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. | +++## Relationships ++None. ## JSON representation The following JSON representation shows the resource type. "lastModifiedDateTime": "DateTimeOffset" } ```--## Properties --| Property | Type | Description | -| - || -| -| lastAccessedDateTime | DateTimeOffset | The date and time the resource was last accessed by the user. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. | -| lastModifiedDateTime | DateTimeOffset | The date and time the resource was last modified by the user. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. | - |
v1.0 | Integerrange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/integerrange.md | Represents an inclusive range of integers described by two Int64 boundaries. |end|Int64|The inclusive upper bound of the integer range.| |start|Int64|The inclusive lower bound of the integer range.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.integerRange" |
v1.0 | Internaldomainfederation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/internaldomainfederation.md | Inherits from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md). |metadataExchangeUri|String|URI of the metadata exchange endpoint used for authentication from rich client applications. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |nextSigningCertificate|String|Fallback token signing certificate that can also be used to sign tokens, for example when the primary signing certificate expires. Formatted as Base64 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 auto-rollover 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 into Microsoft Entra services. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).|-|preferredAuthenticationProtocol|authenticationProtocol|Preferred authentication protocol. The possible values are: `wsFed`, `saml`, `unknownFutureValue`. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| +|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`. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |promptLoginBehavior|promptLoginBehavior|Sets the preferred behavior for the sign-in prompt. The possible values are: `translateToFreshPasswordAuthentication`, `nativeSupport`, `disabled`, `unknownFutureValue`.| |signingCertificate|String|Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 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 will update the federation settings for the domain when a new certificate is available. Inherited from [samlOrWsFedProvider](../resources/samlorwsfedprovider.md).| |signingCertificateUpdateStatus|[signingCertificateUpdateStatus](../resources/signingcertificateupdatestatus.md)|Provides status and timestamp of the last update of the signing certificate.| |
v1.0 | Internalsponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/internalsponsors.md | Title: "internalSponsors complex type" -description: "Identifies a relationship to another user in the tenant who will be allowed as approver." + Title: "internalSponsors resource type" +description: "Identifies a relationship to another user in the tenant who is allowed as approver." ms.localizationpriority: medium doc_type: resourcePageType -# internalSponsors complex type +# internalSponsors resource type Namespace: microsoft.graph |
v1.0 | Intune Devices Windowsdefenderproductstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-devices-windowsdefenderproductstatus.md | Product Status of Windows Defender |platformAboutToBeOutdated|4194304|Platform is about to be outdated| |signatureOrPlatformEndOfLifeIsPastOrIsImpending|8388608|Signature or platform end of life is past or is impending| |windowsSModeSignaturesInUseOnNonWin10SInstall|16777216|Windows SMode signatures still in use on non-Win10S install|++The "ProductStatus" is a bit-mask flag value. Thus, the values can represent one or multiple product states from the list above. ++Examples of multiple product states:\ +524800 = 524288 (noStatusFlagsSet) + 512 (systemInitiatedScanInProgress) = 0x000**8**0**2**00\ +524544 = 524288 (noStatusFlagsSet) + 256 (noFullScanHappenedForSpecifiedPeriod) = 0x000**8**0**1**00\ +524416 = 524288 (noStatusFlagsSet) + 128 (noQuickScanHappenedForSpecifiedPeriod) = 0x000**8**00**8**0 |
v1.0 | Intune Graph Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-graph-overview.md | You can use either API to manage Windows updates; however, these two APIs are no ## Next Steps -- Learn [how to use Azure AD](/intune/intune-graph-apis) to access the Microsoft Graph API for Intune. -- Explore the [PowerShell Intune samples](https://github.com/microsoftgraph/powershell-intune-samples), which show how to use the Microsoft Graph API for Intune in context of working examples.+- Learn [how to use Entra ID](/graph/auth/auth-concepts) to access the Microsoft Graph API for Intune. +- Explore the [PowerShell Intune samples](https://microsoft.github.io/webportal-intune-samples/), which show how to use the Microsoft Graph API for Intune in context of working examples. |
v1.0 | Intune Shared Deviceandappmanagementassignmenttarget | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/intune-shared-deviceandappmanagementassignmenttarget.md | Namespace: microsoft.graph Base type for assignment targets. ## Properties-|Property|Type|Description| -|:|:|:| +None. ## Relationships-None +None. ## JSON Representation-Here is a JSON representation of the resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.deviceAndAppManagementAssignmentTarget" |
v1.0 | Itembody | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/itembody.md | Represents properties of the body of an item, such as a message, event or group |content|String|The content of the item.| |contentType|bodyType|The type of the content. Possible values are `text` and `html`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Keycredential | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/keycredential.md | To add a keyCredential using Microsoft Graph, see [Add a certificate to an app u | Property | Type |Description| |:|:--|:-| |customKeyIdentifier|Binary| A 40-character binary type that can be used to identify the credential. Optional. When not provided in the payload, defaults to the thumbprint of the certificate. |-| displayName | String | Friendly name for the key. Optional. | +| displayName | String | The friendly name for the key, with a maximum length of 90 characters. Longer values are accepted but shortened. Optional. | |endDateTime|DateTimeOffset|The date and time at which the credential expires. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|-|key|Binary| The certificate's raw data in byte array converted to Base64 string. Returned only on `$select` for a single object, that is, `GET applications/{applicationId}?$select=keyCredentials` or `GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials`; otherwise, it is always `null`. <br/><br> From a *.cer* certificate, you can read the key using the **Convert.ToBase64String()** method. For more information, see [Get the certificate key](/graph/applications-how-to-add-certificate).| +|key|Binary| The certificate's raw data in byte array converted to Base64 string. Returned only on `$select` for a single object, that is, `GET applications/{applicationId}?$select=keyCredentials` or `GET servicePrincipals/{servicePrincipalId}?$select=keyCredentials`; otherwise, it's always `null`. <br/><br> From a *.cer* certificate, you can read the key using the **Convert.ToBase64String()** method. For more information, see [Get the certificate key](/graph/applications-how-to-add-certificate).| |keyId|Guid|The unique identifier (GUID) for the key.| |startDateTime|DateTimeOffset|The date and time at which the credential becomes valid.The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |type|String|The type of key credential; for example, `Symmetric`, `AsymmetricX509Cert`.| To add a keyCredential using Microsoft Graph, see [Add a certificate to an app u ## JSON representation -The following is a JSON representation of the resource +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Keycredentialconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/keycredentialconfiguration.md | Title: "keyCredentialConfiguration resource type" -description: "Key credential configuration complex type to configure key credential restriction, maxLifetime, and enforcement date" +description: "Represents a key credential configuration object that contains properties to configure application certificate restrictions." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -Key credential configuration object that contains properties to configure restrictions such as restricting the lifetime of key secrets. +Represents a key credential configuration object that contains properties to configure application certificate restriction. ## Properties -| Property | Type | Description | -| :- | : | :-- | -| restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, `unknownFutureValue`. Each value of restrictionType can be used only once per policy. | -| maxLifetime | Duration | Value that can be used as the maximum duration in days, hours, minutes, or seconds from the date of key creation, for which the key is valid. Defined in ISO 8601 format for Durations. For example, `P4DT12H30M5S` represents a duration of four days, twelve hours, thirty minutes, and five seconds. This property is required when **restrictionType** is set to `keyLifetime`. | -| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Timestamp when the policy is enforced for all apps created on or after the specified date. For existing applications, the enforcement date would be back dated. To apply to all applications regardless of their creation date, this property would be `null`. Nullable. | +| Property | Type | Description | +| : | : | : | +| maxLifetime | Duration | String value that indicates the maximum lifetime for key expiration, defined as an ISO 8601 duration. For example, `P4DT12H30M5S` represents four days, 12 hours, 30 minutes, and five seconds. This property is required when **restrictionType** is set to `keyLifetime`.| +| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.| +| restrictionType | appKeyCredentialRestrictionType | The type of restriction being applied. Possible values are `asymmetricKeyLifetime`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.| +| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.| ## Relationships The following JSON representation shows the resource type. "restrictionType": { "@odata.type": "microsoft.graph.appKeyCredentialRestrictionType" },- "maxLifetime": "String (duration)", - "restrictForAppsCreatedAfterDateTime": "DateTimeOffset" + "state": { + "@odata.type": "microsoft.graph.appManagementRestrictionState" + }, + "restrictForAppsCreatedAfterDateTime": "String (DateTime)", + "maxLifetime": "String (duration)" } ``` |
v1.0 | Keyvaluepair | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/keyvaluepair.md | Key value pair for action parameters. |name|String|Name for this key-value pair| |value|String|Value for this key-value pair| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Location | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/location.md | Depending on how an event is created, expect Outlook to set the read-only **loca | uniqueId | String | For internal use only.| | uniqueIdType | locationUniqueIdType | For internal use only. | +## Relationships ++None. + ## JSON representation +The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "optionalProperties": [ |
v1.0 | Logicapptriggerendpointconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/logicapptriggerendpointconfiguration.md | The configuration details for the logic app's endpoint that is associated with a |subscriptionId|String|Identifier of the Azure subscription for the logic app.| |url|String| The URL to the logic app endpoint that will be triggered. Only required for app-only token scenarios where app is creating a [customCalloutExtension](../resources/customcalloutextension.md) without a signed-in user.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.logicAppTriggerEndpointConfiguration", |
v1.0 | Longrunningoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/longrunningoperation.md | Namespace: microsoft.graph Represents the status of a long-running Microsoft Graph API operation. The following types derive from this object:-- [richLongRunningOperation](richlongrunningoperation.md) - [attackSimulationOperation](../resources/attacksimulationoperation.md)+- [engagementAsyncOperation](../resources/engagementasyncoperation.md) +- [richLongRunningOperation](richlongrunningoperation.md) ## Properties |Property|Type|Description| |:|:|:|-|createdDateTime|DateTimeOffset|The start time of the operation. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|createdDateTime|DateTimeOffset|The start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |id|String|The unique identifier of the operation. |-|lastActionDateTime|DateTimeOffset|The time of the last action in the operation. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|lastActionDateTime|DateTimeOffset|The time of the last action in the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| |resourceLocation|String| URI of the resource that the operation is performed on. | |status|longRunningOperationStatus|The status of the operation. The possible values are: `notStarted`, `running`, `succeeded`, `failed`, `unknownFutureValue`.| |statusDetail|String|Details about the status of the operation.|-The following JSON representation shows the resource type. ## JSON representation |
v1.0 | Mailboxprotectionrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/mailboxprotectionrule.md | Inherits from [protectionRuleBase](../resources/protectionrulebase.md). |createdBy|[identitySet](../resources/identityset.md)|The identity of the person who created the rule.| |createdDateTime|DateTimeOffset|The date and time that the rule was created.| |error|[publicError](../resources/publicerror.md)|Contains error details if an operation on a rule expression fails.|-|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic. Static rules run one time and dynamic rules listen to all changes in the system and update the protection unit list.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Static rules run one time while dynamic rules listen to all changes in the system and update the protection unit list. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified this rule.| |lastModifiedDateTime|DateTimeOffset|Timestamp of last modification to the rule.| |mailboxExpression|String|Contains a mailbox expression. For examples, see [mailboxExpression examples](../resources/mailboxprotectionrule.md#mailboxexpression-examples).|-|status|[protectionRuleStatus](../resources/mailboxprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| +|status|[protectionRuleStatus](../resources/mailboxprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. The `draft` member is currently unsupported.| ### mailboxExpression examples The following table shows the possible formats for the mailbox expression. |Member | Description | |:|:|-|draft | The initial status of the protection rule upon creation.| +|draft | The initial status of the protection rule upon creation. The `draft` member is currently unsupported. | |active | The status of the protection rule upon using the `/run` API.|-|completed |The status of the protection rule after it is successfully applied to the corresponding policy.| -|completedWithErrors | The status of the protection rule after it is applied to the corresponding policy and any failures occurred.| -|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.| +|completed |The status of the protection rule after it's successfully applied to the corresponding policy.| +|completedWithErrors | The status of the protection rule after it's applied to the corresponding policy and any failures occurred.| +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Notebooklinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/notebooklinks.md | Namespace: microsoft.graph Links for opening a OneNote notebook. +## Properties +| Property | Type |Description| +|:|:--|:-| +|oneNoteClientUrl|[externalLink](externallink.md)|Opens the notebook in the OneNote native client if it's installed.| +|oneNoteWebUrl|[externalLink](externallink.md)|Opens the notebook in OneNote on the web.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|oneNoteClientUrl|[externalLink](externallink.md)|Opens the notebook in the OneNote native client if it's installed.| -|oneNoteWebUrl|[externalLink](externallink.md)|Opens the notebook in OneNote on the web.| <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Onattributecollectionexternalusersselfservicesignup | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onattributecollectionexternalusersselfservicesignup.md | Title: "onAttributeCollectionExternalUsersSelfServiceSignUp resource type" -description: "Managed handler that customizes what attributes are collected from an external user when authenticating to an application" +description: "Managed handler for the attribute collection step in an external identities user flow." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -This is a managed handler for attribute collection step of a customized authentication flow for an application in a Microsoft Entra external tenant defined by a multi-event policy, [externalUsersSelfServiceSignUpEventsFlow](externalUsersSelfServiceSignUpEventsFlow.md). This handler defines what attributes to collect from a user. For web-hosted auth flows, it also defines how the attribute collection will be rendered for the user. +This resource is a managed handler for the attribute collection step in an external identities user flow on a Microsoft Entra workforce or customer tenant. It defines what attributes to collect from a user and how the attribute collection will be rendered for the user. Inherits from [onAttributeCollectionHandler](../resources/onattributecollectionhandler.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [authenticationEventsFlow resource type](../resources/authenticationeventsflow.md). + ## Properties |Property|Type|Description| |:|:|:|-|attributeCollectionPage|[authenticationAttributeCollectionPage](../resources/authenticationattributecollectionpage.md)|Required. The configuration for how attributes are displayed in the sign up experience defined by a user flow, like the [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md), specifically on the attribute collection page.| +|attributeCollectionPage|[authenticationAttributeCollectionPage](../resources/authenticationattributecollectionpage.md)|Required. The configuration for how attributes are displayed in the sign-up experience defined by a user flow, like the [externalUsersSelfServiceSignupEventsFlow](../resources/externalusersselfservicesignupeventsflow.md), specifically on the attribute collection page.| <!--|accessPackages|[authenticationAccessPackageConfiguration](../resources/authenticationaccesspackageconfiguration.md) collection|Optional. A list of GUIDs referencing Entitlement Management [accessPackages](../resources/accesspackage.md) to check whether there are pending access requests for the specified user. Applicable only to user flows configured in Azure AD workforce tenant.|--> ## Relationships |
v1.0 | Onattributecollectionlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onattributecollectionlistener.md | A listener for when attributes are collected in an authentication flow. Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Onauthenticationmethodloadstartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onauthenticationmethodloadstartlistener.md | doc_type: resourcePageType Namespace: microsoft.graph -A listener for when authentication methods are ready to be presented to the user in an authentication flow. If this listener isn't specified, the default option is email one time passcode (OTP). May be part of an [authenticationEventsFlow](../resources/authenticationeventsflow.md). +A listener for when authentication methods are ready to be presented to the user in an authentication flow. If this listener isn't specified, the default option is email one time passcode (OTP). May be part of an [authenticationEventsFlow](../resources/authenticationeventsflow.md). Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |id|String|Required. Inherited from [entity](../resources/entity.md).| |conditions|[authenticationConditions](../resources/authenticationconditions.md)|Required. Inherited from [authenticationEventListener](../resources/authenticationeventlistener.md).| |authenticationEventsFlowId|String| Inherited from [authenticationEventListener](../resources/authenticationeventlistener.md).|-|handler|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|Required. Configuration for what to invoke if the event resolves to this listener. This lets us define potential handler configurations per-event.| +|handler|[onAuthenticationMethodLoadStartHandler](../resources/onauthenticationmethodloadstarthandler.md)|Required. Configuration for what to invoke if the event resolves to this listener. This property lets us define potential handler configurations per-event.| ## Relationships None. |
v1.0 | Onenotebasemodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenotebasemodel.md | Namespace: microsoft.graph This is the base type for OneNote entities. +## Properties ++| Property | Type |Description| +|:|:--|:-| +|self|String|The endpoint where you can get details about the page. Read-only.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|self|String|The endpoint where you can get details about the page. Read-only.| - <!-- uuid: bfb567de-2a2a-4b81-bf47-a55626a0c166 2015-10-25 14:57:30 UTC --> <!-- { |
v1.0 | Onenoteentityhierarchymodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenoteentityhierarchymodel.md | Namespace: microsoft.graph A base type for OneNote entities. +## Properties ++| Property | Type |Description| +|:|:--|:-| +|displayName|String|The name of the notebook.| +|createdBy|[identitySet](identityset.md)|Identity of the user, device, and application that created the item. Read-only.| +|lastModifiedBy|[identitySet](identityset.md)|Identity of the user, device, and application that created the item. Read-only.| +|lastModifiedDateTime|DateTimeOffset|The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|displayName|String|The name of the notebook.| -|createdBy|[identitySet](identityset.md)|Identity of the user, device, and application that created the item. Read-only.| -|lastModifiedBy|[identitySet](identityset.md)|Identity of the user, device, and application that created the item. Read-only.| -|lastModifiedDateTime|DateTimeOffset|The date and time when the notebook was last modified. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| <!-- uuid: 8b1af557-1a7c-4432-86eb-94989c2d4b54 2015-10-25 14:57:30 UTC --> |
v1.0 | Onenoteentityschemaobjectmodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenoteentityschemaobjectmodel.md | Namespace: microsoft.graph This is a base type for OneNote entities. +## Properties ++| Property | Type |Description| +|:|:--|:-| +|createdDateTime|DateTimeOffset|The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|createdDateTime|DateTimeOffset|The date and time when the page was created. The timestamp represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only.| <!-- uuid: bfb567de-2a2a-4b81-bf47-a55626a0c166 2015-10-25 14:57:30 UTC --> |
v1.0 | Onenoteoperationerror | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onenoteoperationerror.md | Namespace: microsoft.graph An error from a failed OneNote operation. +## Properties ++| Property | Type |Description| +|:|:--|:-| +|code|string|The error code.| +|message|string|The error message.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|code|string|The error code.| -|message|string|The error message.| <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Oninteractiveauthflowstartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/oninteractiveauthflowstartlistener.md | A listener for what to invoke when an authentication flow is ready to be initiat Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Onpremisesaccidentaldeletionprevention | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesaccidentaldeletionprevention.md | Title: "onPremisesAccidentalDeletionPrevention resource type" description: "Contains the accidental deletion prevention configuration for a tenant."-++ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Onpremisesdirectorysynchronization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesdirectorysynchronization.md | Title: "onPremisesDirectorySynchronization resource type" description: "A container for on-premises directory synchronization functionalities that are available for the organization."-++ ms.localizationpriority: medium doc_type: resourcePageType doc_type: resourcePageType Namespace: microsoft.graph -A container for on-premises directory synchronization functionalities that are available for the organization. Only the read and update operations are supported on this resource; create and delete aren't supported. +A container for [on-premises directory synchronization](../resources/onpremisesdirectorysynchronization.md) functionalities that are available for the organization. Only the read and update operations are supported on this resource; create and delete aren't supported. ## Methods |
v1.0 | Onpremisesdirectorysynchronizationconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesdirectorysynchronizationconfiguration.md | Title: "onPremisesDirectorySynchronizationConfiguration resource type" description: "Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant."-++ ms.localizationpriority: medium doc_type: resourcePageType doc_type: resourcePageType Namespace: microsoft.graph -Consists of configurations that can be fine-tuned and impact the on-premises directory synchronization process for a tenant. +Consists of configurations that can be fine-tuned and impact the [on-premises directory synchronization](../resources/onpremisesdirectorysynchronization.md) process for a tenant. ## Properties |
v1.0 | Onpremisesdirectorysynchronizationfeature | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesdirectorysynchronizationfeature.md | Title: "onPremisesDirectorySynchronizationFeature resource type" description: "Consists of directory synchronization features that can be enabled or disabled."-++ ms.localizationpriority: medium doc_type: resourcePageType Consists of directory synchronization features that can be enabled or disabled. | fopeConflictResolutionEnabled | Boolean | Used to indicate that for a Microsoft Forefront Online Protection for Exchange (FOPE) migrated tenant, the conflicting proxy address should be migrated over. | | groupWriteBackEnabled | Boolean | Used to enable object-level group writeback feature for additional group types. | | passwordSyncEnabled | Boolean | Used to indicate on-premise password synchronization is enabled. |-| passwordWritebackEnabled | Boolean | Used to indicate that writeback of password resets from Microsoft Entra ID to on-premises AD is enabled. | +| passwordWritebackEnabled | Boolean | Used to indicate that writeback of password resets from Microsoft Entra ID to on-premises AD is enabled. **This property isn't in use and updating it isn't supported.** | | quarantineUponProxyAddressesConflictEnabled | Boolean | Used to indicate that we should quarantine objects with conflicting proxy address. | | quarantineUponUpnConflictEnabled | Boolean | Used to indicate that we should quarantine objects conflicting with duplicate userPrincipalName. | | softMatchOnUpnEnabled | Boolean | Used to indicate that we should soft match objects based on userPrincipalName. | |
v1.0 | Onpremisesextensionattributes | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onpremisesextensionattributes.md | doc_type: resourcePageType Namespace: microsoft.graph -The return type of the **onPremisesExtensionAttributes** property of the [user](user.md) object and **extensionAttributes** property of the [device](device.md) object. Returns 15 custom extension attribute properties. +The return type of the **onPremisesExtensionAttributes** property of the [user](user.md) object and **extensionAttributes** property of the [device](device.md) object. Returns 15 custom extension attribute properties. Each attribute can store up to 1024 characters. On the [user](user.md) entity and for an **onPremisesSyncEnabled** user, the source of authority for this set of properties is the on-premises Active Directory that is synchronized to Microsoft Entra ID, and is read-only. For a cloud-only user (where **onPremisesSyncEnabled** is `false` or `null`), these properties can be set during [creation](../api/user-post-users.md) or [update](../api/user-update.md). If a cloud-only user was previously synced from on-premises Active Directory, these properties can't be managed via the Microsoft Graph API. Instead, they can be managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. |
v1.0 | Ontokenissuancestartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/ontokenissuancestartlistener.md | Inherits from [authenticationEventListener](../resources/authenticationeventlist ## Methods None. -For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. +For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. ## Properties |Property|Type|Description| |
v1.0 | Onusercreatestartlistener | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/onusercreatestartlistener.md | A listener for when the user is about to be created in an authentication flow. Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md). +## Methods +None. ++For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type. + ## Properties |Property|Type|Description| |:|:|:| |
v1.0 | Operation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/operation.md | The status of a long-running operation. |lastActionDateTime| DateTimeOffset |The time of the last action of the operation.| |status|operationStatus|The current status of the operation: `notStarted`, `running`, `completed`, `failed` | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Outgoingcalloptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/outgoingcalloptions.md | Inherits from [callOptions](calloptions.md). |:|:--|:| | hideBotAfterEscalation | Boolean | Indicates whether to hide the app after the call is escalated. Inherited from [callOptions](calloptions.md). | | isContentSharingNotificationEnabled | Boolean | Indicates whether content sharing notifications should be enabled for the call. Inherited from [callOptions](calloptions.md). |+| isDeltaRosterEnabled | Boolean | Indicates whether delta roster is enabled for the call. Inherited from [callOptions](calloptions.md). | ## JSON representation The following JSON representation shows the resource type. { "@odata.type": "#microsoft.graph.outgoingCallOptions", "hideBotAfterEscalation": "Boolean",- "isContentSharingNotificationEnabled": "Boolean" + "isContentSharingNotificationEnabled": "Boolean", + "isDeltaRosterEnabled": "Boolean" } ``` |
v1.0 | Outlookgeocoordinates | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/outlookgeocoordinates.md | Namespace: microsoft.graph The geographic coordinates, elevation, and their degree of accuracy for a physical location. +## Properties +| Property | Type |Description| +|:|:--|:-| +|accuracy|double|The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.| +|altitude|double|The altitude of the location.| +|altitudeAccuracy|double|The accuracy of the altitude.| +|latitude|double|The latitude of the location.| +|longitude|double|The longitude of the location.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|accuracy|double|The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.| -|altitude|double|The altitude of the location.| -|altitudeAccuracy|double|The accuracy of the altitude.| -|latitude|double|The latitude of the location.| -|longitude|double|The longitude of the location.| - <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- { |
v1.0 | Pagelinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/pagelinks.md | Namespace: microsoft.graph Links for opening a OneNote page. +## Properties ++| Property | Type |Description| +|:|:--|:-| +|oneNoteClientUrl|[externalLink](externallink.md)|Opens the page in the OneNote native client if it's installed.| +|oneNoteWebUrl|[externalLink](externallink.md)|Opens the page in OneNote on the web.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|oneNoteClientUrl|[externalLink](externallink.md)|Opens the page in the OneNote native client if it's installed.| -|oneNoteWebUrl|[externalLink](externallink.md)|Opens the page in OneNote on the web.| <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> |
v1.0 | Passwordcredentialconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/passwordcredentialconfiguration.md | Password credential configuration object that contains properties to configure r ## Properties -| Property | Type | Description | -| :- | : | : | -| restrictionType | appCredentialRestrictionType | The type of restriction being applied. The possible values are: `passwordAddition`, `passwordLifetime`, `symmetricKeyAddition`, `symmetricKeyLifetime`,`customPasswordAddition`, `unknownFutureValue`. Each value of restrictionType can be used only once per policy. | -| maxLifetime | Duration | Value that can be used as the maximum number for setting password expiration time in days, hours, minutes or seconds. Defined in ISO 8601 format for Durations. For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. This property is required when restriction type is set to `passwordLifetime`. | -| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Enforces the policy for an app created on or after the enforcement date. For existing applications, the enforcement date would be back dated. To apply to all applications, enforcement datetime would be `null`. | +| Property | Type | Description | +| : | : | : | +| maxLifetime | Duration | String value that indicates the maximum lifetime for password expiration, defined as an ISO 8601 duration. For example, `P4DT12H30M5S` represents four days, 12 hours, 30 minutes, and five seconds. This property is required when **restrictionType** is set to `passwordLifetime`.| +| restrictForAppsCreatedAfterDateTime | DateTimeOffset | Specifies the date from which the policy restriction applies to newly created applications. For existing applications, the enforcement date can be retroactively applied.| +| restrictionType | appCredentialRestrictionType | The type of restriction being applied. The possible values are: `passwordAddition`, `passwordLifetime`, `symmetricKeyAddition`, `symmetricKeyLifetime`, `customPasswordAddition`, and `unknownFutureValue`. Each value of restrictionType can be used only once per policy.| +| state | appManagementRestrictionState | String value that indicates if the restriction is evaluated. The possible values are: `enabled`, `disabled`, and `unknownFutureValue`. If `enabled`, the restriction is evaluated. If `disabled`, the restriction isn't evaluated or enforced.| ## Relationships The following JSON representation shows the resource type. "restrictionType": { "@odata.type": "microsoft.graph.appCredentialRestrictionType" },- "maxLifetime": "String (duration)", - "restrictForAppsCreatedAfterDateTime": "DateTimeOffset" + "state": { + "@odata.type": "microsoft.graph.appManagementRestrictionState" + }, + "restrictForAppsCreatedAfterDateTime": "String (DateTime)", + "maxLifetime": "String (duration)" } ``` |
v1.0 | Passwordprofile | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/passwordprofile.md | doc_type: resourcePageType Namespace: microsoft.graph -Contains the password profile associated with a user. The **passwordProfile** property of the [user](user.md) entity is a **passwordProfile** object. +Contains the password profile associated with a user. The **passwordProfile** property of the [user](user.md) entity is a **passwordProfile** object. See an example to [Update the passwordProfile of a user](../api/user-update.md#example-3-update-the-passwordprofile-of-a-user-and-reset-their-password). ## Properties |
v1.0 | Patternedrecurrence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/patternedrecurrence.md | The recurrence pattern and range. This shared object is used to define the recur |pattern|[recurrencePattern](recurrencepattern.md)|The frequency of an event. <br/><br/> For access reviews: <li>Do not specify this property for a one-time access review. <li> Only **interval**, **dayOfMonth**, and **type** (`weekly`, `absoluteMonthly`) properties of [recurrencePattern](recurrencepattern.md) are supported.| |range|[recurrenceRange](recurrencerange.md)|The duration of an event.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Phone | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/phone.md | Represents a phone number. |number|string|The phone number.| |type|phoneType|The type of phone number. The possible values are: `home`, `business`, `mobile`, `other`, `assistant`, `homeFax`, `businessFax`, `otherFax`, `pager`, `radio`.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Physicaladdress | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/physicaladdress.md | Represents the street address of a resource such as a contact or event. |state|String|The state.| |street|String|The street.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Plannerchecklistitems | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerchecklistitems.md | Title: "plannerChecklistItems resource type" -description: "The **plannerChecklistItemCollection** resource represents the collection of checklist items on a task. It's an Open Type. It's part of the task details object. The value in the property-value pair is the checklistItem object." +description: "Represents the collection of checklist items on a task. This complex type is an open type that's part of the task details object. The value in the property-value pair is the checklistItem object." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -The **plannerChecklistItemCollection** resource represents the collection of checklist items on a task. It's an Open Type. It's part of the [task details](plannertaskdetails.md) object. The value in the property-value pair is the [checklistItem](plannerchecklistitem.md) object. +Represents the collection of checklist items on a task. This complex type is an open type that's part of the [task details](plannertaskdetails.md) object. The value in the property-value pair is the [checklistItem](plannerchecklistitem.md) object. ## Properties-Properties of an Open Type can be defined by the client. In this case, the client should provide **GUIDs** as properties and their values must be [checklistItem](plannerchecklistitem.md) objects. Example is shown below. To remove an item in the checklist, set the value of the property to `null`. +Properties of an open type can be defined by the client. In this case, the client should provide **GUIDs** as properties and their values must be [checklistItem](plannerchecklistitem.md) objects. To remove an item in the checklist, set the value of the property to `null`. ## JSON representation The following JSON representation shows the resource type. { "String-value": {+ "@odata.type": "microsoft.graph.plannerChecklistItem", "isChecked": true,- "lastModifiedBy": "String-value", + "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"}, "lastModifiedByDateTime": "String(timestamp)", "orderHint": "String-value", "title": "String-value" } }-``` -// Example --```json -{ - "3a73c9dd-fb47-4230-9c0f-b80788fb0f9b": // client-generated GUID - { - "@odata.type": "microsoft.graph.checklistItem", // required in PATCH requests to edit the checklist on a task - "isChecked": true, - "lastModifiedBy": { - "user": { - "id": "ebf3b108-5234-4e22-b93d-656d7dae5874" - } - }, - "lastModifiedByDateTime": "2015-09-21T17:45:12.039Z", - "orderHint": "0009005756397228702", - "title": "Get stamps" - }, - "5f36f5b2-1ec0-4c48-9c75-ed59429516c5": - { - "@odata.type": "microsoft.graph.checklistItem", - "isChecked": false, - "lastModifiedBy": { - "user": { - "id": "ebf3b108-5234-4e22-b93d-656d7dae5874" - } - }, - "lastModifiedByDateTime": "2015-09-21T17:45:12.039Z", - "orderHint": "0004105723397228784", - "title": "Mail card at UPS" - } -} - ``` <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 |
v1.0 | Plannerorderhintsbyassignee | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerorderhintsbyassignee.md | Title: "plannerOrderHintsByAssignee resource type" -description: "The **plannerOrderHintsByAssignee** is a resource that contains ordering hints for assignees in a plannerTask resource, to indicate the order of the task in Assigned To view of the Task Board." +description: "Contains ordering hints for assignees in a plannerTask resource, to indicate the order of the task in Assigned To view of the Task Board." ms.localizationpriority: medium doc_type: resourcePageType Namespace: microsoft.graph -The **plannerOrderHintsByAssignee** is a resource that contains [ordering hints](planner-order-hint-format.md) for assignees in a [plannerTask](plannertask.md) resource, to indicate the order of the task in Assigned To view of the Task Board. +Contains [ordering hints](planner-order-hint-format.md) for assignees in a [plannerTask](plannertask.md) resource, to indicate the order of the task in Assigned To view of the Task Board. This type is an open type. The properties are the IDs of users assigned to the task, and the values are order hints. ## Properties |
v1.0 | Plannerplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannerplan.md | Represents a plan in Microsoft 365. A plan can be owned by a [group](group.md) a | Method | Return Type |Description| |:|:--|:-|-|[Get plan](../api/plannerplan-get.md) | [plannerPlan](plannerplan.md) |Read properties and relationships of **plannerPlan** object.| +|[Create](../api/planner-post-plans.md) | [plannerPlan](plannerplan.md) |Create a **plannerPlan** object.| +|[Get](../api/plannerplan-get.md) | [plannerPlan](plannerplan.md) |Read properties and relationships of **plannerPlan** object.| +|[Update](../api/plannerplan-update.md) | [plannerPlan](plannerplan.md) |Update **plannerPlan** object. | +|[Delete](../api/plannerplan-delete.md) | None | Delete **plannerPlan** object. | |[List plan buckets](../api/plannerplan-list-buckets.md) |[plannerBucket](plannerbucket.md) collection| Get a **plannerBucket** object collection.| |[List plan tasks](../api/plannerplan-list-tasks.md) |[plannerTask](plannertask.md) collection| Get a **plannerTask** object collection.|-|[Update plan](../api/plannerplan-update.md) | [plannerPlan](plannerplan.md) |Update **plannerPlan** object. | -|[Delete plan](../api/plannerplan-delete.md) | None | Delete **plannerPlan** object. | ## Properties | Property | Type |Description| |
v1.0 | Plannertask | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/plannertask.md | Represents a Planner task in Microsoft 365. A Planner task is contained in a [pl | Method | Return Type |Description| |:|:--|:-|-|[Get task](../api/plannertask-get.md) | [plannerTask](plannertask.md) |Read properties and relationships of **plannerTask** object.| -|[Update task](../api/plannertask-update.md) | [plannerTask](plannertask.md) |Update **plannerTask** object. | -|[Delete task](../api/plannertask-delete.md) | None |Delete **plannerTask** object. | +|[Create](../api/planner-post-tasks.md) | [plannerTask](plannertask.md) |Create **plannerTask** object.| +|[Get](../api/plannertask-get.md) | [plannerTask](plannertask.md) |Read properties and relationships of **plannerTask** object.| +|[Update](../api/plannertask-update.md) | [plannerTask](plannertask.md) |Update **plannerTask** object. | +|[Delete](../api/plannertask-delete.md) | None |Delete **plannerTask** object. | ## Properties | Property | Type |Description| |
v1.0 | Printjobstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printjobstatus.md | Represents the current status of a print job. |releaseWait|5|Job is pending to be released.| |interpreting|6|Job is in 'processing' state, but more specifically, document payload is being interpreted.| +## Relationships ++None. + ## JSON representation+ The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.printJobStatus" |
v1.0 | Printmargin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printmargin.md | Specifies the margin widths to use when printing. |right|Int32|The margin in microns from the right edge.| |top|Int32|The margin in microns from the top edge.| +## Relationships ++None. ## JSON representation+ The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.printMargin" |
v1.0 | Printoperationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printoperationstatus.md | Represents the current status of a long-running Universal Print operation. |failed|3|The operation failed.| |unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +## Relationships ++None. + ## JSON representation+ The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.printOperationStatus" |
v1.0 | Printsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printsettings.md | Represents tenant-wide settings for the Universal Print service. |:|:|:| |documentConversionEnabled|Boolean|Specifies whether document conversion is enabled for the tenant. If document conversion is enabled, Universal Print service will automatically convert documents into a format compatible with the printer (xps to pdf) when needed.| +## Relationships ++None. + ## JSON representation+ The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.printSettings" |
v1.0 | Printtaskstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/printtaskstatus.md | Represents the current execution status of a [printTask](printtask.md). |aborted|3|Task execution was aborted.| |unknownFutureValue|4|Evolvable enumeration sentinel value. Do not use.| +## Relationships ++None. + ## JSON representation+ The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.printTaskStatus" |
v1.0 | Privilegedidentitymanagement For Groups Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/privilegedidentitymanagement-for-groups-api-overview.md | Title: "Govern membership and ownership of groups using privileged identity management (PIM) for groups" -description: "Privileged Identity Management (PIM) is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources, such as groups, in your organization." + Title: "Govern membership and ownership of groups using PIM for groups" +description: "PIM, part of Microsoft Entra ID Governance, enables you to manage, control, and monitor access to important resources, such as groups, in your organization." ms.localizationpriority: medium doc_type: conceptualPageType - Previously updated : 10/03/2023+ Last updated : 09/25/2024+#Customer intent: As a security administrator, I want to understand how to use PIM for groups to govern membership and ownership of groups in my organization. # Govern membership and ownership of groups using PIM for groups -With Privileged Identity Management for groups (PIM for groups), you can govern how principals are assigned membership or ownership of [groups](groups-overview.md). Security and Microsoft 365 groups are critical resources that you can use to provide access to Microsoft cloud resources like Microsoft Entra roles, Azure roles, Azure SQL, Azure Key Vault, Intune; and third-party applications. PIM for groups gives you more control over how and when principals are members or owners of groups, and therefore have privileges granted through their group membership or ownership. +With [Privileged Identity Management for groups (PIM for groups)](/entr). Security and Microsoft 365 Groups are critical resources that you can use to provide access to Microsoft cloud resources like Microsoft Entra roles, Azure roles, Azure SQL, Azure Key Vault, Intune; and third-party applications. PIM for groups gives you more control over how and when principals are members or owners of groups, and therefore have privileges granted through their group membership or ownership. -The PIM for groups APIs in Microsoft Graph provide you with more governance over security and Microsoft 365 groups such as the following capabilities: +The PIM for groups APIs in Microsoft Graph provide you with more governance over security and Microsoft 365 Groups such as the following capabilities: - Providing principals just-in-time membership or ownership of groups - Assigning principals temporary membership or ownership of groups The following table lists scenarios for using PIM for groups APIs to manage acti ## PIM for groups APIs for managing eligible assignments of group owners and members -Your principals may not require permanent membership or ownership of groups because they may not require the privileges granted through the membership or ownership all the time. In this case, PIM for groups allows you to make the principals eligible for the membership or ownership of the groups. +Your principals might not require permanent membership or ownership of groups because they don't require the privileges granted through the membership or ownership all the time. In this case, PIM for groups allows you to make the principals eligible for the membership or ownership of the groups. -When a principal has an eligible assignment, they activate their assignment when they need the privileges granted through the groups to perform privileged tasks. An eligible assignment can be permanent or temporary. The activation is always time-bound for up to a maximum of eight hours. +When a principal has an eligible assignment, they activate their assignment when they need the privileges granted through the groups to perform privileged tasks. An eligible assignment can be permanent or temporary. The activation is always time-bound for a maximum of 8 hours. The principal can also extend or renew their membership or ownership of the group. The following table lists scenarios for using PIM for groups APIs to manage eligible assignments for principals and the corresponding APIs to call. The following table lists scenarios for using PIM for groups APIs to manage elig ## Policy settings in PIM for groups -PIM for groups defines settings or rules that govern how principals can be assigned membership or ownership of security and Microsoft 365 groups. Such rules include whether multifactor authentication (MFA), justification, or approval is required to activate an eligible membership or ownership for a group, or whether you can create permanent assignments or eligibilities for principals to the groups. The rules are defined in policies and a policy can be applied to a group. +PIM for groups defines settings or rules that govern how principals can be assigned membership or ownership of security and Microsoft 365 Groups. Such rules include whether multifactor authentication (MFA), justification, or approval is required to activate an eligible membership or ownership for a group, or whether you can create permanent assignments or eligibilities for principals to the groups. The rules are defined in policies and a policy can be applied to a group. In Microsoft Graph, these rules are managed through the [unifiedRoleManagementPolicy](unifiedrolemanagementpolicy.md) and the [unifiedRoleManagementPolicyAssignment](unifiedrolemanagementpolicyassignment.md) resource types and their related methods. For more information about using Microsoft Graph to configure rules, see [Overvi You can't onboard a group to PIM for groups explicitly. When you request to add assignment to group using [Create assignmentScheduleRequest](../api/privilegedaccessgroup-post-assignmentschedulerequests.md) or [Create eligibilityScheduleRequest](../api/privilegedaccessgroup-post-eligibilityschedulerequests.md), or you update PIM policy (role settings) for a group using [Update unifiedRoleManagementPolicy](../api/unifiedrolemanagementpolicy-update.md) or [Update unifiedRoleManagementPolicyRule](../api/unifiedrolemanagementpolicyrule-update.md), the group is onboarded to PIM automatically if it wasn't onboarded before. -You can call [List assignmentScheduleRequests](../api/privilegedaccessgroup-list-assignmentschedulerequests.md), [List assignmentSchedules](../api/privilegedaccessgroup-list-assignmentschedules.md), [List assignmentScheduleInstances](../api/privilegedaccessgroup-list-assignmentscheduleinstances.md), [List eligibilityScheduleRequests](../api/privilegedaccessgroup-list-eligibilityschedulerequests.md), [List eligibilitySchedules](../api/privilegedaccessgroup-list-eligibilityschedules.md), and [List eligibilityScheduleInstances](../api/privilegedaccessgroup-list-eligibilityscheduleinstances.md) APIs for both groups that are onboarded to PIM and groups that aren't onboarded to PIM yet, but we recommend doing it only for groups that are onboarded to PIM to reduce the chances of getting throttled +You can call one of the following APIs for both groups that are onboarded to PIM and groups that aren't onboarded to PIM yet, but we recommend doing it only for groups that are onboarded to PIM to reduce the chances of getting throttled. +- [List assignmentScheduleRequests](../api/privilegedaccessgroup-list-assignmentschedulerequests.md) +- [List assignmentSchedules](../api/privilegedaccessgroup-list-assignmentschedules.md) +- [List assignmentScheduleInstances](../api/privilegedaccessgroup-list-assignmentscheduleinstances.md), +- [List eligibilityScheduleRequests](../api/privilegedaccessgroup-list-eligibilityschedulerequests.md) +- [List eligibilitySchedules](../api/privilegedaccessgroup-list-eligibilityschedules.md) +- [List eligibilityScheduleInstances](../api/privilegedaccessgroup-list-eligibilityscheduleinstances.md) After PIM onboards a group, IDs of the PIM policies and policy assignments of the specific group change. Call the [Get unifiedRoleManagementPolicy](../api/unifiedrolemanagementpolicy-get.md) or [Get unifiedRoleManagementPolicyAssignment](../api/unifiedrolemanagementpolicyassignment-get.md) API to get the updated IDs. When a principal's *temporary active* membership or ownership of a group expires <!-- End of: Link to ZT guidance --> -## Permissions and privileges --The following Microsoft Graph permissions are required to call the PIM for groups APIs. --| Endpoints | Supported operations | Permissions | -|||| -| assignmentSchedule <br/> assignmentScheduleInstance | LIST, GET | PrivilegedAssignmentSchedule.Read.AzureADGroup <br/> PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| assignmentScheduleRequest | CREATE, LIST, GET, UPDATE, DELELE | PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| eligibilitySchedule <br/> eligibilityScheduleInstance | LIST, GET | PrivilegedEligibilitySchedule.Read.AzureADGroup <br/> PrivilegedEligibilitySchedule.ReadWrite.AzureADGroup | -| eligibilityScheduleRequest | CREATE, LIST, GET, UPDATE, DELELE | PrivilegedEligibilitySchedule.ReadWrite.AzureADGroup | -| approval | GET | PrivilegedAssignmentSchedule.Read.AzureADGroup <br/> PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| approvalStep | LIST, GET | PrivilegedAssignmentSchedule.Read.AzureADGroup <br/> PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| approvalStep | UPDATE | PrivilegedAssignmentSchedule.ReadWrite.AzureADGroup | -| roleManagementPolicy <br/> roleManagementPolicyAssignment | LIST, GET | RoleManagementPolicy.Read.AzureADGroup <br/> RoleManagementPolicy.ReadWrite.AzureADGroup | -| roleManagementPolicy | UPDATE | RoleManagementPolicy.ReadWrite.AzureADGroup | --In addition, for delegated scenarios, the calling principal needs one of the following roles (not applicable to approval and approvalStep endpoints). --| Group | Role | Supported operations | -|||| -| Role-assignable | Privileged Role Administrator <br/> Group owner* <br/> Group member* | CREATE, UPDATE, DELELE | -| Role-assignable | Global Reader <br/> Privileged Role Administrator <br/> Group owner* <br/> Group member* | LIST, GET | -| Non-role-assignable | Directory Writer <br/> Groups Administrator <br/> Identity Governance Administrator <br/> User Administrator <br/> Group owner* <br/> Group member* | CREATE, UPDATE, DELELE | -| Non-role-assignable | Global Reader <br/> Directory Writer <br/> Groups Administrator <br/> Identity Governance Administrator <br/> User Administrator <br/> Group owner* <br/> Group member* | LIST, GET | --`*` Permissions for group members and group owners are limited to the read or write operations they need to perform. For example, a group member can [cancel their assignmentScheduleRequest](../api/privilegedaccessgroupassignmentschedulerequest-cancel.md) but not any other principal's request. --Only the approver of the request can call the `/approval` and `/approvalStep` endpoints. They don't have to be assigned any Microsoft Entra roles. +## Licensing +The tenant where Privileged Identity Management is being used must have enough purchased or trial licenses. For more information, see [Microsoft Entra ID Governance licensing fundamentals](/entra/id-governance/licensing-fundamentals). ## Related content -- [What is Microsoft Entra ID Governance?](/azure/active-directory/governance/identity-governance-overview)-- [What is Microsoft Entra Privileged Identity Management?](/azure/active-directory/privileged-identity-management/pim-configure)-- [Privileged Identity Management (PIM) for groups](/azure/active-directory/privileged-identity-management/concept-pim-for-groups)+- [Microsoft Entra security operations for Privileged Identity Management](/azure/active-directory/architecture/security-operations-privileged-identity-management?source=docs#privileged-identity-management-alerts) in the Microsoft Entra architecture center <!-- { "type": "#page.annotation", |
v1.0 | Privilegedidentitymanagementv3 Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/privilegedidentitymanagementv3-overview.md | Title: "Manage Microsoft Entra role assignments using the privileged identity management (PIM) APIs" -description: "Privileged Identity Management (PIM) is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources in your organization." + Title: "Manage Microsoft Entra role assignments using the PIM APIs" +description: "PIM is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources in your organization." ms.localizationpriority: medium doc_type: conceptualPageType - Previously updated : 09/13/2023+ Last updated : 09/24/2024+# Customer intent: As a developer, I want to learn how to get started with PIM APIs for managing Microsoft Entra roles. # Manage Microsoft Entra role assignments using PIM APIs -Privileged Identity Management (PIM) is a feature of [Microsoft Entra ID Governance](#related-content) that enables you to manage, control, and monitor access to important resources in your organization. One method through which principals such as users, groups, and service principals (applications) are granted access to important resources is through assignment of [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). +[Privileged Identity Management (PIM)](/entra/id-governance/privileged-identity-management/pim-configure) is a feature of Microsoft Entra ID Governance that enables you to manage, control, and monitor access to important resources in your organization. One method through which principals such as users, groups, and service principals (applications) are granted access to important resources is through assignment of [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json). The PIM for Microsoft Entra roles APIs allow you to govern privileged access and limit excessive access to Microsoft Entra roles. This article introduces the governance capabilities of PIM for Microsoft Entra roles APIs in Microsoft Graph. > [!NOTE] > To manage Azure resource roles use the [Azure Resource Manager APIs for PIM](/rest/api/authorization/privileged-role-eligibility-rest-sample). >-> PIM APIs for managing security alerts for Microsoft Entra roles are available on the `beta` endpoint only. For more information, see [Security alerts for Microsoft Entra roles](/graph/api/resources/privilegedidentitymanagementv3-overview?view=graph-rest-beta#security-alerts-for-azure-ad-roles&preserve-view=true). +> PIM APIs for managing security alerts for Microsoft Entra roles are available on the `/beta` endpoint only. For more information, see [Security alerts for Microsoft Entra roles](/graph/api/resources/privilegedidentitymanagementv3-overview?view=graph-rest-beta#security-alerts-for-azure-ad-roles&preserve-view=true). ++## Methods of assigning roles ++PIM for Microsoft Entra roles provides two methods for assigning roles to principals: +- **Active role assignments**: A principal can have a permanent or temporary perpetually active role assignment. +- **Eligible role assignments**: A principal can be eligibile for a role either permanently or temporarily. With eligible assigments, the principal activates their role - thereby creating a temporarily active role assignment - when they need to perform privileged tasks. The activation is always time-bound for a maximum of 8 hours but the maximum duration can be lowered in the role settings. The activation can also be renewed or extended. ## PIM APIs for managing active role assignments PIM allows you to manage active role assignments by creating permanent assignments or temporary assignments. Use the [unifiedRoleAssignmentScheduleRequest](unifiedroleassignmentschedulerequest.md) resource type and its related methods to manage role assignments. +> [!NOTE] +> We recommend using PIM to manage active role assignments over using the [unifiedRoleAssignment](../resources/unifiedroleassignment.md) or the [directoryRole](../resources/directoryrole.md) resource types to manage them directly. + The following table lists scenarios for using PIM to manage role assignments and the APIs to call. |Scenarios |API | The following table lists scenarios for using PIM to manage role assignments and ## PIM APIs for managing role eligibilities -Your principals may not require permanent role assignments because they may not require the privileges granted through the privileged role all the time. In this case, PIM also allows you to create role eligibilities and assign them to the principals. With role eligibilities, the principal activates the role when they need to perform privileged tasks. The activation is always time-bound for a maximum of 8 hours. The role eligibility can also be a permanent eligibility or a temporary eligibility. +Your principals may not require permanent role assignments because they don't require the privileges granted through the privileged role all the time. In this case, PIM also allows you to create role eligibilities and assign them to the principals. With role eligibilities, the principal activates the role when they need to perform privileged tasks. The activation is always time-bound for a maximum of 8 hours. The principal can also be permanently or temporarily eligible fot the role. Use the [unifiedRoleEligibilityScheduleRequest](unifiedroleeligibilityschedulerequest.md) resource type and its related methods to manage role eligibilities. The following table lists scenarios for using PIM to manage rules for Microsoft For more information about using Microsoft Graph to configure rules, see [Overview of rules for Microsoft Entra roles in PIM APIs](/graph/identity-governance-pim-rules-overview). For examples of updating rules, see [Use PIM APIs to update rules for Microsoft Entra ID roles](/graph/how-to-pim-update-rules). +## Audit logs ++All activities made through PIM for Microsoft Entra roles are logged in Microsoft Entra audit logs and you can read through the [List directory audits](/graph/api/directoryaudit-list) API. + <!-- Start of: Link to ZT guidance: H2 section --> [!INCLUDE [zero-trust](../../../includes/identity-zero-trust.md)] The tenant where Privileged Identity Management is being used must have enough p ## Related content -+ [What is Microsoft Entra Privileged Identity Management?](/azure/active-directory/privileged-identity-management/pim-configure) -+ Learn more about role settings in PIM through the following articles: - + [Working with rules for Microsoft Entra roles in PIM APIs](/graph/identity-governance-pim-rules-overview) - + [Use PIM APIs to update rules for Microsoft Entra ID roles](/graph/how-to-pim-update-rules) -+ Follow these tutorials to learn more about using PIM APIs - + [Tutorial: Use the Privileged Identity Management (PIM) API to assign Microsoft Entra roles](/graph/tutorial-assign-azureadroles) +- To learn more about security operations, see [Microsoft Entra security operations for Privileged Identity Management](/azure/active-directory/architecture/security-operations-privileged-identity-management?source=docs#privileged-identity-management-alerts) in the Microsoft Entra architecture center. |
v1.0 | Protectionrulebase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/protectionrulebase.md | Title: "protectionRuleBase resource type" -description: "Describes Protection Rule and its properties " +description: "Represents a protection rule specified by the client as part of a protection plan applied to Microsoft 365 data in an organization." ms.localizationpriority: medium Namespace: microsoft.graph Represents a protection rule specified by the client as part of a protection plan applied to Microsoft 365 data in an organization. Currently, only inclusion rules, which are rules that indicate that a protection policy should match the specified criteria, can be defined. -Protection rules can be static or dynamic, which means that the rules can run one time or at regular intervals. +Currently, protection Rules are static in nature, meaning policy changes are applied only when the rule is executed, with no automatic/dynamic updates. This abstract type is the base type for [siteProtectionRule](../resources/siteprotectionrule.md), [mailboxProtectionRule](../resources/mailboxprotectionrule.md), and [driveProtectionRule](../resources/driveprotectionrule.md). +The following limitations apply to this resource: ++- The protection rule APIs for bulk addition of sites via site names or URL in the backup policy creation workflow can accommodate a maximum of 10 keywords at a time. Each keyword can have a minimum of three characters and a maximum of 255 characters. +- The protection rule APIs for bulk addition of user accounts via security groups or distribution lists can accommodate a maximum of three groups at a time. +- The rules are static and applied one time only. That is, the security groups or distribution lists are flattened at the time they're added to the backup configuration policy. For example, groups or lists aren't dynamically updated in the system if users are added or removed from the original security group. + ## Properties |Property|Type|Description| This abstract type is the base type for [siteProtectionRule](../resources/sitepr |createdBy|[identitySet](../resources/identityset.md)|The identity of person who created the rule.| |createdDateTime|DateTimeOffset|The time of creation of the rule.| |error|[publicError](../resources/publicerror.md)|Contains error details if an operation on a rule fails.|-|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of the person who last modified the rule.| |lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification made to the rule.|-|status|[protectionRuleStatus](../resources/protectionrulebase.md#protectionrulestatus-values )|The status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| +|status|[protectionRuleStatus](../resources/protectionrulebase.md#protectionrulestatus-values )|The status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. The `draft` member is currently unsupported.| ### protectionRuleStatus values |Member | Description | |:|:|-|draft | The initial status of the protection rule upon creation.| +|draft | The initial status of the protection rule upon creation. The `draft` member is currently unsupported. | |active | The status of the protection rule when it's running.| |completed | The status of the protection rule when it's successfully applied to the corresponding policy.| |completedWithErrors | The status of the protection rule when the rule ran but encountered errors.|-|unknownFutureValue | Evolvable enumeration sentinel value. Do not use. | +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ## Relationships |
v1.0 | Protectionunitbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/protectionunitbase.md | toc. Title: Protection unit Namespace: microsoft.graph -Represents a site, drive, or mailbox that's protected by a [protection policy](protectionpolicybase.md). +Represents a site, drive, or mailbox that's protected by a [protection policy](protectionpolicybase.md). All the protection units in a protection policy have same retention period by default. This resource is an abstract type. |
v1.0 | Provisionedplan | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/provisionedplan.md | Used by the **provisionedPlans** property of the [user](user.md) entity and the ## Properties | Property | Type |Description| |:|:--|:-|-|capabilityStatus|String|For example, "Enabled".| -|provisioningStatus|String|For example, "Success".| -|service|String|The name of the service; for example, "AccessControlS2S"| +|capabilityStatus|String|Condition of the capability assignment. The possible values are `Enabled`, `Warning`, `Suspended`, `Deleted`, `LockedOut`. See [a detailed description of each value](../resources/assignedplan.md#capabilitystatus-values).| +|provisioningStatus|String|The possible values are:<br/>`Success` - Service is fully provisioned.<br/>`Disabled` - Service is disabled.<br/>`Error` - The service plan isn't provisioned and is in an error state.<br/>`PendingInput` - The service isn't provisioned and is awaiting service confirmation.<br/>`PendingActivation` - The service is provisioned but requires explicit activation by an administrator (for example, Intune_O365 service plan)<br/>`PendingProvisioning` - Microsoft has added a new service to the product SKU and it isn't activated in the tenant.| +|service|String|The name of the service; for example, "AccessControlS2S".| ## JSON representation |
v1.0 | Recentnotebooklinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/recentnotebooklinks.md | Links for opening a OneNote notebook. This resource type exists as a property on |oneNoteClientUrl|[externalLink](externallink.md)|Opens the notebook in the OneNote native client if it's installed.| |oneNoteWebUrl|[externalLink](externallink.md)|Opens the notebook in OneNote on the web.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Recurrencepattern | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/recurrencepattern.md | Use the **type** property to specify the different types of **recurrencePattern* | `absoluteYearly` | Event repeats on the specified day and month, based on the number of years between occurrences. | Repeat event on the 15th of March every 3 years. | **type**, **interval**, **dayOfMonth**, **month** | | `relativeYearly` | Event repeats on the specified day or days of the week, in the same relative position in a specific month of the year, based on the number of years between occurrences. | Repeat event on the second Thursday or Friday of every November every 3 years. | **type**, **interval**, **daysOfWeek**, **month** | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Recurrencerange | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/recurrencerange.md | Use the **type** property to specify the different types of **recurrenceRange**. |`noEnd` |Range without an end date | Event repeats on all the days that fit the corresponding recurrence pattern beginning on the **startDate**. | Repeat event in the date range starting on June 1, 2017 indefinitely. | **type**, **startDate** | |`numbered`|Range with specific number of occurrences | Event repeats for the **numberOfOccurrences** based on the recurrence pattern beginning on the **startDate**. | Repeat event in the date range starting on June 1, 2017, for 10 occurrences. | **type**, **startDate**, **numberOfOccurrences** | +## Relationships ++None. ## JSON representation |
v1.0 | Report | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/report.md | For details about the settings that govern identification/de-identification of i Microsoft Graph controls access to resources via permissions. You must specify the permissions you need in order to access Reports resources. Typically, you specify permissions in the Microsoft Entra admin center. For more information, see [Microsoft Graph permissions reference](/graph/permissions-reference) and [Reports permissions](/graph/permissions-reference#reports-permissions). +## Settings ++In Microsoft 365 reports, user information such as usernames, groups, and sites is concealed; actual values aren't displayed. You can use the [adminReportSettings](../resources/adminreportsettings.md) API to control the display of user information in the reports. + ## Cloud deployments The following table shows the availability for each API across all cloud deployments. | APIs | Microsoft Graph global service | Microsoft Cloud for US Government | Microsoft Cloud China operated by 21Vianet | | - | | -| |+| [Admin report settings](../resources/adminreportsettings.md) | Γ£ö | Γ₧û | Γ₧û | | [Microsoft 365 activations](reportroot.md#microsoft-365-activations) | Γ£ö | Γ₧û | Γ₧û | | [Microsoft 365 active users](reportroot.md#microsoft-365-active-users) | Γ£ö | Γ₧û | Γ₧û | | [Microsoft 365 apps usage](reportroot.md#microsoft-365-apps-usage) | Γ£ö | Γ₧û | Γ₧û | |
v1.0 | Requestormanager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/requestormanager.md | Title: "requestorManager complex type" + Title: "requestorManager resource type" description: "Identifies a relationship to another user in the tenant who is allowed as approver." ms.localizationpriority: medium doc_type: resourcePageType -# requestorManager complex type +# requestorManager resource type Namespace: microsoft.graph It's a subtype of [subjectSet](subjectset.md), in which the `@odata.type` value |managerLevel|Int32|The hierarchical level of the manager with respect to the requestor. For example, the direct manager of a requestor would have a managerLevel of 1, while the manager of the requestor's manager would have a managerLevel of 2. Default value for managerLevel is 1. Possible values for this property range from 1 to 2. | ## Relationships+ None.+ ## JSON representation+ The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.requestorManager", |
v1.0 | Resourcespecificpermissiongrant | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/resourcespecificpermissiongrant.md | For more information about granting apps consent to access a specific instance o |[List permission grants of a chat](../api/chat-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List permissions that have been granted in a specific chat. | |[List permission grants of a group](../api/group-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List resource-specific permissions that have been granted in a specific [group](group.md). | |[List permission grants of a team](../api/team-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List permissions that have been granted in a specific team. |+|[List permission grants of a user](../api/user-list-permissiongrants.md) | [resourceSpecificPermissionGrant](resourcespecificpermissiongrant.md) collection | List resource-specific permissions that have been granted to a specific [user](user.md). | ## Properties |
v1.0 | Restorepoint | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/restorepoint.md | Namespace: microsoft.graph Represents the date and time when an [artifact](../resources/restoreartifactbase.md) is protected by a [protectionPolicy](../resources/protectionpolicybase.md) and can be restored. +The following limitations apply to this API: ++- When sites or mailboxes are added to a backup policy, it might take up to 15 minutes per 1,000 sites or mailboxes for restore points to become available. +- Although OneDrive account and mailbox backups of deleted users are maintained and restorable after the userΓÇÖs Microsoft Entra ID is deleted, the user is displayed as an empty user in results. + ## Methods |Method|Return type|Description| |
v1.0 | Restoresessionbase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/restoresessionbase.md | toc. Title: Restore session Namespace: microsoft.graph -Represents a restore session for a [protection unit](protectionunitbase.md) that's protected by a [protection policy](protectionpolicybase.md). APIs are used by Global Admin or SharePoint Online Admin for SharePoint Online/OneDrive & Exchange Online Admin for Exchange Online to perform restore related tasks on artifacts that are protected as part of Protection Policy. +Represents a restore session for a [protection unit](protectionunitbase.md) that's protected by a [protection policy](protectionpolicybase.md). Restore session APIs are used by global admins, SharePoint Online admins, and Exchange Online admins to perform restore-related tasks on artifacts that are protected as part of protection policy. ++Restoring to both a new location and the same URL in a single restore session is not supported. ## Methods |
v1.0 | Resulttemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/resulttemplate.md | Represents a dictionary of **resultTemplateIds** and associated values, which in |displayName|String|Name of the result template.| |key|String|ID of a result template. The **key** property must map to a **resultTemplateId** in the [searchHit](searchhit.md) collection.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Resulttemplateoption | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/resulttemplateoption.md | Provides the search result template options to render search results from connec |:-|:|:| |enableResultTemplate|Boolean|Indicates whether search display layouts are enabled. If enabled, the user will get the result template to render the search results content in the **resultTemplates** property of the [response](/graph/api/resources/searchresponse). The result template is based on [Adaptive Cards](https://adaptivecards.io/). Optional. | +## Relationships ++None. ## JSON representation |
v1.0 | Riskdetection | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/riskdetection.md | For more information about risk detection, see [Microsoft Entra ID Protection](/ |lastUpdatedDateTime|DateTimeOffset|Date and time that the risk detection was last updated. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is look like this: `2014-01-01T00:00:00Z`| |location|[signInLocation](../resources/signinlocation.md)|Location of the sign-in.| |requestId|String|Request ID of the sign-in associated with the risk detection. This property is `null` if the risk detection is not associated with a sign-in.|-|riskDetail|riskDetail|Details of the detected risk. The possible values are: `none`, `adminGeneratedTemporaryPassword`, `userPerformedSecuredPasswordChange`, `userPerformedSecuredPasswordReset`, `adminConfirmedSigninSafe`, `aiConfirmedSigninSafe`, `userPassedMFADrivenByRiskBasedPolicy`, `adminDismissedAllRiskForUser`, `adminConfirmedSigninCompromised`, `hidden`, `adminConfirmedUserCompromised`, `unknownFutureValue`, `m365DAdminDismissedDetection`. Note that you must use the `Prefer: include - unknown -enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `m365DAdminDismissedDetection`.| +|riskDetail|riskDetail|Details of the detected risk. The possible values are: `none`, `adminGeneratedTemporaryPassword`, `userChangedPasswordOnPremises`, `userPerformedSecuredPasswordChange`, `userPerformedSecuredPasswordReset`, `adminConfirmedSigninSafe`, `aiConfirmedSigninSafe`, `userPassedMFADrivenByRiskBasedPolicy`, `adminDismissedAllRiskForUser`, `adminConfirmedSigninCompromised`, `hidden`, `adminConfirmedUserCompromised`, `unknownFutureValue`, `m365DAdminDismissedDetection`. Note that you must use the `Prefer: include - unknown -enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `m365DAdminDismissedDetection`.| |riskEventType|String|The type of risk event detected. The possible values are `adminConfirmedUserCompromised`, `anomalousToken`, `anomalousUserActivity`, `anonymizedIPAddress`, `generic`, `impossibleTravel`, `investigationsThreatIntelligence`, `suspiciousSendingPatterns`, `leakedCredentials`, `maliciousIPAddress`,`malwareInfectedIPAddress`, `mcasSuspiciousInboxManipulationRules`, `newCountry`, `passwordSpray`,`riskyIPAddress`, `suspiciousAPITraffic`, `suspiciousBrowser`,`suspiciousInboxForwarding`, `suspiciousIPAddress`, `tokenIssuerAnomaly`, `unfamiliarFeatures`, `unlikelyTravel`. If the risk detection is a premium detection, will show `generic`. <br/>For more information about each value, see [Risk types and detection](/entra/id-protection/concept-identity-protection-risks#risk-types-and-detection).| |riskLevel|riskLevel|Level of the detected risk. Possible values are: `low`, `medium`, `high`, `hidden`, `none`, `unknownFutureValue`.| |riskState|riskState|The state of a detected risky user or sign-in. Possible values are: `none`, `confirmedSafe`, `remediated`, `dismissed`, `atRisk`, `confirmedCompromised`, `unknownFutureValue`.| |
v1.0 | Rubriccriterion | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rubriccriterion.md | See [educationRubric](educationrubric.md) for a description of the relationship |:-|:|:| |description|[itemBody](itembody.md)|The description of this criterion.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Rubriclevel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rubriclevel.md | See [educationRubric](educationrubric.md) for a description of the relationship |grading|[educationAssignmentGradeType](educationassignmentgradetype.md)|Null if this is a no-points rubric; [educationAssignmentPointsGradeType](educationassignmentpointsgradetype.md) if it's a points rubric.| |levelId|String|The ID of this resource.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Rubricquality | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rubricquality.md | See [educationRubric](educationrubric.md) for a description of the relationship |qualityId|String|The ID of this resource.| |weight|Single|If present, a numerical weight for this quality. Weights must add up to 100.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Rubricqualityfeedbackmodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rubricqualityfeedbackmodel.md | Feedback related to a specific [quality](rubricquality.md) of an [educationRubri |feedback|[itemBody](itembody.md)|Specific feedback for one quality of this rubric.| |qualityId|String|The ID of the [rubricQuality](rubricquality.md) that this feedback is related to.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Rubricqualityselectedcolumnmodel | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/rubricqualityselectedcolumnmodel.md | Indicates the [rubricLevel](rubriclevel.md) selected by the teacher when grading |columnId|String|ID of the selected level for this quality.| |qualityId|String|ID of the associated quality.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Scheduleinformation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/scheduleinformation.md | Represents the availability of a user, distribution list, or resource (room or e ## Properties | Property | Type |Description| |:|:--|:-|-|availabilityView |String |Represents a merged view of availability of all the items in `scheduleItems`. The view consists of time slots. Availability during each time slot is indicated with: `0`= free or working elswhere, `1`= tentative, `2`= busy, `3`= out of office.<br><br>**Note:** Working elsewhere is set to `0` instead of `4` for backward compatibility. For details, see the [Q&A](/answers/questions/309571/working-elsewhere-in-getschedules-availabilityview).| +|availabilityView |String |Represents a merged view of availability of all the items in `scheduleItems`. The view consists of time slots. Availability during each time slot is indicated with: `0`= free or working elswhere, `1`= tentative, `2`= busy, `3`= out of office.<br><br>**Note:** Working elsewhere is set to `0` instead of `4` for backward compatibility. For details, see the [Q&A](/answers/questions/309571/working-elsewhere-in-getschedules-availabilityview) and [Exchange 2007 and Exchange 2010 do not use the WorkingElsewhere value](/openspecs/exchange_server_protocols/ms-oxwscdata/e5ec9563-0491-486d-9bec-50585fa2a2c6#Appendix_A_117).| |error |[freeBusyError](freebusyerror.md) |Error information from attempting to get the availability of the user, distribution list, or resource. | |scheduleId |String |An SMTP address of the user, distribution list, or resource, identifying an instance of **scheduleInformation**. | |scheduleItems |[scheduleItem](scheduleitem.md) collection |Contains the items that describe the availability of the user or resource. | |
v1.0 | Schemaextension | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/schemaextension.md | Schema extensions allow you to define a schema to extend and add strongly-typed + [user](/graph/api/resources/user) + [group](/graph/api/resources/group) + [administrativeUnit](/graph/api/resources/administrativeunit)-+ [application](/graph/api/resources/application) + [contact](/graph/api/resources/contact) + [device](/graph/api/resources/device) + [event](/graph/api/resources/event) (for both user and group calendars) |
v1.0 | Scopedrolemembership | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/scopedrolemembership.md | Title: "scopedRoleMembership resource type" -description: "A scoped-role membership describes a user's membership of a directory role, that is further scoped to an Administrative Unit. Scoped-role membership provides a mechanism to allow a tenant-wide company administrator to delegate administrative privileges to a user to manage users and groups in a subset of the organization." +description: "A scoped-role membership describes a user's membership of a directory role, that is further scoped to an Administrative Unit." ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Search Api Answers Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/search-api-answers-overview.md | doc_type: conceptualPageType You can use Microsoft Graph to [manage administrative search answer results](/graph/search-concept-answers) in the [Microsoft Search](/microsoftsearch/overview-microsoft-search) experience. -Requests to manage administrative search answers are performed by global administrators, search administrators, search editors, or are performed on behalf of an application without the presence of a signed-in user, identified using an [access token with application permission](/graph/auth-v2-service). +Requests to manage administrative search answers are performed by users with administrator roles, such as Search Administrators and Search Editors, or are performed on behalf of an application without the presence of a signed-in user, identified using an [access token with application permission](/graph/auth-v2-service). ## Common use cases |
v1.0 | Searchalteration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/searchalteration.md | Provides the details about the search alteration for spelling correction. |alteredQueryString|String| Defines the altered query string with spelling correction.| |alteredQueryTokens|[alteredQueryToken](alteredquerytoken.md) collection| Represents changed segments related to an original user query.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Searchalterationoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/searchalterationoptions.md | Provides the search alteration options for spelling correction. |enableModification|Boolean|Indicates whether spelling modifications are enabled. If enabled, the user gets the search results for the corrected query *if there were no results* for the original query with typos. The [response](/graph/api/resources/searchresponse) will also include the spelling modification information in the **queryAlterationResponse** property. Optional.| |enableSuggestion|Boolean|Indicates whether spelling suggestions are enabled. If enabled, the user gets the search results for the original search query and suggestions for spelling correction in the **queryAlterationResponse** property of the [response](/graph/api/resources/searchresponse) for the typos in the query. Optional.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Searchbucket | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/searchbucket.md | Represents a container for one or more search results that share the same value |count|Int32| The approximate number of search matches that share the same value specified in the **key** property. Note that this number is not the exact number of matches.| |key|String| The discrete value of the field that an aggregation was computed on.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Searchhit | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/searchhit.md | Represents a single result within the list of search results. |externalItem|Encoded string|`AAMkADRiYWU5MDRkLWE1NGEtNDg5OS1hZWM2LWIxOWZmNzQzMTdiYQBGAAAAAAAvZTGE+1bNQp4lDRL1ctayBwCQNOp97HTbQK/QVOV30iomAAAAEF6yAACQNOp97HTbQK/QVOV30iomAAAAG/DWAAA=` | |person|GUID@GUID|`497b7a2a-9e1a-48d7-80e8-2965d2fc3a81@72f988bf-86f1-41af-91ab-2d7cd011db47`| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Searchhitscontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/searchhitscontainer.md | Represent the list of search results. |moreResultsAvailable|Boolean|Provides information if more results are available. Based on this information, you can adjust the **from** and **size** properties of the [searchRequest](searchrequest.md) accordingly.| |total|Int32|The total number of results. Note this isn't the number of results on the page, but the total number of results satisfying the query.| +## Relationships ++None. ## JSON representation |
v1.0 | Searchquery | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/searchquery.md | Title: "searchQuery resource type" -description: "searchQuery" +description: "Represents a search query that contains search terms and optional filters." ms.localizationpriority: medium Represents a search query that contains search terms and optional filters. |:-|:|:| |queryString|String|The search query containing the search terms. Required.| |queryTemplate|String|Provides a way to decorate the query string. Supports both KQL and query variables. Optional.|++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Sectionlinks | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sectionlinks.md | Namespace: microsoft.graph Links for opening a OneNote section. +## Properties ++| Property | Type |Description| +|:|:--|:-| +|oneNoteClientUrl|[externalLink](externallink.md)|Opens the section in the OneNote native client if it's installed.| +|oneNoteWebUrl|[externalLink](externallink.md)|Opens the section in OneNote on the web.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ```-## Properties -| Property | Type |Description| -|:|:--|:-| -|oneNoteClientUrl|[externalLink](externallink.md)|Opens the section in the OneNote native client if it's installed.| -|oneNoteWebUrl|[externalLink](externallink.md)|Opens the section in OneNote on the web.| - <!-- uuid: 8fcb5dbc-d5aa-4681-8e31-b001d5168d79 2015-10-25 14:57:30 UTC --> <!-- { |
v1.0 | Security Alert | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-alert.md | When a security provider detects a threat, it creates an alert in the system. Mi |description|String| String value describing each alert.| |detectionSource|[microsoft.graph.security.detectionSource](#detectionsource-values)| Detection technology or sensor that identified the notable component or activity. Possible values are: `unknown`, `microsoftDefenderForEndpoint`, `antivirus`, `smartScreen`, `customTi`, `microsoftDefenderForOffice365`, `automatedInvestigation`, `microsoftThreatExperts`, `customDetection`, `microsoftDefenderForIdentity`, `cloudAppSecurity`, `microsoft365Defender`, `azureAdIdentityProtection`, `manual`, `microsoftDataLossPrevention`, `appGovernancePolicy`, `appGovernanceDetection`, `unknownFutureValue`, `microsoftDefenderForCloud`, `microsoftDefenderForIoT`, `microsoftDefenderForServers`, `microsoftDefenderForStorage`, `microsoftDefenderForDNS`, `microsoftDefenderForDatabases`, `microsoftDefenderForContainers`, `microsoftDefenderForNetwork`, `microsoftDefenderForAppService`, `microsoftDefenderForKeyVault`, `microsoftDefenderForResourceManager`, `microsoftDefenderForApiManagement`, `microsoftSentinel`, `nrtAlerts`, `scheduledAlerts`, `microsoftDefenderThreatIntelligenceAnalytics`, `builtInMl`. You must use the `Prefer: include-unknown-enum-members` request header to get the following value(s) in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `microsoftDefenderForCloud`, `microsoftDefenderForIoT`, `microsoftDefenderForServers`, `microsoftDefenderForStorage`, `microsoftDefenderForDNS`, `microsoftDefenderForDatabases`, `microsoftDefenderForContainers`, `microsoftDefenderForNetwork`, `microsoftDefenderForAppService`, `microsoftDefenderForKeyVault`, `microsoftDefenderForResourceManager`, `microsoftDefenderForApiManagement`, `microsoftSentinel`, `nrtAlerts`, `scheduledAlerts`, `microsoftDefenderThreatIntelligenceAnalytics`, `builtInMl`.| |detectorId|String| The ID of the detector that triggered the alert.|-|determination|[microsoft.graph.security.alertDetermination](#alertdetermination-values)| Specifies the result of the investigation, whether the alert represents a true attack and if so, the nature of the attack. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedUser`, `phishing`, `maliciousUserActivity`, `clean`, `insufficientData`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| +|determination|[microsoft.graph.security.alertDetermination](#alertdetermination-values)| Specifies the result of the investigation, whether the alert represents a true attack and if so, the nature of the attack. Possible values are: `unknown`, `apt`, `malware`, `securityPersonnel`, `securityTesting`, `unwantedSoftware`, `other`, `multiStagedAttack`, `compromisedAccount`, `phishing`, `maliciousUserActivity`, `notMalicious`, `notEnoughDataToValidate`, `confirmedUserActivity`, `lineOfBusinessApplication`, `unknownFutureValue`.| |evidence|[microsoft.graph.security.alertEvidence](security-alertEvidence.md) collection| Collection of evidence related to the alert.| |firstActivityDateTime|DateTimeOffset| The earliest activity associated with the alert.| |id|String| Unique identifier to represent the **alert** resource.| When a security provider detects a threat, it creates an alert in the system. Mi | securityPersonnel | A true positive alert that detected valid suspicious activity that someone on the customer's security team performed. | | securityTesting | The alert detected valid suspicious activity that was performed as part of a known security testing. | | unwantedSoftware | The alert detected unwanted software. |+| other | Other determination. | | multiStagedAttack | A true positive alert that detected multiple kill-chain attack stages. | | compromisedAccount | A true positive alert that detected that the intended user's credentials were compromised or stolen. | | phishing | A true positive alert that detected a phishing email. | When a security provider detects a threat, it creates an alert in the system. Mi | notEnoughDataToValidate | A false alert, without enough information to prove otherwise. | | confirmedActivity | The alert caught a true suspicious activity that is considered OK because it's a known user activity. | | lineOfBusinessApplication | The alert caught a true suspicious activity that is considered OK because it's a known and confirmed internal application. |-| other | Other determination. | | unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ### alertSeverity values |
v1.0 | Security Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-api-overview.md | The following conditions relate to all queries. Alerts are detailed warnings about suspicious activities in a customer's tenant that Microsoft or partner security providers identified and flagged for action. Attacks typically employ various techniques against different types of entities, such as devices, users, and mailboxes. The result is alerts from multiple security providers for multiple entities in the tenant. Piecing the individual alerts together to gain insight into an attack can be challenging and time-consuming. The security API offers two types of alerts that aggregate other alerts from security providers and make analyzing attacks and determining response easier: -- [Alerts and incidents](#alerts-and-incidents) - these are the latest generation of alerts in the Microsoft Graph security API. They are represented by the [alert](security-alert.md) resource and its collection, [incident](security-incident.md) resource, defined in the `microsoft.graph.security` namespace.-- [Legacy alerts](#legacy-alerts) - these are the first generation of alerts in the Microsoft Graph security API. They are represented by the [alert](alert.md) resource defined in the `microsoft.graph` namespace.+- [Alerts and incidents](#alerts-and-incidents) - these are the latest generation of alerts in the Microsoft Graph security API. They're represented by the [alert](security-alert.md) resource and its collection, [incident](security-incident.md) resource, defined in the `microsoft.graph.security` namespace. +- [Legacy alerts](#legacy-alerts) - these are the first generation of alerts in the Microsoft Graph security API. They're represented by the [alert](alert.md) resource defined in the `microsoft.graph` namespace. ### Alerts and incidents Alerts from the following security providers are available via these rich alerts The legacy [alert](alert.md) resources federate calling of supported Azure and Microsoft 365 Defender security providers. They aggregate common alert data among the different domains to allow applications to unify and streamline management of security issues across all integrated solutions. They enable applications to correlate alerts and context to improve threat protection and response. -The legacy version of the security API offers the [alert](alert.md) resource which federates calling of supported Azure and Microsoft 365 Defender security providers. This **alert** resource aggregates alert data that’s common among the different domains to allow applications to unify and streamline management of security issues across all integrated solutions. This enables applications to correlate alerts and context to improve threat protection and response. +The legacy version of the security API offers the [alert](alert.md) resource that federates calling of supported Azure and Microsoft 365 Defender security providers. This **alert** resource aggregates alert data that’s common among the different domains to allow applications to unify and streamline management of security issues across all integrated solutions. This enables applications to correlate alerts and context to improve threat protection and response. With the alert update capability, you can sync the status of specific alerts across different security products and services that are integrated with the Microsoft Graph security API by updating your **alert** entity. Alerts from the following providers are available via the **alert** resource. Su \* File issue: Alert status gets updated across Microsoft Graph security API integrated applications but not reflected in the provider’s management experience. -\*\* Microsoft Defender for Endpoint requires additional [user roles](/windows/security/threat-protection/microsoft-defender-atp/user-roles) to those required by the Microsoft Graph security API. Only the users in both Microsoft Defender for Endpoint and Microsoft Graph security API roles can access the Microsoft Defender for Endpoint data. Because application-only authentication is not limited by this, we recommend that you use an application-only authentication token. +\*\* Microsoft Defender for Endpoint requires additional [user roles](/windows/security/threat-protection/microsoft-defender-atp/user-roles) to those required by the Microsoft Graph security API. Only the users in both Microsoft Defender for Endpoint and Microsoft Graph security API roles can access the Microsoft Defender for Endpoint data. Because application-only authentication isn't limited by this, we recommend that you use an application-only authentication token. \*\*\* Microsoft Defender for Identity alerts are available via the Microsoft Defender for Cloud Apps integration. This means you get Microsoft Defender for Identity alerts only if you joined Unified SecOps and connected Microsoft Defender for Identity into Microsoft Defender for Cloud Apps. Learn more about [how to integrate Microsoft Defender for Identity and Microsoft Defender for Cloud Apps](/defender-for-identity/mcas-integration). Alerts from the following providers are available via the **alert** resource. Su [Microsoft Purview eDiscovery (Premium)](/microsoft-365/compliance/overview-ediscovery-20) provides an end-to-end workflow to preserve, collect, analyze, review, and export content that's responsive to your organization's internal and external investigations. +## Identities ++### Health issues ++The Microsoft Defender for Identity health issues API allows you to monitor the health status of your sensors and agents across your hybrid identity infrastructure. You can use the health issues API to retrieve information about the current health issues of your sensors, such as the issue type, status, configuration, and severity. You can also use this API to identify and resolve any issues that might affect the functionality or security of your sensors and agents. ++> **Note:** The Microsoft Defender for Identity health issues API is only available on the Defender for Identity plan or Microsoft 365 E5/A5/G5/F5 Security service plans. ++### Sensors +The Defender for Identity sensors management API allows you to create detailed reports of the sensors in your workspace, including information about the server name, sensor version, type, state, and health status. It also enables you to manage sensor settings, such as adding descriptions, enabling or disabling delayed updates, and specifying the domain controller that the sensor connects to for querying Entra ID. + ## Incidents An [incident](security-incident.md) is a collection of correlated  [alerts](security-alert.md) and associated data that make up the story of an attack. Incident management is part of Microsoft 365 Defender, and is available in the Microsoft 365 Defender portal (https://security.microsoft.com/). Grouping related alerts into an incident gives you a comprehensive view of an at - Where the attack started. - What tactics were used. -- How far the attack has gone into your tenant. +- How far the attack went into your tenant. - The scope of the attack, such as how many devices, users, and mailboxes were impacted. - All of the data associated with the attack. The  [incident](security-incident.md) resource and its APIs allow you to sort ## Information protection -The Microsoft Graph threat assessment API helps organizations to assess the threat received by any user in a tenant. This empowers customers to report spam emails, phishing URLs or malware attachments they receive to Microsoft. The policy check result and rescan result can help tenant administrators understand the threat scanning verdict and adjust their organizational policy. +The Microsoft Graph threat assessment API helps organizations to assess the threat received by any user in a tenant. This empowers customers to report spam emails, phishing URLs, or malware attachments they receive to Microsoft. The policy check result and rescan result can help tenant administrators understand the threat scanning verdict and adjust their organizational policy. ## Records management -Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let people effectively and agiley share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. -+Most organizations need to manage data to proactively comply with industry regulations and internal policies, reduce risk in the event of litigation or a security breach, and let people effectively and agilely share knowledge that is current and relevant to them. You can use the [records management APIs](../resources/security-recordsmanagement-overview.md) to systematically apply [retention labels](security-retentionlabel.md) to different types of content that require different retention settings. For example, you can configure the start of retention period from when the content was created, last modified, labeled or when an event occurs for a particular event type. Further, you can use [file plan descriptors](security-fileplandescriptor.md) to improve the manageability of these retention labels. ## Secure Score The following are some of the most popular requests for working with the Microso | **eDiscovery**||| |List eDiscovery cases|[List eDiscoveryCases](../api/security-casesroot-list-ediscoverycases.md)|[https://graph.microsoft.com/v1.0/security/cases/eDiscoveryCases](https://developer.microsoft.com/graph/graph-explorer?request=security%2Fcases%2FeDiscoverycases&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com)| |List eDiscovery case operations|[List caseOperations](../api/security-ediscoverycase-list-operations.md)|[https://graph.microsoft.com/v1.0/security/cases/ediscoveryCases/{id}/operations](https://developer.microsoft.com/graph/graph-explorer?request=security%2Fcases%2FeDiscoverycases%2F%7Bid%7D%2Foperations&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com)|+| **Identities**||| +| List health issues | [List health issues](../api/security-identitycontainer-list-healthissues.md) | [https://graph.microsoft.com/v1.0/security/identities/healthIssues](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/healthIssues&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) | +| List sensors | [List sensors](../api/security-identitycontainer-list-sensors.md) | [https://graph.microsoft.com/v1.0/security/identities/sensors](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/sensors&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) | | **Legacy alerts**||| | List alerts | [List alerts](../api/alert-list.md) | [https://graph.microsoft.com/v1.0/security/alerts](https://developer.microsoft.com/graph/graph-explorer?request=security/alerts&method=GET&version=v1.0&GraphUrl=https://graph.microsoft.com) | | Update alerts | [Update alert](../api/alert-update.md) | [https://graph.microsoft.com/v1.0/security/alerts/{alert-id}](https://developer.microsoft.com/graph/graph-explorer?request=security/alerts/{alert-id}&method=PATCH&version=v1.0&GraphUrl=https://graph.microsoft.com) | |
v1.0 | Security Caseoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-caseoperation.md | Inherits from [entity](../resources/entity.md). ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`.| |completedDateTime|DateTimeOffset| The date and time the operation was completed. | |createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | |createdDateTime|DateTimeOffset| The date and time the operation was created. | Inherits from [entity](../resources/entity.md). |Member|Description| |:-|--|-| addToReviewSet | The operation represents adding data to a review set from an eDiscovery collection. | -| applyTags | The operation represents bulk tagging documents in a review set for the specified review set query. | | contentExport | The operation represents a content export from a review set. |+| applyTags | The operation represents bulk tagging documents in a review set for the specified review set query. | | convertToPdf | The operation represents converting documents to PDFs with redactions. |+| index | The operation represents indexing data sources of custodians and noncustodial data sources to make them searchable. | | estimateStatistics | The operation represents searching against Microsoft 365 services such as Exchange, SharePoint, and OneDrive for Business. |+| addToReviewSet | The operation represents adding data to a review set from an eDiscovery collection. | | holdUpdate | The operation represents updating legal hold (apply/remove) for custodians and noncustodial data sources.-| index | The operation represents indexing data sources of custodians and noncustodial data sources to make them searchable. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | | purgeData | The operation represents purging content from the source workloads. |+| exportReport | The operation exports an item report from an estimated search.| +| exportResult | The operation exports item results from an estimated search. | ### caseOperationStatus values |
v1.0 | Security Deploymentaccesskeytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-deploymentaccesskeytype.md | + + Title: "deploymentAccessKeyType resource type" +description: "Represents the deployment access key for a Microsoft Defender for Identity sensor." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# deploymentAccessKeyType resource type ++Namespace: microsoft.graph.security ++Represents the deployment access key for a Microsoft Defender for Identity sensor. ++## Properties +|Property|Type|Description| +|:|:|:| +|deploymentAccessKey|String|The deployment access key.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.deploymentAccessKeyType" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.deploymentAccessKeyType", + "deploymentAccessKey": "String" +} +``` |
v1.0 | Security Deviceevidence | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-deviceevidence.md | Title: "deviceEvidence resource type" description: "A device that is reported in the alert." Previously updated : 11/11/2022 ms.localizationpriority: medium Inherits from [alertEvidence](../resources/security-alertevidence.md). |azureAdDeviceId|String|A unique identifier assigned to a device by Microsoft Entra ID when device is Microsoft Entra joined.| |defenderAvStatus|[microsoft.graph.security.defenderAvStatus](#defenderavstatus-values)|State of the Defender AntiMalware engine. The possible values are: `notReporting`, `disabled`, `notUpdated`, `updated`, `unknown`, `notSupported`, `unknownFutureValue`.| |deviceDnsName|String|The fully qualified domain name (FQDN) for the device.|+| dnsDomain | String | The DNS domain that this computer belongs to. A sequence of labels separated by dots. | |firstSeenDateTime|DateTimeOffset|The date and time when the device was first seen.| |healthStatus|[microsoft.graph.security.deviceHealthStatus](#devicehealthstatus-values)|The health state of the device. The possible values are: `active`, `inactive`, `impairedCommunication`, `noSensorData`, `noSensorDataImpairedCommunication`, `unknown`, `unknownFutureValue`.|+| hostName | String | The hostname without the domain suffix. | |ipInterfaces|String collection|Ip interfaces of the device during the time of the alert.| |loggedOnUsers|[microsoft.graph.security.loggedOnUser](../resources/security-loggedonuser.md) collection|Users that were logged on the machine during the time of the alert.| |mdeDeviceId|String|A unique identifier assigned to a device by Microsoft Defender for Endpoint.|+| ntDomain | String | A logical grouping of computers within a Microsoft Windows network. | |onboardingStatus|[microsoft.graph.security.onboardingStatus](#onboardingstatus-values)|The status of the machine onboarding to Microsoft Defender for Endpoint. The possible values are: `insufficientInfo`, `onboarded`, `canBeOnboarded`, `unsupported`, `unknownFutureValue`.| |osBuild|Int64|The build version for the operating system the device is running.| |osPlatform|String|The operating system platform the device is running.| The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.security.deviceEvidence",+ "azureAdDeviceId": "String", "createdDateTime": "String (timestamp)",- "verdict": "String", - "remediationStatus": "String", - "remediationStatusDetails": "String", - "roles": [ - "String" - ], - "detailedRoles": [ - "String" - ], - "tags": [ - "String" - ], + "defenderAvStatus": "String", + "detailedRoles": ["String"], + "deviceDnsName": "String", + "dnsDomain": "String", "firstSeenDateTime": "String (timestamp)",+ "healthStatus": "String", + "hostName": "String", + "ipInterfaces": ["String"], + "loggedOnUsers": [{"@odata.type": "microsoft.graph.security.loggedOnUser"}], "mdeDeviceId": "String",- "azureAdDeviceId": "String", - "deviceDnsName": "String", + "ntDomain": "String", + "onboardingStatus": "String", + "osBuild": "Int64", "osPlatform": "String",- "osBuild": "Integer", - "version": "String", - "rbacGroupId": "Integer", + "rbacGroupId": "Int32", "rbacGroupName": "String",- "healthStatus": "String", + "remediationStatus": "String", + "remediationStatusDetails": "String", "riskScore": "String",- "onboardingStatus": "String", - "defenderAvStatus": "String", - "vmMetadata": { - "@odata.type": "microsoft.graph.security.vmMetadata" - }, - "ipInterfaces": [ - "String" - ], - "loggedOnUsers": [ - { - "@odata.type": "microsoft.graph.security.loggedOnUser" - } - ] + "roles": ["String"], + "tags": ["String"], + "verdict": "String", + "version": "String", + "vmMetadata": {"@odata.type": "microsoft.graph.security.vmMetadata"} } ``` |
v1.0 | Security Ediscoveryaddtoreviewsetoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryaddtoreviewsetoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|microsoft.graph.security.caseAction| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ## Relationships |Relationship|Type|Description| |
v1.0 | Security Ediscoverycase | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverycase.md | In the context of eDiscovery, contains custodians, searches, review sets. For de |[Delete ediscoveryCase](../api/security-casesroot-delete-ediscoverycases.md)|None|Delete an [ediscoveryCase](../resources/security-ediscoverycase.md) object.| |[List custodians](../api/security-ediscoverycase-list-custodians.md)|[microsoft.graph.security.ediscoveryCustodian](../resources/security-ediscoverycustodian.md) collection|Get the ediscoveryCustodian resources from the custodians navigation property.| |[Create ediscoveryCustodian](../api/security-ediscoverycase-post-custodians.md)|[microsoft.graph.security.ediscoveryCustodian](../resources/security-ediscoverycustodian.md)|Create a new ediscoveryCustodian object.|+|[List legalHolds](../api/security-ediscoverycase-list-legalholds.md)|[microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) collection|Get the ediscoveryHoldPolicy resources from the legalHolds navigation property.| +|[Delete legalholds](../api/security-ediscoverycase-delete-legalholds.md)|None|Delete an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object.| +|[Create ediscoveryHoldPolicy](../api/security-ediscoverycase-post-legalholds.md)|[microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md)|Create a new ediscoveryHoldPolicy object.| |[List noncustodialDataSources](../api/security-ediscoverysearch-list-noncustodialsources.md)|[microsoft.graph.security.ediscoveryNoncustodialDataSource](../resources/security-ediscoverynoncustodialdatasource.md) collection|Get the ediscoveryNoncustodialDataSource resources from the noncustodialDataSources navigation property.| |[Create ediscoveryNoncustodialDataSource](../api/security-ediscoverycase-post-noncustodialdatasources.md)|[microsoft.graph.security.ediscoveryNoncustodialDataSource](../resources/security-ediscoverynoncustodialdatasource.md)|Create a new ediscoveryNoncustodialDataSource object.| |[List operations](../api/security-ediscoverycase-list-operations.md)|[microsoft.graph.security.caseOperation](../resources/security-caseoperation.md) collection|Get the caseOperation resources from the operations navigation property.| In the context of eDiscovery, contains custodians, searches, review sets. For de |Relationship|Type|Description| |:|:|:| |custodians|[microsoft.graph.security.ediscoveryCustodian](../resources/security-ediscoverycustodian.md) collection|Returns a list of case **ediscoveryCustodian** objects for this **case**.|+|legalHolds|[microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) collection|Returns a list of case **eDiscoveryHoldPolicy** objects for this **case**.| |noncustodialDataSources|[microsoft.graph.security.ediscoveryNoncustodialDataSource](../resources/security-ediscoverynoncustodialdatasource.md) collection|Returns a list of case **ediscoveryNoncustodialDataSource** objects for this **case**.| |operations|[microsoft.graph.security.caseOperation](../resources/security-caseoperation.md) collection|Returns a list of case **caseOperation** objects for this **case**.| |reviewSets|[microsoft.graph.security.ediscoveryReviewSet](../resources/security-ediscoveryreviewset.md) collection|Returns a list of **eDiscoveryReviewSet** objects in the case.| |
v1.0 | Security Ediscoverycustodian | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverycustodian.md | In the context of eDiscovery, represents a user and all of their digital assets, |[Get last index operation](../api/security-ediscoverycustodian-list-lastindexoperation.md)|[microsoft.graph.security.ediscoveryIndexOperation](../resources/security-ediscoveryindexoperation.md) collection|Get a list of the [ediscoveryIndexOperation](../resources/security-ediscoveryindexoperation.md) associated with an [ediscoveryCustodian](../resources/security-ediscoverycustodian.md).| |[List site sources](../api/security-ediscoverycustodian-list-sitesources.md)|[microsoft.graph.security.siteSource](../resources/security-sitesource.md) collection|Get the siteSource resources from the siteSources navigation property.| |[Create site source](../api/security-ediscoverycustodian-post-sitesources.md)|[microsoft.graph.security.siteSource](../resources/security-sitesource.md)|Create a new [siteSource](../resources/security-sitesource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).|-|[List unitifed group sources](../api/security-ediscoverycustodian-list-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md) collection|Get the unifiedGroupSource resources from the unifiedGroupSources navigation property.| -|[Create unifed group source](../api/security-ediscoverycustodian-post-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md)|Create a new [unifiedGroupSource](../resources/security-unifiedgroupsource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).| +|[List unified group sources](../api/security-ediscoverycustodian-list-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md) collection|Get the unifiedGroupSource resources from the unifiedGroupSources navigation property.| +|[Create unified group source](../api/security-ediscoverycustodian-post-unifiedgroupsources.md)|[microsoft.graph.security.unifiedGroupSource](../resources/security-unifiedgroupsource.md)|Create a new [unifiedGroupSource](../resources/security-unifiedgroupsource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).| |[List user sources](../api/security-ediscoverycustodian-list-usersources.md)|[microsoft.graph.security.userSource](../resources/security-usersource.md) collection|Get the userSource resources from the userSources navigation property.| |[Create user source](../api/security-ediscoverycustodian-post-usersources.md)|[microsoft.graph.security.userSource](../resources/security-usersource.md)|Create a new [userSource](../resources/security-usersource.md) object associated with an [eDiscovery custodian](../resources/security-ediscoverycustodian.md).| |
v1.0 | Security Ediscoveryestimateoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryestimateoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|microsoft.graph.security.caseAction| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset|The date and time the operation was completed. Read-only. | -|createdBy|[identitySet](../resources/identityset.md)|The user who created the operation. Read-only. | -|createdDateTime|DateTimeOffset|The date and time the operation was started. Read-only.| -|id|String| The ID for the operation. Read-only.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset|The date and time the operation was completed. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)|The user who created the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset|The date and time the operation was started. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| |indexedItemCount|Int64|The estimated count of items for the **search** that matched the content query.| |indexedItemsSize|Int64|The estimated size of items for the **search** that matched the content query.| |mailboxCount|Int32|The number of mailboxes that had search hits.|-|percentProgress|Int32|The progress of the operation. Read-only. | -|resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. | +|percentProgress|Int32|The progress of the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| |siteCount|Int32|The number of mailboxes that had search hits.|-|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|status|microsoft.graph.security.caseOperationStatus| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| |unindexedItemCount|Int64|The estimated count of unindexed items for the collection.| |unindexedItemsSize|Int64|The estimated size of unindexed items for the collection.| |
v1.0 | Security Ediscoveryexportoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryexportoperation.md | Inherits from [caseOperation](../resources/security-caseoperation.md). ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the export was completed.| -|createdBy|[identitySet](../resources/identityset.md)| The user who initiated the export operation.| -|createdDateTime|DateTimeOffset| The date and time the export was created.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the export was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user who initiated the export operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the export was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| |description|String| The description provided for the export.| |exportFileMetadata | [microsoft.graph.security.ediscoveryExportFileMetadata](../resources/security-ediscoveryexportfilemetadata.md)| Contains the properties for an export file metadata, including **downloadUrl**, **fileName**, and **size**. | |exportOptions|microsoft.graph.security.exportOptions| The options provided for the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `originalFiles`, `text`, `pdfReplacement`, `tags`.| |exportStructure|microsoft.graph.security.exportFileStructure|The options that specify the structure of the export. For more information, see [reviewSet: export](../api/security-ediscoveryreviewset-export.md). Possible values are: `none`, `directory`, `pst`.|-|id|String| The ID for the operation. Read-only. | +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| |outputName|String| The name provided for the export.|-|percentProgress|Int32| The progress of the operation.| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| |resultInfo|[resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).|-|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ### exportOptions values |
v1.0 | Security Ediscoveryholdoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryholdoperation.md | doc_type: resourcePageType Namespace: microsoft.graph.security -- Represents the process of applying hold to data sources, including custodians and non-custodial data sources. Inherits from [caseOperation](../resources/security-caseoperation.md). None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ## Relationships None. |
v1.0 | Security Ediscoveryholdpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryholdpolicy.md | + + Title: "ediscoveryHoldPolicy resource type" +description: "ediscoveryHoldPolicy resource type" ++ms.localizationpriority: medium ++++# ediscoveryHoldPolicy resource type ++Namespace: microsoft.graph.security ++Represents a legal hold policy. Legal holds are holds that are tied to an eDiscovery case. Legal holds should not be confused with retention holds, which are used to control retention policies for Microsoft 365 content. eDiscovery legal holds are for holding content indefinitely for litigation, internal investigations, and other legal actions where content needs to be protected against deletion. For more information, see [Manage holds in eDiscovery (Premium)](/microsoft-365/compliance/managing-holds) ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/security-ediscoverycase-list-legalholds.md)|[microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) collection|Get a list of the [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) objects and their properties.| +|[Create](../api/security-ediscoverycase-post-legalholds.md)|[microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md)|Create a new [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object.| +|[Get](../api/security-ediscoveryholdpolicy-get.md)|[microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md)|Read the properties and relationships of an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object.| +|[Update](../api/security-ediscoveryholdpolicy-update.md)|[microsoft.graph.security.ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md)|Update the properties of an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object.| +|[Delete](../api/security-ediscoverycase-delete-legalholds.md)|None|Delete an [ediscoveryHoldPolicy](../resources/security-ediscoveryholdpolicy.md) object.| +|[List site sources](../api/security-ediscoverycustodian-list-sitesources.md)|[microsoft.graph.security.siteSource](../resources/security-sitesource.md) collection|Get the siteSource resources from the siteSources navigation property.| +|[Create site source](../api/security-ediscoveryholdpolicy-post-sitesources.md)|[microsoft.graph.security.siteSource](../resources/security-sitesource.md)|Create a new siteSource object.| +|[List user sources](../api/security-ediscoverycustodian-list-usersources.md)|[microsoft.graph.security.userSource](../resources/security-usersource.md) collection|Get the userSource resources from the userSources navigation property.| +|[Create user source](../api/security-ediscoveryholdpolicy-post-usersources.md)|[microsoft.graph.security.userSource](../resources/security-usersource.md)|Create a new userSource object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|contentQuery|String|KQL query that specifies content to be held in the specified locations. To learn more, see [Keyword queries and search conditions for Content Search and eDiscovery](/microsoft-365/compliance/keyword-queries-and-search-conditions). To hold all content in the specified locations, leave **contentQuery** blank. | +|createdBy|[identitySet](../resources/identityset.md)|The user who created the legal hold. | +|createdDateTime|DateTimeOffset|The date and time the legal hold was created. | +|description|String| The legal hold description. | +|displayName|String| The display name of the legal hold. | +|errors|String collection|Lists any errors that happened while placing the hold. | +|id|String|The ID for the eDiscovery case. Read-only. Inherited from [entity](../resources/entity.md). | +|isEnabled|Boolean|Indicates whether the hold is enabled and actively holding content. | +|lastModifiedBy|[identitySet](../resources/identityset.md)|the user who last modified the legal hold.| +|lastModifiedDateTime|DateTimeOffset|The date and time the legal hold was last modified. | +|status|microsoft.graph.security.policyStatus|The status of the legal hold. Possible values are: `Pending`, `Error`, `Success`.| ++### policyStatus values ++|Member|Description| +|:|--| +|Pending| The hold distribution process is in progress. | +|Error| There was an error when the hold was applied. | +|Success| The hold was successfully applied and is holding the specified content. | ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|siteSources|[microsoft.graph.security.siteSource](../resources/security-sitesource.md) collection|Data sources that represent SharePoint sites.| +|userSources|[microsoft.graph.security.userSource](../resources/security-usersource.md) collection|Data sources that represent Exchange mailboxes.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.ediscoveryHoldPolicy", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.ediscoveryHoldPolicy", + "id": "String (identifier)", + "displayName": "String", + "description": "String", + "createdBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "createdDateTime": "String (timestamp)", + "lastModifiedBy": { + "@odata.type": "microsoft.graph.identitySet" + }, + "lastModifiedDateTime": "String (timestamp)", + "status": "String", + "isEnabled": "Boolean", + "contentQuery": "String", + "errors": [ + "String" + ] +} +``` + |
v1.0 | Security Ediscoveryindexoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoveryindexoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ## Relationships None. |
v1.0 | Security Ediscoverypurgedataoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverypurgedataoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`, `applyTags`, `contentExport`, `convertToPdf`, `estimateStatistics`, `purgeData`| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success- and failure-specific result information. | -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success- and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ### purgeType values |Name|Description| |:-|--| |recoverable|Purged data is recoverable.|-|permanentlyDeleted|Purged data is permanently deleted.| -|unknownFutureValue|Reserved for future options.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| +|permanentlyDelete|Purged data is permanently deleted.| ### purgeAreas values |Name|Description| |:-|--| |mailboxes|Purges data from Exchange mailboxes.| |teamsMessages|Purges Teams messages.|-|unknownFutureValue|Reserved for future options.| +|unknownFutureValue|Evolvable enumeration sentinel value. Don't use.| ## Relationships None. |
v1.0 | Security Ediscoverysearch | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverysearch.md | Represents an eDiscovery search. For details, see [Collect data for a case in eD |[Update](../api/security-ediscoverysearch-update.md)|[microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md)|Update the properties of an [ediscoverySearch](../resources/security-ediscoverysearch.md) object.| |[Delete](../api/security-ediscoverycase-delete-searches.md)|None|Delete an [microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md) object.| |[Estimate statistics](../api/security-ediscoverysearch-estimatestatistics.md)|None|Run an estimate statistics operation on the data contained in the eDiscovery search.|+|[Purge data](../api/security-ediscoverysearch-purgedata.md)|None|Delete Exchange mailbox items or Microsoft Teams messages contained in an eDiscovery search.| +|[Export report](../api/security-ediscoverysearch-exportreport.md)|None|Export an item report from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md).| +|[Export result](../api/security-ediscoverysearch-exportresult.md)|None|Export results from an estimated [ediscoverySearch](../resources/security-ediscoverysearch.md).| |[List additional sources](../api/security-ediscoverysearch-list-additionalsources.md)|[microsoft.graph.security.dataSource](../resources/security-datasource.md) collection|Get the list of [additional sources](../resources/security-datasource.md) associated with an [eDiscovery search](../resources/security-ediscoverysearch.md).| |[Add additional sources](../api/security-ediscoverysearch-post-additionalsources.md)|[microsoft.graph.security.dataSource](../resources/security-datasource.md)|Create a new [additional source](../resources/security-datasource.md) associated with an [eDiscovery search](../resources/security-ediscoverysearch.md).| |[Get last estimate statistics operation](../api/security-ediscoverysearch-list-lastestimatestatisticsoperation.md)|[microsoft.graph.security.ediscoveryEstimateOperation](../resources/security-ediscoveryestimateoperation.md) collection|Get the last [ediscoveryEstimateOperation](../resources/security-ediscoveryestimateoperation.md) objects and their properties.| Represents an eDiscovery search. For details, see [Collect data for a case in eD |contentQuery|String|The query string in KQL (Keyword Query Language) query. For details, see [Keyword queries and search conditions for Content Search and eDiscovery](/microsoft-365/compliance/keyword-queries-and-search-conditions). You can refine searches by using fields paired with values; for example, *subject:"Quarterly Financials" AND Date>=06/01/2016 AND Date<=07/01/2016*.| |createdBy|[identitySet](../resources/identityset.md)|The user who created the **eDiscovery search**.| |createdDateTime|DateTimeOffset|The date and time the **eDiscovery search** was created.|-|dataSourceScopes|microsoft.graph.security.dataSourceScopes|When specified, the collection will span across a service for an entire workload. Possible values are: `none`, `allTenantMailboxes`, `allTenantSites`, `allCaseCustodians`, `allCaseNoncustodialDataSources`.| +|dataSourceScopes|microsoft.graph.security.dataSourceScopes|When specified, the collection spans across a service for an entire workload. Possible values are: `none`, `allTenantMailboxes`, `allTenantSites`, `allCaseCustodians`, `allCaseNoncustodialDataSources`.| |description|String|The description of the **eDiscovery search**.| |displayName|String|The display name of the **eDiscovery search**.| |id|String| The ID for the **eDiscovery search**. Read-only. | Represents an eDiscovery search. For details, see [Collect data for a case in eD |Member|Description| |:-|--|-|none|Do not specify any scopes - locations would be referenced separately.| +|none|Don't specify any scopes - locations would be referenced separately.| |allTenantMailboxes|Include all tenant mailboxes in the **eDiscovery search**.| |allTenantSites|Include all tenant sites in the **eDiscovery search**.| |allCaseCustodians|Include all custodian locations in the **eDiscovery search**.| The following JSON representation shows the resource type. "contentQuery": "String", "dataSourceScopes": "String" }-``` +``` |
v1.0 | Security Ediscoverysearchexportoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverysearchexportoperation.md | + + Title: "ediscoverySearchExportOperation resource type" +description: "Represents the process of an ediscoverySearch export." ++ms.localizationpriority: medium ++++# ediscoverySearchExportOperation resource type ++Namespace: microsoft.graph.security ++Represents the process of an [ediscoverySearch](../resources/security-ediscoverysearch.md) export. ++Inherits from [caseOperation](../resources/security-caseoperation.md). ++## Properties ++|Property|Type|Description| +|:|:|:| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|additionalOptions|[microsoft.graph.security.additionalOptions](../resources/security-ediscoverysearchexportoperation.md#additionaloptions-values)| The additional items to include in the export. The possible values are: `none`, `teamsAndYammerConversations`, `cloudAttachments`, `allDocumentVersions`, `subfolderContents`, `listAttachments`, `unknownFutureValue`.| +|completedDateTime|DateTimeOffset|The date and time when the operation was completed. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[microsoft.graph.identitySet](../resources/identityset.md)|The user who created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset|The date and time when the operation was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|description|String|The description of the export by the user.| +|displayName|String|The name of export provided by the user.| +|exportCriteria|[microsoft.graph.security.exportCriteria](../resources/security-ediscoverysearchexportoperation.md#exportcriteria-values)|Items to be included in the export. The possible values are: `searchHits`, `partiallyIndexed`, `unknownFutureValue`.| +|exportFileMetadata|[microsoft.graph.security.ediscoveryExportFileMetadata](../resources/security-ediscoveryexportfilemetadata.md) collection|Contains the properties for an export file metadata, including **downloadUrl**, **fileName**, and **size**.| +|exportFormat|[microsoft.graph.security.exportFormat](../resources/security-ediscoverysearchexportoperation.md#exportformat-values)|Format of the emails of the export. The possible values are: `pst`, `msg`, `eml`, `unknownFutureValue`.| +|exportLocation|[microsoft.graph.security.exportLocation](../resources/security-ediscoverysearchexportoperation.md#exportlocation-values)| Location scope for partially indexed items. You can choose to include partially indexed items only in responsive locations with search hits or in all targeted locations. The possible values are: `responsiveLocations`, `nonresponsiveLocations`, `unknownFutureValue`.| +|exportSingleItems|Boolean|Indicates whether to export single items.| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32|The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[microsoft.graph.resultInfo](../resources/resultinfo.md)|Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. The possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`, `unknownFutureValue`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ++### additionalOptions values ++|Member|Description| +|:-|--| +| none | No additional options selected.| +| teamsAndYammerConversations | Collect up to 12 hours of related conversations when a message matches a search.| +| cloudAttachments | Collect items from links to SharePoint or OneDrive.| +| allDocumentVersions | Collect all versions of SharePoint documents. If not selected, only current versions are collected.| +| subfolderContents | Collect items inside subfolders of a matched folder.| +| listAttachments | Collect files attached to SharePoint lists and their child items.| +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++### exportCriteria values ++|Member|Description| +|:-|--| +| searchHits | Export collected items with search hits.| +| partiallyIndexed | Include partially indexed items, such as those in unrecognized formats, encrypted, or not indexed for other reasons.| +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++### exportFormat values ++|Member|Description| +|:-|--| +| pst | Individual .pst files for each mailbox. | +| msg | Individual .msg files for each message. | +| eml | Individual .eml files for each message. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++### exportLocation values ++|Member|Description| +|:-|--| +| responsiveLocations | Locations with search hits only.| +| nonresponsiveLocations | Locations with no search hits.| +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|search|[microsoft.graph.security.ediscoverySearch](../resources/security-ediscoverysearch.md)|The eDiscovery searches under each case.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.ediscoverySearchExportOperation", + "baseType": "microsoft.graph.security.caseOperation", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.ediscoverySearchExportOperation", + "action": "String", + "additionalOptions": "String", + "completedDateTime": "String (timestamp)", + "createdBy": {"@odata.type": "microsoft.graph.identitySet"}, + "createdDateTime": "String (timestamp)", + "description": "String", + "displayName": "String", + "exportCriteria": "String", + "exportFileMetadata": [{"@odata.type": "microsoft.graph.security.ediscoveryExportFileMetadata"}], + "exportFormat": "String", + "exportLocation": "String", + "exportSingleItems": "Boolean", + "id": "String (identifier)", + "percentProgress": "Int32", + "resultInfo": {"@odata.type": "microsoft.graph.resultInfo"}, + "status": "String" +} +``` |
v1.0 | Security Ediscoverytagoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-ediscoverytagoperation.md | None. ## Properties |Property|Type|Description| |:|:|:|-|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `addToReviewSet`,`applyTags`,`contentExport`,`convertToPdf`,`estimateStatistics`, `purgeData`.| -|completedDateTime|DateTimeOffset| The date and time the operation was completed. | -|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. | -|createdDateTime|DateTimeOffset| The date and time the operation was created. | -|id|String| The ID for the operation. Read-only. | -|percentProgress|Int32| The progress of the operation. | -|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. | -|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`.| +|action|[microsoft.graph.security.caseAction](../resources/security-caseoperation.md#caseaction-values)| The type of action the operation represents. Possible values are: `contentExport`, `applyTags`, `convertToPdf`, `index`, `estimateStatistics`, `addToReviewSet`, `holdUpdate`, `unknownFutureValue`, `purgeData`, `exportReport`, `exportResult`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values from this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `purgeData`, `exportReport`, `exportResult`. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|completedDateTime|DateTimeOffset| The date and time the operation was completed. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdBy|[identitySet](../resources/identityset.md)| The user that created the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|createdDateTime|DateTimeOffset| The date and time the operation was created. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|id|String| The ID for the operation. Read-only. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|percentProgress|Int32| The progress of the operation. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|resultInfo|[resultInfo](../resources/resultinfo.md)| Contains success and failure-specific result information. Inherited from [caseOperation](../resources/security-caseoperation.md).| +|status|[microsoft.graph.security.caseOperationStatus](../resources/security-caseoperation.md#caseoperationstatus-values)| The status of the case operation. Possible values are: `notStarted`, `submissionFailed`, `running`, `succeeded`, `partiallySucceeded`, `failed`. Inherited from [caseOperation](../resources/security-caseoperation.md).| ## Relationships None. |
v1.0 | Security Healthissue | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-healthissue.md | + + Title: "healthIssue resource type" +description: "Represents potential issues identified by Microsoft Defender for Identity within a customer's Microsoft Defender for Identity configuration." ++ms.localizationpriority: medium ++++# healthIssue resource type ++Namespace: microsoft.graph.security ++Represents potential issues identified by Microsoft Defender for Identity within a customer's Microsoft Defender for Identity configuration. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/security-identitycontainer-list-healthissues.md)|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md) collection|Get a list of [healthIssue](../resources/security-healthissue.md) objects and their properties.| +|[Get](../api/security-healthissue-get.md)|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md)|Read the properties and relationships of a [healthIssue](../resources/security-healthissue.md) object.| +|[Update](../api/security-healthissue-update.md)|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md)|Update the properties of a [healthIssue](../resources/security-healthissue.md) object.| ++## Properties +|Property|Type|Description| +|:|:|:| +|additionalInformation|String collection|Contains additional information about the issue, such as a list of items to fix.| +|createdDateTime|DateTimeOffset|The date and time when the health issue was generated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|description|String|Contains more detailed information about the health issue.| +|displayName|String|The display name of the health issue.| +|domainNames|String collection|A list of the fully qualified domain names of the domains or the sensors the health issue is related to.| +|healthIssueType|[microsoft.graph.security.healthIssueType](#healthissuetype-values)|The type of the health issue. The possible values are: `sensor`, `global`, `unknownFutureValue`. For a list of all health issues and their identifiers, see [Microsoft Defender for Identity health issues](/defender-for-identity/health-alerts). | +|id|String|A unique identifier that represents the health issue. Inherited from [entity](../resources/entity.md).| +|issueTypeId|String|The type identifier of the health issue. For a list of all health issues and their identifiers, see [Microsoft Defender for Identity health issues](/defender-for-identity/health-alerts).| +|lastModifiedDateTime|DateTimeOffset|The date and time when the health issue was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|recommendations|String collection|A list of recommended actions that can be taken to resolve the issue effectively and efficiently. These actions might include instructions for further investigation and aren't limited to prewritten responses.| +|recommendedActionCommands|String collection|A list of commands from the PowerShell module for the product that can be used to resolve the issue, if available. If no commands can be used to solve the issue, this property is empty. The commands, if present, provide a quick and efficient way to address the issue. These commands run in sequence for the single recommended fix.| +|sensorDNSNames|String collection|A list of the DNS names of the sensors the health issue is related to.| +|severity|[microsoft.graph.security.healthIssueSeverity](#healthissueseverity-values)|The severity of the health issue. The possible values are: `low`, `medium`, `high`, `unknownFutureValue`.| +|status|[microsoft.graph.security.healthIssueStatus](#healthissuestatus-values)|The status of the health issue. The possible values are: `open`, `closed`, `suppressed`, `unknownFutureValue`.| ++### healthIssueSeverity values ++| Member | Description | +| :--| : | +| low | Low severity health issues usually indicate minor issues that don't have a significant impact on your environment. These issues require further investigation, but they usually don't require immediate action. | +| medium | Medium severity health issues indicate more significant issues that could potentially impact your environment. These issues may require further investigation and action to prevent any potential problems. | +| high | High severity health issues indicate critical issues that could have a severe impact on your environment. These issues require immediate attention and action. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ++### healthIssueStatus values ++| Member | Description | +| :--| : | +| open | The issue is open and should be addressed. | +| closed | The issue was addressed. Either someone manually closed the issue or took an action on the affected item, or it was closed automatically by the system. | +| suppressed | The operator suppressed the issue manually. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ++### healthIssueType values ++| Member | Description | +| :--| : | +| sensor | The issue is on specific sensor. | +| global | The issue is in the Defender for Identity system configuration. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.healthIssue", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.healthIssue", + "additionalInformation": ["String"], + "createdDateTime": "String (timestamp)", + "description": "String", + "displayName": "String", + "domainNames": ["String"], + "healthIssueType": "String", + "id": "String (identifier)", + "issueTypeId": "String", + "lastModifiedDateTime": "String (timestamp)", + "recommendations": ["String"], + "recommendedActionCommands": ["String"], + "sensorDNSNames": ["String"], + "severity": "String", + "status": "String" +} +``` |
v1.0 | Security Identitycontainer | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-identitycontainer.md | + + Title: "identityContainer resource type" +description: "Represents a container for security identities APIs that currently exposes the healthIssues relationship." ++ms.localizationpriority: medium ++++# identityContainer resource type ++Namespace: microsoft.graph.security ++Represents a container for security identities APIs that currently exposes the [healthIssues](security-healthissue.md) relationship. ++## Methods ++None. ++## Properties ++None. ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|healthIssues|[microsoft.graph.security.healthIssue](security-healthissue.md) collection| Represents potential issues identified by Microsoft Defender for Identity within a customer's Microsoft Defender for Identity configuration. | +|sensors|[microsoft.graph.security.sensor](security-sensor.md) collection| Represents a customer's Microsoft Defender for Identity sensors.| ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.identityContainer", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.identityContainer" +} +``` |
v1.0 | Security Networkadapter | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-networkadapter.md | + + Title: "networkAdapter resource type" +description: "Represents the network adapter from which the Microsoft Defender for Identity sensor analyzes network traffic." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# networkAdapter resource type ++Namespace: microsoft.graph.security ++Represents the network adapter from which the Microsoft Defender for Identity sensor analyzes network traffic. ++Inherits from [entity](../resources/entity.md). ++## Properties +|Property|Type|Description| +|:|:|:| +|id|String|A unique identifier that represents the network adapter. Inherited from [entity](../resources/entity.md).| +|isEnabled|Boolean|Indicates whether the network adapter is selected for capturing and analyzing network traffic.| +|name|String|The name of the network adapter.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.networkAdapter", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.networkAdapter", + "id": "String (identifier)", + "isEnabled": "Boolean", + "name": "String" +} +``` |
v1.0 | Security Sensor | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-sensor.md | + + Title: "sensor resource type" +description: "Represents a Microsoft Defender for Identity sensor." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# sensor resource type ++Namespace: microsoft.graph.security ++Represents a Microsoft Defender for Identity sensor. ++Inherits from [entity](../resources/entity.md). ++## Methods +|Method|Return type|Description| +|:|:|:| +|[List](../api/security-identitycontainer-list-sensors.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md) collection|Get a list of [sensor](../resources/security-sensor.md) objects and their properties.| +|[Get](../api/security-sensor-get.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Read the properties and relationships of a [sensor](../resources/security-sensor.md) object.| +|[Update](../api/security-sensor-update.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Update the properties of a [sensor](../resources/security-sensor.md) object.| +|[Delete](../api/security-sensor-delete.md)|None|Delete a [sensor](../resources/security-sensor.md) object.| +|[Get deployment access key](../api/security-sensor-getdeploymentaccesskey.md)|[microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md)|Get the deployment access key for Microsoft Defender for Identity that is required to install sensors associated with the workspace.| +|[Get deployment package URI](../api/security-sensor-getdeploymentpackageuri.md)|[microsoft.graph.security.sensorDeploymentPackage](../resources/security-sensordeploymentpackage.md)|Get the [sensor](../resources/security-sensor.md) deployment package URL and version.| +|[Regenerate deployment access key](../api/security-sensor-regeneratedeploymentaccesskey.md)|[microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md)|Generate a new deployment access key that can be used to install a [sensor](../resources/security-sensor.md) associated with the workspace.| ++## Properties +|Property|Type|Description| +|:|:|:| +|createdDateTime|DateTimeOffset|The date and time when the sensor was generated. The Timestamp represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|deploymentStatus|[microsoft.graph.security.deploymentStatus](#deploymentstatus-values)|The deployment status of the sensor. The possible values are: `upToDate`, `outdated`, `updating`, `updateFailed`, `notConfigured`, `unreachable`, `disconnected`, `startFailure`, `syncing`, `unknownFutureValue`.| +|displayName|String|The display name of the sensor.| +|domainName|String|The fully qualified domain name of the sensor.| +|healthStatus|[microsoft.graph.security.sensorHealthStatus](#sensorhealthstatus-values)|The health status of the sensor. The possible values are: `healthy`, `notHealthyLow`, `notHealthyMedium`, `notHealthyHigh`, `unknownFutureValue`.| +|id|String|Unique identifier to represent the sensor. Inherited from [entity](../resources/entity.md).| +|openHealthIssuesCount|Int64|This field displays the count of health issues related to this sensor.| +|sensorType|[microsoft.graph.security.sensorType](#sensortype-values)|The type of the sensor. The possible values are: `adConnectIntegrated`, `adcsIntegrated`, `adfsIntegrated`, `domainControllerIntegrated`, `domainControllerStandalone`, `unknownFutureValue`.| +|settings|[microsoft.graph.security.sensorSettings](../resources/security-sensorsettings.md)|Sensor settings information.| +|version|String|The version of the sensor.| ++### deploymentStatus values ++| Member | Description | +| :--| :-- | +| upToDate |Sensor is running a current version of the sensor.| +| outdated |Sensor is running a version of the software that is at least three versions behind the current version.| +| updating |Sensor software is being updated.| +| updateFailed |Sensor failed to update to a new version.| +| notConfigured |Sensor requires more configuration before it's fully operational. This applies to sensors installed on ADFS and ADCS servers or standalone sensors.| +| unreachable |The domain controller was deleted from Active Directory. However, the sensor installation wasn't uninstalled and removed from the domain controller before it was decommissioned. You can safely delete this entry.| +| disconnected |The Defender for Identity service hasn't seen any communication from this sensor in 10 minutes.| +| startFailure |Sensor didn't pull configuration for more than 30 minutes.| +| syncing |Sensor has configuration updates pending, but it didn't yet pull the new configuration.| +| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.| ++### sensorHealthStatus values ++| Member | Description | +| :--| :-- | +| healthy |No opened health issues.| +| notHealthyLow |The highest severity opened health issue is low.| +| notHealthyMedium |The highest severity opened health issue is medium.| +| notHealthyHigh |The highest severity opened health issue is high.| +| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.| ++### sensorType values ++| Member | Description | +| :--| :-- | +| adConnectIntegrated |Entra Connect sensor.| +| adcsIntegrated |Active Directory Certificate Services (ADCS) sensor.| +| adfsIntegrated |Active Directory Federation Services (ADFS) sensor.| +| domainControllerIntegrated |Domain controller sensor.| +| domainControllerStandalone |Standalone sensor.| +| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|healthIssues|[microsoft.graph.security.healthIssue](../resources/security-healthissue.md) collection|Represents potential issues within a customer's Microsoft Defender for Identity configuration that Microsoft Defender for Identity identified related to the sensor.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.security.sensor", + "baseType": "microsoft.graph.entity", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.sensor", + "createdDateTime": "String (timestamp)", + "deploymentStatus": "String", + "displayName": "String", + "domainName": "String", + "healthStatus": "String", + "id": "String (identifier)", + "openHealthIssuesCount": "Int64", + "sensorType": "String", + "settings": {"@odata.type": "microsoft.graph.security.sensorSettings"}, + "version": "String" +} +``` |
v1.0 | Security Sensordeploymentpackage | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-sensordeploymentpackage.md | + + Title: "sensorDeploymentPackage resource type" +description: "Represents a sensor deployment package." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# sensorDeploymentPackage resource type ++Namespace: microsoft.graph.security ++Represents a sensor deployment package. ++## Properties +|Property|Type|Description| +|:|:|:| +|downloadUrl|String|URL to download the sensor deployment package.| +|version|String|Version of the sensor.| ++## Relationships +None. ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.sensorDeploymentPackage" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.sensorDeploymentPackage", + "downloadUrl": "String", + "version": "String" +} +``` |
v1.0 | Security Sensorsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security-sensorsettings.md | + + Title: "sensorSettings resource type" +description: "Provides settings information for a sensor." ++ms.localizationpriority: medium + Last updated : 10/29/2024+++# sensorSettings resource type ++Namespace: microsoft.graph.security ++Provides settings information for a sensor. ++## Properties +|Property|Type|Description| +|:|:|:| +|description|String|Description of the sensor.| +|domainControllerDnsNames|String collection|DNS names for the domain controller| +|isDelayedDeploymentEnabled|Boolean|Indicates whether to delay updates for the sensor.| ++## Relationships +|Relationship|Type|Description| +|:|:|:| +|networkAdapters|[microsoft.graph.security.networkAdapter](../resources/security-networkadapter.md) collection|Sensor network adapters.| ++## JSON representation +The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "@odata.type": "microsoft.graph.security.sensorSettings" +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.security.sensorSettings", + "description": "String", + "domainControllerDnsNames": [ + "String" + ], + "isDelayedDeploymentEnabled": "Boolean" +} +``` |
v1.0 | Security | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/security.md | None |:-|:|:| |alerts|[alert](alert.md) collection| Read-only. Nullable.| |alerts_v2 | [microsoft.graph.security.alert](security-alert.md) collection | A collection of alerts in Microsoft 365 Defender.|+|identities|[microsoft.graph.security.identityContainer](../resources/security-identitycontainer.md)|A container for security identities APIs.| |incidents | [microsoft.graph.security.incident](security-incident.md) collection | A collection of incidents in Microsoft 365 Defender, each of which is a set of correlated alerts and associated metadata that reflects the story of an attack.| |
v1.0 | Serviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/serviceprincipal.md | This resource supports using [delta query](/graph/delta-query-overview) to track |appOwnerOrganizationId|Guid|Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports `$filter` (`eq`, `ne`, `NOT`, `ge`, `le`).| |appRoleAssignmentRequired|Boolean|Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is `false`. Not nullable. <br><br>Supports `$filter` (`eq`, `ne`, `NOT`). | |appRoles|[appRole](approle.md) collection|The roles exposed by the application that's linked to this service principal. For more information, see the **appRoles** property definition on the [application](application.md) entity. Not nullable. |-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). Filter value is case sensitive.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). Filter value is case sensitive. <br><li>To read this property, the calling app must be assigned the *CustomSecAttributeAssignment.Read.All* permission. To write this property, the calling app must be assigned the *CustomSecAttributeAssignment.ReadWrite.All* permissions. <li>To read or write this property in delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role.| | deletedDateTime | DateTimeOffset | The date and time the service principal was deleted. Read-only. | | description | String | Free text field to provide an internal end-user facing description of the service principal. End-user portals such [MyApps](/azure/active-directory/user-help/my-apps-portal-end-user-access) displays the application description in this field. The maximum allowed size is 1,024 characters. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `startsWith`) and `$search`.| | disabledByMicrosoftStatus | String | Specifies whether Microsoft has disabled the registered application. Possible values are: `null` (default value), `NotDisabled`, and `DisabledDueToViolationOfServicesAgreement` (reasons include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). <br><br> Supports `$filter` (`eq`, `ne`, `not`). | This resource supports using [delta query](/graph/delta-query-overview) to track |notificationEmailAddresses|String collection|Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications.| |oauth2PermissionScopes|[permissionScope](permissionScope.md) collection|The delegated permissions exposed by the application. For more information, see the **oauth2PermissionScopes** property on the [application](application.md) entity's **api** property. Not nullable.| | passwordCredentials | [passwordCredential](passwordcredential.md) collection|The collection of password credentials associated with the application. Not nullable.|-|preferredSingleSignOnMode|string|Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are `password`, `saml`, `notSupported`, and `oidc`.| +|preferredSingleSignOnMode|string|Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are `password`, `saml`, `notSupported`, and `oidc`. **Note:** This field might be `null` for older SAML apps and for OIDC applications where it isn't set automatically.| |preferredTokenSigningKeyThumbprint|String|This property can be used on SAML applications (apps that have **preferredSingleSignOnMode** set to `saml`) to control which certificate is used to sign the SAML responses. For applications that aren't SAML, don't write or otherwise rely on this property.| |replyUrls|String collection|The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. | |resourceSpecificApplicationPermissions|[resourceSpecificPermission](../resources/resourcespecificpermission.md) collection|The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for [Teams apps accessing to specific chats and teams](/microsoftteams/platform/graph-api/rsc/resource-specific-consent) using Microsoft Graph. Read-only.| |
v1.0 | Shareddriveitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/shareddriveitem.md | Title: sharedDriveItem resource type ms.localizationpriority: medium -description: "The sharedDriveItem resource is returned when using the Shares API to access a shared driveItem." +description: The sharedDriveItem resource is returned when using the Shares API to access a shared driveItem. doc_type: resourcePageType Namespace: microsoft.graph The **sharedDriveItem** resource is returned when using the [shares](../api/shares-get.md) API to access a shared [driveItem](driveitem.md). -## JSON representation --Here is a JSON representation of the **sharedDriveItem** resource. --The **sharedDriveItem** resource is derived from [**baseItem**](baseitem.md) and inherits properties from that resource. +The **sharedDriveItem** resource is derived from [baseItem](baseitem.md) and inherits properties from that resource. -<!-- { - "blockType": "resource", - "baseType": "microsoft.graph.baseItem", - "optionalProperties": [ ], - "@odata.type": "microsoft.graph.sharedDriveItem" -}--> +For more information about the facets on a DriveItem, see [driveItem](driveitem.md). -```json -{ - "id": "string", - "name": "string", - "owner": { "@odata.type": "microsoft.graph.identitySet" }, +## Methods - "driveItem": { "@odata.type": "microsoft.graph.driveItem" }, - "items": [ { "@odata.type": "microsoft.graph.driveItem" }], - "list": { "@odata.type": "microsoft.graph.list" }, - "listItem": { "@odata.type": "microsoft.graph.listItem" }, - "root": { "@odata.type": "microsoft.graph.driveItem" }, - "site": { "@odata.type": "microsoft.graph.site" } -} -``` +| Method | Return Type | Description | +|:|:--|:| +| [Use sharing links](../api/shares-get.md) | [sharedDriveItem](shareddriveitem.md) | Access a shared item or a collection of shared items by using a **shareId** or sharing URL. | ## Properties The **sharedDriveItem** resource is derived from [**baseItem**](baseitem.md) and ## Relationships -| Relationship name | Type | Description -| |:--|:-- -| **driveItem** | [**driveItem**][driveItem] | Used to access the underlying **driveItem** -| **list** | [**list**][list] | Used to access the underlying **list** -| **listItem** | [**listItem**][listItem] | Used to access the underlying **listItem** -| **permission** | [**permission**][permission] | Used to access the **permission** representing the underlying sharing link -| **site** | [**site**][site] | Used to access the underlying **site** +| Relationship name | Type | Description | +| |:-|:| +| driveItem | [driveItem][driveItem] | Used to access the underlying driveItem | +| list | [list][list] | Used to access the underlying list | +| listItem | [listItem][listItem] | Used to access the underlying listItem | +| permission | [permission][permission] | Used to access the permission representing the underlying sharing link | +| site | [site][site] | Used to access the underlying site | Alternatively, for **driveItems** shared from personal OneDrive accounts, the following relationships may also be used. -| Relationship name | Type | Description -| |:--|:-- -| **items** | [**driveItem**][driveItem] collection | All driveItems contained in the sharing root. This collection cannot be enumerated. -| **root** | [**driveItem**][driveItem] | Used to access the underlying **driveItem**. Deprecated -- use `driveItem` instead. +| Relationship name | Type | Description | +| |:-|:| +| items | [driveItem][driveItem] collection | All driveItems contained in the sharing root. This collection cannot be enumerated. | +| root | [driveItem][driveItem] | Used to access the underlying driveItem. Deprecated -- use `driveItem` instead. | [driveItem]: driveitem.md [list]: list.md Alternatively, for **driveItems** shared from personal OneDrive accounts, the fo [permission]: permission.md [site]: site.md -## Methods +## JSON representation -| Method | REST Path | -| :-- | :-- | -| [Use sharing links](../api/shares-get.md) | `GET /shares/{share-id}` | +The following JSON representation shows the resource. -## Remarks +<!-- { + "blockType": "resource", + "baseType": "microsoft.graph.baseItem", + "optionalProperties": [ ], + "@odata.type": "microsoft.graph.sharedDriveItem" +}--> -For more information about the facets on a DriveItem, see [driveItem](driveitem.md). +```json +{ + "id": "string", + "name": "string", + "owner": { "@odata.type": "microsoft.graph.identitySet" }, ++ "driveItem": { "@odata.type": "microsoft.graph.driveItem" }, + "items": [ { "@odata.type": "microsoft.graph.driveItem" }], + "list": { "@odata.type": "microsoft.graph.list" }, + "listItem": { "@odata.type": "microsoft.graph.listItem" }, + "root": { "@odata.type": "microsoft.graph.driveItem" }, + "site": { "@odata.type": "microsoft.graph.site" } +} +``` <!-- { "type": "#page.annotation", |
v1.0 | Sharepointonedriveoptions | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharepointonedriveoptions.md | ms.localizationpriority: medium doc_type: "resourcePageType"+toc. Title: "SharePoint OneDrive options" # sharePointOneDriveOptions resource type Provides the search content options when a search is performed using application |:-|:|:| |includeContent|searchContent| The type of search content. The possible values are: `sharedContent`, `privateContent`, `unknownFutureValue`. Read-only. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Sharepointprotectionpolicy | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sharepointprotectionpolicy.md | toc. Title: SharePoint protection policy Namespace: microsoft.graph -Represents a plan defined by the SharePoint Online Admin to protect SharePoint Online, including what data to protect, when to protect it, and for what time period to retain the protected data. +Represents a plan defined by the SharePoint Online admin to protect SharePoint Online, including what data to protect, when to protect it, and for what time period to retain the protected data. Currently, policies are supported only for SharePoint Online sites in the main geolocation only; multi-geo tenants aren't supported. Inherits from [protectionPolicyBase](../resources/protectionpolicybase.md). |
v1.0 | Signin | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/signin.md | The [Microsoft Entra data retention policies](/azure/active-directory/reports-mo |:|:--|:-| |appDisplayName|String|App name displayed in the Microsoft Entra admin center. <br/><br/> Supports `$filter` (`eq`, `startsWith`).| |appId|String|Unique GUID that represents the app ID in the Microsoft Entra ID. <br/><br/> Supports `$filter` (`eq`).|-|appliedConditionalAccessPolicies|[appliedConditionalAccessPolicy](appliedconditionalaccesspolicy.md) collection|Provides a list of conditional access policies that the corresponding sign-in activity triggers. Apps need more Conditional Access-related privileges to read the details of this property. For more information, see [Viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#viewing-applied-conditional-access-ca-policies-in-sign-ins).| +|appliedConditionalAccessPolicies|[appliedConditionalAccessPolicy](appliedconditionalaccesspolicy.md) collection|Provides a list of conditional access policies that the corresponding sign-in activity triggers. Apps need more Conditional Access-related privileges to read the details of this property. For more information, see [Permissions for viewing applied conditional access (CA) policies in sign-ins](../api/signin-list.md#permissions).| |clientAppUsed|String|Identifies the client used for the sign-in activity. Modern authentication clients include `Browser`, `modern clients`. Legacy authentication clients include `Exchange ActiveSync`, `IMAP`, `MAPI`, `SMTP`, `POP`, and `other clients`. <br/><br/> Supports `$filter` (`eq`).| |conditionalAccessStatus|conditionalAccessStatus| Reports status of an activated conditional access policy. Possible values are: `success`, `failure`, `notApplied`, and `unknownFutureValue`. <br/><br/> Supports `$filter` (`eq`).| |correlationId|String|The request ID sent from the client when the sign-in is initiated. Used to troubleshoot sign-in activity. <br/><br/> Supports `$filter` (`eq`).| |
v1.0 | Singleserviceprincipal | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/singleserviceprincipal.md | Title: "singleServicePrincipal complex type" -description: "Identifies a service principal in the tenant who will be allowed as requestor, approver, or reviewer." + Title: "singleServicePrincipal resource type" +description: "Identifies a service principal in the tenant who is allowed as requestor, approver, or reviewer." ms.localizationpriority: medium doc_type: resourcePageType -# singleServicePrincipal complex type +# singleServicePrincipal resource type Namespace: microsoft.graph |
v1.0 | Singleuser | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/singleuser.md | Title: "singleUser complex type" -description: "Identifies a user in the tenant who will be allowed as requestor, approver, or reviewer." + Title: "singleUser resource type" +description: "Identifies a user in the tenant who is allowed as requestor, approver, or reviewer." ms.localizationpriority: medium doc_type: resourcePageType -# singleUser complex type +# singleUser resource type Namespace: microsoft.graph |
v1.0 | Siteprotectionrule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/siteprotectionrule.md | Inherits from [protectionRuleBase](../resources/protectionrulebase.md). |createdBy|[identitySet](../resources/identityset.md)|The identity of the person who created the rule.| |createdDateTime|DateTimeOffset|The date and time that the rule was created.| |error|[publicError](../resources/publicerror.md)|Contains error details if any operation on a rule expression fails.|-|isAutoApplyEnabled|Boolean|Indicates whether the protection rule is static or dynamic. Static rules run one time and dynamic rules listen to all changes in the system and update the protection unit list.| +|isAutoApplyEnabled|Boolean| `true` indicates that the protection rule is dynamic; `false` that it's static. Static rules run one time while dynamic rules listen to all changes in the system and update the protection unit list. Currently, only static rules are supported.| |lastModifiedBy|[identitySet](../resources/identityset.md)|Identity of the person who last modified the rule.| |lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification to the rule.| |siteExpression|String|Contains a site expression. For examples, see [siteExpression example](../resources/siteprotectionrule.md#siteexpression-examples).|-|status|[protectionRuleStatus](../resources/siteprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`.| +|status|[protectionRuleStatus](../resources/siteprotectionrule.md#protectionrulestatus-values )|Status of the protection rule. The possible values are: `draft`, `active`, `completed`, `completedWithErrors`, `unknownFutureValue`. The `draft` member is currently unsupported.| ### siteExpression examples The following table shows the possible formats for the site expression. |Member | Description | |:|:|-|draft | The initial status of the protection rule upon creation.| +|draft | The initial status of the protection rule upon creation. The `draft` member is currently unsupported. | |active | The status of the protection rule upon using the `/run` API.|-|completed |The status of the protection rule after it is successfully applied to the corresponding policy.| -|completedWithErrors | The status of the protection rule after it is applied to the corresponding policy and any failures occurred.| -|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.| +|completed |The status of the protection rule after it's successfully applied to the corresponding policy.| +|completedWithErrors | The status of the protection rule after it's applied to the corresponding policy and any failures occurred.| +|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.| ## Relationships |
v1.0 | Sortproperty | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/sortproperty.md | Indicates the order to sort search results. |isDescending|Boolean|`True` if the sort order is descending. Default is `false`, with the sort order as ascending. Optional.| |name|String|The name of the property to sort on. Required.| +## Relationships ++None. ## JSON representation |
v1.0 | Staffavailabilityitem | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/staffavailabilityitem.md | Represents the available and busy time slots of a Microsoft Bookings [staff memb |availabilityItems |[availabilityItem](availabilityitem.md) collection |Each item in this collection indicates a slot and the status of the staff member.| |staffId |String |The ID of the staff member.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Subjectset | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/subjectset.md | Title: "subjectSet complex type" + Title: "subjectSet resource type" description: "A shared object that is used in entitlement management access package assignment policies, role management policies, and lifecycle workflows." ms.localizationpriority: medium doc_type: resourcePageType -# subjectSet complex type +# subjectSet resource type Namespace: microsoft.graph |
v1.0 | Targetmanager | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/targetmanager.md | ms.localizationpriority: medium doc_type: resourcePageType -# targetManager complex type +# targetManager resource type Namespace: microsoft.graph |
v1.0 | Targetusersponsors | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/targetusersponsors.md | Title: "targetUserSponsors complex type" -description: "Identifies a relationship to another user in the tenant who will be allowed as approver." + Title: "targetUserSponsors resource type" +description: "Identifies a relationship to another user in the tenant who can approve." ms.localizationpriority: medium doc_type: resourcePageType -# targetUserSponsors complex type +# targetUserSponsors resource type Namespace: microsoft.graph -Identifies a relationship to another user in the tenant who will be allowed as approver. Used in the approval settings of an [access package assignment policy](accesspackageassignmentpolicy.md). +Identifies a relationship to another user in the tenant who can approve. Used in the approval settings of an [access package assignment policy](accesspackageassignmentpolicy.md). This resource is a subtype of [subjectSet](subjectset.md), in which the `@odata.type` value `#microsoft.graph.targetUserSponsors` indicates that a requesting user's sponsors are the approvers. When creating an access package assignment policy approval stage with **targetUserSponsors**, also include another approver, such as a single user or group member, in case the requesting user doesn't have sponsors. Inherits from [subjectSet](subjectset.md). +## Properties ++None. ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type.+ <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.targetUserSponsors" |
v1.0 | Teamfunsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamfunsettings.md | Title: "teamFunSettings resource type" description: "Settings to configure use of Giphy, memes, and stickers in the team." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Teamguestsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamguestsettings.md | Title: "teamGuestSettings resource type" description: "Settings to configure whether guests can create, update, or delete channels in the team." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Teammembersettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teammembersettings.md | Title: "teamMemberSettings resource type" description: "Settings to configure whether members can perform certain actions, for example, create channels and add bots, in the team." ms.localizationpriority: medium-+ doc_type: resourcePageType |
v1.0 | Teammessagingsettings | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teammessagingsettings.md | Title: "teamMessagingSettings resource type" description: "Settings to configure messaging and mentions in the team."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teams Api Overview | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teams-api-overview.md | Title: "Use the Microsoft Graph API to work with Microsoft Teams" description: "Microsoft Teams is a chat-based workspace in Microsoft 365 that provides built-in access to team-specific calendars, files, OneNote notes, Planner plans, and more." ms.localizationpriority: high-+ doc_type: conceptualPageType The following table lists common use cases for Microsoft Teams APIs in Microsoft | Use cases | REST resources | See also | :--|:-|:--|-| Create and manage teams, groups and channels | [team](../resources/team.md), [channel](../resources/channel.md), [group](../resources/group.md) | [create team](../api/team-put-teams.md), [list teams](../api/user-list-joinedteams.md), [create channel](../api/channel-post.md) | -| Add tabs, manage or install apps in the Microsoft Teams app catalog | [teamsTab](../resources/teamstab.md), [teamsAppInstallation](../resources/teamsappinstallation.md) | [create teamsTab](../api/channel-post-tabs.md), [list teamsTab](../api/channel-list-tabs.md), [list apps](../api/appcatalogs-list-teamsapps.md) | +| Create and manage teams, groups, and channels | [team](../resources/team.md), [channel](../resources/channel.md), [group](../resources/group.md) | [create team](../api/team-put-teams.md), [list teams](../api/user-list-joinedteams.md), [create channel](../api/channel-post.md) | +| Add tabs, manage, or install apps in the Microsoft Teams app catalog | [teamsTab](../resources/teamstab.md), [teamsAppInstallation](../resources/teamsappinstallation.md) | [create teamsTab](../api/channel-post-tabs.md), [list teamsTab](../api/channel-list-tabs.md), [list apps](../api/appcatalogs-list-teamsapps.md) | | Create channels and chats to send and receive chat messages | [channel](../resources/channel.md), [chat](../resources/chat.md), [chatMessage](../resources/chatmessage.md) | [create channel](../api/channel-post.md), [list channel](../api/channel-list.md), [send chatMessage](../api/chatmessage-post.md) | | Use tags to classify users or groups based on common attributes within a team | [teamworkTag](../resources/teamworktag.md), [teamworkTagMember](../resources/teamworktagmember.md) | [list teamworkTag](../api/teamworktag-list.md), [create teamworkTag](../api/teamworktag-post.md) | | Create and receive calls, call records or retrieve meeting coordinates | [call](../resources/call.md), [callRecords](../resources/callrecords-api-overview.md) | [answer](../api/call-answer.md), [invite participants](../api/participant-invite.md) | | Connect bots to calls and implement interactive voice response (IVR) | [call](../resources/call.md) | [IVR scenarios](#ivr-scenarios) | | Create and retrieve online meetings or check users presence and activity | [onlineMeetings](../resources/onlinemeeting.md), [presence](../resources/presence.md) | [create onlineMeetings](../api/application-post-onlinemeetings.md), [meetingAttendanceReport](../resources/meetingattendancereport.md)-| Create and manage workforce integration with shifts, schedules, time cards or time off in your organization | [workforceIntegration](../resources/workforceintegration.md), [schedule](../resources/schedule.md), [shift](../resources/shift.md), [timeOff](../resources/timeoff.md), [timeOffReason](../resources/timeoffreason.md) | [create workforceIntegration](../api/workforceintegration-post.md), [create schedule](../api/schedule-post-schedulinggroups.md), [create shift](../api/schedule-post-shifts.md), [create timeOff](../api/schedule-post-timesoff.md) | +| Create and manage workforce integration with shifts, schedules, time cards, or time off in your organization | [workforceIntegration](../resources/workforceintegration.md), [schedule](../resources/schedule.md), [shift](../resources/shift.md), [timeOff](../resources/timeoff.md), [timeOffReason](../resources/timeoffreason.md) | [create workforceIntegration](../api/workforceintegration-post.md), [create schedule](../api/schedule-post-schedulinggroups.md), [create shift](../api/schedule-post-shifts.md), [create timeOff](../api/schedule-post-timesoff.md) | | Use the employee learning API to integrate with Viva Learning | [employee learning](../resources/viva-learning-api-overview.md), [learningProvider](../resources/learningprovider.md), [learningContent](../resources/learningcontent.md) | [list learningProviders](../api/employeeexperience-list-learningproviders.md), [list learningContents](../api/learningprovider-list-learningcontents.md) | ### IVR scenarios If your app polls to see whether a resource has changed, you can only do that on If you need to hear about changes more frequently than that, you should [create a subscription](../api/subscription-post-subscriptions.md) to that resource and receive change notifications (webhooks). If you don't find support for the type of subscription you need, we encourage you to provide feedback via the [Microsoft 365 Developer Platform ideas forum](https://techcommunity.microsoft.com/t5/microsoft-365-developer-platform/idb-p/Microsoft365DeveloperPlatform/label-name/Microsoft%20Graph). -When polling for new messages, you must specify a date range where supported. For details, see [get channel messages delta](../api/chatmessage-delta.md). +When polling for new messages, you must specify a date range where supported. For more information, see [get delta chat messages for a user](../api/chatmessage-delta.md). Polling is doing a GET operation on a resource over and over again to see if that resource has changed. You're allowed to GET the same resource multiple times a day, as long as it's not polling. -For example, it is okay to GET /me/joinedTeams every time the user visits/refreshes your web page, -but it is not okay to GET /me/joinedTeams in a loop every 30 seconds to refresh that web page. +For example, it's okay to GET /me/joinedTeams every time the user visits/refreshes your web page, +but it isn't okay to GET /me/joinedTeams in a loop every 30 seconds to refresh that web page. Apps that don't follow these polling requirements will be considered in violation of the [Microsoft APIs Terms of Use](/legal/microsoft-apis/terms-of-use). This may result in additional [throttling](/graph/throttling) |
v1.0 | Teamsapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsapp.md | Title: "teamsApp resource type" description: "Represents an app in the Microsoft Teams app catalog."-+ ms.localizationpriority: high doc_type: resourcePageType |
v1.0 | Teamsappauthorization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsappauthorization.md | doc_type: resourcePageType Namespace: microsoft.graph - The authorization details of a [teamsApp](teamsapp.md). ## Properties |Property|Type|Description| |:|:|:|+|clientAppId|String|The registration ID of the Microsoft Entra app ID associated with the [teamsApp](teamsapp.md). | |requiredPermissionSet|[teamsAppPermissionSet](../resources/teamsapppermissionset.md)|Set of permissions required by the [teamsApp](teamsapp.md).| ## Relationships The following JSON representation shows the resource type. ``` json { "@odata.type": "#microsoft.graph.teamsAppAuthorization",- "requiredPermissionSet": { - "@odata.type": "microsoft.graph.teamsAppPermissionSet" - } + "clientAppId": "String", + "requiredPermissionSet": {"@odata.type": "microsoft.graph.teamsAppPermissionSet"} } ``` |
v1.0 | Teamsappdefinition | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsappdefinition.md | Title: "teamsAppDefinition resource type" description: "Represents the details of one version of a teamsApp."-+ ms.localizationpriority: medium doc_type: resourcePageType Represents the details of a version of a [teamsApp](teamsapp.md). | Property | Type | Description | |:- |:-- |:-- |-| description | string | Verbose description of the application. | -| displayName | string | The name of the app provided by the app developer. | -| id | string | A unique ID (not the Teams app ID). | -| publishingState| string|The published status of a specific version of a Teams app. Possible values are:</br>`submitted`ΓÇöThe specific version of the Teams app has been submitted and is under review. </br>`published`ΓÇöThe request to publish the specific version of the Teams app has been approved by the admin and the app is published. </br> `rejected`ΓÇöThe admin rejected the request to publish the specific version of the Teams app. | -| shortDescription | string | Short description of the application. | -| teamsAppId | string | The ID from the Teams app manifest. | -| version | string | The version number of the application. | -|authorization|[teamsAppAuthorization](../resources/teamsappauthorization.md)|Authorization requirements specified in the Teams app manifest.| +| authorization | [teamsAppAuthorization](../resources/teamsappauthorization.md)| Authorization requirements specified in the Teams app manifest. | +| description | String | Verbose description of the application. | +| displayName | String | The name of the app provided by the app developer. | +| id | String | A unique ID (not the Teams app ID). | +| publishingState| String |The published status of a specific version of a Teams app. Possible values are:</br>`submitted`ΓÇöThe specific version of the Teams app was submitted and is under review.</br>`published`ΓÇöThe request to publish the specific version of the Teams app was approved by the admin and the app is published.</br>`rejected`ΓÇöThe admin rejected the request to publish the specific version of the Teams app. | +| shortDescription | String | Short description of the application. | +| teamsAppId | String | The ID from the Teams app manifest. | +| version | String | The version number of the application. | ## Relationships Represents the details of a version of a [teamsApp](teamsapp.md). ## JSON representation +The following JSON representation shows the resource type. + <!-- { "blockType": "resource", "@odata.type": "microsoft.graph.teamsAppDefinition", Represents the details of a version of a [teamsApp](teamsapp.md). ```json {- "id": "string", - "teamsAppId": "string", - "displayName": "string", - "version": "string", - "authorization": "#microsoft.graph.teamsAppAuthorization" + "authorization": {"@odata.type": "microsoft.graph.teamsAppAuthorization"}, + "description": "String", + "displayName": "String", + "id": "String (identifier)", + "publishingState": "String", + "shortDescription": "String", + "teamsAppId": "String", + "version": "String" } ``` |
v1.0 | Teamsappinstallation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsappinstallation.md | Represents a [teamsApp](teamsapp.md) installed in a [team](team.md) or the perso |[Add app for user](../api/userteamwork-post-installedapps.md) | | Add (install) an app in the personal scope of a user.| |[Upgrade installed app for user](../api/userteamwork-teamsappinstallation-upgrade.md) | None | Upgrade the app installed in the personal scope of a user to the latest version.| |[Remove app for user](../api/userteamwork-delete-installedapps.md) | None | Remove (uninstall) an app in the personal scope of a user.|+|[List apps in chat](../api/chat-list-installedapps.md) |[teamsAppInstallation](teamsappinstallation.md) collection | List apps installed in a chat.| +|[Get app installed in chat](../api/chat-get-installedapps.md) | [teamsAppInstallation](teamsappinstallation.md) | Get the specified app installed in a chat.| +|[Add app in chat](../api/chat-post-installedapps.md) | | Add (install) an app to a chat.| +|[Upgrade app installed in chat](../api/chat-teamsappinstallation-upgrade.md) | None | Upgrade the app installed in a chat to the latest version.| +|[Remove app from chat](../api/chat-delete-installedapps.md) | None | Remove (uninstall) an app from a chat.| ## Properties |
v1.0 | Teamsappinstalledstate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsappinstalledstate.md | Title: "Members" description: "Describes the current installation status of a teamsApp."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamsasyncoperation | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsasyncoperation.md | Title: "teamsAsyncOperation resource type" description: "A Microsoft Teams async operation transcends the lifetime of a single API request. "-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamsasyncoperationstatus | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsasyncoperationstatus.md | Title: "teamsAsyncOperationStatus enum type" description: "Describes the current status of a teamsAsyncOperation."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamsasyncoperationtype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamsasyncoperationtype.md | Title: "teamsAsyncOperationType enum type" description: "Types of teamsAsyncOperation."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamscatalogapp | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamscatalogapp.md | Title: "teamsCatalogApp resource type" description: "see teamsApp."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamspecialization | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamspecialization.md | Title: "teamSpecialization enum type" description: "Describes special use case for a team."-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamstabconfiguration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamstabconfiguration.md | Title: "teamsTabConfiguration resource type (Open Type)" description: "The settings that determine the content of a tab."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamstemplate | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamstemplate.md | Title: "teamsTemplate resource type" description: "Describes teamsTemplate entity."-+ ms.localizationpriority: medium doc_type: resourcePageType |
v1.0 | Teamvisibilitytype | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamvisibilitytype.md | Title: "Members" description: "Describes the visibility of a team. "-+ ms.localizationpriority: medium doc_type: enumPageType |
v1.0 | Teamwork | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/teamwork.md | A container for the range of Microsoft Teams functionalities that are available |:|:--|:-| |id|string|The default teamwork identifier.| |isTeamsEnabled|Boolean|Indicates whether Microsoft Teams is enabled for the organization.| -|region|string|Represents the region of the organization or the tenant. The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israe`l, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| +|region|string|Represents the region of the organization or the tenant. The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israel`, `Spain`, `Mexico`, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| ## Relationships |
v1.0 | Termsexpiration | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/termsexpiration.md | Provides additional settings for the scheduled expiration of the agreement. | frequency| Duration | Represents the frequency at which the terms will expire, after its first expiration as set in **startDateTime**. The value is represented in ISO 8601 format for durations. For example, `PT1M` represents a time period of one month.| | startDateTime|DateTimeOffset | The DateTime when the agreement is set to expire for all users. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +## Relationships ++None. ## JSON representation -Here's a JSON representation of this resource. +The following JSON representation shows the resource type. <!-- { "blockType": "resource", |
v1.0 | Timeslot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/timeslot.md | Title: "timeSlot resource type" -description: "A time period." +description: "Represents a time slot for a meeting." ms.localizationpriority: medium Represents a time slot for a meeting. |end|[dateTimeTimeZone](datetimetimezone.md)|The date, time, and time zone that a period ends. | |start|[dateTimeTimeZone](datetimetimezone.md)|The date, time, and time zone that a period begins.| +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Uploadsession | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/uploadsession.md | Namespace: microsoft.graph The **uploadSession** resource provides information about how to upload large files to OneDrive, OneDrive for Business, or SharePoint document libraries, or to Outlook [event](event.md) and [message](message.md) items as attachments. +## Properties +++| Property | Type |Description +|:-|:|: +| expirationDateTime | DateTimeOffset | The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached.| +| nextExpectedRanges | String collection | A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format "start-end" (for example "0-26" to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value "{start}", the location in the file where the next upload should begin.| +| uploadUrl | String | The URL endpoint that accepts PUT requests for byte ranges of the file.| ++## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. The following JSON representation shows the resource type. } ``` -## Properties ---| Property | Type |Description -|:-|:|: -| expirationDateTime | DateTimeOffset | The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached. -| nextExpectedRanges | String collection | A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format "start-end" (for example "0-26" to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value "{start}", the location in the file where the next upload should begin. -| uploadUrl | String | The URL endpoint that accepts PUT requests for byte ranges of the file. - ## Related content - [Attach large files to Outlook messages and events as attachments ](/graph/outlook-large-attachments) |
v1.0 | User | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/user.md | This resource supports: |country|String|The country/region where the user is located; for example, `US` or `UK`. Maximum length is 128 characters. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |createdDateTime | DateTimeOffset |The date and time the user was created, in ISO 8601 format and UTC. The value can't be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is `null` for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).| | creationType | String | Indicates whether the user account was created through one of the following methods: <br/> <ul><li>As a regular school or work account (`null`). <li>As an external account (`Invitation`). <li>As a local account for an Azure Active Directory B2C tenant (`LocalAccount`). <li>Through self-service sign-up by an internal user using email verification (`EmailVerified`). <li>Through self-service sign-up by a guest signing up through a link that is part of a user flow (`SelfServiceSignUp`).</ul> <br>Read-only.<br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`). |-|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). The filter value is case-sensitive.| +|customSecurityAttributes|[customSecurityAttributeValue](../resources/customsecurityattributevalue.md)|An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `startsWith`). The filter value is case-sensitive. <br><li>To read this property, the calling app must be assigned the *CustomSecAttributeAssignment.Read.All* permission. To write this property, the calling app must be assigned the *CustomSecAttributeAssignment.ReadWrite.All* permissions. <li>To read or write this property in delegated scenarios, the admin must be assigned the *Attribute Assignment Administrator* role. | |deletedDateTime| DateTimeOffset | The date and time the user was deleted. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`). | |department|String|The name of the department in which the user works. Maximum length is 64 characters. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, and `eq` on `null` values).| |displayName|String|The name displayed in the address book for the user. This value is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't be cleared during updates. Maximum length is 256 characters. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values), `$orderby`, and `$search`.| | employeeHireDate | DateTimeOffset |The date and time when the user was hired or will start work in a future hire. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).|-| employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. <br><br>To read this property, the calling app must be assigned the *User-LifeCycleInfo.Read.All* permission. To write this property, the calling app must be assigned the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* permissions. To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator*, *Global Reader*. To write this property in delegated scenarios, the admin needs the *Global Administrator* role. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). <br><br>For more information, see [Configure the employeeLeaveDateTime property for a user](/graph/tutorial-lifecycle-workflows-set-employeeleavedatetime).| +| employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. <br><li>To read this property, the calling app must be assigned the *User-LifeCycleInfo.Read.All* permission. To write this property, the calling app must be assigned the *User.Read.All* and *User-LifeCycleInfo.ReadWrite.All* permissions. <li>To read this property in delegated scenarios, the admin needs at least one of the following Microsoft Entra roles: *Lifecycle Workflows Administrator* (least privilege), *Global Reader*. To write this property in delegated scenarios, the admin needs the *Global Administrator* role. <br><br>Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`). <br><br>For more information, see [Configure the employeeLeaveDateTime property for a user](/graph/tutorial-lifecycle-workflows-set-employeeleavedatetime).| | employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |employeeOrgData|[employeeOrgData](employeeorgdata.md) |Represents organization data (for example, division and costCenter) associated with a user. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`).| | employeeType | String | Captures enterprise worker type. For example, `Employee`, `Contractor`, `Consultant`, or `Vendor`. Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not` , `ge`, `le`, `in`, `startsWith`).| This resource supports: |officeLocation|String|The office location in the user's place of business. <br><br>Returned by default. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| |onPremisesDistinguishedName|String| Contains the on-premises Active Directory `distinguished name` or `DN`. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. <br><br>Returned only on `$select`. | |onPremisesDomainName|String| Contains the on-premises `domainFQDN`, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. <br><br>Returned only on `$select`.|-|onPremisesExtensionAttributes|[onPremisesExtensionAttributes](onpremisesextensionattributes.md)|Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. <br><li>For an **onPremisesSyncEnabled** user, the source of authority for this set of properties is the on-premises and is read-only. </li><li>For a cloud-only user (where **onPremisesSyncEnabled** is `false`), these properties can be set during the creation or update of a user object. </li><li>For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.</li><br> Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`). | +|onPremisesExtensionAttributes|[onPremisesExtensionAttributes](onpremisesextensionattributes.md)|Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. <br><li>For an **onPremisesSyncEnabled** user, the source of authority for this set of properties is the on-premises and is read-only. </li><li>For a cloud-only user (where **onPremisesSyncEnabled** is `false`), these properties can be set during the creation or update of a user object. </li><li>For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.</li><br> Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`). | |onPremisesImmutableId|String|This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's **userPrincipalName** (UPN) property. **NOTE:** The **$** and **\_** characters can't be used when specifying this property. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`). | |onPremisesLastSyncDateTime|DateTimeOffset|Indicates the last time at which the object was synced with the on-premises directory; for example: `2013-02-16T03:04:54Z`. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Read-only. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`).| |onPremisesProvisioningErrors|[onPremisesProvisioningError](onpremisesprovisioningerror.md) collection| Errors when using Microsoft synchronization product during provisioning. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `not`, `ge`, `le`).| This resource supports: |onPremisesUserPrincipalName|String| Contains the on-premises `userPrincipalName` synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`).| |otherMails|String collection| A list of other email addresses for the user; for example: `["bob@contoso.com", "Robert@fabrikam.com"]`. <br>NOTE: This property can't contain accent characters. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `not`, `ge`, `le`, `in`, `startsWith`, `endsWith`, `/$count eq 0`, `/$count ne 0`).| |passwordPolicies|String|Specifies password policies for the user. This value is an enumeration with one possible value being `DisableStrongPassword`, which allows weaker passwords than the default policy to be specified. `DisablePasswordExpiration` can also be specified. The two might be specified together; for example: `DisablePasswordExpiration, DisableStrongPassword`. <br><br>Returned only on `$select`. For more information on the default password policies, see [Microsoft Entra password policies](/azure/active-directory/authentication/concept-sspr-policy#password-policies-that-only-apply-to-cloud-user-accounts). Supports `$filter` (`ne`, `not`, and `eq` on `null` values).|-|passwordProfile|[passwordProfile](passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values).| +|passwordProfile|[passwordProfile](passwordprofile.md)|Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the **passwordPolicies** property. By default, a strong password is required. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `in`, and `eq` on `null` values). <br><br>To update this property: <br><li> In delegated access, the calling app must be assigned the *Directory.AccessAsUser.All* delegated permission on behalf of the signed-in user. <li> In application-only access, the calling app must be assigned the *User.ReadWrite.All* (least privilege) or *Directory.ReadWrite.All* (higher privilege) application permission *and* at least the *User Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).| |pastProjects|String collection|A list for the user to enumerate their past projects. <br><br>Returned only on `$select`.| |postalCode|String|The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. <br><br>Returned only on `$select`. Supports `$filter` (`eq`, `ne`, `not`, `ge`, `le`, `in`, `startsWith`, and `eq` on `null` values).| | preferredDataLocation | String | The preferred data location for the user. For more information, see [OneDrive Online Multi-Geo](/sharepoint/dev/solution-guidance/multigeo-introduction).| For example: Cameron is the administrator of a directory for an elementary schoo |photos|[profilePhoto](profilephoto.md) collection| The collection of the user's profile photos in different sizes. Read-only.| |planner|[plannerUser](planneruser.md)| Entry-point to the Planner resource that might exist for a user. Read-only.| |registeredDevices|[directoryObject](directoryobject.md) collection|Devices that are registered for the user. Read-only. Nullable. Supports `$expand` and returns up to 100 objects.|+|solutions|[userSolutionRoot](../resources/usersolutionroot.md)|The identifier that relates the user to the working time schedule triggers. Read-Only. Nullable| |sponsors|[directoryObject](../resources/directoryobject.md) collection|The users and groups responsible for this guest's privileges in the tenant and keeping the guest's information and access updated. (HTTP Methods: GET, POST, DELETE.). Supports `$expand`.| |teamwork|[userTeamwork](userteamwork.md)| A container for Microsoft Teams features available for the user. Read-only. Nullable.| |todo|[todo](todo.md)|Represents the To Do services available to a user. | |
v1.0 | Useridentity | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/useridentity.md | Inherits from [identity](identity.md). | ipAddress | String | Indicates the client IP address associated with the user performing the activity (audit log only).| | userPrincipalName | String | The **userPrincipalName** attribute of the user. | +## Relationships ++None. + ## JSON representation The following JSON representation shows the resource type. |
v1.0 | Users | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/users.md | The user ID or userPrincipalName is always the signed-in user's. | Reset password | `POST /users/{id or userPrincipalName}/authentication/methods/{id}/resetPassword` where the authentication method ID is always `28c10230-6103-485e-b985-444c60001490`. | UserAuthenticationMethod.ReadWrite | --> -## Who can reset passwords +## Sensitive actions -In the following table, the columns list the roles that can reset passwords and invalidate refresh tokens. The rows list the roles for which their password can be reset. For example, a Password Administrator can reset the password for Directory Readers, Guest Inviter, Password Administrator, and users with no administrator role. If a user is assigned any other role, the Password Administrator cannot reset their password. --The following table is for roles assigned at the scope of a tenant. For roles assigned at the scope of an administrative unit, [further restrictions apply](/entra/identity/role-based-access-control/admin-units-assign-roles#roles-that-can-be-assigned-with-administrative-unit-scope). --| Role that password can be reset | Password Admin | Helpdesk Admin | Auth Admin | User Admin | Privileged Auth Admin | Global Admin | -| | | | | | | | -| Auth Admin | | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | -| Directory Readers | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Global Admin | | | | | :white_check_mark: | :white_check_mark:\* | -| Groups Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Guest Inviter | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Helpdesk Admin | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Message Center Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Password Admin | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Privileged Auth Admin | | | | | :white_check_mark: | :white_check_mark: | -| Privileged Role Admin | | | | | :white_check_mark: | :white_check_mark: | -| Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| User<br/>(no admin role) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| User<br/>(no admin role, but member or owner of a role-assignable group | | | | | :white_check_mark: | :white_check_mark: | -| User with a role scoped to a restricted management administrative unit | | | | | :white_check_mark: | :white_check_mark: | -| User Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| Usage Summary Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| All custom roles | | | | | :white_check_mark: | :white_check_mark: | --The ability to reset a password includes the ability to update the following sensitive properties required for [self-service password reset](/entra/identity/authentication/concept-sspr-howitworks): -> - businessPhones -> - mobilePhone -> - otherMails --## Who can perform sensitive actions --Some administrators can perform the following sensitive actions for some users. All users can read the sensitive properties. +The following actions against the user object are considered sensitive and might be locked down to only specific administrators. All users can read the sensitive properties. | Sensitive action | Sensitive property name | ||-| Some administrators can perform the following sensitive actions for some users. | Update user principal name | userPrincipalName | | Delete or restore users | Not applicable | +### Who can perform sensitive actions ++Some administrators can perform the preceding sensitive actions for some users. + In the following table, the columns list the roles that can perform sensitive actions. The rows list the roles for which the sensitive action can be performed upon. The following table is for roles assigned at the scope of a tenant. For roles assigned at the scope of an administrative unit, [further restrictions apply](/entra/identity/role-based-access-control/admin-units-assign-roles#roles-that-can-be-assigned-with-administrative-unit-scope). The following table is for roles assigned at the scope of a tenant. For roles as | Usage Summary Reports Reader | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | All custom roles | | | :white_check_mark: | :white_check_mark: | +### Who can reset passwords ++In the following table, the columns list the roles that can reset passwords and invalidate refresh tokens. The rows list the roles for which their password can be reset. For example, a Password Administrator can reset the password for Directory Readers, Guest Inviter, Password Administrator, and users with no administrator role. If a user is assigned any other role, the Password Administrator cannot reset their password. ++The following table is for roles assigned at the scope of a tenant. For roles assigned at the scope of an administrative unit, [further restrictions apply](/entra/identity/role-based-access-control/admin-units-assign-roles#roles-that-can-be-assigned-with-administrative-unit-scope). ++| Role that password can be reset | Password Admin | Helpdesk Admin | Auth Admin | User Admin | Privileged Auth Admin | Global Admin | +| | | | | | | | +| Auth Admin | | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | +| Directory Readers | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Global Admin | | | | | :white_check_mark: | :white_check_mark:\* | +| Groups Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Guest Inviter | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Helpdesk Admin | | :white_check_mark: | | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Message Center Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Password Admin | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Privileged Auth Admin | | | | | :white_check_mark: | :white_check_mark: | +| Privileged Role Admin | | | | | :white_check_mark: | :white_check_mark: | +| Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| User<br/>(no admin role) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| User<br/>(no admin role, but member or owner of a role-assignable group) | | | | | :white_check_mark: | :white_check_mark: | +| User with a role scoped to a restricted management administrative unit | | | | | :white_check_mark: | :white_check_mark: | +| User Admin | | | | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Usage Summary Reports Reader | | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| All custom roles | | | | | :white_check_mark: | :white_check_mark: | ++The ability to reset a password includes the ability to update the following sensitive properties required for [self-service password reset](/entra/identity/authentication/concept-sspr-howitworks): +> - businessPhones +> - mobilePhone +> - otherMails + ## Common properties The following represent the default set of properties that are returned when getting a user or listing users. These are a subset of all available properties. To get more user properties, use the `$select` query parameter. Learn [how to use the $select query parameter](/graph/query-parameters#select-parameter) and see [properties that support the $select query parameter](../resources/user.md#properties). |
v1.0 | Usersolutionroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/usersolutionroot.md | + + Title: "userSolutionRoot resource type" +description: "Represents an identifier that relates a user to the working time schedule triggers." ++ms.localizationpriority: medium ++++# userSolutionRoot resource type ++Namespace: microsoft.graph +++Represents an identifier that relates a user to the working time schedule triggers. ++## Properties ++|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier for the user's custom solution entity. Read-only.| ++## Relationships ++|Relationship|Type|Description| +|:|:|:| +|workingTimeSchedule|[workingTimeSchedule](../resources/workingtimeschedule.md)|The working time schedule entity associated with the solution.| ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.userSolutionRoot", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.userSolutionRoot", + "id": "String (identifier)" +} +``` |
v1.0 | Userteamwork | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/userteamwork.md | Represents a container for the range of Microsoft Teams functionalities that are |:|:--|:-| |id| String|The unique identifier for the **userTeamwork** object.| |locale|String |Represents the location that a user selected in Microsoft Teams and doesn't follow the Office's locale setting. A userΓÇÖs locale is represented by their preferred language and country or region. For example, `en-us`. The language component follows two-letter codes as defined in [ISO 639-1](https://www.iso.org/iso/home/standards/language_codes.htm), and the country component follows two-letter codes as defined in [ISO 3166-1 alpha-2](https://www.iso.org/iso/country_codes.htm).|-|region|string|Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region.<br><br>The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israe`l, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| +|region|string|Represents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region.<br><br>The **region** value can be any region supported by the Teams payload. The possible values are: `Americas`, `Europe and MiddleEast`, `Asia Pacific`, `UAE`, `Australia`, `Brazil`, `Canada`, `Switzerland`, `Germany`, `France`, `India`, `Japan`, `South Korea`, `Norway`, `Singapore`, `United Kingdom`, `South Africa`, `Sweden`, `Qatar`, `Poland`, `Italy`, `Israel`, `Spain`, `Mexico`, `USGov Community Cloud`, `USGov Community Cloud High`, `USGov Department of Defense`, and `China`.| ## Relationships |
v1.0 | Virtualeventsroot | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/virtualeventsroot.md | The container for [virtual event](virtualevent.md) APIs. ## Methods -None. +|Method|Return type|Description| +|:|:|:| +| [List webinars](../api/virtualeventsroot-list-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in a tenant. | ## Properties |
v1.0 | Virtualeventtownhall | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/virtualeventtownhall.md | Inherits from [virtualEvent](../resources/virtualevent.md). | id | String | Unique identifier of the town hall. Inherited from [entity](../resources/entity.md). Read-only. | | invitedAttendees | [identity](../resources/identity.md) collection | The attendees invited to the town hall. The supported identities are: [communicationsUserIdentity](../resources/communicationsuseridentity.md) and [communicationsGuestIdentity](../resources/communicationsguestidentity.md). | | isInviteOnly | Boolean | Indicates whether the town hall is only open to invited people and groups within your organization. The **isInviteOnly** property can only be `true` if the value of the **audience** property is set to `organization`. |+| settings | [virtualEventSettings](../resources/virtualeventsettings.md) | The virtual event settings. | | startDateTime | [dateTimeTimeZone](../resources/datetimetimezone.md) | Date and time when the town hall starts. The **timeZone** property _can_ be set to any of the time zones currently supported by Windows. For details on how to get all available time zones using PowerShell, see [Get-TimeZone](/powershell/module/microsoft.powershell.management/get-timezone#example-3-get-all-available-time-zones). Inherited from [virtualEvent](../resources/virtualevent.md). | | status | virtualEventStatus | Status of the town hall. Possible values are: `draft`, `published`, `canceled`, and `unknownFutureValue`. Inherited from [virtualEvent](../resources/virtualevent.md). | The following JSON representation shows the resource type. "id": "String (identifier)", "invitedAttendees": [{"@odata.type": "microsoft.graph.identity"}], "isInviteOnly": "Boolean",+ "settings": {"@odata.type": "microsoft.graph.virtualEventSettings"}, "startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"}, "status": "String" } |
v1.0 | Virtualeventwebinar | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/virtualeventwebinar.md | Inherits from [virtualEvent](../resources/virtualevent.md). | Method | Return Type |Description | | | -- | - |+| [List](../api/virtualeventsroot-list-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in a tenant. | | [Create](../api/virtualeventsroot-post-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) | Create a [virtualEventWebinar](../resources/virtualeventwebinar.md) object. | | [Get](../api/virtualeventwebinar-get.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) | Read the properties and relationships of a [virtualEventWebinar](../resources/virtualeventwebinar.md) object. | | [Update](../api/virtualeventwebinar-update.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) | Update the properties of a [virtualEventWebinar](../resources/virtualeventwebinar.md) object. | | [Publish](../api/virtualeventwebinar-publish.md) | None | Publish a [virtualEventWebinar](../resources/virtualeventwebinar.md). | | [Cancel](../api/virtualeventwebinar-cancel.md) | None | Cancel a [virtualEventWebinar](../resources/virtualeventwebinar.md). |-| [List in organization](../api/virtualeventsroot-list-webinars.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get the list of all [virtualEventWebinar](../resources/virtualeventwebinar.md) objects created in the tenant. | -| [List by user role](../api/virtualeventwebinar-getbyuserrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the signed-in user is either the organizer or a co-organizer. | -| [List by user ID and role](../api/virtualeventwebinar-getbyuseridandrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the specified user is either the organizer or a co-organizer. | +| [List by user role](../api/virtualeventwebinar-getbyuserrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the signed-in user is either the organizer or a coorganizer. | +| [List by user ID and role](../api/virtualeventwebinar-getbyuseridandrole.md) | [virtualEventWebinar](../resources/virtualeventwebinar.md) collection | Get a **virtualEventWebinar** collection where the specified user is either the organizer or a coorganizer. | ## Properties |
v1.0 | Workbookrangesort | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workbookrangesort.md | The following JSON representation shows the resource type. The following example shows a request. +# [HTTP](#tab/http) <!--{ "blockType": "request", "name": "range_sort" The following example shows a request. GET https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/sort ``` +# [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 | Workinghours | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workinghours.md | to the destination time zone so that Outlook time values are displayed in local When other people request work meetings with you in your usual place of work, they can still respect your working hours in the appropriate time zone. +> **Note:** The [working hours experience](https://support.microsoft.com/office/set-your-work-hours-and-location-in-outlook-af2fddf9-249e-4710-9c95-5911edfd76f6#articleFooterSupportBridge=communityBridge) in new Outlook and Outlook on the web isn't currently supported. + ## Properties | Property | Type |Description| |
v1.0 | Workingtimeschedule | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/resources/workingtimeschedule.md | + + Title: "workingTimeSchedule resource type" +description: "Contains triggers for policies associated with the start and end of working hours for users." ++ms.localizationpriority: medium ++++# workingTimeSchedule resource type ++Namespace: microsoft.graph +++Contains triggers for policies associated with the start and end of working hours for users. ++## Methods ++|Method|Return type|Description| +|:|:|:| +|[Get](../api/workingtimeschedule-get.md)|[workingTimeSchedule](../resources/workingtimeschedule.md)|Read the properties and relationships of a [workingTimeSchedule](../resources/workingtimeschedule.md) object.| +|[Start working time](../api/workingtimeschedule-startworkingtime.md)|None|Trigger the policies associated with the start of working hours for a specific user.| +|[End working time](../api/workingtimeschedule-endworkingtime.md)|None|Trigger the policies associated with the end of working hours for a specific user.| ++## Properties ++|Property|Type|Description| +|:|:|:| +|id|String|The unique identifier for the working time schedule. Read-only.| ++## Relationships ++None. ++## JSON representation ++The following JSON representation shows the resource type. +<!-- { + "blockType": "resource", + "keyProperty": "id", + "@odata.type": "microsoft.graph.workingTimeSchedule", + "openType": false +} +--> +``` json +{ + "@odata.type": "#microsoft.graph.workingTimeSchedule", + "id": "String (identifier)" +} +``` |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc.yml | a/api-reference/v1.0/toc.yml items: href: toc/device-and-app-management/toc.yml - name: Education href: toc/education/toc.yml+ - name: Employee experience + href: toc/employee-experience/toc.yml - name: Extensions href: toc/extensions/toc.yml displayName: Directory extensions, Schema extensions, Open extensions, On-premises extensions |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/applications/toc.yml | a/api-reference/v1.0/toc/applications/toc.yml items: href: ../../api/federatedidentitycredential-delete.md - name: Policies items:- - name: Remote desktop security configuration + - name: Application management policy items:- - name: Remote desktop security configuration - href: ../../resources/remotedesktopsecurityconfiguration.md - - name: Create - href: ../../api/serviceprincipal-post-remotedesktopsecurityconfiguration.md - - name: Get - href: ../../api/remotedesktopsecurityconfiguration-get.md - - name: Update - href: ../../api/remotedesktopsecurityconfiguration-update.md - - name: Delete - href: ../../api/serviceprincipal-delete-remotedesktopsecurityconfiguration.md + - name: Overview + href: ../../resources/applicationauthenticationmethodpolicy.md + - name: App management policy + items: + - name: App management policy + href: ../../resources/appmanagementpolicy.md + - name: List + href: ../../api/appmanagementpolicy-list.md + - name: Create + href: ../../api/appmanagementpolicy-post.md + - name: Get + href: ../../api/appmanagementpolicy-get.md + - name: Update + href: ../../api/appmanagementpolicy-update.md + - name: Delete + href: ../../api/appmanagementpolicy-delete.md + - name: List applies to + href: ../../api/appmanagementpolicy-list-appliesto.md + - name: Create applies to + href: ../../api/appmanagementpolicy-post-appliesto.md + - name: Delete applies to + href: ../../api/appmanagementpolicy-delete-appliesto.md + - name: Tenant app management policy + items: + - name: Tenant app management policy + href: ../../resources/tenantappmanagementpolicy.md + - name: Get + href: ../../api/tenantappmanagementpolicy-get.md + - name: Update + href: ../../api/tenantappmanagementpolicy-update.md - name: Token issuance policy items: - name: Token issuance policy items: href: ../../api/serviceprincipal-list-homerealmdiscoverypolicies.md - name: Unassign from service principal href: ../../api/serviceprincipal-delete-homerealmdiscoverypolicies.md+ - name: Remote desktop security policy + items: + - name: Remote desktop security configuration + items: + - name: Remote desktop security configuration + href: ../../resources/remotedesktopsecurityconfiguration.md + - name: Create + href: ../../api/serviceprincipal-post-remotedesktopsecurityconfiguration.md + - name: Get + href: ../../api/remotedesktopsecurityconfiguration-get.md + - name: Update + href: ../../api/remotedesktopsecurityconfiguration-update.md + - name: Delete + href: ../../api/serviceprincipal-delete-remotedesktopsecurityconfiguration.md + - name: Target device group + items: + - name: Target device group + href: ../../resources/targetdevicegroup.md + - name: List + href: ../../api/remotedesktopsecurityconfiguration-list-targetdevicegroups.md + - name: Create + href: ../../api/remotedesktopsecurityconfiguration-post-targetdevicegroups.md + - name: Get + href: ../../api/targetdevicegroup-get.md + - name: Update + href: ../../api/targetdevicegroup-update.md + - name: Delete + href: ../../api/remotedesktopsecurityconfiguration-delete-targetdevicegroups.md - name: Synchronization items: - name: Overview |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/backup-storage/toc.yml | a/api-reference/v1.0/toc/backup-storage/toc.yml items: - name: Restore artifact href: ../../resources/restoreartifactbase.md items:- - name: Granular mail box restore artifact + - name: Granular mailbox restore artifact items:- - name: Granular mail box restore artifact + - name: Granular mailbox restore artifact href: ../../resources/granularmailboxrestoreartifact.md - name: List href: ../../api/exchangerestoresession-list-mailboxrestoreartifacts.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/calendars/toc.yml | a/api-reference/v1.0/toc/calendars/toc.yml items: href: ../../api/post-list-attachments.md - name: Delete href: ../../api/attachment-delete.md+- name: File attachment + items: + - name: File attachment + href: ../../resources/fileattachment.md + - name: Get attachment + href: ../../api/attachment-get.md + - name: Delete attachment + href: ../../api/attachment-delete.md +- name: Item attachment + items: + - name: Item attachment + href: ../../resources/itemattachment.md + - name: Get attachment + href: ../../api/attachment-get.md + - name: Delete attachment + href: ../../api/attachment-delete.md +- name: Reference attachment + items: + - name: Reference attachment + href: ../../resources/referenceattachment.md + - name: Get attachment + href: ../../api/attachment-get.md + - name: Delete attachment + href: ../../api/attachment-delete.md - name: Calendar group items: - name: Calendar group |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/customer-booking/toc.yml | a/api-reference/v1.0/toc/customer-booking/toc.yml items: href: ../../api/bookingbusiness-publish.md - name: Unpublish href: ../../api/bookingbusiness-unpublish.md+ - name: Get staff availability + href: ../../api/bookingbusiness-getstaffavailability.md - name: Booking currency items: - name: Booking currency |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/employee-experience/toc.yml | +# +# GENERATED FILE - DO NOT EDIT +# +items: +- name: Employee engagement + items: + - name: Overview + href: ../../resources/engagement-api-overview.md + - name: Community + items: + - name: Community + href: ../../resources/community.md + - name: List + href: ../../api/employeeexperience-list-communities.md + - name: Create + href: ../../api/employeeexperience-post-communities.md + - name: Get + href: ../../api/community-get.md + - name: Update + href: ../../api/community-update.md + - name: Delete + href: ../../api/community-delete.md + - name: Engagement async operation + items: + - name: Engagement async operation + href: ../../resources/engagementasyncoperation.md + - name: Get + href: ../../api/engagementasyncoperation-get.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/files/toc.yml | a/api-reference/v1.0/toc/files/toc.yml items: items: - name: Drive href: ../../resources/drive.md+ - name: List drive + href: ../../api/drive-list.md - name: Get drive href: ../../api/drive-get.md - name: Get drive root items: href: ../../api/filestoragecontainer-update-customproperty.md - name: Delete custom property href: ../../api/filestoragecontainer-delete-customproperty.md+- name: Shared drive item + items: + - name: Shared drive item + href: ../../resources/shareddriveitem.md + - name: Use sharing links + href: ../../api/shares-get.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/identity-and-access/toc.yml | a/api-reference/v1.0/toc/identity-and-access/toc.yml items: href: ../../api/directory-deleteditems-get.md - name: Restore href: ../../api/directory-deleteditems-restore.md+ - name: App role assignment + items: + - name: App role assignment + href: ../../resources/approleassignment.md + - name: List app role assignments for a group + href: ../../api/group-list-approleassignments.md + - name: List app role assignments for a user + href: ../../api/user-list-approleassignments.md + - name: List app role assignments for a client service principal + href: ../../api/serviceprincipal-list-approleassignments.md + - name: List app role assignments for users, groups, and client service principals for a resource service principal + href: ../../api/serviceprincipal-list-approleassignedto.md + - name: Grant app role to a group + href: ../../api/group-post-approleassignments.md + - name: Grant app role to a user + href: ../../api/user-post-approleassignments.md + - name: Grant app role to a client service principal + href: ../../api/serviceprincipal-post-approleassignments.md + - name: Grant app role assignment to user, group, or client service principal for a resource service principal + href: ../../api/serviceprincipal-post-approleassignedto.md + - name: Get app role assignment + href: ../../api/approleassignment-get.md + - name: Delete app role assignment for a group + href: ../../api/group-delete-approleassignments.md + - name: Delete app role assignment for a user + href: ../../api/user-delete-approleassignments.md + - name: Delete app role assignment for a client service principal + href: ../../api/serviceprincipal-delete-approleassignments.md + - name: Delete app role assignment for user, group, or client service principal to a resource service principal + href: ../../api/serviceprincipal-delete-approleassignedto.md - name: BitLocker recovery key items: - name: BitLocker recovery key items: href: ../../api/device-list-transitivememberof.md - name: List registered owners href: ../../api/device-list-registeredowners.md+ - name: Add registered owners + href: ../../api/device-post-registeredowners.md + - name: Remove registered owners + href: ../../api/device-delete-registeredowners.md - name: List registered users href: ../../api/device-list-registeredusers.md+ - name: Add registered users + href: ../../api/device-post-registeredusers.md + - name: Remove registered users + href: ../../api/device-delete-registeredusers.md - name: Check member objects href: ../../api/directoryobject-checkmemberobjects.md - name: Get member objects items: href: ../../api/domain-post-domains.md - name: Get href: ../../api/domain-get.md+ - name: Get root domain + href: ../../api/domain-get-rootdomain.md - name: Update href: ../../api/domain-update.md - name: Delete items: href: ../../api/accesspackageassignmentrequest-get.md - name: Delete href: ../../api/accesspackageassignmentrequest-delete.md- - name: Filter by current user - href: ../../api/accesspackageassignmentrequest-filterbycurrentuser.md - name: Cancel href: ../../api/accesspackageassignmentrequest-cancel.md+ - name: Filter by current user + href: ../../api/accesspackageassignmentrequest-filterbycurrentuser.md - name: Reprocess href: ../../api/accesspackageassignmentrequest-reprocess.md+ - name: Resume + href: ../../api/accesspackageassignmentrequest-resume.md - name: Access package catalog items: - name: Access package catalog items: href: ../../api/identitygovernance-lifecyclemanagementsettings-get.md - name: Update href: ../../api/identitygovernance-lifecyclemanagementsettings-update.md+ - name: Insights + items: + - name: Insights + href: ../../resources/identitygovernance-insights.md + - name: Get top workflows summary + href: ../../api/identitygovernance-insights-topworkflowsprocessedsummary.md + - name: Get top tasks summary + href: ../../api/identitygovernance-insights-toptasksprocessedsummary.md + - name: Get workflows processed summary + href: ../../api/identitygovernance-insights-workflowsprocessedsummary.md + - name: Get workflows processed by category + href: ../../api/identitygovernance-insights-workflowsprocessedbycategory.md - name: Complex types items: - name: Custom callout extension items: href: ../../resources/termsexpiration.md - name: Identity and sign-in items:- - name: Authentication event listener + - name: Authentication event listeners items: - name: Authentication event listener- href: ../../resources/authenticationeventlistener.md - - name: List - href: ../../api/identitycontainer-list-authenticationeventlisteners.md - - name: Create - href: ../../api/identitycontainer-post-authenticationeventlisteners.md - - name: Get - href: ../../api/authenticationeventlistener-get.md - - name: Update - href: ../../api/authenticationeventlistener-update.md - - name: Delete - href: ../../api/authenticationeventlistener-delete.md + items: + - name: Authentication event listener + href: ../../resources/authenticationeventlistener.md + - name: List + href: ../../api/identitycontainer-list-authenticationeventlisteners.md + - name: Create + href: ../../api/identitycontainer-post-authenticationeventlisteners.md + - name: Get + href: ../../api/authenticationeventlistener-get.md + - name: Update + href: ../../api/authenticationeventlistener-update.md + - name: Delete + href: ../../api/authenticationeventlistener-delete.md + - name: On attribute collection listener + href: ../../resources/onattributecollectionlistener.md + - name: On authentication method load start listener + href: ../../resources/onauthenticationmethodloadstartlistener.md + - name: On interactive auth flow start listener + href: ../../resources/oninteractiveauthflowstartlistener.md + - name: On token issuance start listener + href: ../../resources/ontokenissuancestartlistener.md + - name: On user create start listener + href: ../../resources/onusercreatestartlistener.md - name: Authentication methods items: - name: Overview items: href: ../../resources/authenticationcontextclassreference.md - name: List href: ../../api/conditionalaccessroot-list-authenticationcontextclassreferences.md- - name: Create or update authenticationContextClassReference + - name: Create or update href: ../../api/authenticationcontextclassreference-update.md - name: Get href: ../../api/authenticationcontextclassreference-get.md items: href: ../../api/crosstenantidentitysyncpolicypartner-update.md - name: Delete href: ../../api/crosstenantidentitysyncpolicypartner-delete.md- - name: Custom authentication extension + - name: Custom authentication extensions items: - name: Custom authentication extension- href: ../../resources/customauthenticationextension.md - - name: List - href: ../../api/identitycontainer-list-customauthenticationextensions.md - - name: Create - href: ../../api/identitycontainer-post-customauthenticationextensions.md - - name: Get - href: ../../api/customauthenticationextension-get.md - - name: Update - href: ../../api/customauthenticationextension-update.md - - name: Delete - href: ../../api/customauthenticationextension-delete.md - - name: Validate authentication configuration - href: ../../api/customauthenticationextension-validateauthenticationconfiguration.md + items: + - name: Custom authentication extension + href: ../../resources/customauthenticationextension.md + - name: List + href: ../../api/identitycontainer-list-customauthenticationextensions.md + - name: Create + href: ../../api/identitycontainer-post-customauthenticationextensions.md + - name: Get + href: ../../api/customauthenticationextension-get.md + - name: Update + href: ../../api/customauthenticationextension-update.md + - name: Delete + href: ../../api/customauthenticationextension-delete.md + - name: Validate authentication configuration + href: ../../api/customauthenticationextension-validateauthenticationconfiguration.md - name: On token issuance start custom extension href: ../../resources/ontokenissuancestartcustomextension.md - name: Data policy operation items: href: ../../api/riskyuser-dismiss.md - name: List history href: ../../api/riskyuser-list-history.md+ - name: Risky user history item + items: + - name: Risky user history item + href: ../../resources/riskyuserhistoryitem.md + - name: List history + href: ../../api/riskyuser-list-history.md - name: Service principal risk detection items: - name: Service principal risk detection items: href: ../../api/authorizationpolicy-get.md - name: Update href: ../../api/authorizationpolicy-update.md- - name: Claims mapping policy - items: - - name: Claims mapping policy - href: ../../resources/claimsmappingpolicy.md - - name: List - href: ../../api/claimsmappingpolicy-list.md - - name: Create - href: ../../api/claimsmappingpolicy-post-claimsmappingpolicies.md - - name: Get - href: ../../api/claimsmappingpolicy-get.md - - name: Update - href: ../../api/claimsmappingpolicy-update.md - - name: Delete - href: ../../api/claimsmappingpolicy-delete.md - - name: List applies to - href: ../../api/claimsmappingpolicy-list-appliesto.md - - name: Assign to service principal - href: ../../api/serviceprincipal-post-claimsmappingpolicies.md - - name: List assigned to service principal - href: ../../api/serviceprincipal-list-claimsmappingpolicies.md - - name: Unassign from service principal - href: ../../api/serviceprincipal-delete-claimsmappingpolicies.md - name: Home realm discovery policy items: - name: Home realm discovery policy items: href: ../../api/serviceprincipal-list-homerealmdiscoverypolicies.md - name: Unassign from service principal href: ../../api/serviceprincipal-delete-homerealmdiscoverypolicies.md- - name: Token issuance policy - items: - - name: Token issuance policy - href: ../../resources/tokenissuancepolicy.md - - name: List - href: ../../api/tokenissuancepolicy-list.md - - name: Create - href: ../../api/tokenissuancepolicy-post-tokenissuancepolicy.md - - name: Get - href: ../../api/tokenissuancepolicy-get.md - - name: Update - href: ../../api/tokenissuancepolicy-update.md - - name: Delete - href: ../../api/tokenissuancepolicy-delete.md - - name: List applied to applications - href: ../../api/tokenissuancepolicy-list-appliesto.md - - name: Token lifetime policy - items: - - name: Token lifetime policy - href: ../../resources/tokenlifetimepolicy.md - - name: List - href: ../../api/tokenlifetimepolicy-list.md - - name: Create - href: ../../api/tokenlifetimepolicy-post-tokenlifetimepolicies.md - - name: Get - href: ../../api/tokenlifetimepolicy-get.md - - name: Update - href: ../../api/tokenlifetimepolicy-update.md - - name: Delete - href: ../../api/tokenlifetimepolicy-delete.md - - name: List applied to applications - href: ../../api/tokenlifetimepolicy-list-appliesto.md - name: Authentication flows policy items: - name: Authentication flows policy items: href: ../../api/identitysecuritydefaultsenforcementpolicy-get.md - name: Update href: ../../api/identitysecuritydefaultsenforcementpolicy-update.md- - name: Application authentication method policy - items: - - name: Overview - href: ../../resources/applicationauthenticationmethodpolicy.md - - name: Tenant app management policy - items: - - name: Tenant app management policy - href: ../../resources/tenantappmanagementpolicy.md - - name: Get - href: ../../api/tenantappmanagementpolicy-get.md - - name: Update - href: ../../api/tenantappmanagementpolicy-update.md - - name: App management policy - items: - - name: App management policy - href: ../../resources/appmanagementpolicy.md - - name: List - href: ../../api/appmanagementpolicy-list.md - - name: Create - href: ../../api/appmanagementpolicy-post.md - - name: Get - href: ../../api/appmanagementpolicy-get.md - - name: Update - href: ../../api/appmanagementpolicy-update.md - - name: Delete - href: ../../api/appmanagementpolicy-delete.md - - name: List applies to - href: ../../api/appmanagementpolicy-list-appliesto.md - - name: Create applies to - href: ../../api/appmanagementpolicy-post-appliesto.md - name: Authentication methods policy items: - name: Overview items: href: ../../api/x509certificateauthenticationmethodconfiguration-update.md - name: Delete href: ../../api/x509certificateauthenticationmethodconfiguration-delete.md- - name: Remote desktop security configuration - items: - - name: Remote desktop security configuration - items: - - name: Remote desktop security configuration - href: ../../resources/remotedesktopsecurityconfiguration.md - - name: Create - href: ../../api/serviceprincipal-post-remotedesktopsecurityconfiguration.md - - name: Get - href: ../../api/remotedesktopsecurityconfiguration-get.md - - name: Update - href: ../../api/remotedesktopsecurityconfiguration-update.md - - name: Delete - href: ../../api/serviceprincipal-delete-remotedesktopsecurityconfiguration.md - - name: Target device group - items: - - name: Target device group - href: ../../resources/targetdevicegroup.md - - name: List - href: ../../api/remotedesktopsecurityconfiguration-list-targetdevicegroups.md - - name: Create - href: ../../api/remotedesktopsecurityconfiguration-post-targetdevicegroups.md - - name: Get - href: ../../api/targetdevicegroup-get.md - - name: Update - href: ../../api/targetdevicegroup-update.md - - name: Delete - href: ../../api/remotedesktopsecurityconfiguration-delete-targetdevicegroups.md - name: User flows in external tenants items: - name: Authentication events flow items: href: ../../api/identityuserflowattribute-delete.md - name: List attributes in a user flow href: ../../api/onattributecollectionexternalusersselfservicesignup-list-attributes.md- - name: List attributes in a user flow - href: ../../api/onattributecollectionexternalusersselfservicesignup-list-attributes.md - name: Add attribute to a user flow href: ../../api/onattributecollectionexternalusersselfservicesignup-post-attributes.md - name: Remove attribute from a user flow items: href: ../../api/identityapiconnector-uploadclientcertificate.md - name: Delete href: ../../api/identityapiconnector-delete.md+ - name: User flows in Azure AD B2C (deprecated) + href: ../../resources/identityuserflow.md - name: Granular delegated admin privileges displayName: GDAP, Partner Center, CSP, VAR items: |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/reports/toc.yml | a/api-reference/v1.0/toc/reports/toc.yml items: items: - name: Overview href: ../../resources/report.md+ - name: Admin report settings + items: + - name: Admin report settings + href: ../../resources/adminreportsettings.md + - name: Get + href: ../../api/adminreportsettings-get.md + - name: Update + href: ../../api/adminreportsettings-update.md - name: Report root items: - name: Report root |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/search/toc.yml | a/api-reference/v1.0/toc/search/toc.yml items: href: ../../resources/searchhitscontainer.md - name: Search query href: ../../resources/searchquery.md- - name: Share point one drive options + - name: SharePoint OneDrive options href: ../../resources/sharepointonedriveoptions.md - name: Sort property href: ../../resources/sortproperty.md |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/security/toc.yml | a/api-reference/v1.0/toc/security/toc.yml items: href: ../../api/security-ediscoverycase-list-custodians.md - name: Create ediscoveryCustodian href: ../../api/security-ediscoverycase-post-custodians.md+ - name: List legalHolds + href: ../../api/security-ediscoverycase-list-legalholds.md + - name: Delete legalholds + href: ../../api/security-ediscoverycase-delete-legalholds.md + - name: Create ediscoveryHoldPolicy + href: ../../api/security-ediscoverycase-post-legalholds.md - name: List noncustodialDataSources href: ../../api/security-ediscoverysearch-list-noncustodialsources.md - name: Create ediscoveryNoncustodialDataSource items: href: ../../api/security-ediscoverycustodian-list-sitesources.md - name: Create site source href: ../../api/security-ediscoverycustodian-post-sitesources.md- - name: List unitifed group sources + - name: List unified group sources href: ../../api/security-ediscoverycustodian-list-unifiedgroupsources.md- - name: Create unifed group source + - name: Create unified group source href: ../../api/security-ediscoverycustodian-post-unifiedgroupsources.md - name: List user sources href: ../../api/security-ediscoverycustodian-list-usersources.md items: href: ../../api/security-ediscoverynoncustodialdatasource-removehold.md - name: Get last index operation href: ../../api/security-ediscoverycustodian-list-lastindexoperation.md+ - name: eDiscovery hold policy + items: + - name: eDiscovery hold policy + href: ../../resources/security-ediscoveryholdpolicy.md + - name: List + href: ../../api/security-ediscoverycase-list-legalholds.md + - name: Create + href: ../../api/security-ediscoverycase-post-legalholds.md + - name: Get + href: ../../api/security-ediscoveryholdpolicy-get.md + - name: Update + href: ../../api/security-ediscoveryholdpolicy-update.md + - name: Delete + href: ../../api/security-ediscoverycase-delete-legalholds.md + - name: List site sources + href: ../../api/security-ediscoverycustodian-list-sitesources.md + - name: Create site source + href: ../../api/security-ediscoveryholdpolicy-post-sitesources.md + - name: List user sources + href: ../../api/security-ediscoverycustodian-list-usersources.md + - name: Create user source + href: ../../api/security-ediscoveryholdpolicy-post-usersources.md - name: eDiscovery search items: - name: eDiscovery search items: href: ../../api/security-ediscoverycase-delete-searches.md - name: Estimate statistics href: ../../api/security-ediscoverysearch-estimatestatistics.md+ - name: Purge data + href: ../../api/security-ediscoverysearch-purgedata.md + - name: Export report + href: ../../api/security-ediscoverysearch-exportreport.md + - name: Export result + href: ../../api/security-ediscoverysearch-exportresult.md - name: List additional sources href: ../../api/security-ediscoverysearch-list-additionalsources.md - name: Add additional sources items: href: ../../api/security-ediscoverycase-delete-tags.md - name: List tags as hierarchy href: ../../api/security-ediscoveryreviewtag-ashierarchy.md+- name: Identities + items: + - name: Health issue + items: + - name: Health issue + href: ../../resources/security-healthissue.md + - name: List + href: ../../api/security-identitycontainer-list-healthissues.md + - name: Get + href: ../../api/security-healthissue-get.md + - name: Update + href: ../../api/security-healthissue-update.md + - name: Sensor + items: + - name: Sensor + href: ../../resources/security-sensor.md + - name: List + href: ../../api/security-identitycontainer-list-sensors.md + - name: Get + href: ../../api/security-sensor-get.md + - name: Update + href: ../../api/security-sensor-update.md + - name: Delete + href: ../../api/security-sensor-delete.md + - name: Get deployment access key + href: ../../api/security-sensor-getdeploymentaccesskey.md + - name: Get deployment package URI + href: ../../api/security-sensor-getdeploymentpackageuri.md + - name: Regenerate deployment access key + href: ../../api/security-sensor-regeneratedeploymentaccesskey.md + - name: Complex types + items: + - name: Deployment access key type + href: ../../resources/security-deploymentaccesskeytype.md + - name: Identity container + href: ../../resources/security-identitycontainer.md + - name: Network adapter + href: ../../resources/security-networkadapter.md + - name: Sensor deployment package + href: ../../resources/security-sensordeploymentpackage.md + - name: Sensor settings + href: ../../resources/security-sensorsettings.md - name: Information protection items: - name: Threat assessment |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/tasks-and-plans/toc.yml | a/api-reference/v1.0/toc/tasks-and-plans/toc.yml items: items: - name: Planner plan href: ../../resources/plannerplan.md- - name: Get plan + - name: Create + href: ../../api/planner-post-plans.md + - name: Get href: ../../api/plannerplan-get.md+ - name: Update + href: ../../api/plannerplan-update.md + - name: Delete + href: ../../api/plannerplan-delete.md - name: List plan buckets href: ../../api/plannerplan-list-buckets.md - name: List plan tasks href: ../../api/plannerplan-list-tasks.md- - name: Update plan - href: ../../api/plannerplan-update.md - - name: Delete plan - href: ../../api/plannerplan-delete.md - name: Planner plan details items: - name: Planner plan details items: items: - name: Planner task href: ../../resources/plannertask.md- - name: Get task + - name: Create + href: ../../api/planner-post-tasks.md + - name: Get href: ../../api/plannertask-get.md- - name: Update task + - name: Update href: ../../api/plannertask-update.md- - name: Delete task + - name: Delete href: ../../api/plannertask-delete.md - name: Planner task details items: |
v1.0 | Toc.Yml | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/teamwork-and-communications/toc.yml | a/api-reference/v1.0/toc/teamwork-and-communications/toc.yml items: href: ../../api/userteamwork-teamsappinstallation-upgrade.md - name: Remove app for user href: ../../api/userteamwork-delete-installedapps.md+ - name: List apps in chat + href: ../../api/chat-list-installedapps.md + - name: Get app installed in chat + href: ../../api/chat-get-installedapps.md + - name: Add app in chat + href: ../../api/chat-post-installedapps.md + - name: Upgrade app installed in chat + href: ../../api/chat-teamsappinstallation-upgrade.md + - name: Remove app from chat + href: ../../api/chat-delete-installedapps.md - name: Teams app settings items: - name: Teams app settings items: href: ../../api/group-list-permissiongrants.md - name: List permission grants of a team href: ../../api/team-list-permissiongrants.md+ - name: List permission grants of a user + href: ../../api/user-list-permissiongrants.md - name: Calls and online meetings items: - name: Overview items: items: - name: Call href: ../../resources/call.md+ - name: Create + href: ../../api/application-post-calls.md - name: Get href: ../../api/call-get.md - name: Delete/hang up items: href: ../../api/onlinemeeting-list-recordings.md - name: Get href: ../../api/callrecording-get.md+ - name: Get delta by organizer + href: ../../api/callrecording-delta.md + - name: List recordings by organizer + href: ../../api/onlinemeeting-getallrecordings.md - name: Call transcript items: - name: Call transcript items: href: ../../api/onlinemeeting-list-transcripts.md - name: Get transcript href: ../../api/calltranscript-get.md+ - name: Get delta by organizer + href: ../../api/calltranscript-delta.md + - name: List transcripts by organizer + href: ../../api/onlinemeeting-getalltranscripts.md - name: Virtual appointment items: - name: Get virtual appointment join link items: items: - name: Virtual event webinar href: ../../resources/virtualeventwebinar.md+ - name: List + href: ../../api/virtualeventsroot-list-webinars.md - name: Create href: ../../api/virtualeventsroot-post-webinars.md - name: Get items: href: ../../api/virtualeventwebinar-publish.md - name: Cancel href: ../../api/virtualeventwebinar-cancel.md- - name: List in organization - href: ../../api/virtualeventsroot-list-webinars.md - name: List by user role href: ../../api/virtualeventwebinar-getbyuserrole.md - name: List by user ID and role items: href: ../../api/channel-patch.md - name: Delete channel href: ../../api/channel-delete.md- - name: Get message delta - href: ../../api/chatmessage-delta.md - name: List channel messages href: ../../api/channel-list-messages.md - name: Get all channel messages href: ../../api/channel-getallmessages.md+ - name: Get all retained channel messages + href: ../../api/channel-getallretainedmessages.md - name: Create channel message post href: ../../api/channel-post-messages.md - name: Create reply to channel message post items: href: ../../api/chatmessage-get.md - name: Get messages across all chats href: ../../api/chats-getallmessages.md+ - name: Get retained messages across all chats + href: ../../api/chat-getallretainedmessages.md + - name: Get delta chat messages for user + href: ../../api/chatmessage-delta.md - name: Apps items: - name: List apps in chat items: items: - name: List messages in channel href: ../../api/channel-list-messages.md- - name: Get delta of messages in channel - href: ../../api/chatmessage-delta.md - name: Create subscription for new channel messages href: ../../api/subscription-post-subscriptions.md - name: Get message in channel items: href: ../../api/chatmessage-get.md - name: Get messages across all chats for user href: ../../api/chats-getallmessages.md+ - name: Get delta chat messages for user + href: ../../api/chatmessage-delta.md - name: Get all channel messages href: ../../api/channel-getallmessages.md - name: Create subscription for new chat messages items: href: ../../api/workforceintegration-update.md - name: Delete href: ../../api/workforceintegration-delete.md+ - name: Working time schedule + items: + - name: Working time schedule + href: ../../resources/workingtimeschedule.md + - name: Get + href: ../../api/workingtimeschedule-get.md + - name: Start working time + href: ../../api/workingtimeschedule-startworkingtime.md + - name: End working time + href: ../../api/workingtimeschedule-endworkingtime.md - name: Complex types items: - name: Change tracked entity items: href: ../../resources/timeoffitem.md - name: Time range href: ../../resources/timerange.md+ - name: User solution root + href: ../../resources/usersolutionroot.md - name: Workforce integration encryption href: ../../resources/workforceintegrationencryption.md |
v1.0 | Toc.Mapping.Json | https://github.com/microsoftgraph/microsoft-graph-docs-contrib/commits/main/api-reference/v1.0/toc/toc.mapping.json | a/api-reference/v1.0/toc/toc.mapping.json "childNodes": [ { "name": "Policies", + "shouldSort": true, "resources": [- "remoteDesktopSecurityConfiguration", "tokenIssuancePolicy", "tokenLifetimePolicy"+ ], + "childNodes": [ + { + "name": "Application management policy", + "shouldSort": true, + "overview": "../../resources/applicationauthenticationmethodpolicy.md", + "resources": [ + "tenantAppManagementPolicy", + "appManagementPolicy" + ] + } ] } ] "claimsMappingPolicy", "customClaimsPolicy", "homeRealmDiscoveryPolicy"+ ], + "childNodes": [ + { + "name": "Remote desktop security policy", + "resources": [ + "remoteDesktopSecurityConfiguration", + "targetDeviceGroup" + ] + } ] } ] "event", "eventMessage", "attachment",+ "fileAttachment", + "itemAttachment", + "referenceAttachment", "calendarGroup", "calendarPermission", "outlookCategory" "rubricQualitySelectedColumnModel" ] },+ { + "name": "Employee experience", + "childNodes": [ + { + "name": "Employee engagement", + "overview": "../../resources/engagement-api-overview.md", + "resources": [ + "community", + "engagementAsyncOperation" + ] + } + ] + }, { "name": "Extensions", "overview": "/graph/extensibility-overview?context=graph%2Fapi%2F1.0&preserve-view=true", "driveItem", "bundle", "permission",- "fileStorageContainer" + "fileStorageContainer", + "sharedDriveItem" ] }, { "shouldSort": true, "resources": [ "administrativeUnit",+ "appRoleAssignment", "contract", "directory", "device", "microsoft.graph.identityGovernance.workflowTemplate", "microsoft.graph.identityGovernance.taskDefinition", "microsoft.graph.identityGovernance.customTaskExtension",- "microsoft.graph.identityGovernance.lifecycleManagementSettings" + "microsoft.graph.identityGovernance.lifecycleManagementSettings", + "microsoft.graph.identitygovernance.insights" ], "complexTypes": [ "azureAdPopTokenAuthentication", "name": "Identity and sign-in", "shouldSort": true, "resources": [- "authenticationEventListener", - "customAuthenticationExtension", "dataPolicyOperation", "oAuth2PermissionGrant", "certificateBasedAuthConfiguration", "invitation" ], "childNodes": [+ { + "name": "Authentication event listeners", + "resources": [ + "authenticationEventListener", + "onAttributeCollectionListener", + "onAttributeCollectionStartListener", + "onAttributeCollectionSubmitListener", + "onAuthenticationMethodLoadStartListener", + "onInteractiveAuthFlowStartListener", + "onTokenIssuanceStartListener", + "onUserCreateStartListener" + ] + }, { "name": "Authentication methods", "overview": "../../resources/authenticationmethods-overview.md", ] }, {- "name": "Custom authentication extension", + "name": "Custom authentication extensions", "resources": [+ "customAuthenticationExtension", "onTokenIssuanceStartCustomExtension" ] }, "resources": [ "riskDetection", "riskyUser",+ "riskyUserHistoryItem", "servicePrincipalRiskDetection", "riskyServicePrincipal" ] "resources": [ "activityBasedTimeoutPolicy", "authorizationPolicy",- "claimsMappingPolicy", "homeRealmDiscoveryPolicy",- "tokenIssuancePolicy", - "tokenLifetimePolicy", "authenticationFlowsPolicy", "authenticationStrengthPolicy", "featureRolloutPolicy", "identitySecurityDefaultsEnforcementPolicy" ], "childNodes": [- { - "name": "Application authentication method policy", - "overview": "../../resources/applicationauthenticationmethodpolicy.md", - "resources": [ - "tenantAppManagementPolicy", - "appManagementPolicy" - ] - }, { "name": "Authentication methods policy", "overview": "../../resources/authenticationmethodspolicies-overview.md", "voiceAuthenticationMethodConfiguration", "x509CertificateAuthenticationMethodConfiguration" ]- }, - { - "name": "Remote desktop security configuration", - "resources": [ - "remoteDesktopSecurityConfiguration", - "targetDeviceGroup" - ] } ] }, "identityUserFlowAttribute", "identityUserFlowAttributeAssignment", "userFlowLanguageConfiguration",- "identityApiConnector" + "identityApiConnector", + "identityUserFlow" ] } ] "name": "Microsoft 365 usage reports", "overview": "../../resources/report.md", "resources": [+ "adminReportSettings", "reportRoot" ] }, "microsoft.graph.security.caseOperation", "microsoft.graph.security.ediscoveryCustodian", "microsoft.graph.security.ediscoveryNoncustodialDataSource",+ "microsoft.graph.security.ediscoveryHoldPolicy", "microsoft.graph.security.ediscoverySearch", "microsoft.graph.security.ediscoveryReviewSet", "microsoft.graph.security.ediscoveryReviewTag" ] },+ { + "name": "Identities", + "resources": [ + "microsoft.graph.security.healthIssue", + "microsoft.graph.security.sensor" + ], + "complexTypes": [ + "microsoft.graph.security.deploymentAccessKeyType", + "microsoft.graph.security.identityContainer", + "microsoft.graph.security.networkAdapter", + "microsoft.graph.security.sensorDeploymentPackage", + "microsoft.graph.security.sensorSettings" + ] + }, { "name": "Information protection", "childNodes": [ "timeOff", "timeOffReason", "timeOffRequest",- "workforceIntegration" + "workforceIntegration", + "workingTimeSchedule" ], "complexTypes": [ "changeTrackedEntity", "shiftItem", "timeOffItem", "timeRange",+ "userSolutionRoot", "workforceIntegrationEncryption" ] } |